class Nokogiri::XML::Node
Nokogiri::XML::Node is your window to the fun filled world of dealing with XML and HTML tags. A Nokogiri::XML::Node may be treated similarly to a hash with regard to attributes. For example (from irb):
irb(main):004:0> node => <a href="#foo" id="link">link</a> irb(main):005:0> node['href'] => "#foo" irb(main):006:0> node.keys => ["href", "id"] irb(main):007:0> node.values => ["#foo", "link"] irb(main):008:0> node['class'] = 'green' => "green" irb(main):009:0> node => <a href="#foo" id="link" class="green">link</a> irb(main):010:0>
See #[] and Nokogiri::XML#[]= for more information.
Nokogiri::XML::Node also has methods that let you move around your tree. For navigating your tree, see:
When printing or otherwise emitting a document or a node (and its subtree), there are a few methods you might want to use:
-
content, text, #inner_text, #to_str: emit plaintext
These methods will all emit the plaintext version of your document, meaning that entities will be replaced (e.g., “<” will be replaced with “<”), meaning that any sanitizing will likely be un-done in the output.
-
#to_s, #to_xml, #to_html, #inner_html: emit well-formed markup
These methods will all emit properly-escaped markup, meaning that it's suitable for consumption by browsers, parsers, etc.
You may search this node's subtree using Nokogiri::XML::Searchable#xpath and Nokogiri::XML::Searchable#css
Constants
- ATTRIBUTE_DECL
Attribute declaration type
- ATTRIBUTE_NODE
Attribute node type
- CDATA_SECTION_NODE
- COMMENT_NODE
- DOCB_DOCUMENT_NODE
DOCB document node type
- DOCUMENT_FRAG_NODE
Document fragment node type
- DOCUMENT_NODE
- DOCUMENT_TYPE_NODE
Document type node type
- DTD_NODE
DTD node type
- ELEMENT_DECL
Element declaration type
- ELEMENT_NODE
- ENTITY_DECL
Entity declaration type
- ENTITY_NODE
Entity node type
- ENTITY_REF_NODE
Entity reference node type
- HTML_DOCUMENT_NODE
- NAMESPACE_DECL
Namespace declaration type
- NOTATION_NODE
Notation node type
- PI_NODE
PI node type
- TEXT_NODE
- XINCLUDE_END
XInclude end type
- XINCLUDE_START
XInclude start type
Public Class Methods
Create a new node with name
sharing GC lifecycle with
document
static VALUE new(int argc, VALUE *argv, VALUE klass) { xmlDocPtr doc; xmlNodePtr node; VALUE name; VALUE document; VALUE rest; VALUE rb_node; rb_scan_args(argc, argv, "2*", &name, &document, &rest); Data_Get_Struct(document, xmlDoc, doc); node = xmlNewNode(NULL, (xmlChar *)StringValueCStr(name)); node->doc = doc->doc; nokogiri_root_node(node); rb_node = Nokogiri_wrap_xml_node( klass == cNokogiriXmlNode ? (VALUE)NULL : klass, node ); rb_obj_call_init(rb_node, argc, argv); if(rb_block_given_p()) { rb_yield(rb_node); } return rb_node; }
Public Instance Methods
Add node_or_tags
as a child of this Node. node_or_tags
can be a Nokogiri::XML::Node, a ::DocumentFragment, a
::NodeSet, or a string containing markup.
Returns self, to support chaining of calls (e.g., root << child1 << child2)
Also see related method add_child
.
# File lib/nokogiri/xml/node.rb, line 183 def << node_or_tags add_child node_or_tags self end
Test to see if this Node is equal to
other
# File lib/nokogiri/xml/node.rb, line 667 def == other return false unless other return false unless other.respond_to?(:pointer_id) pointer_id == other.pointer_id end
Search this node's immediate children using CSS selector selector
# File lib/nokogiri/xml/node.rb, line 113 def > selector ns = document.root.namespaces xpath CSS.xpath_for(selector, :prefix => "./", :ns => ns).first end
Get the attribute value for the attribute name
# File lib/nokogiri/xml/node.rb, line 120 def [] name get(name.to_s) end
Set the attribute value for the attribute name
to
value
# File lib/nokogiri/xml/node.rb, line 126 def []= name, value set name.to_s, value.to_s end
Accept a visitor. This method calls “visit” on visitor
with
self.
# File lib/nokogiri/xml/node.rb, line 661 def accept visitor visitor.visit(self) end
Add node_or_tags
as a child of this Node. node_or_tags
can be a Nokogiri::XML::Node, a ::DocumentFragment, a
::NodeSet, or a string containing markup.
Returns the reparented node (if node_or_tags
is a Node), or NodeSet (if
node_or_tags
is a DocumentFragment, NodeSet, or string).
Also see related method +<<+.
# File lib/nokogiri/xml/node.rb, line 137 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_and_reparent_attrs n } else add_child_node_and_reparent_attrs node_or_tags end node_or_tags end
Add name
to the “class” attribute value of this Node and return self. If the value is already in the
current value, it is not added. If no “class” attribute exists yet, one is
created with the given value.
More than one class may be added at a time, separated by a space.
# File lib/nokogiri/xml/node.rb, line 380 def add_class name names = classes self['class'] = (names + (name.scan(/\S+/) - names)).join(' ') self end
Adds a namespace definition with prefix
using
href
value. The result is as if parsed XML for this node had included an attribute
'xmlns:prefix=value'. A default namespace for this node (“xmlns=”)
can be added by passing 'nil' for prefix. Namespaces added this way
will not show up in attributes,
but they will be included as an xmlns attribute when the node is serialized
to XML.
static VALUE add_namespace_definition(VALUE self, VALUE prefix, VALUE href) { xmlNodePtr node, namespace; xmlNsPtr ns; Data_Get_Struct(self, xmlNode, node); namespace = node ; ns = xmlSearchNs( node->doc, node, (const xmlChar *)(NIL_P(prefix) ? NULL : StringValueCStr(prefix)) ); if(!ns) { if (node->type != XML_ELEMENT_NODE) { namespace = node->parent; } ns = xmlNewNs( namespace, (const xmlChar *)StringValueCStr(href), (const xmlChar *)(NIL_P(prefix) ? NULL : StringValueCStr(prefix)) ); } if (!ns) { return Qnil ; } if(NIL_P(prefix) || node != namespace) { xmlSetNs(node, ns); } return Nokogiri_wrap_xml_namespace(node->doc, ns); }
Insert node_or_tags
after this Node
(as a sibling). node_or_tags
can be a Nokogiri::XML::Node, a ::DocumentFragment, a
::NodeSet, or a string containing markup.
Returns the reparented node (if node_or_tags
is a Node), or NodeSet (if
node_or_tags
is a DocumentFragment, NodeSet, or string).
Also see related method after
.
# File lib/nokogiri/xml/node.rb, line 208 def add_next_sibling node_or_tags raise ArgumentError.new("A document may not have multiple root nodes.") if (parent && parent.document?) && !(node_or_tags.comment? || node_or_tags.processing_instruction?) add_sibling :next, node_or_tags end
Insert node_or_tags
before this Node
(as a sibling). node_or_tags
can be a Nokogiri::XML::Node, a ::DocumentFragment, a
::NodeSet, or a string containing markup.
Returns the reparented node (if node_or_tags
is a Node), or NodeSet (if
node_or_tags
is a DocumentFragment, NodeSet, or string).
Also see related method before
.
# File lib/nokogiri/xml/node.rb, line 195 def add_previous_sibling node_or_tags raise ArgumentError.new("A document may not have multiple root nodes.") if (parent && parent.document?) && !(node_or_tags.comment? || node_or_tags.processing_instruction?) add_sibling :previous, node_or_tags end
Insert node_or_tags
after this node (as a sibling).
node_or_tags
can be a Nokogiri::XML::Node, a Nokogiri::XML::DocumentFragment, or a
string containing markup.
Returns self, to support chaining of calls.
Also see related method add_next_sibling
.
# File lib/nokogiri/xml/node.rb, line 233 def after node_or_tags add_next_sibling node_or_tags self end
Get a list of ancestor Node for this Node. If selector
is given, the
ancestors must match selector
# File lib/nokogiri/xml/node.rb, line 601 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 search_results = root.search(selector) NodeSet.new(document, parents.find_all { |parent| search_results.include?(parent) }) end
Append name
to the “class” attribute value of this Node and return self. The value is simply appended
without checking if it is already in the current value. If no “class”
attribute exists yet, one is created with the given value.
More than one class may be appended at a time, separated by a space.
# File lib/nokogiri/xml/node.rb, line 394 def append_class name self['class'] = (classes + name.scan(/\S+/)).join(' ') self end
Get the attribute node with name
static VALUE attr(VALUE self, VALUE name) { xmlNodePtr node; xmlAttrPtr prop; Data_Get_Struct(self, xmlNode, node); prop = xmlHasProp(node, (xmlChar *)StringValueCStr(name)); if(! prop) { return Qnil; } return Nokogiri_wrap_xml_node(Qnil, (xmlNodePtr)prop); }
returns a list containing the Node attributes.
static VALUE attribute_nodes(VALUE self) { /* this code in the mode of xmlHasProp() */ xmlNodePtr node; VALUE attr; Data_Get_Struct(self, xmlNode, node); attr = rb_ary_new(); Nokogiri_xml_node_properties(node, attr); return attr ; }
Get the attribute node with name
and namespace
static VALUE attribute_with_ns(VALUE self, VALUE name, VALUE namespace) { xmlNodePtr node; xmlAttrPtr prop; Data_Get_Struct(self, xmlNode, node); prop = xmlHasNsProp(node, (xmlChar *)StringValueCStr(name), NIL_P(namespace) ? NULL : (xmlChar *)StringValueCStr(namespace)); if(! prop) { return Qnil; } return Nokogiri_wrap_xml_node(Qnil, (xmlNodePtr)prop); }
Returns a hash containing the node's attributes. The key is the attribute name without any namespace, the value is a Nokogiri::XML::Attr representing the attribute. If you need to distinguish attributes with the same name, with different namespaces use attribute_nodes instead.
# File lib/nokogiri/xml/node.rb, line 339 def attributes Hash[attribute_nodes.map { |node| [node.node_name, node] }] end
Insert node_or_tags
before this node (as a sibling).
node_or_tags
can be a Nokogiri::XML::Node, a ::DocumentFragment, a
::NodeSet, or a string containing markup.
Returns self, to support chaining of calls.
Also see related method add_previous_sibling
.
# File lib/nokogiri/xml/node.rb, line 221 def before node_or_tags add_previous_sibling node_or_tags self end
Is this node blank?
static VALUE blank_eh(VALUE self) { xmlNodePtr node; Data_Get_Struct(self, xmlNode, node); return (1 == xmlIsBlankNode(node)) ? Qtrue : Qfalse ; }
# File lib/nokogiri/xml/node.rb, line 820 def canonicalize(mode=XML::XML_C14N_1_0,inclusive_namespaces=nil,with_comments=false) c14n_root = self document.canonicalize(mode, inclusive_namespaces, with_comments) do |node, parent| tn = node.is_a?(XML::Node) ? node : parent tn == c14n_root || tn.ancestors.include?(c14n_root) end end
Returns true if this is a CDATA
# File lib/nokogiri/xml/node.rb, line 524 def cdata? type == CDATA_SECTION_NODE end
Returns the child node
static VALUE child(VALUE self) { xmlNodePtr node, child; Data_Get_Struct(self, xmlNode, node); child = node->children; if(!child) { return Qnil; } return Nokogiri_wrap_xml_node(Qnil, child); }
Get the list of children for this node as a NodeSet
static VALUE children(VALUE self) { xmlNodePtr node; xmlNodePtr child; xmlNodeSetPtr set; VALUE document; VALUE node_set; Data_Get_Struct(self, xmlNode, node); child = node->children; set = xmlXPathNodeSetCreate(child); document = DOC_RUBY_OBJECT(node->doc); if(!child) { return Nokogiri_wrap_xml_node_set(set, document); } child = child->next; while(NULL != child) { xmlXPathNodeSetAddUnique(set, child); child = child->next; } node_set = Nokogiri_wrap_xml_node_set(set, document); return node_set; }
Set the inner html for this Node
node_or_tags
node_or_tags
can be a Nokogiri::XML::Node, a Nokogiri::XML::DocumentFragment, or a
string containing markup.
Returns the reparented node (if node_or_tags
is a Node), or NodeSet (if
node_or_tags
is a DocumentFragment, NodeSet, or string).
Also see related method inner_html=
# File lib/nokogiri/xml/node.rb, line 257 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_and_reparent_attrs n } else add_child_node_and_reparent_attrs node_or_tags end node_or_tags end
Get the list of class names of this Node, without deduplication or sorting.
# File lib/nokogiri/xml/node.rb, line 368 def classes self['class'].to_s.scan(/\S+/) end
Returns true if this is a Comment
# File lib/nokogiri/xml/node.rb, line 519 def comment? type == COMMENT_NODE end
Returns the plaintext content for this Node. Note that entities will always be expanded in the returned string.
static VALUE get_native_content(VALUE self) { xmlNodePtr node; xmlChar * content; Data_Get_Struct(self, xmlNode, node); content = xmlNodeGetContent(node); if(content) { VALUE rval = NOKOGIRI_STR_NEW2(content); xmlFree(content); return rval; } return Qnil; }
Create an external subset
static VALUE create_external_subset(VALUE self, VALUE name, VALUE external_id, VALUE system_id) { xmlNodePtr node; xmlDocPtr doc; xmlDtdPtr dtd; Data_Get_Struct(self, xmlNode, node); doc = node->doc; if(doc->extSubset) { rb_raise(rb_eRuntimeError, "Document already has an external subset"); } dtd = xmlNewDtd( doc, NIL_P(name) ? NULL : (const xmlChar *)StringValueCStr(name), NIL_P(external_id) ? NULL : (const xmlChar *)StringValueCStr(external_id), NIL_P(system_id) ? NULL : (const xmlChar *)StringValueCStr(system_id) ); if(!dtd) { return Qnil; } return Nokogiri_wrap_xml_node(Qnil, (xmlNodePtr)dtd); }
Create the internal subset of a document.
doc.create_internal_subset("chapter", "-//OASIS//DTD DocBook XML//EN", "chapter.dtd") # => <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML//EN" "chapter.dtd"> doc.create_internal_subset("chapter", nil, "chapter.dtd") # => <!DOCTYPE chapter SYSTEM "chapter.dtd">
static VALUE create_internal_subset(VALUE self, VALUE name, VALUE external_id, VALUE system_id) { xmlNodePtr node; xmlDocPtr doc; xmlDtdPtr dtd; Data_Get_Struct(self, xmlNode, node); doc = node->doc; if(xmlGetIntSubset(doc)) { rb_raise(rb_eRuntimeError, "Document already has an internal subset"); } dtd = xmlCreateIntSubset( doc, NIL_P(name) ? NULL : (const xmlChar *)StringValueCStr(name), NIL_P(external_id) ? NULL : (const xmlChar *)StringValueCStr(external_id), NIL_P(system_id) ? NULL : (const xmlChar *)StringValueCStr(system_id) ); if(!dtd) { return Qnil; } return Nokogiri_wrap_xml_node(Qnil, (xmlNodePtr)dtd); }
Get the path to this node as a CSS expression
# File lib/nokogiri/xml/node.rb, line 592 def css_path path.split(/\//).map { |part| part.length == 0 ? nil : part.gsub(/\[(\d+)\]/, ':nth-of-type(\1)') }.compact.join(' > ') end
Decorate this node with the decorators set up in this node's Document
# File lib/nokogiri/xml/node.rb, line 107 def decorate! document.decorate(self) end
Adds a default namespace supplied as a string url
href, to
self. The consequence is as an xmlns attribute with supplied argument were
present in parsed XML. A default namespace set
with this method will now show up in attributes, but when this node is
serialized to XML an “xmlns” attribute will
appear. See also namespace and
namespace=
# File lib/nokogiri/xml/node.rb, line 628 def default_namespace= url add_namespace_definition(nil, url) end
Fetch the Nokogiri::HTML::ElementDescription for this node. Returns nil on XML documents and on unknown tags.
# File lib/nokogiri/xml/node.rb, line 561 def description return nil if document.xml? Nokogiri::HTML::ElementDescription[name] end
Do xinclude substitution on the subtree below node. If given a block, a Nokogiri::XML::ParseOptions object initialized
from options
, will be passed to it, allowing more convenient
modification of the parser options.
# File lib/nokogiri/xml/node.rb, line 810 def do_xinclude options = XML::ParseOptions::DEFAULT_XML options = Nokogiri::XML::ParseOptions.new(options) if Integer === options # give options to user yield options if block_given? # call c extension process_xincludes(options.to_i) end
Get the document for this Node
static VALUE document(VALUE self) { xmlNodePtr node; Data_Get_Struct(self, xmlNode, node); return DOC_RUBY_OBJECT(node->doc); }
Returns true if this is a Document
# File lib/nokogiri/xml/node.rb, line 539 def document? is_a? XML::Document end
Copy this node. An optional depth may be passed in. 0 is a shallow copy, 1 (the default) is a deep copy. An optional new_parent_doc may also be passed in, which will be the new node's parent document. Defaults to the current node's document. current document.
static VALUE duplicate_node(int argc, VALUE *argv, VALUE self) { VALUE r_level, r_new_parent_doc; int level; int n_args; xmlDocPtr new_parent_doc; xmlNodePtr node, dup; Data_Get_Struct(self, xmlNode, node); n_args = rb_scan_args(argc, argv, "02", &r_level, &r_new_parent_doc); if (n_args < 1) { r_level = INT2NUM((long)1); } level = (int)NUM2INT(r_level); if (n_args < 2) { new_parent_doc = node->doc; } else { Data_Get_Struct(r_new_parent_doc, xmlDoc, new_parent_doc); } dup = xmlDocCopyNode(node, new_parent_doc, level); if(dup == NULL) { return Qnil; } nokogiri_root_node(dup); return Nokogiri_wrap_xml_node(rb_obj_class(self), dup); }
Iterate over each attribute name and value pair for this Node.
# File lib/nokogiri/xml/node.rb, line 359 def each attribute_nodes.each { |node| yield [node.node_name, node.value] } end
Returns true if this is an Element node
# File lib/nokogiri/xml/node.rb, line 574 def element? type == ELEMENT_NODE end
Get the list of children for this node as a NodeSet. All nodes will be element nodes.
Example:
@doc.root.element_children.all? { |x| x.element? } # => true
static VALUE element_children(VALUE self) { xmlNodePtr node; xmlNodePtr child; xmlNodeSetPtr set; VALUE document; VALUE node_set; Data_Get_Struct(self, xmlNode, node); child = xmlFirstElementChild(node); set = xmlXPathNodeSetCreate(child); document = DOC_RUBY_OBJECT(node->doc); if(!child) { return Nokogiri_wrap_xml_node_set(set, document); } child = xmlNextElementSibling(child); while(NULL != child) { xmlXPathNodeSetAddUnique(set, child); child = xmlNextElementSibling(child); } node_set = Nokogiri_wrap_xml_node_set(set, document); return node_set; }
Encode any special characters in string
static VALUE encode_special_chars(VALUE self, VALUE string) { xmlNodePtr node; xmlChar *encoded; VALUE encoded_str; Data_Get_Struct(self, xmlNode, node); encoded = xmlEncodeSpecialChars( node->doc, (const xmlChar *)StringValueCStr(string) ); encoded_str = NOKOGIRI_STR_NEW2(encoded); xmlFree(encoded); return encoded_str; }
Get the external subset
static VALUE external_subset(VALUE self) { xmlNodePtr node; xmlDocPtr doc; xmlDtdPtr dtd; Data_Get_Struct(self, xmlNode, node); if(!node->doc) { return Qnil; } doc = node->doc; dtd = doc->extSubset; if(!dtd) { return Qnil; } return Nokogiri_wrap_xml_node(Qnil, (xmlNodePtr)dtd); }
Returns the first child node of this node that is an element.
Example:
@doc.root.first_element_child.element? # => true
static VALUE first_element_child(VALUE self) { xmlNodePtr node, child; Data_Get_Struct(self, xmlNode, node); child = xmlFirstElementChild(node); if(!child) { return Qnil; } return Nokogiri_wrap_xml_node(Qnil, child); }
Create a DocumentFragment containing
tags
that is relative to this context node.
# File lib/nokogiri/xml/node.rb, line 441 def fragment tags type = document.html? ? Nokogiri::HTML : Nokogiri::XML type::DocumentFragment.new(document, tags, self) end
Returns true if this is a DocumentFragment
# File lib/nokogiri/xml/node.rb, line 554 def fragment? type == DOCUMENT_FRAG_NODE end
Returns true if this is an HTML::Document node
# File lib/nokogiri/xml/node.rb, line 534 def html? type == HTML_DOCUMENT_NODE end
Get the #inner_html for this node's #children
# File lib/nokogiri/xml/node.rb, line 587 def inner_html *args children.map { |x| x.to_html(*args) }.join end
Set the inner html for this Node to
node_or_tags
node_or_tags
can be a Nokogiri::XML::Node, a Nokogiri::XML::DocumentFragment, or a
string containing markup.
Returns self.
Also see related method children=
# File lib/nokogiri/xml/node.rb, line 245 def inner_html= node_or_tags self.children = node_or_tags self end
Get the internal subset
static VALUE internal_subset(VALUE self) { xmlNodePtr node; xmlDocPtr doc; xmlDtdPtr dtd; Data_Get_Struct(self, xmlNode, node); if(!node->doc) { return Qnil; } doc = node->doc; dtd = xmlGetIntSubset(doc); if(!dtd) { return Qnil; } return Nokogiri_wrap_xml_node(Qnil, (xmlNodePtr)dtd); }
Returns true if attribute
is set
static VALUE key_eh(VALUE self, VALUE attribute) { xmlNodePtr node; Data_Get_Struct(self, xmlNode, node); if(xmlHasProp(node, (xmlChar *)StringValueCStr(attribute))) { return Qtrue; } return Qfalse; }
Get the attribute names for this Node.
# File lib/nokogiri/xml/node.rb, line 353 def keys attribute_nodes.map(&:node_name) end
Searches the language of a node, i.e. the values of the xml:lang attribute or the one carried by the nearest ancestor.
static VALUE get_lang(VALUE self_rb) { xmlNodePtr self ; xmlChar* lang ; VALUE lang_rb ; Data_Get_Struct(self_rb, xmlNode, self); lang = xmlNodeGetLang(self); if (lang) { lang_rb = NOKOGIRI_STR_NEW2(lang); xmlFree(lang); return lang_rb ; } return Qnil ; }
Set the language of a node, i.e. the values of the xml:lang attribute.
static VALUE set_lang(VALUE self_rb, VALUE lang_rb) { xmlNodePtr self ; xmlChar* lang ; Data_Get_Struct(self_rb, xmlNode, self); lang = (xmlChar*)StringValueCStr(lang_rb); xmlNodeSetLang(self, lang); return Qnil ; }
Returns the last child node of this node that is an element.
Example:
@doc.root.last_element_child.element? # => true
static VALUE last_element_child(VALUE self) { xmlNodePtr node, child; Data_Get_Struct(self, xmlNode, node); child = xmlLastElementChild(node); if(!child) { return Qnil; } return Nokogiri_wrap_xml_node(Qnil, child); }
Returns the line for this Node
static VALUE line(VALUE self) { xmlNodePtr node; Data_Get_Struct(self, xmlNode, node); return INT2NUM(xmlGetLineNo(node)); }
Returns true if this Node matches
selector
# File lib/nokogiri/xml/node.rb, line 434 def matches? selector ancestors.last.search(selector).include?(self) end
returns the namespace of the element or attribute node as a Namespace object, or nil if there is no namespace for the element or attribute.
static VALUE namespace(VALUE self) { xmlNodePtr node ; Data_Get_Struct(self, xmlNode, node); if (node->ns) { return Nokogiri_wrap_xml_namespace(node->doc, node->ns); }
Set the default namespace on this node (as would be defined with an
“xmlns=” attribute in XML source), as a Namespace object ns
. Note that a Namespace added this way will NOT be serialized
as an xmlns attribute for this node. You probably want default_namespace=
instead, or perhaps add_namespace_definition
with a nil prefix argument.
# File lib/nokogiri/xml/node.rb, line 639 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
returns namespaces defined on self element directly, as an array of Namespace objects. Includes both a default namespace (as in“xmlns=”), and prefixed namespaces (as in “xmlns:prefix=”).
static VALUE namespace_definitions(VALUE self) { /* this code in the mode of xmlHasProp() */ xmlNodePtr node ; VALUE list; xmlNsPtr ns; Data_Get_Struct(self, xmlNode, node); list = rb_ary_new(); ns = node->nsDef; if(!ns) { return list; } while(NULL != ns) { rb_ary_push(list, Nokogiri_wrap_xml_namespace(node->doc, ns)); ns = ns->next; } return list; }
returns namespaces in scope for self – those defined on self element directly or any ancestor node – as an array of Namespace objects. Default namespaces (“xmlns=” style) for self are included in this array; Default namespaces for ancestors, however, are not. See also namespaces
static VALUE namespace_scopes(VALUE self) { xmlNodePtr node ; VALUE list; xmlNsPtr *ns_list; int j; Data_Get_Struct(self, xmlNode, node); list = rb_ary_new(); ns_list = xmlGetNsList(node->doc, node); if(!ns_list) { return list; } for (j = 0 ; ns_list[j] != NULL ; ++j) { rb_ary_push(list, Nokogiri_wrap_xml_namespace(node->doc, ns_list[j])); } xmlFree(ns_list); return list; }
Returns true if attribute
is set with namespace
static VALUE namespaced_key_eh(VALUE self, VALUE attribute, VALUE namespace) { xmlNodePtr node; Data_Get_Struct(self, xmlNode, node); if(xmlHasNsProp(node, (xmlChar *)StringValueCStr(attribute), NIL_P(namespace) ? NULL : (xmlChar *)StringValueCStr(namespace))) { return Qtrue; } return Qfalse; }
Returns a Hash of +{prefix => value}+ for all namespaces on this node and its ancestors.
This method returns the same namespaces as namespace_scopes.
Returns namespaces in scope for self – those defined on self element directly or any ancestor node – as a Hash of attribute-name/value pairs. Note that the keys in this hash XML attributes that would be used to define this namespace, such as “xmlns:prefix”, not just the prefix. Default namespace set on self will be included with key “xmlns”. However, default namespaces set on ancestor will NOT be, even if self has no explicit default namespace.
# File lib/nokogiri/xml/node.rb, line 511 def namespaces Hash[namespace_scopes.map { |nd| key = ['xmlns', nd.prefix].compact.join(':') [key, nd.href] }] end
Set the content for this Node
static VALUE set_native_content(VALUE self, VALUE content) { xmlNodePtr node, child, next ; Data_Get_Struct(self, xmlNode, node); child = node->children; while (NULL != child) { next = child->next ; xmlUnlinkNode(child) ; nokogiri_root_node(child); child = next ; } xmlNodeSetContent(node, (xmlChar *)StringValueCStr(content)); return content; }
Returns the next Nokogiri::XML::Element type sibling node.
static VALUE next_element(VALUE self) { xmlNodePtr node, sibling; Data_Get_Struct(self, xmlNode, node); sibling = xmlNextElementSibling(node); if(!sibling) { return Qnil; } return Nokogiri_wrap_xml_node(Qnil, sibling); }
Returns the next sibling node
static VALUE next_sibling(VALUE self) { xmlNodePtr node, sibling; Data_Get_Struct(self, xmlNode, node); sibling = node->next; if(!sibling) { return Qnil; } return Nokogiri_wrap_xml_node(Qnil, sibling) ; }
Returns the name for this Node
static VALUE get_name(VALUE self) { xmlNodePtr node; Data_Get_Struct(self, xmlNode, node); if(node->name) { return NOKOGIRI_STR_NEW2(node->name); } return Qnil; }
Set the name for this Node
static VALUE set_name(VALUE self, VALUE new_name) { xmlNodePtr node; Data_Get_Struct(self, xmlNode, node); xmlNodeSetName(node, (xmlChar*)StringValueCStr(new_name)); return new_name; }
Get the type for this Node
static VALUE node_type(VALUE self) { xmlNodePtr node; Data_Get_Struct(self, xmlNode, node); return INT2NUM((long)node->type); }
Parse string_or_io
as a document fragment within the context
of this node. Returns a XML::NodeSet containing the nodes parsed from
string_or_io
.
# File lib/nokogiri/xml/node.rb, line 450 def parse string_or_io, options = nil ## # When the current node is unparented and not an element node, use the # document as the parsing context instead. Otherwise, the in-context # parser cannot find an element or a document node. # Document Fragments are also not usable by the in-context parser. if !element? && !document? && (!parent || parent.fragment?) return document.parse(string_or_io, options) end options ||= (document.html? ? ParseOptions::DEFAULT_HTML : ParseOptions::DEFAULT_XML) if Integer === 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
Returns the path associated with this Node
static VALUE path(VALUE self) { xmlNodePtr node; xmlChar *path ; VALUE rval; Data_Get_Struct(self, xmlNode, node); path = xmlGetNodePath(node); rval = NOKOGIRI_STR_NEW2(path); xmlFree(path); return rval ; }
Get the internal pointer number
static VALUE pointer_id(VALUE self) { xmlNodePtr node; Data_Get_Struct(self, xmlNode, node); return INT2NUM((long)(node)); }
Add node_or_tags
as the first child of this Node. node_or_tags
can be a Nokogiri::XML::Node, a ::DocumentFragment, a
::NodeSet, or a string containing markup.
Returns the reparented node (if node_or_tags
is a Node), or NodeSet (if
node_or_tags
is a DocumentFragment, NodeSet, or string).
Also see related method add_child
.
# File lib/nokogiri/xml/node.rb, line 154 def prepend_child node_or_tags if first = children.first # Mimic the error add_child would raise. raise RuntimeError, "Document already has a root node" if document? && !(node_or_tags.comment? || node_or_tags.processing_instruction?) first.__send__(:add_sibling, :previous, node_or_tags) else add_child(node_or_tags) end end
Returns the previous Nokogiri::XML::Element type sibling node.
static VALUE previous_element(VALUE self) { xmlNodePtr node, sibling; Data_Get_Struct(self, xmlNode, node); /* * note that we don't use xmlPreviousElementSibling here because it's buggy pre-2.7.7. */ sibling = node->prev; if(!sibling) { return Qnil; } while(sibling && sibling->type != XML_ELEMENT_NODE) { sibling = sibling->prev; } return sibling ? Nokogiri_wrap_xml_node(Qnil, sibling) : Qnil ; }
Returns the previous sibling node
static VALUE previous_sibling(VALUE self) { xmlNodePtr node, sibling; Data_Get_Struct(self, xmlNode, node); sibling = node->prev; if(!sibling) { return Qnil; } return Nokogiri_wrap_xml_node(Qnil, sibling); }
Returns true if this is a ProcessingInstruction node
# File lib/nokogiri/xml/node.rb, line 544 def processing_instruction? type == PI_NODE end
Is this a read only node?
# File lib/nokogiri/xml/node.rb, line 568 def read_only? # According to gdome2, these are read-only node types [NOTATION_NODE, ENTITY_NODE, ENTITY_DECL].include?(type) end
Remove the attribute named name
# File lib/nokogiri/xml/node.rb, line 425 def remove_attribute name attr = attributes[name].remove if key? name clear_xpath_context if Nokogiri.jruby? attr end
Remove name
from the “class” attribute value of this Node and return self. If there are many occurrences
of the name, they are all removed.
More than one class may be removed at a time, separated by a space.
If no class name is left after removal, or when name
is nil,
the “class” attribute is removed from this Node.
# File lib/nokogiri/xml/node.rb, line 409 def remove_class name = nil if name names = classes - name.scan(/\S+/) if names.empty? delete 'class' else self['class'] = names.join(' ') end else delete "class" end self end
Replace this Node with node_or_tags
.
node_or_tags
can be a Nokogiri::XML::Node, a ::DocumentFragment, a
::NodeSet, or a string containing markup.
Returns the reparented node (if node_or_tags
is a Node), or NodeSet (if
node_or_tags
is a DocumentFragment, NodeSet, or string).
Also see related method swap
.
# File lib/nokogiri/xml/node.rb, line 275 def replace node_or_tags # We cannot replace a text node directly, otherwise libxml will return # an internal error at parser.c:13031, I don't know exactly why # libxml is trying to find a parent node that is an element or document # so I can't tell if this is bug in libxml or not. issue #775. if text? replacee = Nokogiri::XML::Node.new 'dummy', document add_previous_sibling_node replacee unlink return replacee.replace node_or_tags end node_or_tags = coerce(node_or_tags) if node_or_tags.is_a?(XML::NodeSet) node_or_tags.each { |n| add_previous_sibling n } unlink else replace_node node_or_tags end node_or_tags end
Serialize Node using options
. Save
options can also be set using a block. See SaveOptions.
These two statements are equivalent:
node.serialize(:encoding => 'UTF-8', :save_with => FORMAT | AS_XML)
or
node.serialize(:encoding => 'UTF-8') do |config| config.format.as_xml end
# File lib/nokogiri/xml/node.rb, line 687 def serialize *args, &block options = args.first.is_a?(Hash) ? args.shift : { :encoding => args[0], :save_with => args[1] } encoding = options[:encoding] || document.encoding options[:encoding] = encoding outstring = String.new outstring.force_encoding(Encoding.find(encoding || 'utf-8')) io = StringIO.new(outstring) write_to io, options, &block io.string end
Swap this Node for node_or_tags
node_or_tags
can be a Nokogiri::XML::Node, a ::DocumentFragment, a
::NodeSet, or a string containing markup.
Returns self, to support chaining of calls.
Also see related method replace
.
# File lib/nokogiri/xml/node.rb, line 305 def swap node_or_tags replace node_or_tags self end
Returns true if this is a Text node
# File lib/nokogiri/xml/node.rb, line 549 def text? type == TEXT_NODE end
Yields self and all children to block
recursively.
# File lib/nokogiri/xml/node.rb, line 654 def traverse &block children.each{|j| j.traverse(&block) } block.call(self) end
Unlink this node from its current context.
static VALUE unlink_node(VALUE self) { xmlNodePtr node; Data_Get_Struct(self, xmlNode, node); xmlUnlinkNode(node); nokogiri_root_node(node); return self; }
Get the attribute values for this Node.
# File lib/nokogiri/xml/node.rb, line 347 def values attribute_nodes.map(&:value) end
Add html around this node
Returns self
# File lib/nokogiri/xml/node.rb, line 169 def wrap(html) new_parent = document.parse(html).first add_next_sibling(new_parent) new_parent.add_child(self) self end
Write Node to io
with
options
. options
modify the output of this
method. Valid options are:
-
:encoding
for changing the encoding -
:indent_text
the indentation text, defaults to one space -
:indent
the number of:indent_text
to use, defaults to 2 -
:save_with
a combination of SaveOptions constants.
To save with UTF-8 indented twice:
node.write_to(io, :encoding => 'UTF-8', :indent => 2)
To save indented with two dashes:
node.write_to(io, :indent_text => '-', :indent => 2)
# File lib/nokogiri/xml/node.rb, line 752 def write_to io, *options options = options.first.is_a?(Hash) ? options.shift : {} encoding = options[:encoding] || options[0] if Nokogiri.jruby? save_options = options[:save_with] || options[1] indent_times = options[:indent] || 0 else save_options = options[:save_with] || options[1] || SaveOptions::FORMAT indent_times = options[:indent] || 2 end indent_text = options[:indent_text] || ' ' config = SaveOptions.new(save_options.to_i) yield config if block_given? native_write_to(io, encoding, indent_text * indent_times, config.options) end
Returns true if this is an XML::Document node
# File lib/nokogiri/xml/node.rb, line 529 def xml? type == DOCUMENT_NODE end
Private Instance Methods
# File lib/nokogiri/xml/node.rb, line 830 def add_sibling next_or_previous, node_or_tags impl = (next_or_previous == :next) ? :add_next_sibling_node : :add_previous_sibling_node iter = (next_or_previous == :next) ? :reverse_each : :each node_or_tags = coerce node_or_tags if node_or_tags.is_a?(XML::NodeSet) if text? pivot = Nokogiri::XML::Node.new 'dummy', document send impl, pivot else pivot = self end node_or_tags.send(iter) { |n| pivot.send impl, n } pivot.unlink if text? else send impl, node_or_tags end node_or_tags end
Returns the Node as html.
static VALUE dump_html(VALUE self) { xmlBufferPtr buf ; xmlNodePtr node ; VALUE html; Data_Get_Struct(self, xmlNode, node); buf = xmlBufferCreate() ; htmlNodeDump(buf, node->doc, node); html = NOKOGIRI_STR_NEW2(buf->content); xmlBufferFree(buf); return html ; }
Get the value for attribute
static VALUE get(VALUE self, VALUE rattribute) { xmlNodePtr node; xmlChar *value = 0; VALUE rvalue; xmlChar *colon; xmlChar *attribute, *attr_name, *prefix; xmlNsPtr ns; if (NIL_P(rattribute)) { return Qnil; } Data_Get_Struct(self, xmlNode, node); attribute = xmlCharStrdup(StringValueCStr(rattribute)); colon = (xmlChar *)(uintptr_t)xmlStrchr(attribute, (const xmlChar)':'); if (colon) { /* split the attribute string into separate prefix and name by * null-terminating the prefix at the colon */ prefix = attribute; attr_name = colon + 1; (*colon) = 0; ns = xmlSearchNs(node->doc, node, prefix); if (ns) { value = xmlGetNsProp(node, attr_name, ns->href); } else { value = xmlGetProp(node, (xmlChar*)StringValueCStr(rattribute)); } } else { value = xmlGetNoNsProp(node, attribute); } xmlFree((void *)attribute); if (!value) { return Qnil; } rvalue = NOKOGIRI_STR_NEW2(value); xmlFree((void *)value); return rvalue ; }
TODO: DOCUMENT ME
static VALUE in_context(VALUE self, VALUE _str, VALUE _options) { xmlNodePtr node, list = 0, tmp, child_iter, node_children, doc_children; xmlNodeSetPtr set; xmlParserErrors error; VALUE doc, err; int doc_is_empty; Data_Get_Struct(self, xmlNode, node); doc = DOC_RUBY_OBJECT(node->doc); err = rb_iv_get(doc, "@errors"); doc_is_empty = (node->doc->children == NULL) ? 1 : 0; node_children = node->children; doc_children = node->doc->children; xmlSetStructuredErrorFunc((void *)err, Nokogiri_error_array_pusher); /* Twiddle global variable because of a bug in libxml2. * http://git.gnome.org/browse/libxml2/commit/?id=e20fb5a72c83cbfc8e4a8aa3943c6be8febadab7 */ #ifndef HTML_PARSE_NOIMPLIED htmlHandleOmittedElem(0); #endif /* This function adds a fake node to the child of +node+. If the parser * does not exit cleanly with XML_ERR_OK, the list is freed. This can * leave the child pointers in a bad state if they were originally empty. * * http://git.gnome.org/browse/libxml2/tree/parser.c#n13177 * */ error = xmlParseInNodeContext(node, StringValuePtr(_str), (int)RSTRING_LEN(_str), (int)NUM2INT(_options), &list); /* xmlParseInNodeContext should not mutate the original document or node, * so reassigning these pointers should be OK. The reason we're reassigning * is because if there were errors, it's possible for the child pointers * to be manipulated. */ if (error != XML_ERR_OK) { node->doc->children = doc_children; node->children = node_children; } /* make sure parent/child pointers are coherent so an unlink will work * properly (#331) */ child_iter = node->doc->children ; while (child_iter) { if (child_iter->parent != (xmlNodePtr)node->doc) { child_iter->parent = (xmlNodePtr)node->doc; } child_iter = child_iter->next; } #ifndef HTML_PARSE_NOIMPLIED htmlHandleOmittedElem(1); #endif xmlSetStructuredErrorFunc(NULL, NULL); /* Workaround for a libxml2 bug where a parsing error may leave a broken * node reference in node->doc->children. * This workaround is limited to when a parse error occurs, the document * went from having no children to having children, and the context node is * part of a document fragment. * https://bugzilla.gnome.org/show_bug.cgi?id=668155 */ if (error != XML_ERR_OK && doc_is_empty && node->doc->children != NULL) { child_iter = node; while (child_iter->parent) { child_iter = child_iter->parent; } if (child_iter->type == XML_DOCUMENT_FRAG_NODE) { node->doc->children = NULL; } } /* FIXME: This probably needs to handle more constants... */ switch (error) { case XML_ERR_INTERNAL_ERROR: case XML_ERR_NO_MEMORY: rb_raise(rb_eRuntimeError, "error parsing fragment (%d)", error); break; default: break; } set = xmlXPathNodeSetCreate(NULL); while (list) { tmp = list->next; list->next = NULL; xmlXPathNodeSetAddUnique(set, list); nokogiri_root_node(list); list = tmp; } return Nokogiri_wrap_xml_node_set(set, doc); }
# File lib/nokogiri/xml/node.rb, line 866 def inspect_attributes [:name, :namespace, :attribute_nodes, :children] end
Write this Node to io
with
encoding
and options
static VALUE native_write_to( VALUE self, VALUE io, VALUE encoding, VALUE indent_string, VALUE options ) { xmlNodePtr node; const char * before_indent; xmlSaveCtxtPtr savectx; Data_Get_Struct(self, xmlNode, node); xmlIndentTreeOutput = 1; before_indent = xmlTreeIndentString; xmlTreeIndentString = StringValueCStr(indent_string); savectx = xmlSaveToIO( (xmlOutputWriteCallback)io_write_callback, (xmlOutputCloseCallback)io_close_callback, (void *)io, RTEST(encoding) ? StringValueCStr(encoding) : NULL, (int)NUM2INT(options) ); xmlSaveTree(savectx, node); xmlSaveClose(savectx); xmlTreeIndentString = before_indent; return io; }
Loads and substitutes all xinclude elements below the node. The parser
context will be initialized with options
.
static VALUE process_xincludes(VALUE self, VALUE options) { int rcode ; xmlNodePtr node; VALUE error_list = rb_ary_new(); Data_Get_Struct(self, xmlNode, node); xmlSetStructuredErrorFunc((void *)error_list, Nokogiri_error_array_pusher); rcode = xmlXIncludeProcessTreeFlags(node, (int)NUM2INT(options)); xmlSetStructuredErrorFunc(NULL, NULL); if (rcode < 0) { xmlErrorPtr error; error = xmlGetLastError(); if(error) { rb_exc_raise(Nokogiri_wrap_xml_syntax_error(error)); } else { rb_raise(rb_eRuntimeError, "Could not perform xinclude substitution"); } } return self; }
Set the property
to value
static VALUE set(VALUE self, VALUE property, VALUE value) { xmlNodePtr node, cur; xmlAttrPtr prop; Data_Get_Struct(self, xmlNode, node); /* If a matching attribute node already exists, then xmlSetProp will destroy * the existing node's children. However, if Nokogiri has a node object * pointing to one of those children, we are left with a broken reference. * * We can avoid this by unlinking these nodes first. */ if (node->type != XML_ELEMENT_NODE) { return(Qnil); } prop = xmlHasProp(node, (xmlChar *)StringValueCStr(property)); if (prop && prop->children) { for (cur = prop->children; cur; cur = cur->next) { if (cur->_private) { nokogiri_root_node(cur); xmlUnlinkNode(cur); } } } xmlSetProp(node, (xmlChar *)StringValueCStr(property), (xmlChar *)StringValueCStr(value)); return value; }
Set the namespace to namespace
static VALUE set_namespace(VALUE self, VALUE namespace) { xmlNodePtr node; xmlNsPtr ns = NULL; Data_Get_Struct(self, xmlNode, node); if(!NIL_P(namespace)) { Data_Get_Struct(namespace, xmlNs, ns); } xmlSetNs(node, ns); return self; }
# File lib/nokogiri/xml/node.rb, line 850 def to_format save_option, 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] = save_option unless options[:save_with] serialize(options) end
# File lib/nokogiri/xml/node.rb, line 858 def write_format_to save_option, 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] ||= save_option write_to io, options end