Class: Nokogiri::XML::NodeSet

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/nokogiri/xml/node_set.rb,
lib/nokogiri/ffi/xml/node_set.rb,
ext/nokogiri/xml_node_set.c

Overview

A NodeSet contains a list of Nokogiri::XML::Node objects. Typically a NodeSet is return as a result of searching a Document via Nokogiri::XML::Node#css or Nokogiri::XML::Node#xpath

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(document, list = []) {|_self| ... } ⇒ NodeSet

Create a NodeSet with document defaulting to list

Yields:

  • (_self)

Yield Parameters:



14
15
16
17
18
19
 
# File 'lib/nokogiri/xml/node_set.rb', line 14

def initialize document, list = []
  @document = document
  document.decorate(self)
  list.each { |x| self << x }
  yield self if block_given?
end

Instance Attribute Details

#cstruct ⇒ Object

:nodoc:



5
6
7
 
# File 'lib/nokogiri/ffi/xml/node_set.rb', line 5

def cstruct
  @cstruct
end

#document ⇒ Object

The Document this NodeSet is associated with



11
12
13
 
# File 'lib/nokogiri/xml/node_set.rb', line 11

def document
  @document
end

Class Method Details

.new(document, list = []) {|set| ... } ⇒ Object

:nodoc:

Yields:



103
104
105
106
107
108
109
 
# File 'lib/nokogiri/ffi/xml/node_set.rb', line 103

def self.new document, list = [] # :nodoc:
  set = NodeSet.wrap(LibXML.xmlXPathNodeSetCreate(nil), document)
  set.document = document
  list.each { |x| set << x }
  yield set if block_given?
  set
end

.wrap(ptr, document) ⇒ Object

:nodoc:



111
112
113
114
115
116
117
118
119
 
# File 'lib/nokogiri/ffi/xml/node_set.rb', line 111

def self.wrap(ptr, document) # :nodoc:
  set = allocate
  set.cstruct = LibXML::XmlNodeSet.new(ptr)
  if document
    set.document = document
    document.decorate(set)
  end
  set
end

Instance Method Details

#&(node_set) ⇒ Object

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



67
68
69
70
71
 
# File 'lib/nokogiri/ffi/xml/node_set.rb', line 67

def &(node_set) # :nodoc:
  raise(ArgumentError, "node_set must be a Nokogiri::XML::NodeSet") unless node_set.is_a?(XML::NodeSet)
  new_set_ptr = LibXML.xmlXPathIntersection(cstruct, node_set.cstruct)
  NodeSet.wrap(new_set_ptr, self.document)
end

#+ ⇒ Object 



347
 
# File 'lib/nokogiri/xml/node_set.rb', line 347

alias :+ :|

#-(node_set) ⇒ Object

Difference - returns a new NodeSet that is a copy of this NodeSet, removing

each item that also appears in +node_set+



30
31
32
33
34
35
36
37
38
39
 
# File 'lib/nokogiri/ffi/xml/node_set.rb', line 30

def -(node_set) # :nodoc:
  raise(ArgumentError, "node_set must be a Nokogiri::XML::NodeSet") unless node_set.is_a?(XML::NodeSet)
  new_set_ptr = LibXML.xmlXPathNodeSetMerge(nil, self.cstruct)

  other_nodetab = node_set.cstruct.nodeTab
  node_set.cstruct[:nodeNr].times do |j|
    LibXML.xmlXPathNodeSetDel(new_set_ptr, other_nodetab[j])
  end        
  NodeSet.wrap(new_set_ptr, self.document)
end

#<< ⇒ Object 



63
 
# File 'lib/nokogiri/xml/node_set.rb', line 63

alias :<< :push

#==(other) ⇒ Object

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



314
315
316
317
318
319
320
321
 
# File 'lib/nokogiri/xml/node_set.rb', line 314

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) ⇒ Object

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



143
144
145
146
 
# 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

#[](*args) ⇒ Object Also known as: slice

start, length

-> NodeSet or nil

range

-> NodeSet or nil

slice(index) -> Node or nil
slice(start, length) -> NodeSet or nil
slice(range) -> NodeSet or nil

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.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/nokogiri/ffi/xml/node_set.rb', line 50

def [](*args) # :nodoc:
  raise(ArgumentError, "got #{args.length} arguments, expected 1 (or 2)") if args.length > 2

  if args.length == 2
    beg = args[0]
    len = args[1]
    beg += cstruct[:nodeNr] if beg < 0
    return subseq(beg, len)
  end
  arg = args[0]

  return subseq(arg.first, arg.last-arg.first+1) if arg.is_a?(Range)

  index_at(arg)
end

#add_class(name) ⇒ Object

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



183
184
185
186
187
188
189
 
