ruby - 将 ActiveRecord 如何使用模块应用到其他 Ruby 项目

Question

我决定深入研究 Rails 的 ActiveRecord 代码，试图弄清楚其中的一些是如何工作的，并且惊讶地发现它由许多模块组成，而这些模块似乎都包含在 ActiveRecord::Base 中。

我知道 Ruby 模块提供了一种对相关和可重用方法进行分组的方法，这些方法可以混合到其他类中以扩展它们的功能。

但是，大多数 ActiveRecord 模块似乎都高度特定于 ActiveRecord。在某些模块中似乎有对实例变量的引用，这表明这些模块了解整个 ActiveRecord 类和其他模块的内部结构。

这让我想知道 ActiveRecord 是如何设计的，以及这种逻辑可以或应该如何应用于其他 Ruby 应用程序。

这是一种常见的“设计模式”，将大类拆分为模块，而这些模块在其他地方并不能真正重用，只是为了拆分类文件？当模块使用可能由不同模块或类的一部分定义的实例变量时，它被视为好设计还是坏设计？

如果一个类可以有很多方法并且将它们全部定义在一个文件中会变得很麻烦，那么在其他文件中重新打开该类并在其中定义更多方法是否同样有意义？

在我正在处理的命令行应用程序中，我有几个执行各种功能的类，但我有一个顶级类为整个应用程序提供 API - 我发现该类正在陷入困境许多方法真正将工作移交给其他类，就像将应用程序的各个部分粘合在一起的胶水一样。我想我想知道将一些相关方法拆分成模块或在不同的代码文件中重新打开类对我来说是否有意义？或者还有什么我没有想到的？

Answer 1

我已经创建了很多我不打算高度可重用的模块。它使得单独测试一组相关方法变得更容易，并且如果类只有几百行而不是数千行，则它们更具可读性。与往常一样，需要取得平衡。

我还创建了期望包含类定义实例方法的模块，以便在模块上定义的方法可以使用它们。我不会说它非常优雅，但如果您只在几个类之间共享代码并且记录得很好，那么它是可行的。如果类没有定义您想要的方法，您也可以引发异常:

module Aggregator
  def aggregate
    unless respond_to?(:collection)
      raise Exception.new("Classes including #{self} must define #collection")
    end
    # ...
  end
end

如果依赖共享实例变量，我会更加犹豫。

我发现重新开课最大的问题就是管理你的源代码。您最终会在不同目录中得到多个 aggregator.rb 副本吗？这些文件的加载顺序是否确定，这是否会影响类中的覆盖或调用方法？至少对于模块，包含顺序在源代码中是明确的。

---

更新:在评论中，Stephen 询问了有关测试要包含在类中的模块的问题。

RSpec 提供 shared_examples 作为测试共享行为的便捷方式。您可以在共享上下文中定义模块的行为，然后声明每个包含的类也应该表现出该行为:

# spec/shared_examples/aggregator_examples.rb
shared_examples_for 'Aggregator' do
  describe 'when aggregating records' do
    it 'should accumulate values' do
      # ...
    end
  end
end

# spec/models/model_spec.rb
describe Model
  it_should_behave_like 'Aggregator'
end

即使您不使用 RSpec，您仍然可以创建一个包含您的模块的简单 stub 类，然后针对该类的实例编写测试:

# test/unit/aggregator_test.rb
class AggregatorTester
  attr_accessor :collection

  def initialize(collection)
    self.collection = collection
  end

  include Aggregator
end

def test_aggregation
  assert_equal 6, AggregatorTester.new([1, 2, 3]).aggregate
end