class Nokogiri::XML::Node
You may search this node’s subtree using Node#xpath and Node#css
* Nokogiri::XML::Node#previous
* Nokogiri::XML::Node#next
* Nokogiri::XML::Node#children
* Nokogiri::XML::Node#parent
tree. For navigating your tree, see:
Nokogiri::XML::Node also has methods that let you move around your
See Nokogiri::XML::Node#[] and Nokogiri::XML#[]= for more information.
irb(main):010:0>
=> <a href=“#foo” id=“link” class=“green”>link</a>
irb(main):009:0> node
=> “green”
irb(main):008:0> node = ‘green’
=> [“#foo”, “link”]
irb(main):007:0> node.values
=> [“href”, “id”]
irb(main):006:0> node.keys
=> “#foo”
irb(main):005:0> node[‘href’]
=> <a href=“#foo” id=“link”>link</a>
irb(main):004:0> node
to a hash with regard to attributes. For example (from irb):
with XML and HTML tags. A Nokogiri::XML::Node may be treated similarly
Nokogiri::XML::Node is your window to the fun filled world of dealing
###
def <=> other
Compare two Node objects with respect to their Document. Nodes from
##
def <=> other return nil unless other.is_a?(Nokogiri::XML::Node) return nil unless document == other.document compare other end
def == other
##
def == other return false unless other return false unless other.respond_to?(:pointer_id) pointer_id == other.pointer_id end
def > selector
##
def > selector ns = document.root.namespaces xpath CSS.xpath_for(selector, :prefix => "./", :ns => ns).first end
def [] name
##
def [] name return nil unless key?(name.to_s) get(name.to_s) end
def accept visitor
##
def accept visitor visitor.visit(self) end
def add_child node_or_tags
+node_or_tags+ can be a Nokogiri::XML::Node, a ::DocumentFragment, a ::NodeSet, or a string containing markup.
Add +node_or_tags+ as a child of this Node.
##
def add_child node_or_tags node_or_tags = coerce(node_or_tags) if node_or_tags.is_a?(XML::NodeSet) node_or_tags.each { |n| add_child_node n } else add_child_node node_or_tags end node_or_tags end
def add_next_sibling node_or_tags
Returns the reparented node (if +node_or_tags+ is a Node), or NodeSet (if +node_or_tags+ is a DocumentFragment, NodeSet, or string).
+node_or_tags+ can be a Nokogiri::XML::Node, a ::DocumentFragment, a ::NodeSet, or a string containing markup.
Insert +node_or_tags+ after this Node (as a sibling).
##
def add_next_sibling node_or_tags node_or_tags = coerce(node_or_tags) if node_or_tags.is_a?(XML::NodeSet) if text? pivot = Nokogiri::XML::Node.new 'dummy', document add_next_sibling_node pivot else pivot = self end node_or_tags.reverse.each { |n| pivot.send :add_next_sibling_node, n } pivot.unlink if text? else add_next_sibling_node node_or_tags end node_or_tags end
def add_previous_sibling node_or_tags
Returns the reparented node (if +node_or_tags+ is a Node), or NodeSet (if +node_or_tags+ is a DocumentFragment, NodeSet, or string).
+node_or_tags+ can be a Nokogiri::XML::Node, a ::DocumentFragment, a ::NodeSet, or a string containing markup.
Insert +node_or_tags+ before this Node (as a sibling).
##
def add_previous_sibling node_or_tags node_or_tags = coerce(node_or_tags) if node_or_tags.is_a?(XML::NodeSet) if text? pivot = Nokogiri::XML::Node.new 'dummy', document add_previous_sibling_node pivot else pivot = self end node_or_tags.each { |n| pivot.send :add_previous_sibling_node, n } pivot.unlink if text? else add_previous_sibling_node node_or_tags end node_or_tags end
def after node_or_tags
Returns self, to support chaining of calls.
+node_or_tags+ can be a Nokogiri::XML::Node, a Nokogiri::XML::DocumentFragment, or a string containing markup.
Insert +node_or_tags+ after this node (as a sibling).
###
def after node_or_tags add_next_sibling node_or_tags self end
def ancestors selector = nil
Get a list of ancestor Node for this Node. If +selector+ is given,
##
def ancestors selector = nil return NodeSet.new(document) unless respond_to?(:parent) return NodeSet.new(document) unless parent parents = [parent] while parents.last.respond_to?(:parent) break unless ctx_parent = parents.last.parent parents << ctx_parent end return NodeSet.new(document, parents) unless selector root = parents.last NodeSet.new(document, parents.find_all { |parent| root.search(selector).include?(parent) }) end
def at path, ns = document.root ? document.root.namespaces : {}
Search for the first occurrence of +path+.
##
def at path, ns = document.root ? document.root.namespaces : {} search(path, ns).first end
def at_css *rules
See Node#css for more information.
Equivalent to css(rules).first
Search this node for the first occurrence of CSS +rules+.
#
def at_css *rules css(*rules).first end
def at_xpath *paths
See Node#xpath for more information.
Equivalent to xpath(paths).first
Search this node for the first occurrence of XPath +paths+.
#
def at_xpath *paths xpath(*paths).first end
def attributes
If you need to distinguish attributes with the same name, with different namespaces
representing the attribute.
the attribute name without any namespace, the value is a Nokogiri::XML::Attr
Returns a hash containing the node's attributes. The key is
###
def attributes Hash[*(attribute_nodes.map { |node| [node.node_name, node] }.flatten)] end
def before node_or_tags
Returns self, to support chaining of calls.
+node_or_tags+ can be a Nokogiri::XML::Node, a ::DocumentFragment, a ::NodeSet, or a string containing markup.
Insert +node_or_tags+ before this node (as a sibling).
###
def before node_or_tags add_previous_sibling node_or_tags self end
def cdata?
def cdata? type == CDATA_SECTION_NODE end
def children= node_or_tags
Returns the reparented node (if +node_or_tags+ is a Node), or NodeSet (if +node_or_tags+ is a DocumentFragment, NodeSet, or string).
+node_or_tags+ can be a Nokogiri::XML::Node, a Nokogiri::XML::DocumentFragment, or a string containing markup.
Set the inner html for this Node +node_or_tags+
###
def children= node_or_tags node_or_tags = coerce(node_or_tags) children.unlink if node_or_tags.is_a?(XML::NodeSet) node_or_tags.each { |n| add_child_node n } else add_child_node node_or_tags end node_or_tags end
def coerce data # :nodoc:
def coerce data # :nodoc: return data if data.is_a?(XML::NodeSet) return data.children if data.is_a?(XML::DocumentFragment) return fragment(data).children if data.is_a?(String) if data.is_a?(Document) || !data.is_a?(XML::Node) raise ArgumentError, <<-EOERR es a Node, NodeSet or String argument, and cannot accept a #{data.class}. robably want to select a node from the Document with at() or search(), or create a new Node via Node.new().) EOERR end data end
def comment?
def comment? type == COMMENT_NODE end
def content= string
###
def content= string self.native_content = encode_special_chars(string.to_s) end
def css *rules
(e.g., "H1" is distinct from "h1").
found in an XML document, where tags names are case-sensitive
will match only lowercase CSS queries. However, "H1" might be
an HTML document, you'll never find anything, since HTML tags
to your document type. That is, if you're looking for "H1" in
Note that the CSS query string is case-sensitive with regards
}.new)
end
node_set.find_all { |node| node['some_attribute'] =~ /#{regex}/ }
def regex node_set, regex
node.css('title:regex("\w+")', Class.new {
arguments are ones that you pass in. For example:
method will be the current matching NodeSet. Any other
pseudo class you want defined. The first argument to the
custom pseudo classes, create a class and implement the custom
Custom CSS pseudo classes may also be defined. To define
node.css('bike|tire', {'bike' => 'http://schwinn.com/'})
A hash of namespace bindings may be appended. For example:
node.css('div + p.green', 'div#one')
node.css('body h1.bold')
node.css('title')
selectors. For example:
Search this node for CSS +rules+. +rules+ must be one or more CSS
call-seq: css *rules, [namespace-bindings, custom-pseudo-class]
##
def css *rules rules, handler, ns, binds = extract_params(rules) prefix = "#{implied_xpath_context}/" rules = rules.map { |rule| CSS.xpath_for(rule, :prefix => prefix, :ns => ns) }.flatten.uniq + [ns, handler, binds].compact xpath(*rules) end
def css_path
def css_path path.split(/\//).map { |part| part.length == 0 ? nil : part.gsub(/\[(\d+)\]/, ':nth-of-type(\1)') }.compact.join(' > ') end
def decorate!
##
def decorate! document.decorate(self) end
def default_namespace= url
now show up in #attributes, but when this node is serialized to XML an
present in parsed XML. A default namespace set with this method will
The consequence is as an xmlns attribute with supplied argument were
Adds a default namespace supplied as a string +url+ href, to self.
##
def default_namespace= url add_namespace_definition(nil, url) end
def description
Fetch the Nokogiri::HTML::ElementDescription for this node. Returns
##
def description return nil if document.xml? Nokogiri::HTML::ElementDescription[name] end
def each &block
##
def each &block attribute_nodes.each { |node| block.call([node.node_name, node.value]) } end
def element?
def element? type == ELEMENT_NODE end
def extract_params params # :nodoc:
def extract_params params # :nodoc: # Pop off our custom function handler if it exists handler = params.find { |param| ![Hash, String, Symbol].include?(param.class) } params -= [handler] if handler hashes = [] hashes << params.pop while Hash === params.last || params.last.nil? ns, binds = hashes.reverse ns ||= document.root ? document.root.namespaces : {} [params, handler, ns, binds] end
def fragment tags
Create a DocumentFragment containing +tags+ that is relative to _this_
##
def fragment tags type = document.html? ? Nokogiri::HTML : Nokogiri::XML type::DocumentFragment.new(document, tags, self) end
def fragment?
def fragment? type == DOCUMENT_FRAG_NODE end
def html?
def html? type == HTML_DOCUMENT_NODE end
def implied_xpath_context
def implied_xpath_context "./" end
def initialize name, document # :nodoc:
def initialize name, document # :nodoc: # ... Ya. This is empty on purpose. end
def inner_html *args
def inner_html *args children.map { |x| x.to_html(*args) }.join end
def inner_html= node_or_tags
Returns self.
+node_or_tags+ can be a Nokogiri::XML::Node, a Nokogiri::XML::DocumentFragment, or a string containing markup.
Set the inner html for this Node to +node_or_tags+
###
def inner_html= node_or_tags self.children = node_or_tags self end
def inspect_attributes
def inspect_attributes [:name, :namespace, :attribute_nodes, :children] end
def keys
##
def keys attribute_nodes.map { |node| node.node_name } end
def matches? selector
##
def matches? selector ancestors.last.search(selector).include?(self) end
def namespace= ns
for this node. You probably want #default_namespace= instead, or perhaps
a Namespace added this way will NOT be serialized as an xmlns attribute
"xmlns=" attribute in XML source), as a Namespace object +ns+. Note that
Set the default namespace on this node (as would be defined with an
##
def namespace= ns return set_namespace(ns) unless ns unless Nokogiri::XML::Namespace === ns raise TypeError, "#{ns.class} can't be coerced into Nokogiri::XML::Namespace" end if ns.document != document raise ArgumentError, 'namespace must be declared on the same document' end set_namespace ns end
def namespaces
default namespaces set on ancestor will NOT be, even if self
set on self will be included with key "xmlns". However,
such as "xmlns:prefix", not just the prefix. Default namespace
XML attributes that would be used to define this namespace,
attribute-name/value pairs. Note that the keys in this hash
element directly or any ancestor node -- as a Hash of
Returns namespaces in scope for self -- those defined on self
This method returns the same namespaces as #namespace_scopes.
node and its ancestors.
Returns a Hash of {prefix => value} for all namespaces on this
##
def namespaces Hash[*namespace_scopes.map { |nd| key = ['xmlns', nd.prefix].compact.join(':') if RUBY_VERSION >= '1.9' && document.encoding begin key.force_encoding document.encoding rescue ArgumentError end end [key, nd.href] }.flatten] end
def parent= parent_node
##
def parent= parent_node parent_node.add_child(self) parent_node end
def parse string_or_io, options = nil
*this* node. Returns a XML::NodeSet containing the nodes parsed from
Parse +string_or_io+ as a document fragment within the context of
##
def parse string_or_io, options = nil options ||= (document.html? ? ParseOptions::DEFAULT_HTML : ParseOptions::DEFAULT_XML) if Fixnum === options options = Nokogiri::XML::ParseOptions.new(options) end # Give the options to the user yield options if block_given? contents = string_or_io.respond_to?(:read) ? string_or_io.read : string_or_io return Nokogiri::XML::NodeSet.new(document) if contents.empty? ## # This is a horrible hack, but I don't care. See #313 for background. error_count = document.errors.length node_set = in_context(contents, options.to_i) if node_set.empty? and document.errors.length > error_count and options.recover? fragment = Nokogiri::HTML::DocumentFragment.parse contents node_set = fragment.children end node_set end
def read_only?
##
def read_only? # According to gdome2, these are read-only node types [NOTATION_NODE, ENTITY_NODE, ENTITY_DECL].include?(type) end
def remove_attribute name
##
def remove_attribute name attributes[name].remove if key? name end
def replace node_or_tags
Returns the reparented node (if +node_or_tags+ is a Node), or NodeSet (if +node_or_tags+ is a DocumentFragment, NodeSet, or string).
+node_or_tags+ can be a Nokogiri::XML::Node, a ::DocumentFragment, a ::NodeSet, or a string containing markup.
Replace this Node with +node_or_tags+.
###
def replace node_or_tags node_or_tags = coerce(node_or_tags) if node_or_tags.is_a?(XML::NodeSet) if text? replacee = Nokogiri::XML::Node.new 'dummy', document add_previous_sibling_node replacee unlink else replacee = self end node_or_tags.each { |n| replacee.add_previous_sibling n } replacee.unlink else replace_node node_or_tags end node_or_tags end
def search *paths
optional hash of namespaces may be appended.
Search this node for +paths+. +paths+ can be XPath or CSS, and an
##
def search *paths # TODO use paths, handler, ns, binds = extract_params(paths) ns = paths.last.is_a?(Hash) ? paths.pop : (document.root ? document.root.namespaces : {}) prefix = "#{implied_xpath_context}/" xpath(*(paths.map { |path| path = path.to_s path =~ /^(\.\/|\/)/ ? path : CSS.xpath_for( path, :prefix => prefix, :ns => ns ) }.flatten.uniq) + [ns]) end
def serialize *args, &block
end
config.format.as_xml
node.serialize(:encoding => 'UTF-8') do |config|
or
node.serialize(:encoding => 'UTF-8', :save_with => FORMAT | AS_XML)
These two statements are equivalent:
block. See SaveOptions.
Serialize Node using +options+. Save options can also be set using a
##
def serialize *args, &block options = args.first.is_a?(Hash) ? args.shift : { :encoding => args[0], :save_with => args[1] || SaveOptions::FORMAT } encoding = options[:encoding] || document.encoding outstring = "" if encoding && outstring.respond_to?(:force_encoding) outstring.force_encoding(Encoding.find(encoding)) end io = StringIO.new(outstring) write_to io, options, &block io.string end
def swap node_or_tags
Returns self, to support chaining of calls.
+node_or_tags+ can be a Nokogiri::XML::Node, a ::DocumentFragment, a ::NodeSet, or a string containing markup.
Swap this Node for +node_or_tags+
###
def swap node_or_tags replace node_or_tags self end
def text?
def text? type == TEXT_NODE end
def to_html options = {}
See Node#write_to for a list of +options+. For formatted output,
doc.to_html
Serialize this Node to HTML
##
def to_html options = {} # FIXME: this is a hack around broken libxml versions return dump_html if Nokogiri.uses_libxml? && %w[2 6] === LIBXML_VERSION.split('.')[0..1] options[:save_with] ||= SaveOptions::FORMAT | SaveOptions::NO_DECLARATION | SaveOptions::NO_EMPTY_TAGS | SaveOptions::AS_HTML serialize(options) end
def to_s
Turn this node in to a string. If the document is HTML, this method
##
def to_s document.xml? ? to_xml : to_html end
def to_xhtml options = {}
doc.to_xhtml(:indent => 5, :encoding => 'UTF-8')
Serialize this Node to XHTML using +options+
##
def to_xhtml options = {} # FIXME: this is a hack around broken libxml versions return dump_html if Nokogiri.uses_libxml? && %w[2 6] === LIBXML_VERSION.split('.')[0..1] options[:save_with] ||= SaveOptions::FORMAT | SaveOptions::NO_DECLARATION | SaveOptions::NO_EMPTY_TAGS | SaveOptions::AS_XHTML serialize(options) end
def to_xml options = {}
doc.to_xml(:indent => 5, :encoding => 'UTF-8')
Serialize this Node to XML using +options+
##
def to_xml options = {} options[:save_with] ||= SaveOptions::FORMAT | SaveOptions::AS_XML serialize(options) end
def traverse &block
###
def traverse &block children.each{|j| j.traverse(&block) } block.call(self) end
def values
##
def values attribute_nodes.map { |node| node.value } end
def write_html_to io, options = {}
Write Node as HTML to +io+ with +options+
##
def write_html_to io, options = {} # FIXME: this is a hack around broken libxml versions return (io << dump_html) if Nokogiri.uses_libxml? && %w[2 6] === LIBXML_VERSION.split('.')[0..1] options[:save_with] ||= SaveOptions::FORMAT | SaveOptions::NO_DECLARATION | SaveOptions::NO_EMPTY_TAGS | SaveOptions::AS_HTML write_to io, options end
def write_to io, *options
node.write_to(io, :indent_text => '-', :indent => 2
To save indented with two dashes:
node.write_to(io, :encoding => 'UTF-8', :indent => 2)
To save with UTF-8 indented twice:
* +:save_with+ a combination of SaveOptions constants.
* +:indent+ the number of +:indent_text+ to use, defaults to 2
* +:indent_text+ the indentation text, defaults to one space
* +:encoding+ for changing the encoding
this method. Valid options are:
Write Node to +io+ with +options+. +options+ modify the output of
##
def write_to io, *options options = options.first.is_a?(Hash) ? options.shift : {} encoding = options[:encoding] || options[0] save_options = options[:save_with] || options[1] || SaveOptions::FORMAT indent_text = options[:indent_text] || ' ' indent_times = options[:indent] || 2 config = SaveOptions.new(save_options) yield config if block_given? native_write_to(io, encoding, indent_text * indent_times, config.options) end
def write_xhtml_to io, options = {}
Write Node as XHTML to +io+ with +options+
##
def write_xhtml_to io, options = {} # FIXME: this is a hack around broken libxml versions return (io << dump_html) if Nokogiri.uses_libxml? && %w[2 6] === LIBXML_VERSION.split('.')[0..1] options[:save_with] ||= SaveOptions::FORMAT | SaveOptions::NO_DECLARATION | SaveOptions::NO_EMPTY_TAGS | SaveOptions::AS_XHTML write_to io, options end
def write_xml_to io, options = {}
doc.write_xml_to io, :encoding => 'UTF-8'
Write Node as XML to +io+ with +options+
##
def write_xml_to io, options = {} options[:save_with] ||= SaveOptions::FORMAT | SaveOptions::AS_XML write_to io, options end
def xml?
def xml? type == DOCUMENT_NODE end
def xpath *paths
}.new)
end
node_set.find_all { |node| node['some_attribute'] =~ /#{regex}/ }
def regex node_set, regex
node.xpath('.//title[regex(., "\w+")]', Class.new {
argument list. For example:
you pass in. Note that this class may appear anywhere in the
current matching NodeSet. Any other arguments are ones that
to define. The first argument to the method will be the
functions create a class and implement the function you want
Custom XPath functions may also be defined. To define custom
node.xpath('.//address[@domestic=$value]', nil, {:value => 'Yes'})
A hash of variable bindings may also be appended to the namespace bindings. For example:
node.xpath('.//xmlns:name', node.root.namespaces)
node.xpath('.//foo:name', {'foo' => 'http://example.org/'})
A hash of namespace bindings may be appended. For example:
node.xpath('.//title')
queries.
Search this node for XPath +paths+. +paths+ must be one or more XPath
call-seq: xpath *paths, [namespace-bindings, variable-bindings, custom-handler-class]
##
def xpath *paths return NodeSet.new(document) unless document paths, handler, ns, binds = extract_params(paths) sets = paths.map { |path| ctx = XPathContext.new(self) ctx.register_namespaces(ns) path = path.gsub(/\/xmlns:/,'/:') unless Nokogiri.uses_libxml? binds.each do |key,value| ctx.register_variable key.to_s, value end if binds ctx.evaluate(path, handler) } return sets.first if sets.length == 1 NodeSet.new(document) do |combined| sets.each do |set| set.each do |node| combined << node end end end end