Comment utiliser les préoccupations dans Rails 4

Le générateur de projet par défaut de Rails 4 crée maintenant le répertoire "préoccupations" sous les contrôleurs et les modèles. J'ai trouvé quelques explications sur la façon d'utiliser les problèmes de routage, mais rien sur les contrôleurs ou les modèles.

Je suis à peu près sûr que cela a à voir avec la "tendance DCI" actuelle dans la communauté et je voudrais essayer.

La question est, comment suis-je censé utiliser cette fonctionnalité, existe-t-il une convention sur la façon de définir la hiérarchie de nommage / classe afin de la faire fonctionner? Comment puis-je inclure une préoccupation dans un modèle ou un contrôleur?

Je l'ai donc découvert par moi-même. C'est en fait un concept assez simple mais puissant. Cela concerne la réutilisation du code comme dans l'exemple ci-dessous. Fondamentalement, l'idée est d'extraire des morceaux de code communs et / ou spécifiques au contexte afin de nettoyer les modèles et d'éviter qu'ils ne deviennent trop gros et désordonnés.

À titre d'exemple, je vais mettre un modèle bien connu, le modèle taggable:

# app/models/product.rb
class Product
  include Taggable

  ...
end

# app/models/concerns/taggable.rb
# notice that the file name has to match the module name 
# (applying Rails conventions for autoloading)
module Taggable
  extend ActiveSupport::Concern

  included do
    has_many :taggings, as: :taggable
    has_many :tags, through: :taggings

    class_attribute :tag_limit
  end

  def tags_string
    tags.map(&:name).join(', ')
  end

  def tags_string=(tag_string)
    tag_names = tag_string.to_s.split(', ')

    tag_names.each do |tag_name|
      tags.build(name: tag_name)
    end
  end

  # methods defined here are going to extend the class, not the instance of it
  module ClassMethods

    def tag_limit(value)
      self.tag_limit_value = value
    end

  end

end

Ainsi, en suivant l'exemple de produit, vous pouvez ajouter Taggable à n'importe quelle classe de votre choix et partager ses fonctionnalités.

Ceci est assez bien expliqué par DHH :

Dans Rails 4, nous allons inviter les programmeurs à utiliser des préoccupations avec les répertoires app / models / concern et app / controllers / concern par défaut qui font automatiquement partie du chemin de chargement. Avec l'encapsuleur ActiveSupport :: Concern, c'est juste assez de support pour faire briller ce mécanisme d'affacturage léger.

J'ai lu comment utiliser les préoccupations des modèles pour maquiller les modèles gras et sécher vos codes de modèle. Voici une explication avec des exemples:

1) SÉCHAGE des codes modèles

Prenons un modèle d'article, un modèle d'événement et un modèle de commentaire. Un article ou un événement a de nombreux commentaires. Un commentaire appartient à un article ou à un événement.

Traditionnellement, les modèles peuvent ressembler à ceci:

Modèle de commentaire:

class Comment < ActiveRecord::Base
  belongs_to :commentable, polymorphic: true
end

Modèle d'article:

class Article < ActiveRecord::Base
  has_many :comments, as: :commentable 

  def find_first_comment
    comments.first(created_at DESC)
  end

  def self.least_commented
   #return the article with least number of comments
  end
end

Modèle d'événement

class Event < ActiveRecord::Base
  has_many :comments, as: :commentable 

  def find_first_comment
    comments.first(created_at DESC)
  end

  def self.least_commented
   #returns the event with least number of comments
  end
end

Comme nous pouvons le remarquer, il existe un morceau de code important commun à la fois à l'événement et à l'article. En utilisant des préoccupations, nous pouvons extraire ce code commun dans un module séparé Commentable.

Pour cela, créez un fichier commentable.rb dans app / models / préoccupations.

module Commentable
  extend ActiveSupport::Concern

  included do
    has_many :comments, as: :commentable
  end

  # for the given article/event returns the first comment
  def find_first_comment
    comments.first(created_at DESC)
  end

  module ClassMethods
    def least_commented
      #returns the article/event which has the least number of comments
    end
  end
end

Et maintenant, vos modèles ressemblent à ceci:

Modèle de commentaire:

class Comment < ActiveRecord::Base
  belongs_to :commentable, polymorphic: true
end

Modèle d'article:

class Article < ActiveRecord::Base
  include Commentable
end

Modèle d'événement:

class Event < ActiveRecord::Base
  include Commentable
end

2) Modèles Fat Skin-nizing.

Prenons un modèle d'événement. Un événement a de nombreux participants et commentaires.

En règle générale, le modèle d'événement peut ressembler à ceci

class Event < ActiveRecord::Base   
  has_many :comments
  has_many :attenders


  def find_first_comment
    # for the given article/event returns the first comment
  end

  def find_comments_with_word(word)
    # for the given event returns an array of comments which contain the given word
  end 

  def self.least_commented
    # finds the event which has the least number of comments
  end

  def self.most_attended
    # returns the event with most number of attendes
  end

  def has_attendee(attendee_id)
    # returns true if the event has the mentioned attendee
  end
end

Les modèles avec de nombreuses associations et autrement ont tendance à accumuler de plus en plus de code et à devenir ingérables. Les préoccupations fournissent un moyen de skin-nize les modules adipeux les rendant plus modularisés et faciles à comprendre.

Le modèle ci-dessus peut être refactorisé en utilisant les préoccupations comme ci-dessous: Créez un fichier attendable.rbet commentable.rbdans le dossier app / models / concern / event

attendable.rb

