module Rails::Dom::Testing::Assertions::DomAssertions

Public Instance Methods

assert_dom_equal(expected, actual, message = nil) click to toggle source

Test two HTML strings for equivalency (e.g., equal even when attributes are in another order)

# assert that the referenced method generates the appropriate HTML string
assert_dom_equal '<a href="http://www.example.com">Apples</a>', link_to("Apples", "http://www.example.com")
# File lib/rails/dom/testing/assertions/dom_assertions.rb, line 10
def assert_dom_equal(expected, actual, message = nil)
  expected_dom, actual_dom = fragment(expected), fragment(actual)
  message ||= "Expected: #{expected}\nActual: #{actual}"
  assert compare_doms(expected_dom, actual_dom), message
end
assert_dom_not_equal(expected, actual, message = nil) click to toggle source

The negated form of assert_dom_equal.

# assert that the referenced method does not generate the specified HTML string
assert_dom_not_equal '<a href="http://www.example.com">Apples</a>', link_to("Oranges", "http://www.example.com")
# File lib/rails/dom/testing/assertions/dom_assertions.rb, line 20
def assert_dom_not_equal(expected, actual, message = nil)
  expected_dom, actual_dom = fragment(expected), fragment(actual)
  message ||= "Expected: #{expected}\nActual: #{actual}"
  assert_not compare_doms(expected_dom, actual_dom), message
end

Protected Instance Methods

compare_doms(expected, actual) click to toggle source
# File lib/rails/dom/testing/assertions/dom_assertions.rb, line 28
def compare_doms(expected, actual)
  return false unless expected.children.size == actual.children.size

  expected.children.each_with_index do |child, i|
    return false unless equal_children?(child, actual.children[i])
  end

  true
end
equal_attribute?(attr, other_attr) click to toggle source
# File lib/rails/dom/testing/assertions/dom_assertions.rb, line 63
def equal_attribute?(attr, other_attr)
  attr.name == other_attr.name && attr.value == other_attr.value
end
equal_attribute_nodes?(nodes, other_nodes) click to toggle source
# File lib/rails/dom/testing/assertions/dom_assertions.rb, line 50
def equal_attribute_nodes?(nodes, other_nodes)
  return false unless nodes.size == other_nodes.size

  nodes = nodes.sort_by(&:name)
  other_nodes = other_nodes.sort_by(&:name)

  nodes.each_with_index do |attr, i|
    return false unless equal_attribute?(attr, other_nodes[i])
  end

  true
end
equal_children?(child, other_child) click to toggle source
# File lib/rails/dom/testing/assertions/dom_assertions.rb, line 38
def equal_children?(child, other_child)
  return false unless child.type == other_child.type

  if child.element?
    child.name == other_child.name &&
        equal_attribute_nodes?(child.attribute_nodes, other_child.attribute_nodes) &&
        compare_doms(child, other_child)
  else
    child.to_s == other_child.to_s
  end
end

Private Instance Methods

fragment(text) click to toggle source
# File lib/rails/dom/testing/assertions/dom_assertions.rb, line 69
def fragment(text)
  Nokogiri::HTML::DocumentFragment.parse(text)
end