ruby-on-rails - tutorial - web app ruby on rails




Comment utiliser les préoccupations dans Rails 4 (4)

Donc je l'ai trouvé par moi-même. C'est en fait un concept assez simple mais puissant. Cela a à voir avec 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 deviennent trop gros et salissants.

Par 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 que vous désirez et partager ses fonctionnalités.

C'est assez bien expliqué par DHH :

Dans Rails 4, nous allons inviter les programmeurs à utiliser les problèmes avec les répertoires app / models / concerns et app / controllers / concerns 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.

Le générateur de projet Rails 4 par défaut 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 assez 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é, y a-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?


En ce qui concerne faire le fichier filename.rb

Par exemple, je veux dans mon application où l'attribut create_by existe mettre à jour sa valeur par 1, et 0 par update_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

après cela inclure dans votre modèle comme ceci:

class Role < ActiveRecord::Base
  include TestConcern
end

J'ai lu à propos de l'utilisation des préoccupations de modèles pour skin-nize modèles de graisse ainsi que sécher vos codes de modèle. Voici une explication avec des exemples:

1) Séchage des codes modèles

Considérons un modèle d'article, un modèle d'événement et un modèle de commentaire. Un article ou un événement a beaucoup de 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 y a un morceau significatif de code commun à la fois à l'événement et à l'article. En utilisant les 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 / concerns.

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 de graisse de nidation de peau.

Considérez 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 deviennent ingérables. Les préoccupations fournissent un moyen de skin-nize modules de graisse, ce qui les rend plus modulaire et facile à comprendre.

Le modèle ci-dessus peut être remodelé en utilisant les préoccupations suivantes: Créer un fichier attendable.rb et un fichier commentable.rb dans le dossier app / models / concerns / event

attenable.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 Concerns, votre modèle d'événement réduit à

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

* Lors de l'utilisation, il est conseillé d'opter pour un regroupement basé sur le domaine plutôt que pour un groupement "technique". Le regroupement basé sur un domaine est similaire à 'Commentable', 'Photoable', 'Attendable'. Le regroupement technique signifiera «ValidationMethods», «FinderMethods», etc.


J'ai ressenti la plupart des exemples ici démontrant la puissance du module plutôt que comment ActiveSupport::Concern ajoute de la valeur au module .

Exemple 1: Des modules plus lisibles.

Donc, sans se soucier de ce que sera un module 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 les méthodes d'instance, les méthodes de classe et le bloc inclus sont moins salissants. Les préoccupations les injecteront de manière appropriée pour vous. C'est un avantage d'utiliser ActiveSupport::Concern .

Exemple 2: Gérez les dépendances du module 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, Bar est le module dont Host réellement besoin. Mais étant donné que Bar a une dépendance avec Foo la classe Host doit include Foo (mais attendez que l' Host veuille savoir à propos de Foo ? Peut-il être évité?).

Donc, Bar ajoute la dépendance partout où ça va. Et l' ordre d'inclusion compte également ici. Cela ajoute beaucoup de complexité / dépendance à l'é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, cela semble simple.

Si vous pensez pourquoi ne pouvons-nous pas ajouter la dépendance Foo dans le module Bar lui-même? Cela ne marchera pas puisque method_injected_by_foo_to_host_klass doit être injecté dans la classe thats incluant le module Bar not on Bar .

Source: Rails ActiveSupport :: Préoccupation







dci