ruby-on-rails - 如何让一个问题包含另一个对参数的关注

Question

假设您从 ActiveSupport::Concern 的文档中获得此代码，但您希望包含的 Foo block 具有不同的内容，具体取决于包含 Foo 的模块或类。

在我试图解决的特定问题中，我有一组地址验证，但地址字段将被命名为 home_zip_code 或 work_zip_code，我希望包含验证问题以了解 zip_code 的前缀字段。

require 'active_support/concern'

module Foo
  extend ActiveSupport::Concern
  included do
    # have some_value be accessible 
    def self.method_injected_by_foo
      ...
    end
  end
end

module Bar
  extend ActiveSupport::Concern
  # set some_value that will used when Foo is included 
  include Foo

  included do
    self.method_injected_by_foo
  end
end

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

我已将此讨论放在此处:http://forum.railsonmaui.com/t/how-make-a-concern-parameterized/173

以下 2 个选项有效。我想知道哪个更好。

使用类方法的问题

这是需要“参数化”的关注点:

module Addressable
  extend ActiveSupport::Concern

  included do
    zip_field = "#{address_prefix}_zip_code".to_sym

    zip_code_regexp = /^\d{5}(?:[-\s]\d{4})?$/

    validates zip_field, format: zip_code_regexp, allow_blank: true
end

在包含可寻址关注点之前，我找到了 2 种设置地址前缀的方法。

当关注模块包含在类中时

在包含关注点之前需要定义类方法

cattr_accessor :address_prefix
self.address_prefix = "home"
include Addressable

或者像这样

def self.address_prefix
    "home"
end
include Addressable

当关注模块包含在另一个模块中时

这里的技巧是覆盖 self.append_features 并添加该方法。

  def self.append_features(base)
    base.class_eval do
      def self.address_prefix
        "home"
      end
    end
    super
  end

或

  def self.append_features(base)
    base.cattr_accessor :address_prefix
    base.address_prefix = "home"
    super
  end

问题

1. 哪个更好，cattr_accessor 方式还是定义类方法？
2. 对于关注情况中的关注，重写 self.append_features 是正确的钩子(Hook)吗？
3. class_eval 是创建方法的正确调用，而不是 class exec 吗？或者代码是否不需要访问实例变量真的​​无关紧要。 Module docs here .
4. 我怎么能把这个问题包含两次，比如前缀为“work”和前缀“home”，以便验证适用于两者。显然在包含的类上设置类方法是行不通的。或者如果在包含之间重新定义方法，也许会这样？有什么更清洁的方法吗？

Answer 1

cattr_accessor 或类方法方式是我以前用过的一种很好的方式。 cattr_accessor 正在定义一个方法，所以两者都可以。一个区别涉及继承，我认为 cattr_accessor 变量不是继承的。如果这可能是一个问题，可能想调查一下。

但实际上我此时会以一种完全不同的方式来处理这个问题。对我来说最简单的是定义一个可以带参数的类方法，例如 acts_as_addressable(address_prefix。您可以在模块 Addressible 中定义此方法，您可以在其中这样做:

extend Addressible
acts_as_addressbile('home')
acts_as_addressible('work')

你可以采用许多 gem 使用的捷径，实际上强制你的模块进入 ActiveRecord::Base，防止你需要在每个类中使用 extend ，但我个人讨厌那种风格。

根据您包含的 block 还做了什么，也许 validates_zip_code 是类方法的更好名称。对于样式，我建议实际使用该字段的全名。稍微输入更多，可读性更强:

module ZipCodeValidatable
  ZIP_CODE_REGEX = /^\d{5}(?:[-\s]\d{4})?$/
  def validates_zip_code(zip_field)
    validates zip_field, format: ZIP_CODE_REGEX, allow_blank: true
  end
end

class MyRecord << ActiveRecord::Base
  extend ZipCodeValidatable
  validates_zip_code("work_zip_code")
  validates_zip_code("home_zip_code")
end

如果验证邮政编码是您正在做的全部，那么您可以使用 custom validator .在我看来，您可以使用关于 ActiveModel::EachValidator 的第二部分。我从来没有用过这些，但我读过它看起来像:

class ZipCodeValidator < ActiveModel::EachValidator
  ZIP_CODE_REGEX = /^\d{5}(?:[-\s]\d{4})?$/
  def validate(record, attribute, value)
    unless ZIP_CODE_REGEX =~ value
      errors[attribute] << "Invalid zip code in field #{attribute}"
    end
  end
end