Module: Hpricot::Traverse

filter(tok, &blk)

%(expr)

Alias for at

/(expr, &blk)

Alias for search

after(html)

Adds elements immediately after this element, contained in the html string.

at(expr)

Find the first matching node for the CSS or XPath expr string.

before(html)

Adds elements immediately before this element, contained in the html string.

bogusetag?()

Is this object a stranded end tag?

children_of_type(tag_name)

Find children of a given tag_name.

  ele.children_of_type('p')
    #=> [...array of paragraphs...]

clean_path(path)

comment?()

Is this object a comment?

css_path()

Builds a unique CSS string for this node, from the root of the document containing it.

doc?()

Is this object the enclosing HTML or XML document?

doctype?()

Is this object a doctype tag?

elem?()

Is this object an HTML or XML element?

get_subnode(*indexes)

innerHTML()

Alias for inner_html

innerHTML=(inner)

Alias for inner_html=

innerText()

Alias for inner_text

inner_html()

Builds an HTML string from the contents of this node.

inner_html=(inner)

Inserts new contents into the current node, based on the HTML contained in string inner.

inner_text()

Builds a string from the text contained in this node. All HTML elements are removed.

next_node()

Returns the node neighboring this node to the south: just below it. This method includes text nodes and comments and such.

node_position()

nodes_at(*pos)

Puts together an array of neighboring nodes based on their proximity to this node. So, for example, to get the next node, you could use nodes_at(1). Or, to get the previous node, use <tt>nodes_at(1).

This method also accepts ranges and sets of numbers.

   ele.nodes_at(-3..-1, 1..3) # gets three nodes before and three after
   ele.nodes_at(1, 5, 7) # gets three nodes at offsets below the current node
   ele.nodes_at(0, 5..6) # the current node and two others

position()

previous_node()

Returns to node neighboring this node to the north: just above it. This method includes text nodes and comments and such.

procins?()

Is this object an XML processing instruction?

search(expr, &blk)

Searches this node for all elements matching the CSS or XPath expr. Returns an Elements array containing the matching nodes. If blk is given, it is used to iterate through the matching set.

swap(html)

Replace this element and its contents with the nodes contained in the html string.

text?()

Is this object an HTML text node?

to_html()

Builds an HTML string from this node and its contents. If you need to write to a stream, try calling output(io) as a method on this object.

to_original_html()

Attempts to preserve the original HTML of the document, only outputing new tags for elements which have changed.

to_plain_text()

Builds a string from the text contained in this node. All HTML elements are removed.

to_s()

Alias for to_html

traverse_element(*names) {|element| ...}

traverse_element traverses elements in the tree. It yields elements in depth first order.

If names are empty, it yields all elements. If non-empty names are given, it should be list of universal names.

A nested element is yielded in depth first order as follows.

  t = Hpricot('<a id=0><b><a id=1 /></b><c id=2 /></a>')
  t.traverse_element("a", "c") {|e| p e}
  # =>
  {elem <a id="0"> {elem <b> {emptyelem <a id="1">} </b>} {emptyelem <c id="2">} </a>}
  {emptyelem <a id="1">}
  {emptyelem <c id="2">}

Universal names are specified as follows.

  t = Hpricot(<<'End')
  <html>
  <meta name="robots" content="index,nofollow">
  <meta name="author" content="Who am I?">
  </html>
  End
  t.traverse_element("{http://www.w3.org/1999/xhtml}meta") {|e| p e}
  # =>
  {emptyelem <{http://www.w3.org/1999/xhtml}meta name="robots" content="index,nofollow">}
  {emptyelem <{http://www.w3.org/1999/xhtml}meta name="author" content="Who am I?">}

traverse_text() {|text| ...}

traverse_text traverses texts in the tree

xmldecl?()

Is this object an XML declaration?

xpath()

Builds a unique XPath string for this node, from the root of the document containing it.

Methods

Public Class methods

Public Instance methods