Nokogiri

%(path, ns = document.root ? document.root.namespaces : {})

&(p1) Show Source

Set Intersection — Returns a new NodeSet containing nodes common to the two NodeSets.

static VALUE intersection(VALUE self, VALUE rb_other)
{
  nokogiriNodeSetTuple *tuple, *other;
  xmlNodeSetPtr intersection;

  if(!rb_obj_is_kind_of(rb_other, cNokogiriXmlNodeSet))
    rb_raise(rb_eArgError, "node_set must be a Nokogiri::XML::NodeSet");

  Data_Get_Struct(self, nokogiriNodeSetTuple, tuple);
  Data_Get_Struct(rb_other, nokogiriNodeSetTuple, other);

  intersection = xmlXPathIntersection(tuple->node_set, other->node_set);
  return Nokogiri_wrap_xml_node_set(intersection, rb_iv_get(self, "@document"));
}

+(p1)

-(p1) Show Source

Difference - returns a new NodeSet that is a copy of this NodeSet, removing each item that also appears in node_set

static VALUE minus(VALUE self, VALUE rb_other)
{
  nokogiriNodeSetTuple *tuple, *other;
  xmlNodeSetPtr new;
  int j ;

  if(!rb_obj_is_kind_of(rb_other, cNokogiriXmlNodeSet))
    rb_raise(rb_eArgError, "node_set must be a Nokogiri::XML::NodeSet");

  Data_Get_Struct(self, nokogiriNodeSetTuple, tuple);
  Data_Get_Struct(rb_other, nokogiriNodeSetTuple, other);

  new = xmlXPathNodeSetMerge(NULL, tuple->node_set);
  for (j = 0 ; j < other->node_set->nodeNr ; ++j) {
    xmlXPathNodeSetDel(new, other->node_set->nodeTab[j]);
  }

  return Nokogiri_wrap_xml_node_set(new, rb_iv_get(self, "@document"));
}

/(*paths)

<<(p1)

==(other) Show Source

Equality – Two NodeSets are equal if the contain the same number of elements and if each element is equal to the corresponding element in the other NodeSet

# File lib/nokogiri/xml/node_set.rb, line 321
def == other
  return false unless other.is_a?(Nokogiri::XML::NodeSet)
  return false unless length == other.length
  each_with_index do |node, i|
    return false unless node == other[i]
  end
  true
end

>(selector) Show Source

Search this NodeSet’s nodes’ immediate children using CSS selector selector

# File lib/nokogiri/xml/node_set.rb, line 143
def > selector
  ns = document.root.namespaces
  xpath CSS.xpath_for(selector, :prefix => "./", :ns => ns).first
end

[](p1, p2 = v2) Show Source

Element reference - returns the node at index, or returns a NodeSet containing nodes starting at start and continuing for length elements, or returns a NodeSet containing nodes specified by range. Negative indices count backward from the end of the node_set (-1 is the last node). Returns nil if the index (or start) are out of range.

static VALUE slice(int argc, VALUE *argv, VALUE self)
{
  VALUE arg ;
  long beg, len ;
  xmlNodeSetPtr node_set;
  nokogiriNodeSetTuple *tuple;
  Data_Get_Struct(self, nokogiriNodeSetTuple, tuple);
  node_set = tuple->node_set;

  if (argc == 2) {
    beg = NUM2LONG(argv[0]);
    len = NUM2LONG(argv[1]);
    if (beg < 0) {
      beg += node_set->nodeNr ;
    }
    return subseq(self, beg, len);
  }

  if (argc != 1) {
    rb_scan_args(argc, argv, "11", NULL, NULL);
  }
  arg = argv[0];

  if (FIXNUM_P(arg)) {
    return index_at(self, FIX2LONG(arg));
  }
  
  /* if arg is Range */
  switch (rb_range_beg_len(arg, &beg, &len, (long)node_set->nodeNr, 0)) {
  case Qfalse:
    break;
  case Qnil:
    return Qnil;
  default:
    return subseq(self, beg, len);
  }

  return index_at(self, NUM2LONG(arg));
}

add_class(name) Show Source

Append the class attribute name to all Node objects in the NodeSet.