module Attendable
  extend ActiveSupport::Concern

  included do 
    has_many :attenders
  end

  def has_attender(attender_id)
    # returns true if the event has the mentioned attendee
  end

  module ClassMethods
    def most_attended
      # returns the event with most number of attendes
    end
  end
end

commentable.rb

module Commentable
  extend ActiveSupport::Concern

  included do 
    has_many :comments
  end

  def find_first_comment
    # for the given article/event returns the first comment
  end

  def find_comments_with_word(word)
    # for the given event returns an array of comments which contain the given word
  end

  module ClassMethods
    def least_commented
      # finds the event which has the least number of comments
    end
  end
end

Et maintenant, en utilisant Préoccupations, votre modèle d'événement se réduit à

class Event < ActiveRecord::Base
  include Commentable
  include Attendable
end

* Lors de l'utilisation, il est préférable d'opter pour un groupement basé sur un domaine plutôt que sur un groupement «technique». Le regroupement basé sur le domaine est comme «Commentable», «Photoable», «Attendable». Le regroupement technique signifie «ValidationMethods», «FinderMethods», etc.

Il convient de mentionner que l'utilisation de préoccupations est considérée comme une mauvaise idée par beaucoup.

1. comme ce mec
2. et celui-là

Certaines raisons:

1. Il y a de la magie noire dans les coulisses - Le souci est la includeméthode de correction , il y a tout un système de gestion des dépendances - beaucoup trop de complexité pour quelque chose qui est un bon vieux modèle de mixage Ruby.
2. Vos cours ne sont pas moins secs. Si vous bourrez 50 méthodes publiques dans divers modules et les incluez, votre classe a toujours 50 méthodes publiques, c'est juste que vous cachez cette odeur de code, sorte de mettre vos ordures dans les tiroirs.
3. Codebase est en fait plus difficile à naviguer avec toutes ces préoccupations.
4. Êtes-vous sûr que tous les membres de votre équipe ont la même compréhension de ce qui devrait réellement remplacer la préoccupation?

Les soucis sont un moyen facile de se tirer une balle dans la jambe, soyez prudent avec eux.

Ce message m'a aidé à comprendre les préoccupations.

# app/models/trader.rb
class Trader
  include Shared::Schedule
end

# app/models/concerns/shared/schedule.rb
module Shared::Schedule
  extend ActiveSupport::Concern
  ...
end

J'ai senti que la plupart des exemples présentés ici démontraient le pouvoir de modulela ActiveSupport::Concernvaleur ajoutée plutôt que la façon dont elle l' ajoutait module.

Exemple 1: modules plus lisibles.

Donc, sans se soucier de la façon dont ce modulesera typique .

module M
  def self.included(base)
    base.extend ClassMethods
    base.class_eval do
      scope :disabled, -> { where(disabled: true) }
    end
  end

  def instance_method
    ...
  end

  module ClassMethods
    ...
  end
end

Après refactoring avec ActiveSupport::Concern.

require 'active_support/concern'

module M
  extend ActiveSupport::Concern

  included do
    scope :disabled, -> { where(disabled: true) }
  end

  class_methods do
    ...
  end

  def instance_method
    ...
  end
end

Vous voyez que les méthodes d'instance, les méthodes de classe et le bloc inclus sont moins compliqués. Les préoccupations les injecteront de manière appropriée pour vous. C'est un avantage de l'utilisation ActiveSupport::Concern.

Exemple 2: Gérez les dépendances des modules avec élégance.

module Foo
  def self.included(base)
    base.class_eval do
      def self.method_injected_by_foo_to_host_klass
        ...
      end
    end
  end
end

module Bar
  def self.included(base)
    base.method_injected_by_foo_to_host_klass
  end
end

class Host
  include Foo # We need to include this dependency for Bar
  include Bar # Bar is the module that Host really needs
end

Dans cet exemple, Barle module a Hostvraiment besoin. Mais puisque la Bardépendance avec Foola Hostclasse doit le faire include Foo(mais attendez pourquoi Hostveut savoir Foo? Peut-il être évité?).

BarAjoute donc la dépendance partout où il va. Et l' ordre d'inclusion est également important ici. Cela ajoute beaucoup de complexité / dépendance à une énorme base de code.

Après refactoring avec ActiveSupport::Concern

require 'active_support/concern'

module Foo
  extend ActiveSupport::Concern
  included do
    def self.method_injected_by_foo_to_host_klass
      ...
    end
  end
end

module Bar
  extend ActiveSupport::Concern
  include Foo

  included do
    self.method_injected_by_foo_to_host_klass
  end
end

class Host
  include Bar # It works, now Bar takes care of its dependencies
end

Maintenant, ça a l'air simple.

Si vous pensez pourquoi ne pouvons-nous pas ajouter de Foodépendance dans le Barmodule lui-même? Cela ne fonctionnera pas car method_injected_by_foo_to_host_klassil doit être injecté dans une classe qui n'inclut Barpas le Barmodule lui-même.

Source: Rails ActiveSupport :: Préoccupation

En cas de soucis, créez le fichier filename.rb

Par exemple, je veux dans mon application où l'attribut create_by existe mettre à jour la valeur par 1, et 0 pour updated_by

module TestConcern 
  extend ActiveSupport::Concern

  def checkattributes   
    if self.has_attribute?(:created_by)
      self.update_attributes(created_by: 1)
    end
    if self.has_attribute?(:updated_by)
      self.update_attributes(updated_by: 0)
    end
  end

end

Si vous voulez passer des arguments en action

included do
   before_action only: [:create] do
     blaablaa(options)
   end
end

après cela, incluez dans votre modèle comme ceci:

class Role < ActiveRecord::Base
  include TestConcern
end