Qu'est-ce que le scope/named_scope in rails?

Question

J'ai récemment commencé un stage. Mon employeur utilise ruby on rails, et je rencontre fréquemment de nouvelles syntaxes que je dois chercher pour comprendre. J'ai cherché sur Google une bonne explication de named_scope, mais ce que j'ai trouvé jusqu'à présent est principalement des articles de blog le louant, plutôt qu'une définition ou une introduction claire.

Qu'est-ce que named_scope (maintenant simplement appelé scope) en ruby on rails exactement?

Answer 1

Une portée est un sous-ensemble d'une collection. Cela semble compliqué ? Ce n'est pas le cas. Imaginez ceci :

Vous avez des Utilisateurs. Maintenant, certains de ces Utilisateurs sont abonnés à votre bulletin d'information. Vous avez marqué ceux qui reçoivent un bulletin d'information en ajoutant un champ à la base de données des Utilisateurs (user.subscribed_to_newsletter = true). Naturellement, vous voulez parfois obtenir ces Utilisateurs qui sont abonnés à votre bulletin d'information.

Vous pourriez, bien sûr, toujours faire ceci :

User.where(subscribed_to_newsletter: true).each do #quelquechose

Au lieu d'écrire cela tout le temps, vous pourriez cependant faire quelque chose comme ceci.

#Fichier: users.rb
class User < ActiveRecord::Base
  scope :newsletter, where(subscribed_to_newsletter: true)
  #bla bla

Si vous utilisez Rails 4 ou plus récent, faites ceci à la place :

#Fichier: users.rb
class User < ActiveRecord::Base
  scope :newsletter, -> { where(subscribed_to_newsletter: true) }
  #bla bla

Cela vous permet d'accéder à vos abonnés en faisant simplement ceci :

User.newsletter.each do #quelquechose

Ceci est un exemple très simple mais en général, les portées peuvent être des outils très puissants pour faciliter votre travail.

Consultez ce lien : Description de l'API

Answer 2

Scope dans active record est comme des méthodes de classe mais elles retournent un objet Relation, ce qui signifie que vous pouvez appeler un autre scope ou une méthode de requête active record dessus.

Par exemple, si vous avez un modèle Zombie (table zombies) avec les méthodes de scope mentionnées ci-dessous,

class Zombie
  scope :rotting, -> { where(rotting: true) }
  scope :fresh, -> { where('age < ?', 25) }
  scope :recent, -> { order(created_at: :desc) }
end

Et vous appelez

Zombie.rotting.fresh.recent.limit(3)

Cela se traduit par le SQL ci-dessous,

select "zombies.*" from "zombies" where "zombies"."rotting" = 't' and (age<20) order by create_at desc limit 3

L'exemple ci-dessus est basé sur la syntaxe de rails 4

Answer 3

Les scopes ne sont rien d'autre que des méthodes de classe.

Pourquoi les utiliser?

Le scoping vous permet de spécifier des requêtes couramment utilisées (cela peut être considéré comme un raccourci pour les requêtes longues ou les plus fréquemment utilisées) qui peuvent être référencées comme des appels de méthode sur les objets d'association ou les modèles. Avec ces scopes, vous pouvez utiliser toutes les méthodes précédemment couvertes telles que where, joins et includes. Toutes les méthodes de scope retourneront un objet ActiveRecord::Relation qui permettra d'appeler d'autres méthodes (comme d'autres scopes) dessus.

Pour définir un scope simple, nous utilisons la méthode scope à l'intérieur de la classe, en passant la requête que nous aimerions exécuter lorsque ce scope est appelé:

class Article < ActiveRecord::Base
  scope :published, -> { where(published: true) }
end

C'est exactement la même chose que de définir une méthode de classe, et celui que vous utilisez dépend de vos préférences personnelles:

class Article < ActiveRecord::Base
  def self.published
    where(published: true)
  end

Veuillez suivre le lien suivant pour une description complète avec exemple. J'espère que cela vous aidera.

http://guides.rubyonrails.org/active_record_querying.html

Answer 4

La meilleure façon de comprendre les détails est de consulter la documentation de l'API.

Vous obtiendrez les détails complets et les façons dont nous pouvons utiliser les Scopes.

Documentation de l'API sur les Scopes

Answer 5

• Imaginez que vous avez un modèle: Personne.

Maintenant, imaginez que vous :

• voulez toutes les personnes dans le monde qui ont les cheveux roux.
• voulez toutes les personnes dans le monde qui jouent au cricket

Vous pourriez obtenir ces classes particulières de personnes en utilisant une portée !

Personne.cheveux_roux.cricket ## trouve toutes les personnes aux cheveux roux qui jouent au cricket
Personne.cheveux_roux ## trouve toutes les personnes aux cheveux roux
Personne.cricket ## trouve toutes les personnes qui jouent au cricket.

Maintenant, ce n'était pas si difficile, n'est-ce pas ?