# File lib/nokogiri/xml/node_set.rb, line 183
def add_class name
  each do |el|
    classes = el['class'].to_s.split(/s+/)
    el['class'] = classes.push(name).uniq.join " "
  end
  self
end

after(datum) Show Source

Insert datum after the last Node in this NodeSet

# File lib/nokogiri/xml/node_set.rb, line 59
def after datum
  last.after datum
end

at(path, ns = document.root ? document.root.namespaces : {}) Show Source

If path is a string, search this document for path returning the first Node. Otherwise, index in to the array with path.

# File lib/nokogiri/xml/node_set.rb, line 151
def at path, ns = document.root ? document.root.namespaces : {}
  return self[path] if path.is_a?(Numeric)
  search(path, ns).first
end

at_css(*rules) Show Source

Search this NodeSet for the first occurrence of CSS rules. Equivalent to css(rules).first See NodeSet#css for more information.

# File lib/nokogiri/xml/node_set.rb, line 171
def at_css *rules
  css(*rules).first
end

at_xpath(*paths) Show Source

Search this NodeSet for the first occurrence of XPath paths. Equivalent to xpath(paths).first See NodeSet#xpath for more information.

# File lib/nokogiri/xml/node_set.rb, line 162
def at_xpath *paths
  xpath(*paths).first
end

attr(key, value = nil, &blk) Show Source

Set the attribute key to value or the return value of blk on all Node objects in the NodeSet.

# File lib/nokogiri/xml/node_set.rb, line 214
def attr key, value = nil, &blk
  unless Hash === key || key && (value || blk)
    return first.attribute(key)
  end

  hash = key.is_a?(Hash) ? key : { key => value }

  hash.each { |k,v| each { |el| el[k] = v || blk[el] } }

  self
end

attribute(key, value = nil, &blk)

before(datum) Show Source

Insert datum before the first Node in this NodeSet

# File lib/nokogiri/xml/node_set.rb, line 53
def before datum
  first.before datum
end

children() Show Source

Returns a new NodeSet containing all the children of all the nodes in the NodeSet

# File lib/nokogiri/xml/node_set.rb, line 333
def children
  inject(NodeSet.new(document)) { |set, node| set += node.children }
end

css(*paths) Show Source

Search this NodeSet for css paths

For more information see Nokogiri::XML::Node#css

# File lib/nokogiri/xml/node_set.rb, line 96
def css *paths
  handler = ![
    Hash, String, Symbol
  ].include?(paths.last.class) ? paths.pop : nil

  ns = paths.last.is_a?(Hash) ? paths.pop : nil

  sub_set = NodeSet.new(document)

  each do |node|
    doc = node.document
    search_ns = ns || (doc.root ? doc.root.namespaces : {})

    xpaths = paths.map { |rule|
      [
        CSS.xpath_for(rule.to_s, :prefix => ".//", :ns => search_ns),
        CSS.xpath_for(rule.to_s, :prefix => "self::", :ns => search_ns)
      ].join(' | ')
    }

    sub_set += node.xpath(*(xpaths + [search_ns, handler].compact))
  end
  document.decorate(sub_set)
  sub_set
end

delete(p1) Show Source

Delete node from the Nodeset, if it is a member. Returns the deleted node if found, otherwise returns nil.

static VALUE delete(VALUE self, VALUE rb_node)
{
  nokogiriNodeSetTuple *tuple;
  xmlNodePtr node ;

  if(!(rb_obj_is_kind_of(rb_node, cNokogiriXmlNode) || rb_obj_is_kind_of(rb_node, cNokogiriXmlNamespace)))
    rb_raise(rb_eArgError, "node must be a Nokogiri::XML::Node or Nokogiri::XML::Namespace");

  Data_Get_Struct(self, nokogiriNodeSetTuple, tuple);
  Data_Get_Struct(rb_node, xmlNode, node);

  if (xmlXPathNodeSetContains(tuple->node_set, node)) {
    xmlXPathNodeSetDel(tuple->node_set, node);
    return rb_node ;
  }

  return Qnil ;
}

dup() Show Source

Duplicate this node set

