如何测试 (ActiveRecord) 对象相等性

Question

在 Rails 3.0.3 上的 Ruby 1.9.2 中，我尝试测试两个 Friend 之间的对象相等性（类继承自 ActiveRecord::Base) 对象。

对象是相等的，但测试失败：

Failure/Error: Friend.new(name: 'Bob').should eql(Friend.new(name: 'Bob'))

expected #<Friend id: nil, event_id: nil, name: 'Bob', created_at: nil, updated_at: nil>
     got #<Friend id: nil, event_id: nil, name: 'Bob', created_at: nil, updated_at: nil>

(compared using eql?)

只是为了笑，我还测试了对象身份，这正如我所期望的那样失败了：

Failure/Error: Friend.new(name: 'Bob').should equal(Friend.new(name: 'Bob'))

expected #<Friend:2190028040> => #<Friend id: nil, event_id: nil, name: 'Bob', created_at: nil, updated_at: nil>
     got #<Friend:2190195380> => #<Friend id: nil, event_id: nil, name: 'Bob', created_at: nil, updated_at: nil>

Compared using equal?, which compares object identity,
but expected and actual are not the same object. Use
'actual.should == expected' if you don't care about
object identity in this example.

有人可以向我解释为什么对象相等的第一个测试失败，以及我如何成功断言这些对象两个物体相等吗？

Answer 1

Rails 特意将相等性检查委托给标识列。如果您想知道两个 AR 对象是否包含相同的内容，请比较对两者调用 #attributes 的结果。

Answer 2

查看 上的 API 文档 ==（别名eql?）用于ActiveRecord::Base的操作

如果comparison_object是同一个对象，或者comparison_object具有相同的类型并且self有一个ID并且它等于comparison_object.id，则返回true。

请注意，根据定义，新记录不同于任何其他记录，除非其他记录是接收者本身。此外，如果您使用 select 获取现有记录并省略 ID，则您只能靠自己，此谓词将返回 false。

另请注意，销毁记录会在模型实例中保留其 ID，因此删除的模型仍然具有可比性。

Answer 3

如果您想根据属性比较两个模型实例，您可能需要从比较中排除某些不相关的属性，例如：id、created_at< /code> 和 updated_at。 （我认为这些更多的是关于记录的元数据，而不是记录数据本身的一部分。）

当您比较两个新的（未保存的）记录时，这可能并不重要（因为id、created_at 和 updated_at 在保存之前都将是 nil），但有时我发现有必要比较已保存的< /em> 对象有一个未保存（在这种情况下 == 会给你 false，因为 nil != 5）。或者我想比较两个保存的对象以查明它们是否包含相同的数据（因此 ActiveRecord == 运算符不起作用，因为如果它们具有不同的 id，即使它们在其他方面相同，它也会返回 false）。

我对这个问题的解决方案是在您想要使用属性进行比较的模型中添加类似的内容：

  def self.attributes_to_ignore_when_comparing
    [:id, :created_at, :updated_at]
  end

  def identical?(other)
    self. attributes.except(*self.class.attributes_to_ignore_when_comparing.map(&:to_s)) ==
    other.attributes.except(*self.class.attributes_to_ignore_when_comparing.map(&:to_s))
  end

然后在我的规范中我可以编写这样可读且简洁的内容：

Address.last.should be_identical(Address.new({city: 'City', country: 'USA'}))

我计划分叉 active_record_attributes_equality< /code> gem 并将其更改为使用此行为，以便可以更轻松地重用它。

不过，我的一些问题包括：

• 这样的宝石是否已经存在？
• 该方法应该被称为什么？我认为覆盖现有的 == 运算符不是一个好主意，所以现在我将其称为 identical?。但也许类似 practically_identical? 或 attributes_eql? 会更准确，因为它不会检查它们是否严格相同（某些 的属性允许不同。）...
• attributes_to_ignore_when_comparing 太冗长了。如果他们想要使用 gem 的默认值，则不需要将其显式添加到每个模型中。也许允许使用像 ignore_for_attributes_eql :last_signed_in_at, :updated_at 这样的类宏覆盖默认值

，欢迎发表评论...

更新：而不是分叉 active_record_attributes_equality，我编写了一个全新的 gem，active_record_ignored_attributes，可在 http://github .com/TylerRick/active_record_ignored_attributes 和 http://rubygems.org/gems/active_record_ignored_attributes

Answer 4

 META = [:id, :created_at, :updated_at, :interacted_at, :confirmed_at]

 def eql_attributes?(original,new)
   original = original.attributes.with_indifferent_access.except(*META)
   new = new.attributes.symbolize_keys.with_indifferent_access.except(*META)
   original == new
 end

 eql_attributes? attrs, attrs2

Answer 5

我在 RSpec 上创建了一个匹配器专门用于这种类型的比较，非常简单，但有效。

在这个文件里面：
spec/support/matchers.rb

您可以实现此匹配器...

RSpec::Matchers.define :be_a_clone_of do |model1|
  match do |model2|
    ignored_columns = %w[id created_at updated_at]
    model1.attributes.except(*ignored_columns) == model2.attributes.except(*ignored_columns)
  end
end

之后，您可以通过以下方式在编写规范时使用它...

item = create(:item) # FactoryBot gem
item2 = item.dup

expect(item).to be_a_clone_of(item2)
# True

有用的链接：

https://relishapp.com/rspec/rspec-expectations/ v/2-4/docs/custom-matchers/define-matcher
https://github.com/thoughtbot/factory_bot

Answer 6

如果像我一样，您正在寻找这个问题的Minitest答案，那么这里有一个自定义方法，它断言两个对象的属性是相等的。

它假定您始终希望排除 id、created_at 和 updated_at 属性，但如果您愿意，可以覆盖该行为。

我喜欢保持 test_helper.rb 干净，因此创建了一个包含以下内容的 test/shared/custom_assertions.rb 文件。

module CustomAssertions
  def assert_attributes_equal(original, new, except: %i[id created_at updated_at])
    extractor = proc { |record| record.attributes.with_indifferent_access.except(*except) }
    assert_equal extractor.call(original), extractor.call(new)
  end
end

然后更改您的 test_helper.rb 以包含它，以便您可以在测试中访问它。

require 'shared/custom_assertions'

class ActiveSupport::TestCase
  include CustomAssertions
end

基本用法：

test 'comments should be equal' do
  assert_attributes_equal(Comment.first, Comment.second)
end

如果要覆盖它忽略的属性，请使用 except 参数传递字符串或符号数组：

test 'comments should be equal' do
  assert_attributes_equal(
    Comment.first, 
    Comment.second, 
    except: %i[id created_at updated_at edited_at]
  )
end