# 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) ⇒ Object

Insert datum after the last Node in this NodeSet



59
60
61
 
# File 'lib/nokogiri/xml/node_set.rb', line 59

def after datum
  last.after datum
end

#at(path, ns = document.root ? document.root.namespaces : {}) ⇒ Object Also known as: %

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



151
152
153
154
 
# 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) ⇒ Object

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



171
172
173
 
# File 'lib/nokogiri/xml/node_set.rb', line 171

def at_css *rules
  css(*rules).first
end

#at_xpath(*paths) ⇒ Object

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



162
163
164
 
# File 'lib/nokogiri/xml/node_set.rb', line 162

def at_xpath *paths
  xpath(*paths).first
end

#attr(key, value = nil, &blk) ⇒ Object Also known as: set, attribute

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



214
215
216
217
218
219
220
221
222
223
224
 
# 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

#before(datum) ⇒ Object

Insert datum before the first Node in this NodeSet



53
54
55
 
# File 'lib/nokogiri/xml/node_set.rb', line 53

def before datum
  first.before datum
end

#children ⇒ Object

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



326
327
328
 
# File 'lib/nokogiri/xml/node_set.rb', line 326

def children
  inject(NodeSet.new(document)) { |set, node| set += node.children }
end

#css(*paths) ⇒ Object

Search this NodeSet for css paths

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



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# 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(node) ⇒ Object

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



41
42
43
44
45
46
47
48
 
# File 'lib/nokogiri/ffi/xml/node_set.rb', line 41

def delete(node) # :nodoc:
  raise(ArgumentError, "node must be a Nokogiri::XML::Node") unless node.is_a?(XML::Node) || node.is_a?(XML::Namespace)
  if LibXML.xmlXPathNodeSetContains(cstruct, node.cstruct) != 0
    LibXML.xmlXPathNodeSetDel(cstruct, node.cstruct)
    return node
  end
  return nil
end

#dup ⇒ Object

Duplicate this node set



7
8
9
10
 
# File 'lib/nokogiri/ffi/xml/node_set.rb', line 7

def dup # :nodoc:
  dup = LibXML.xmlXPathNodeSetMerge(nil, self.cstruct)
  NodeSet.wrap(dup, self.document)
end

#each(&block) ⇒ Object

Iterate over each node, yielding to block



237
238
239
240
241
 
# File 'lib/nokogiri/xml/node_set.rb', line 237

def each(&block)
  0.upto(length - 1) do |x|
    yield self[x]
  end
end

#empty? ⇒ Boolean

Is this NodeSet empty?

Returns:

  • (Boolean) 


40
41
42
 
# File 'lib/nokogiri/xml/node_set.rb', line 40

def empty?
  length == 0
end

#filter(expr) ⇒ Object

Filter this list for nodes that match expr



177
178
179
 
# File 'lib/nokogiri/xml/node_set.rb', line 177

def filter expr
  find_all { |node| node.matches?(expr) }
end

#first(n = nil) ⇒ Object

Get the first element of the NodeSet.



23
24
25
26
27
28
29
30
 
# 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?(node) ⇒ Boolean

Returns true if any member of node set equals node.

Returns:

  • (Boolean) 


73
74
75
76
 
# File 'lib/nokogiri/ffi/xml/node_set.rb', line 73

def include?(node) # :nodoc:
  raise(ArgumentError, "node must be a Nokogiri::XML::Node") unless node.is_a?(XML::Node) || node.is_a?(XML::Namespace)
  (LibXML.xmlXPathNodeSetContains(cstruct, node.cstruct) != 0) ? true : false
end

#index(node) ⇒ Object

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



46
47
48
49
 
# 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) ⇒ Object

Get the inner html of all contained Node objects



252
253
254
 
# File 'lib/nokogiri/xml/node_set.rb', line 252

def inner_html *args
  collect{|j| j.inner_html(*args) }.join('')
end

#inner_text ⇒ Object Also known as: text

Get the inner text of all contained Node objects



245
246
247
 
# File 'lib/nokogiri/xml/node_set.rb', line 245

def inner_text
  collect{|j| j.inner_text}.join('')
end

#inspect ⇒ Object

Return a nicely formated string representation



343
344
345
 
# File 'lib/nokogiri/xml/node_set.rb', line 343

def inspect
  "[#{map { |c| c.inspect }.join ', '}]"
end

#last ⇒ Object

Get the last element of the NodeSet.



34
35
36
 
# File 'lib/nokogiri/xml/node_set.rb', line 34

def last
  self[length - 1]
end

#length ⇒ Object

Get the length of the node set



12
13
14
 
# File 'lib/nokogiri/ffi/xml/node_set.rb', line 12

def length # :nodoc:
  cstruct.pointer.null? ? 0 : cstruct[:nodeNr]