static VALUE duplicate(VALUE self)
{
  nokogiriNodeSetTuple *tuple;
  xmlNodeSetPtr dupl;

  Data_Get_Struct(self, nokogiriNodeSetTuple, tuple);

  dupl = xmlXPathNodeSetMerge(NULL, tuple->node_set);

  return Nokogiri_wrap_xml_node_set(dupl, rb_iv_get(self, "@document"));
}

each(&block) Show Source

Iterate over each node, yielding to block

# File lib/nokogiri/xml/node_set.rb, line 237
def each(&block)
  0.upto(length - 1) do |x|
    yield self[x]
  end
end

empty?() Show Source

Is this NodeSet empty?

# File lib/nokogiri/xml/node_set.rb, line 40
def empty?
  length == 0
end

filter(expr) Show Source

Filter this list for nodes that match expr

# File lib/nokogiri/xml/node_set.rb, line 177
def filter expr
  find_all { |node| node.matches?(expr) }
end

first(n = nil) Show Source

Get the first element of the NodeSet.

# File lib/nokogiri/xml/node_set.rb, line 23
def first n = nil
  return self[0] unless n
  list = []
  0.upto(n - 1) do |i|
    list << self[i]
  end
  list
end

include?(p1) Show Source

Returns true if any member of node set equals node.

static VALUE include_eh(VALUE self, VALUE rb_node)
{
  nokogiriNodeSetTuple *tuple;
  xmlNodePtr node;

  if(!(rb_obj_is_kind_of(rb_node, cNokogiriXmlNode) || rb_obj_is_kind_of(rb_node, cNokogiriXmlNamespace)))
    rb_raise(rb_eArgError, "node must be a Nokogiri::XML::Node or Nokogiri::XML::Namespace");

  Data_Get_Struct(self, nokogiriNodeSetTuple, tuple);
  Data_Get_Struct(rb_node, xmlNode, node);

  return (xmlXPathNodeSetContains(tuple->node_set, node) ? Qtrue : Qfalse);
}

index(node) Show Source

Returns the index of the first node in self that is == to node. Returns nil if no match is found.

# File lib/nokogiri/xml/node_set.rb, line 46
def index(node)
  each_with_index { |member, j| return j if member == node }
  nil
end

inner_html(*args) Show Source

Get the inner html of all contained Node objects

# File lib/nokogiri/xml/node_set.rb, line 252
def inner_html *args
  collect{|j| j.inner_html(*args) }.join('')
end

inner_text() Show Source

Get the inner text of all contained Node objects

# File lib/nokogiri/xml/node_set.rb, line 245
def inner_text
  collect{|j| j.inner_text}.join('')
end

inspect() Show Source

Return a nicely formated string representation

# File lib/nokogiri/xml/node_set.rb, line 350
def inspect
  "[#{map { |c| c.inspect }.join ', '}]"
end

last() Show Source

Get the last element of the NodeSet.

# File lib/nokogiri/xml/node_set.rb, line 34
def last
  self[length - 1]
end

length() Show Source

Get the length of the node set

static VALUE length(VALUE self)
{
  nokogiriNodeSetTuple *tuple;
  Data_Get_Struct(self, nokogiriNodeSetTuple, tuple);

  return tuple->node_set ? INT2NUM(tuple->node_set->nodeNr) : INT2NUM(0);
}

pop() Show Source

Removes the last element from set and returns it, or nil if the set is empty

# File lib/nokogiri/xml/node_set.rb, line 304
def pop
  return nil if length == 0
  delete last
end

push(p1) Show Source

Append node to the NodeSet.

static VALUE push(VALUE self, VALUE rb_node)
{
  nokogiriNodeSetTuple *tuple;
  xmlNodePtr node;

  if(!(rb_obj_is_kind_of(rb_node, cNokogiriXmlNode) || rb_obj_is_kind_of(rb_node, cNokogiriXmlNamespace)))
    rb_raise(rb_eArgError, "node must be a Nokogiri::XML::Node or Nokogiri::XML::Namespace");

  Data_Get_Struct(self, nokogiriNodeSetTuple, tuple);
  Data_Get_Struct(rb_node, xmlNode, node);
  xmlXPathNodeSetAdd(tuple->node_set, node);
  return self;
}

remove()

remove_attr(name) Show Source

Remove the attributed named name from all Node objects in the NodeSet

