Scopes en Ruby on Rails: consultas con nombre
Los scopes (en español, «ámbitos» o «alcances») son condiciones que declaras en el modelo para definir grupos de registros de una tabla: los artículos publicados, los usuarios activos, los pedidos de este mes.
Piensa en las carpetas inteligentes de tu correo: defines una vez «correos sin leer de mi jefa» y luego solo haces clic. No vuelves a escribir el filtro cada vez.
Por qué las consultas van en el modelo
Las consultas pertenecen al modelo, no al controlador. Si escribes el mismo where en varios controladores, tendrás que cambiarlo en todos cuando cambie la regla. Si lo declaras en el modelo, está en un solo sitio y lo llamas desde donde haga falta.
Cómo se declara un scope
class Article < ApplicationRecord
scope :publicados, -> { where(state: "published") }
scope :ultimos, -> { order(created_at: :desc).limit(2) }
end
-> crea una lambda, un bloque de código guardado que Rails ejecuta cada vez que llamas al scope. Así la consulta se calcula en el momento y no cuando arranca la aplicación.
Se usa como cualquier método de clase:
Article.publicados # todos los publicados
Article.publicados.ultimos # los dos publicados más recientes
Encadenar scopes
Cada scope devuelve una relación (ActiveRecord::Relation), así que puedes seguir añadiendo condiciones. Rails no lanza una consulta por cada eslabón: los junta todos y ejecuta una sola SQL cuando necesitas los datos.
Article.publicados.ultimos.to_sql
# SELECT "articles".* FROM "articles"
# WHERE "articles"."state" = 'published'
# ORDER BY "articles"."created_at" DESC LIMIT 2
También se combinan con where, order o con los métodos de las consultas desde la consola. Para filtrar por datos de otra tabla, combina el scope con joins sobre sus asociaciones.
Scopes con parámetros
La lambda puede recibir argumentos:
class Article < ApplicationRecord
scope :con_titulo, ->(texto) { where("title LIKE ?", "%#{sanitize_sql_like(texto)}%") }
end
Article.publicados.con_titulo("Ruby")
El ? evita la inyección SQL y sanitize_sql_like escapa los caracteres especiales de LIKE (% y _) si vienen en el texto del usuario.
Scope o método de clase
El original de este artículo decía que crear un scope o un método de clase «es exactamente lo mismo». Casi, pero no del todo:
# Scope
scope :publicados, -> { where(state: "published") }
# Método de clase equivalente
def self.publicados
where(state: "published")
end
La diferencia aparece cuando hay una condición. Un scope siempre devuelve una relación, aunque la condición no se cumpla; un método de clase puede devolver nil y romper la cadena:
scope :desde, ->(fecha) { where(created_at: fecha..) if fecha }
Article.desde(nil).publicados # funciona: el scope devuelve todos
def self.desde(fecha)
where(created_at: fecha..) if fecha
end
Article.desde(nil).publicados # NoMethodError: undefined method 'publicados' for nil
Si prefieres el método de clase, devuelve all en la rama vacía para que siga siendo encadenable.
Scope
- Una línea, fácil de leer
- Siempre encadenable
- Para filtros sencillos
Método de clase
- Admite lógica de varias líneas
- Puede devolver
nilsi te descuidas - Para consultas con más lógica
Escribe el filtro una vez; llámalo por su nombre.
Un enum del modelo también crea scopes solos: con enum :status, [:borrador, :publicado], Rails define Article.borrador y Article.publicado.
Un scope con nombre también es más fácil de probar: puedes escribir un test que compruebe qué registros devuelve. Si quieres empezar con tests en Ruby, mira Introducción al testing en Ruby.
Fuentes
- Active Record Query Interface: Scopes (guías de Rails 8.1.4.1): declaración, argumentos, «a scope will always return an
ActiveRecord::Relationobject, even if the conditional evaluates tofalse»,default_scopeyunscoped. - ActiveRecord::Sanitization::ClassMethods#sanitize_sql_like.
Los scopes publicados, ultimos y con_titulo, el encadenamiento y la SQL generada se han ejecutado con Rails 8.1.4.1 y Ruby 4.0.9 (imagen oficial ruby:latest de Docker) sobre SQLite, con un modelo Course en lugar de Article. El ejemplo de desde(nil), con el scope y con el método de clase, se ha ejecutado con un modelo Article en las mismas versiones.