Module: Dommy::Internal::ElementMatching

Defined in:

lib/dommy/internal/element_matching.rb

Overview

Element-type-specific finders for links, forms, selects, and checkable fields. Lives in dommy core so that companion gems (currently dommy-rails) share a single finder implementation instead of re-implementing the selector / filter logic per gem.

Attribute criteria (href:, action:, name:) accept a String (exact match), a Regexp, or any object responding to matches? — the extension point dommy-rails uses to inject URL normalization.

Class Method Summary

• .attribute_matches?(element, attr_name, expected) ⇒ Boolean
• .field_label_matches?(field, expected_label) ⇒ Boolean
• .field_labels(field) ⇒ Object

  Labels associated with a field: a pointing at its id, and/or the nearest ancestor wrapping it.

• .find_checkable_fields(scope, name: nil, checked: nil) ⇒ Object

  Find checkable fields (input) matching the given criteria.

• .find_forms(scope, action: nil, method: nil) ⇒ Object

  Find

  elements matching the given criteria.

• .find_links(scope, text: nil, href: nil) ⇒ Object

  Find elements matching the given criteria.

• .find_selects(scope, name: nil, label: nil) ⇒ Object

  Find elements matching the given criteria.

  .form_method_matches?(form, expected_method) ⇒ Boolean

  Class Method Details

  .attribute_matches?(element, attr_name, expected) ⇒ Boolean

  Returns:

  • (Boolean)

  # File 'lib/dommy/internal/element_matching.rb', line 54
  
  def attribute_matches?(element, attr_name, expected)
    actual = element.get_attribute(attr_name).to_s
    case expected
    when Regexp
      actual.match?(expected)
    else
      if expected.respond_to?(:matches?)
        expected.matches?(actual)
      else
        actual == expected.to_s
      end
    end
  end

  .field_label_matches?(field, expected_label) ⇒ Boolean

  Returns:

  • (Boolean)

  # File 'lib/dommy/internal/element_matching.rb', line 95
  
  def field_label_matches?(field, expected_label)
    field_labels(field).any? { |label| DomMatching.text_matches?(label.text_content, expected_label) }
  end

  .field_labels(field) ⇒ Object

  Labels associated with a field: a pointing at its id, and/or the nearest ancestor wrapping it. Scans label elements instead of interpolating the id into a selector, so ids containing quotes cannot break the query.

  # File 'lib/dommy/internal/element_matching.rb', line 72
  
  def field_labels(field)
    labels = []
  
    id = field.get_attribute("id").to_s
    unless id.empty?
      for_label = field.owner_document.query_selector_all("label").to_a.find do |label|
        label.get_attribute("for") == id
      end
      labels << for_label if for_label
    end
  
    parent = field.parent_node
    while parent
      if parent.respond_to?(:tag_name) && parent.tag_name == "LABEL"
        labels << parent
        break
      end
      parent = parent.respond_to?(:parent_node) ? parent.parent_node : nil
    end
  
    labels
  end

  .find_checkable_fields(scope, name: nil, checked: nil) ⇒ Object

  Find checkable fields (input) matching the given criteria.

  # File 'lib/dommy/internal/element_matching.rb', line 46
  
  def find_checkable_fields(scope, name: nil, checked: nil)
    fields = scope.query_selector_all("input[type='checkbox'], input[type='radio']").to_a
    fields = fields.select { |el| attribute_matches?(el, "name", name) } if name
    fields = fields.select { |el| el.get_attribute("checked") } if checked == true
    fields = fields.reject { |el| el.get_attribute("checked") } if checked == false
    fields
  end

  .find_forms(scope, action: nil, method: nil) ⇒ Object

  Find elements matching the given criteria. method: is matched against the effective method, honoring a hidden _method override field inside POST forms.

  # File 'lib/dommy/internal/element_matching.rb', line 29
  
  def find_forms(scope, action: nil, method: nil)
    forms = scope.query_selector_all("form").to_a
    forms = forms.select { |el| attribute_matches?(el, "action", action) } if action
    forms = forms.select { |el| form_method_matches?(el, method) } if method
    forms
  end

  .find_links(scope, text: nil, href: nil) ⇒ Object

  Find elements matching the given criteria.

  # File 'lib/dommy/internal/element_matching.rb', line 19
  
  def find_links(scope, text: nil, href: nil)
    links = scope.query_selector_all("a[href]").to_a
    links = links.select { |el| DomMatching.text_matches?(el.text_content, text) } if text
    links = links.select { |el| attribute_matches?(el, "href", href) } if href
    links
  end

  .find_selects(scope, name: nil, label: nil) ⇒ Object

  Find

  elements matching the given criteria.