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)
{
  xmlNodeSetPtr node_set;
  xmlNodeSetPtr other;

  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, xmlNodeSet, node_set);
  Data_Get_Struct(rb_other, xmlNodeSet, other);

  return Nokogiri_wrap_xml_node_set(xmlXPathIntersection(node_set, other), 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)
{
  xmlNodeSetPtr node_set;
  xmlNodeSetPtr 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, xmlNodeSet, node_set);
  Data_Get_Struct(rb_other, xmlNodeSet, other);

  new = xmlXPathNodeSetMerge(NULL, node_set);
  for (j = 0 ; j < other->nodeNr ; ++j) {
    xmlXPathNodeSetDel(new, other->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 289
289:       def == other
290:         return false unless other.is_a?(Nokogiri::XML::NodeSet)
291:         return false unless length == other.length
292:         each_with_index do |node, i|
293:           return false unless node == other[i]
294:         end
295:         true
296:       end

[](...) 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;
  Data_Get_Struct(self, xmlNodeSet, 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, 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 158
158:       def add_class name
159:         each do |el|
160:           classes = el['class'].to_s.split(/\s+/)
161:           el['class'] = classes.push(name).uniq.join " "
162:         end
163:         self
164:       end

after(datum) Show Source

Insert datum after the last Node in this NodeSet

    # File lib/nokogiri/xml/node_set.rb, line 59
59:       def after datum
60:         last.after datum
61:       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 144
144:       def at path, ns = document.root ? document.root.namespaces : {}
145:         return self[path] if path.is_a?(Numeric)
146:         search(path, ns).first
147:       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 189
189:       def attr key, value = nil, &blk
190:         unless Hash === key || key && (value || blk)
191:           return first.attribute(key)
192:         end
193: 
194:         hash = key.is_a?(Hash) ? key : { key => value }
195: 
196:         hash.each { |k,v| each { |el| el[k] = v || blk[el] } }
197: 
198:         self
199:       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
53:       def before datum
54:         first.before datum
55:       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 301
301:       def children
302:         inject(NodeSet.new(document)) { |set, node| set += node.children }
303:       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
 96:       def css *paths
 97:         handler = ![
 98:           Hash, String, Symbol
 99:         ].include?(paths.last.class) ? paths.pop : nil
100: 
101:         ns = paths.last.is_a?(Hash) ? paths.pop : nil
102: 
103:         sub_set = NodeSet.new(document)
104: 
105:         each do |node|
106:           doc = node.document
107:           search_ns = ns || doc.root ? doc.root.namespaces : {}
108: 
109:           xpaths = paths.map { |rule|
110:             [
111:               CSS.xpath_for(rule.to_s, :prefix => ".//", :ns => search_ns),
112:               CSS.xpath_for(rule.to_s, :prefix => "self::", :ns => search_ns)
113:             ].join(' | ')
114:           }
115: 
116:           sub_set += node.xpath(*(xpaths + [search_ns, handler].compact))
117:         end
118:         document.decorate(sub_set)
119:         sub_set
120:       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)
{
  xmlNodeSetPtr node_set ;
  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, xmlNodeSet, node_set);
  Data_Get_Struct(rb_node, xmlNode, node);

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

  return Qnil ;
}

dup() Show Source

Duplicate this node set

static VALUE duplicate(VALUE self)
{
  xmlNodeSetPtr node_set;
  xmlNodeSetPtr dupl;

  Data_Get_Struct(self, xmlNodeSet, node_set);

  dupl = xmlXPathNodeSetMerge(NULL, 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 212
212:       def each(&block)
213:         0.upto(length - 1) do |x|
214:           yield self[x]
215:         end
216:       end

empty?() Show Source

Is this NodeSet empty?

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

filter(expr) Show Source

Filter this list for nodes that match expr

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

first(n = nil) Show Source

Get the first element of the NodeSet.

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

include?(p1) Show Source

Returns true if any member of node set equals node.

static VALUE include_eh(VALUE self, VALUE rb_node)
{
  xmlNodeSetPtr node_set;
  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, xmlNodeSet, node_set);
  Data_Get_Struct(rb_node, xmlNode, node);

  return (xmlXPathNodeSetContains(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
46:       def index(node)
47:         each_with_index { |member, j| return j if member == node }
48:         nil
49:       end

inner_html(*args) Show Source

Get the inner html of all contained Node objects

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

inner_text() Show Source

Get the inner text of all contained Node objects

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

inspect() Show Source

Return a nicely formated string representation

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

last() Show Source

Get the last element of the NodeSet.

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

length() Show Source

Get the length of the node set

static VALUE length(VALUE self)
{
  xmlNodeSetPtr node_set;
  Data_Get_Struct(self, xmlNodeSet, node_set);

  if(node_set)
    return INT2NUM(node_set->nodeNr);

  return 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 272
272:       def pop
273:         return nil if length == 0
274:         delete last
275:       end

push(p1) Show Source

Append node to the NodeSet.

static VALUE push(VALUE self, VALUE rb_node)
{
  xmlNodeSetPtr node_set;
  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, xmlNodeSet, node_set);
  Data_Get_Struct(rb_node, xmlNode, node);
  xmlXPathNodeSetAdd(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 205
205:       def remove_attr name
206:         each { |el| el.delete name }
207:         self
208:       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 170
170:       def remove_class name = nil
171:         each do |el|
172:           if name
173:             classes = el['class'].to_s.split(/\s+/)
174:             if classes.empty?
175:               el.delete 'class'
176:             else
177:               el['class'] = (classes - [name]).uniq.join " "
178:             end
179:           else
180:             el.delete "class"
181:           end
182:         end
183:         self
184:       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 308
308:       def reverse
309:         node_set = NodeSet.new(document)
310:         (length - 1).downto(0) do |x|
311:           node_set.push self[x]
312:         end
313:         node_set
314:       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
71:       def search *paths
72:         handler = ![
73:           Hash, String, Symbol
74:         ].include?(paths.last.class) ? paths.pop : nil
75: 
76:         ns = paths.last.is_a?(Hash) ? paths.pop : nil
77: 
78:         sub_set = NodeSet.new(document)
79: 
80:         paths.each do |path|
81:           sub_set += send(
82:             path =~ /^(\.\/|\/)/ ? :xpath : :css,
83:             *(paths + [ns, handler]).compact
84:           )
85:         end
86: 
87:         document.decorate(sub_set)
88:         sub_set
89:       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 280
280:       def shift
281:         return nil if length == 0
282:         delete first
283:       end

size()

slice(...) 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;
  Data_Get_Struct(self, xmlNodeSet, 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, 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;

  Data_Get_Struct(self, xmlNodeSet, 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 {
      xmlNodePtr node = set->nodeTab[i];

      if(node->_private) {
        if(node->type == XML_DOCUMENT_NODE || node->type == XML_HTML_DOCUMENT_NODE)
          elts[i] = DOC_RUBY_OBJECT(node->doc);
        else
          elts[i] = (VALUE)node->_private;
      } else {
        elts[i] = Nokogiri_wrap_xml_node(Qnil, node);
      }
    }
  }

  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 250
250:       def to_html *args
251:         map { |x| x.to_html(*args) }.join
252:       end

to_s() Show Source

Convert this NodeSet to a string.

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

to_xhtml(*args) Show Source

Convert this NodeSet to XHTML

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

to_xml(*args) Show Source

Convert this NodeSet to XML

     # File lib/nokogiri/xml/node_set.rb, line 262
262:       def to_xml *args
263:         map { |x| x.to_xml(*args) }.join
264:       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 ;

  Data_Get_Struct(self, xmlNodeSet, 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 233
233:       def wrap(html, &blk)
234:         each do |j|
235:           new_parent = document.root.parse(html).first
236:           j.add_next_sibling(new_parent)
237:           new_parent.add_child(j)
238:         end
239:         self
240:       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
126:       def xpath *paths
127:         handler = ![
128:           Hash, String, Symbol
129:         ].include?(paths.last.class) ? paths.pop : nil
130: 
131:         ns = paths.last.is_a?(Hash) ? paths.pop : nil
132: 
133:         sub_set = NodeSet.new(document)
134:         each do |node|
135:           sub_set += node.xpath(*(paths + [ns, handler].compact))
136:         end
137:         document.decorate(sub_set)
138:         sub_set
139:       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)
{
  xmlNodeSetPtr node_set;
  xmlNodeSetPtr 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, xmlNodeSet, node_set);
  Data_Get_Struct(rb_other, xmlNodeSet, other);

  new = xmlXPathNodeSetMerge(NULL, node_set);
  new = xmlXPathNodeSetMerge(new, other);

  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