Rubocop 25 行块大小和 RSpec 测试

Question

典型的 RSpec 单元测试广泛使用嵌套 Ruby 块来构建代码并使用 DSL "magic" 使规范像 BDD 语句一样阅读：

describe Foo do
  context "with a bar" do
    before :each do
      subject { Foo.new().add_bar }
    end

    it "looks like a baz" do
      expect # etc

在理想的规范中，每个示例都可以相对简短和精确。然而，外部块增长到 100 行以上似乎很常见，因为 RSpec 结构以这种方式工作，并且没有采用很多规范示例，每个示例可能有几行特定设置，以达到describe 个大小与所描述主题的代码相同或更大的块。

Rubocop 最近的升级引入了一条新规则，即块不应超过 25 行。我不确定这样做的理由，因为它没有在 Ruby style guide 中列出。我明白为什么它可能是一件好事，并添加到默认规则集中。然而，在升级之后，我们的 Rubocop 测试多次失败并显示类似 tests/component_spec.rb:151:3: C: Block has too many lines. [68/25]

的消息

使用 Rubocop 等代码度量工具，我喜欢有一个 "Use the defaults, link to the style guide, job done." 的策略（主要是因为争论制表符与空格和其他细节是在浪费时间，并且IME never 得到解决）这显然是不可能的，我们的两个核心数据质量工具不同意代码布局方法 - 或者至少这是我解释结果的方式，我不看看我们编写规范的方式有什么本质上的错误。

作为回应，我们只是将 Rubocop 块大小规则设置为一个高阈值。但这让我想知道——我错过了什么？ RSpec 是否使用了现在不可信的代码布局方法，以及我必须在我们的 RSpec 测试中减少块大小的合理选项是什么？我可以看到重组代码以避免大块的方法，但它们无一例外都是丑陋的黑客，纯粹是为了满足 Rubocop 的规则，例如将所有块分解为辅助函数：

def looks_like_a_baz
  it "looks like a baz" do
         expect # etc
  end
end

def bar_context
  context "with a bar" do
    before :each do
      subject { Foo.new().add_bar }
    end
    looks_like_a_baz
  end
end


describe Foo do
  bar_context
  # etc

。 . .我的意思是，这是可行的，但以这种方式将大量规范示例转换为辅助函数似乎与 RSpec 设计鼓励的可读方法相反。

除了想办法忽略它，我还能做些什么吗？

我能在这里找到的关于这个主题的最接近的现有问题是 RSpec & Rubocop / Ruby Style Guide，这看起来可以通过编辑测试模板来解决。

Answer 1

A recent upgrade of Rubocop brought a new rule into play, that blocks should be no longer than 25 lines. I'm not sure of the rationale for it, because it is not listed in the Ruby style guide.

过去所有的警察都是基于 Ruby 风格指南，而 RuboCop 是一种遵守社区规定的做法的方式。

从那时起，方向发生了变化，RuboCop 的范围已经扩大，以帮助开发人员确保其代码库的总体一致性。这导致了两件事：

警察（即使是那些基于 Ruby 风格指南的警察）现在大部分都是可配置的。
对于 Ruby 风格指南中未提及的内容，有一些提示，但对于在项目中强制执行一致性仍然很有用。

这个警察属于第二类。

Is RSpec using a now discredited approach for code layout, and what reasonable options do I have to reduce block sizes in our RSpec tests?

简短的回答是否定的。 DSL 仍然很酷。 :-)

这个cop针对的是命令式编程意义上的大块。作为一般指南，它不适用于通常是声明性的 DSL。例如，在 Rails 中有一个长 routes.rb 文件是完全无害的。这只是大型应用程序的自然结果，而不是样式违规。（进行大量测试真是太棒了。）

现在，RuboCop 非常聪明，但它不知道什么是 DSL 什么不是，所以我们不能自动忽略它们。有人可能会争辩说我们可以排除流行框架的 DSL 入口方法，例如 Rails 路由和 RSpec 规范。不这样做的原因主要是：

漏报。任何 class 都可以实现一个方法，使用一个块，同名。
RuboCop 是一个 Ruby 分析工具，不应该真正了解外部库。（排除 /spec 目录是一种礼貌，直到我们有一个适当的扩展系统，这可以由 rubocop-rspec gem 处理。）

I mean, that's do-able, but turning bunches of spec examples into helper functions in this way seems to be the opposite of the readable approach encouraged by RSpec design.

底线是：RuboCop 可以帮助我们编写更好的代码。如果我们的应用程序设计在其他方面是合理的，并且我们发现自己只是为了取悦 RuboCop 而降低了可读性，那么我们应该过滤、配置或禁用 cop。 :-)

In response, we have simply set the Rubocop block size rule to a high threshold. But that makes me wonder - what am I missing?

这是一个相当生硬的工具，正如您所暗示的那样，您可能会因此而出现一些漏报。这个警察有两种类型的误报：

包含纯声明性 DSL 的文件，例如Rails 路线，RSpec 规格。
将声明性 DSL 混入大多数命令式代码中的文件，例如Rails 模型中的 aasm 状态机声明。

在第一种情况下，最好的解决方案是排除文件或目录，在第二种情况下使用内联禁用。

在您的情况下，您应该将 .rubocop.yml 更新为：

Metrics/BlockLength:
  Exclude:
    - 'Rakefile'
    - '**/*.rake'
    - 'test/**/*.rb'

（请注意，您需要从默认配置中重新迭代基本排除项，因为列表将被覆盖。）

Answer 2

如果特定块通常太长，我指定它而不是文件

Metrics/BlockLength:
  IgnoredMethods: ['describe', 'context']

Rubocop 25 行块大小和 RSpec 测试

Rubocop 25 line block size and RSpec tests

ruby

rspec

rubocop