# File lib/nokogiri/xml/node_set.rb, line 230
def remove_attr name
  each { |el| el.delete name }
  self
end

remove_class(name = nil) Show Source

Remove the class attribute name from all Node objects in the NodeSet. If name is nil, remove the class attribute from all Nodes in the NodeSet.

# File lib/nokogiri/xml/node_set.rb, line 195
def remove_class name = nil
  each do |el|
    if name
      classes = el['class'].to_s.split(/s+/)
      if classes.empty?
        el.delete 'class'
      else
        el['class'] = (classes - [name]).uniq.join " "
      end
    else
      el.delete "class"
    end
  end
  self
end

reverse() Show Source

Returns a new NodeSet containing all the nodes in the NodeSet in reverse order

# File lib/nokogiri/xml/node_set.rb, line 340
def reverse
  node_set = NodeSet.new(document)
  (length - 1).downto(0) do |x|
    node_set.push self[x]
  end
  node_set
end

search(*paths) Show Source

Search this document for paths

For more information see Nokogiri::XML::Node#css and Nokogiri::XML::Node#xpath

# File lib/nokogiri/xml/node_set.rb, line 71
def search *paths
  handler = ![
    Hash, String, Symbol
  ].include?(paths.last.class) ? paths.pop : nil

  ns = paths.last.is_a?(Hash) ? paths.pop : nil

  sub_set = NodeSet.new(document)

  paths.each do |path|
    sub_set += send(
      path =~ /^(./|/)/ ? :xpath : :css,
      *(paths + [ns, handler]).compact
    )
  end

  document.decorate(sub_set)
  sub_set
end

set(key, value = nil, &blk)

shift() Show Source

Returns the first element of the NodeSet and removes it. Returns nil if the set is empty.

# File lib/nokogiri/xml/node_set.rb, line 312
def shift
  return nil if length == 0
  delete first
end

size()

slice(p1, p2 = v2) Show Source

Element reference - returns the node at index, or returns a NodeSet containing nodes starting at start and continuing for length elements, or returns a NodeSet containing nodes specified by range. Negative indices count backward from the end of the node_set (-1 is the last node). Returns nil if the index (or start) are out of range.

static VALUE slice(int argc, VALUE *argv, VALUE self)
{
  VALUE arg ;
  long beg, len ;
  xmlNodeSetPtr node_set;
  nokogiriNodeSetTuple *tuple;
  Data_Get_Struct(self, nokogiriNodeSetTuple, tuple);
  node_set = tuple->node_set;

  if (argc == 2) {
    beg = NUM2LONG(argv[0]);
    len = NUM2LONG(argv[1]);
    if (beg < 0) {
      beg += node_set->nodeNr ;
    }
    return subseq(self, beg, len);
  }

  if (argc != 1) {
    rb_scan_args(argc, argv, "11", NULL, NULL);
  }
  arg = argv[0];

  if (FIXNUM_P(arg)) {
    return index_at(self, FIX2LONG(arg));
  }
  
  /* if arg is Range */
  switch (rb_range_beg_len(arg, &beg, &len, (long)node_set->nodeNr, 0)) {
  case Qfalse:
    break;
  case Qnil:
    return Qnil;
  default:
    return subseq(self, beg, len);
  }

  return index_at(self, NUM2LONG(arg));
}

text()

to_a() Show Source

Return this list as an Array

static VALUE to_array(VALUE self, VALUE rb_node)
{
  xmlNodeSetPtr set;
  VALUE *elts;
  VALUE list;
  int i;
  nokogiriNodeSetTuple *tuple;

  Data_Get_Struct(self, nokogiriNodeSetTuple, tuple);
  set = tuple->node_set;

  elts = calloc((size_t)set->nodeNr, sizeof(VALUE *));
  for(i = 0; i < set->nodeNr; i++) {
    if (XML_NAMESPACE_DECL == set->nodeTab[i]->type)
      elts[i] = Nokogiri_wrap_xml_namespace2(rb_iv_get(self, "@document"), (xmlNsPtr)(set->nodeTab[i]));
    else
      elts[i] = Nokogiri_wrap_xml_node(Qnil, set->nodeTab[i]);
  }

  list = rb_ary_new4((long)set->nodeNr, elts);

  /*free(elts); */

  return list;
}