end

#pop ⇒ Object

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



297
298
299
300
 
# File 'lib/nokogiri/xml/node_set.rb', line 297

def pop
  return nil if length == 0
  delete last
end

#push(node) ⇒ Object

Append node to the NodeSet.



16
17
18
19
20
 
# File 'lib/nokogiri/ffi/xml/node_set.rb', line 16

def push(node) # :nodoc:
  raise(ArgumentError, "node must be a Nokogiri::XML::Node") unless node.is_a?(XML::Node) || node.is_a?(XML::Namespace)
  LibXML.xmlXPathNodeSetAdd(cstruct, node.cstruct)
  self
end

#remove ⇒ Object 



64
 
# File 'lib/nokogiri/xml/node_set.rb', line 64

alias :remove :unlink

#remove_attr(name) ⇒ Object

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



230
231
232
233
 
# File 'lib/nokogiri/xml/node_set.rb', line 230

def remove_attr name
  each { |el| el.delete name }
  self
end

#remove_class(name = nil) ⇒ Object

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.



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# 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 ⇒ Object

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



333
334
335
336
337
338
339
 
# File 'lib/nokogiri/xml/node_set.rb', line 333

def reverse
  node_set = NodeSet.new(document)
  (length - 1).downto(0) do |x|
    node_set.push self[x]
  end
  node_set
end

#search(*paths) ⇒ Object Also known as: /

Search this document for paths

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# 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

#shift ⇒ Object

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



305
306
307
308
 
# File 'lib/nokogiri/xml/node_set.rb', line 305

def shift
  return nil if length == 0
  delete first
end

#size ⇒ Object 



291
 
# File 'lib/nokogiri/xml/node_set.rb', line 291

alias :size :length

#to_a ⇒ Object

Return this list as an Array



78
79
80
81
82
83
84
85
86
87
 
# File 'lib/nokogiri/ffi/xml/node_set.rb', line 78

def to_a # :nodoc:
  cstruct.nodeTab.collect do |node|
    node_cstruct = LibXML::XmlNode.new(node)
    if node_cstruct[:type] == XML::Node::NAMESPACE_DECL
      Namespace.wrap(document.cstruct, node)
    else
      Node.wrap(node_cstruct)
    end
  end
end

#to_ary ⇒ Object 



292
 
# File 'lib/nokogiri/xml/node_set.rb', line 292

alias :to_ary :to_a

#to_html(*args) ⇒ Object

Convert this NodeSet to HTML



275
276
277
 
# File 'lib/nokogiri/xml/node_set.rb', line 275

def to_html *args
  map { |x| x.to_html(*args) }.join
end

#to_s ⇒ Object

Convert this NodeSet to a string.



269
270
271
 
# File 'lib/nokogiri/xml/node_set.rb', line 269

def to_s
  map { |x| x.to_s }.join
end

#to_xhtml(*args) ⇒ Object

Convert this NodeSet to XHTML



281
282
283
 
# File 'lib/nokogiri/xml/node_set.rb', line 281

def to_xhtml *args
  map { |x| x.to_xhtml(*args) }.join
end

#to_xml(*args) ⇒ Object

Convert this NodeSet to XML



287
288
289
 
# File 'lib/nokogiri/xml/node_set.rb', line 287

def to_xml *args
  map { |x| x.to_xml(*args) }.join
end

#unlink ⇒ Object

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



89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/nokogiri/ffi/xml/node_set.rb', line 89

def unlink # :nodoc:
  nodetab = cstruct.nodeTab
  cstruct[:nodeNr].times do |j|
    node_cstruct = LibXML::XmlNode.new(nodetab[j])
    if node_cstruct[:type] != XML::Node::NAMESPACE_DECL
      node = Node.wrap(node_cstruct)
      node.unlink
      nodetab[j] = node.cstruct.pointer
    end
  end
  cstruct.nodeTab = nodetab
  self
end

#wrap(html, &blk) ⇒ Object

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



258
259
260
261
262
263
264
265
 
# 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) ⇒ Object

Search this NodeSet for XPath paths

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



126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# 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

#|(node_set) ⇒ Object

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



22
23
24
25
26
27
28
 
# File 'lib/nokogiri/ffi/xml/node_set.rb', line 22

def |(node_set) # :nodoc:
  raise(ArgumentError, "node_set must be a Nokogiri::XML::NodeSet") unless node_set.is_a?(XML::NodeSet)
  new_set_ptr = LibXML::xmlXPathNodeSetMerge(nil, self.cstruct)
  new_set_ptr = LibXML::xmlXPathNodeSetMerge(new_set_ptr, node_set.cstruct)

  NodeSet.wrap(new_set_ptr, self.document)
end