ruby - 我可以为嵌套的 RSpec 匹配器起别名吗？

Question

我有几个共享以下复杂期望的 RSpec 示例，数组 records 和 float min_long、max_long、min_lat、max_lat 在这些示例之间有所不同。

  expect(records).to all have_attributes(
    shape: have_attributes(
      exterior_ring: have_attributes(
        points: all(
          have_attributes(
            longitude: be_between(min_long, max_long),
            latitude: be_between(min_lat, max_lat)
          )
        )
      )
    )
  )

(期望检查相应测试产生的所有记录是否具有完全包含在测试特定边界框中的形状(RGeo Polygon，在我的例子中)。)

为了减少重复并通过在其上贴上名称使复杂期望的意图更加清晰，我将其提取为一个方法:

def expect_in_bbox(records, min_long, max_long, min_lat, max_lat)
  expect(records).to all have_attributes(
    shape: have_attributes(
      exterior_ring: have_attributes(
        points: all(
          have_attributes(
            longitude: be_between(min_long, max_long),
            latitude: be_between(min_lat, max_lat)
          )
        )
      )
    )
  )
end

这工作正常，但现在我必须用例如调用该方法

expect_in_bbox(valid_records, 12.55744, 12.80270, 51.36250, 51.63187)

在我的示例中。

这在 RSpec 的规范 DSL 中看起来很陌生。 我希望能够写作

expect(valid_records).to be_in_bbox(12.55744, 12.80270, 51.36250, 51.63187)

或

expect(valid_records).to all be_in_bbox(12.55744, 12.80270, 51.36250, 51.63187)

代替。

是否有推荐的方法来实现这一点？

我不认为我可以为此使用 RSpec 的匹配器别名工具，因为它们似乎只是将匹配器名称映射到其他匹配器名称，而不是完整的匹配器调用争论。虽然，也许是 alias_matcher 的 options 参数是为了那个？

当然，我也可以实现一个自定义匹配器，但是我可能会被迫提供一个返回 bool 值的实现，这与它由已经存在的匹配器组成相矛盾。 (并不是说它很难，但我喜欢使用诸如 all 和 be_between 之类的实现。)

最后，我还可以对 valid_records 元素的类进行猴子修补，使其具有 in_bbox?(min_long, max_long, min_lat, max_lat) 属性，这样RSpec 会自动提供相应的 be_in_bbox(min_long, max_long, min_lat, max_lat) 匹配器。

Answer 1

当然可以。让它成为 helper method .

辅助方法

这些只是普通的 Ruby 方法。您可以在任何示例组中定义它们。这些辅助方法会暴露给定义它们的组中的示例和嵌套在该组中的组，但不会暴露给父组或兄弟组。

def be_in_bbox(min_long, max_long, min_lat, max_lat)
  all(
    have_attributes(
      shape: have_attributes(
        exterior_ring: have_attributes(
          points: all(
            have_attributes(
              longitude: be_between(min_long, max_long),
              latitude: be_between(min_lat, max_lat)
            )
          )
        )
      )
    )
  )
end

我建议将该方法放在一个有用的命名文件中，该文件存储在 spec/support 中。可能是诸如 spec/support/rgeo_matchers.rb 之类的东西。正如所写，这将在 main 上定义 helper，将其混合到 Kernel 中，这使得它可用于 Ruby 中的每个对象。您需要确保所有必要的规范文件都需要此帮助程序文件:require 'support/rgeo_matchers'。

我建议不要在 main 上定义助手，而是 placing them in a module防止全局泄漏:

module MyProject
  module RGeo
    module Matchers
      def be_in_bbox(...)
        # ...
      end
    end
  end
end

由于匹配器位于模块中，因此您需要在 RSpec.describe block 中添加 include MyProject::RGeo::Matchers。

另一种方法是将其设为 shared context :

RSpec.shared_context "RGeo matchers" do
  def be_in_bbox(...)
    # ...
  end
end

对于共享上下文，您需要使用 include_context 代替 include:include_context "RGeo matchers"。

复杂匹配器

虽然您描述的匹配器相当嵌套，但如果它适合您的域模型并描述连贯的“单元”，那么这在我的书中是可以接受的。 “测试一件事”并不一定意味着只测试一个属性。这意味着测试一个“连贯的概念”或“单元”。这意味着什么取决于域模型。

合并composable matchers与 compound expectations ，正如您所展示的，提供了一种简单有效的替代方法来编写 custom matcher .

备选方案

根据您的建议，也许从助手中删除 all 以便匹配器仅描述“在边界框中”:

def be_in_bbox(min_long, max_long, min_lat, max_lat)
  have_attributes(
    # ...
  )
end

这使得匹配器更易于重用。因为它确实描述了“一件事”(例如“在边界框内”)。这允许您将其用作独立的匹配器或将其与其他匹配器组合:

it "returns matching bounding boxes" do
  expect(valid_records).to all be_in_bbox(12.55744, 12.80270, 51.36250, 51.63187)
end

it "is in bounding box defined by [(12.55744..12.80270), (51.36250..51.63187)]" do
  expect(generated_box).to be_in_bbox(12.55744, 12.80270, 51.36250, 51.63187)
end