to_ary()

to_html(*args) Show Source

Convert this NodeSet to HTML

# File lib/nokogiri/xml/node_set.rb, line 275
def to_html *args
  if Nokogiri.jruby?
    options = args.first.is_a?(Hash) ? args.shift : {}
    if !options[:save_with]
      options[:save_with] = Node::SaveOptions::NO_DECLARATION | Node::SaveOptions::NO_EMPTY_TAGS | Node::SaveOptions::AS_HTML
    end
    args.insert(0, options)
  end
  map { |x| x.to_html(*args) }.join
end

to_s() Show Source

Convert this NodeSet to a string.

# File lib/nokogiri/xml/node_set.rb, line 269
def to_s
  map { |x| x.to_s }.join
end

to_xhtml(*args) Show Source

Convert this NodeSet to XHTML

# File lib/nokogiri/xml/node_set.rb, line 288
def to_xhtml *args
  map { |x| x.to_xhtml(*args) }.join
end

to_xml(*args) Show Source

Convert this NodeSet to XML

# File lib/nokogiri/xml/node_set.rb, line 294
def to_xml *args
  map { |x| x.to_xml(*args) }.join
end

unlink() Show Source

Unlink this NodeSet and all Node objects it contains from their current context.

static VALUE unlink_nodeset(VALUE self)
{
  xmlNodeSetPtr node_set;
  int j, nodeNr ;
  nokogiriNodeSetTuple *tuple;

  Data_Get_Struct(self, nokogiriNodeSetTuple, tuple);
  node_set = tuple->node_set;
  nodeNr = node_set->nodeNr ;
  for (j = 0 ; j < nodeNr ; j++) {
    if (XML_NAMESPACE_DECL != node_set->nodeTab[j]->type) {
      VALUE node ;
      xmlNodePtr node_ptr;
      node = Nokogiri_wrap_xml_node(Qnil, node_set->nodeTab[j]);
      rb_funcall(node, rb_intern("unlink"), 0); /* modifies the C struct out from under the object */
      Data_Get_Struct(node, xmlNode, node_ptr);
      node_set->nodeTab[j] = node_ptr ;
    }
  }
  return self ;
}

wrap(html, &blk) Show Source

Wrap this NodeSet with html or the results of the builder in blk

# File lib/nokogiri/xml/node_set.rb, line 258
def wrap(html, &blk)
  each do |j|
    new_parent = document.parse(html).first
    j.add_next_sibling(new_parent)
    new_parent.add_child(j)
  end
  self
end

xpath(*paths) Show Source

Search this NodeSet for XPath paths

For more information see Nokogiri::XML::Node#xpath

# File lib/nokogiri/xml/node_set.rb, line 126
def xpath *paths
  handler = ![
    Hash, String, Symbol
  ].include?(paths.last.class) ? paths.pop : nil

  ns = paths.last.is_a?(Hash) ? paths.pop : nil

  sub_set = NodeSet.new(document)
  each do |node|
    sub_set += node.xpath(*(paths + [ns, handler].compact))
  end
  document.decorate(sub_set)
  sub_set
end

|(p1) Show Source

Returns a new set built by merging the set and the elements of the given set.

static VALUE set_union(VALUE self, VALUE rb_other)
{
  nokogiriNodeSetTuple *tuple, *other;
  xmlNodeSetPtr new;

  if(!rb_obj_is_kind_of(rb_other, cNokogiriXmlNodeSet))
    rb_raise(rb_eArgError, "node_set must be a Nokogiri::XML::NodeSet");

  Data_Get_Struct(self, nokogiriNodeSetTuple, tuple);
  Data_Get_Struct(rb_other, nokogiriNodeSetTuple, other);

  new = xmlXPathNodeSetMerge(NULL, tuple->node_set);
  new = xmlXPathNodeSetMerge(new, other->node_set);

  return Nokogiri_wrap_xml_node_set(new, rb_iv_get(self, "@document"));
}

An HTML, XML, SAX, & Reader parser with the ability to search documents via XPath or CSS3 selectors… and much more

Nokogiri 鋸

Class Nokogiri::XML::NodeSet inherits from Object

Attributes

Public Class Methods

Public Instance Methods