Class: Nokogiri::XML::Node

Inherits:
Object
  • Object
show all
Includes:
Enumerable, PP::Node, Searchable
Defined in:
lib/nokogiri/xml/node.rb,
lib/nokogiri/xml/node/save_options.rb,
ext/nokogiri/xml_node.c

Overview

Node is your window to the fun filled world of dealing with XML and HTML tags. A Node may be treated similarly to a hash with regard to attributes. For example:

node = Nokogiri::XML::DocumentFragment.parse("<a href='#foo' id='link'>link</a>").at_css("a")
node.to_html # => "<a href=\"#foo\" id=\"link\">link</a>"
node['href'] # => "#foo"
node.keys # => ["href", "id"]
node.values # => ["#foo", "link"]
node['class'] = 'green' # => "green"
node.to_html # => "<a href=\"#foo\" id=\"link\" class=\"green\">link</a>"

See the method group entitled “Working With Node Attributes” for the full set of methods.

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: These methods will all emit plaintext, meaning that entities will be replaced (e.g., “&lt;” will be replaced with “<”), meaning that any sanitizing will likely be un-done in the output.

  • #to_s, #to_xml, #to_html, #inner_html: 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 Searchable#xpath and Searchable#css

Defined Under Namespace

Classes: SaveOptions

Constant Summary collapse

ELEMENT_NODE =

Element node type, see #element?

1
ATTRIBUTE_NODE =

Attribute node type

2
TEXT_NODE =

Text node type, see #text?

3
CDATA_SECTION_NODE =

CDATA node type, see #cdata?

4
ENTITY_REF_NODE =

Entity reference node type

5
ENTITY_NODE =

Entity node type

6
PI_NODE =

PI node type

7
COMMENT_NODE =

Comment node type, see #comment?

8
DOCUMENT_NODE =

Document node type, see #xml?

9
DOCUMENT_TYPE_NODE =

Document type node type

10
DOCUMENT_FRAG_NODE =

Document fragment node type

11
NOTATION_NODE =

Notation node type

12
HTML_DOCUMENT_NODE =

HTML document node type, see #html?

13
DTD_NODE =

DTD node type

14
ELEMENT_DECL =

Element declaration type

15
ATTRIBUTE_DECL =

Attribute declaration type

16
ENTITY_DECL =

Entity declaration type

17
NAMESPACE_DECL =

Namespace declaration type

18
XINCLUDE_START =

XInclude start type

19
XINCLUDE_END =

XInclude end type

20
DOCB_DOCUMENT_NODE =

DOCB document node type

21

Searching via XPath or CSS Queries collapse

Manipulating Document Structure collapse

Working With Node Attributes collapse

Serialization and Generating Output collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, document) {|node| ... } ⇒ Nokogiri::XML::Node

Create a new node with name sharing GC lifecycle with document.

Parameters:

Yield Parameters:

See Also:



99
100
101
# File 'lib/nokogiri/xml/node.rb', line 99

def initialize(name, document)
  # This is intentionally empty.
end

Class Method Details

.new(name, document) {|node| ... } ⇒ Nokogiri::XML::Node

Create a new node with name sharing GC lifecycle with document.

Parameters:

Yield Parameters:

Returns:

See Also:



1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
# File 'ext/nokogiri/xml_node.c', line 1448

static VALUE
rb_xml_node_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;
  noko_xml_document_pin_node(node);

  rb_node = noko_xml_node_wrap(
              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;
}

Instance Method Details

#<<(node_or_tags) ⇒ Object

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.



174
175
176
177
# File 'lib/nokogiri/xml/node.rb', line 174

def <<(node_or_tags)
  add_child node_or_tags
  self
end

#<=>(other) ⇒ Object

Compare two Node objects with respect to their Document. Nodes from different documents cannot be compared.



1000
1001
1002
1003
1004
# File 'lib/nokogiri/xml/node.rb', line 1000

def <=>(other)
  return nil unless other.is_a?(Nokogiri::XML::Node)
  return nil unless document == other.document
  compare other
end

#==(other) ⇒ Object

Test to see if this Node is equal to other



991
992
993
994
995
# File 'lib/nokogiri/xml/node.rb', line 991

def ==(other)
  return false unless other
  return false unless other.respond_to?(:pointer_id)
  pointer_id == other.pointer_id
end

#>(selector) ⇒ Object

Search this node's immediate children using CSS selector selector



113
114
115
116
# File 'lib/nokogiri/xml/node.rb', line 113

def >(selector)
  ns = document.root.namespaces
  xpath CSS.xpath_for(selector, :prefix => "./", :ns => ns).first
end

#[](name) ⇒ Object Also known as: get_attribute, attr

Get the attribute value for the attribute name



381
382
383
# File 'lib/nokogiri/xml/node.rb', line 381

def [](name)
  get(name.to_s)
end

#[]=(name, value) ⇒ Object Also known as: set_attribute

Set the attribute value for the attribute name to value



387
388
389
# File 'lib/nokogiri/xml/node.rb', line 387

def []=(name, value)
  set name.to_s, value.to_s
end

#accept(visitor) ⇒ Object

Accept a visitor. This method calls “visit” on visitor with self.



985
986
987
# File 'lib/nokogiri/xml/node.rb', line 985

def accept(visitor)
  visitor.visit(self)
end

#add_child(node_or_tags) ⇒ Object

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 <<.



129
130
131
132
133
134
135
136
137
# File 'lib/nokogiri/xml/node.rb', line 129

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_class(names) ⇒ Node

Ensure HTML CSS classes are present on a Node. Any CSS classes in names that already exist in the Node's class attribute are not added. Note that any existing duplicates in the class attribute are not removed. Compare with #append_class.

This is a convenience function and is equivalent to:

node.kwattr_add("class", names)

Examples:

Ensure that a Node has CSS class “section”

node                      # => <div></div>
node.add_class("section") # => <div class="section"></div>
node.add_class("section") # => <div class="section"></div> # duplicate not added

Ensure that a Node has CSS classes “section” and “header”, via a String argument.

node                             # => <div class="section section"></div>
node.add_class("section header") # => <div class="section section header"></div>
# Note that the CSS class "section" is not added because it is already present.
# Note also that the pre-existing duplicate CSS class "section" is not removed.

Ensure that a Node has CSS classes “section” and “header”, via an Array argument.

node                                  # => <div></div>
node.add_class(["section", "header"]) # => <div class="section header"></div>

Parameters:

  • names (String, Array<String>)

    CSS class names to be added to the Node's class attribute. May be a string containing whitespace-delimited names, or an Array of String names. Any class names already present will not be added. Any class names not present will be added. If no class attribute exists, one is created.

Returns:

  • (Node)

    Returns self for ease of chaining method calls.

See Also:



500
501
502
# File 'lib/nokogiri/xml/node.rb', line 500

def add_class(names)
  kwattr_add("class", names)
end

#add_namespace_definition(prefix, href) ⇒ Object Also known as: add_namespace

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.



1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
# File 'ext/nokogiri/xml_node.c', line 1409

static VALUE
add_namespace_definition(VALUE rb_node, VALUE rb_prefix, VALUE rb_href)
{
  xmlNodePtr c_node, element;
  xmlNsPtr c_namespace;
  const xmlChar *c_prefix = (const xmlChar *)(NIL_P(rb_prefix) ? NULL : StringValueCStr(rb_prefix));

  Data_Get_Struct(rb_node, xmlNode, c_node);
  element = c_node ;

  c_namespace = xmlSearchNs(c_node->doc, c_node, c_prefix);

  if (!c_namespace) {
    if (c_node->type != XML_ELEMENT_NODE) {
      element = c_node->parent;
    }
    c_namespace = xmlNewNs(element, (const xmlChar *)StringValueCStr(rb_href), c_prefix);
  }

  if (!c_namespace) {
    return Qnil ;
  }

  if (NIL_P(rb_prefix) || c_node != element) {
    xmlSetNs(c_node, c_namespace);
  }

  return noko_xml_namespace_wrap(c_namespace, c_node->doc);
}

#add_next_sibling(node_or_tags) ⇒ Object Also known as: next=

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.

Raises:

  • (ArgumentError)


199
200
201
202
203
# File 'lib/nokogiri/xml/node.rb', line 199

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

#add_previous_sibling(node_or_tags) ⇒ Object Also known as: previous=

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.

Raises:

  • (ArgumentError)


186
187
188
189
190
# File 'lib/nokogiri/xml/node.rb', line 186

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

#after(node_or_tags) ⇒ Object

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.



224
225
226
227
# File 'lib/nokogiri/xml/node.rb', line 224

def after(node_or_tags)
  add_next_sibling node_or_tags
  self
end

#ancestors(selector = nil) ⇒ Object

Get a list of ancestor Node for this Node. If selector is given, the ancestors must match selector



955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
# File 'lib/nokogiri/xml/node.rb', line 955

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_class(names) ⇒ Node

Add HTML CSS classes to a Node, regardless of duplication. Compare with #add_class.

This is a convenience function and is equivalent to:

node.kwattr_append("class", names)

Examples:

Append “section” to a Node's CSS class attriubute

node                         # => <div></div>
node.append_class("section") # => <div class="section"></div>
node.append_class("section") # => <div class="section section"></div> # duplicate added!

Append “section” and “header” to a Node's CSS class attribute, via a String argument.

node                                # => <div class="section section"></div>
node.append_class("section header") # => <div class="section section section header"></div>
# Note that the CSS class "section" is appended even though it is already present.

Append “section” and “header” to a Node's CSS class attribute, via an Array argument.

node                                     # => <div></div>
node.append_class(["section", "header"]) # => <div class="section header"></div>
node.append_class(["section", "header"]) # => <div class="section header section header"></div>

Parameters:

  • names (String, Array<String>)

    CSS class names to be appended to the Node's class attribute. May be a string containing whitespace-delimited names, or an Array of String names. All class names passed in will be appended to the class attribute even if they are already present in the attribute value. If no class attribute exists, one is created.

Returns:

  • (Node)

    Returns self for ease of chaining method calls.

See Also:



541
542
543
# File 'lib/nokogiri/xml/node.rb', line 541

def append_class(names)
  kwattr_append("class", names)
end

#at(*args) ⇒ Object Also known as: % Originally defined in module Searchable

call-seq: search *paths, [namespace-bindings, xpath-variable-bindings, custom-handler-class]

Search this object for paths, and return only the first result. paths must be one or more XPath or CSS queries.

See Searchable#search for more information.

#at_css(*args) ⇒ Object Originally defined in module Searchable

call-seq: css *rules, [namespace-bindings, custom-pseudo-class]

Search this object for CSS rules, and return only the first match. rules must be one or more CSS selectors.

See Searchable#css for more information.

#at_xpath(*args) ⇒ Object Originally defined in module Searchable

call-seq: xpath *paths, [namespace-bindings, variable-bindings, custom-handler-class]

Search this node for XPath paths, and return only the first match. paths must be one or more XPath queries.

See Searchable#xpath for more information.

#attribute(name) ⇒ Object

Get the attribute node with name



993
994
995
996
997
998
999
1000
1001
1002
1003
# File 'ext/nokogiri/xml_node.c', line 993

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 noko_xml_node_wrap(Qnil, (xmlNodePtr)prop);
}

#attribute_nodesArray<Nokogiri::XML::Attr>

Get the attributes for a Node

Returns:



1029
1030
1031
1032
1033
1034
1035
1036
1037
# File 'ext/nokogiri/xml_node.c', line 1029

static VALUE
attribute_nodes(VALUE rb_node)
{
  xmlNodePtr c_node;

  Data_Get_Struct(rb_node, xmlNode, c_node);

  return noko_xml_node_attrs(c_node);
}

#attribute_with_ns(name, namespace) ⇒ Object

Get the attribute node with name and namespace



1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
# File 'ext/nokogiri/xml_node.c', line 1011

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 noko_xml_node_wrap(Qnil, (xmlNodePtr)prop);
}

#attributesObject

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.



397
398
399
400
401
# File 'lib/nokogiri/xml/node.rb', line 397

def attributes
  attribute_nodes.each_with_object({}) do |node, hash|
    hash[node.node_name] = node
  end
end

#before(node_or_tags) ⇒ Object

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.



212
213
214
215
# File 'lib/nokogiri/xml/node.rb', line 212

def before(node_or_tags)
  add_previous_sibling node_or_tags
  self
end

#blank?Boolean

Is this node blank?

Returns:

  • (Boolean)


606
607
608
609
610
611
612
# File 'ext/nokogiri/xml_node.c', line 606

static VALUE
blank_eh(VALUE self)
{
  xmlNodePtr node;
  Data_Get_Struct(self, xmlNode, node);
  return (1 == xmlIsBlankNode(node)) ? Qtrue : Qfalse ;
}

#canonicalize(mode = XML::XML_C14N_1_0, inclusive_namespaces = nil, with_comments = false) ⇒ Object



1137
1138
1139
1140
1141
1142
1143
# File 'lib/nokogiri/xml/node.rb', line 1137

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

#cdata?Boolean

Returns true if this is a CDATA

Returns:

  • (Boolean)


877
878
879
# File 'lib/nokogiri/xml/node.rb', line 877

def cdata?
  type == CDATA_SECTION_NODE
end

#childObject

Returns the child node



787
788
789
790
791
792
793
794
795
796
797
# File 'ext/nokogiri/xml_node.c', line 787

static VALUE
child(VALUE self)
{
  xmlNodePtr node, child;
  Data_Get_Struct(self, xmlNode, node);

  child = node->children;
  if (!child) { return Qnil; }

  return noko_xml_node_wrap(Qnil, child);
}

#childrenObject

Get the list of children for this node as a NodeSet



712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
# File 'ext/nokogiri/xml_node.c', line 712

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 noko_xml_node_set_wrap(set, document); }

  child = child->next;
  while (NULL != child) {
    xmlXPathNodeSetAddUnique(set, child);
    child = child->next;
  }

  node_set = noko_xml_node_set_wrap(set, document);

  return node_set;
}

#children=(node_or_tags) ⇒ Object

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=



248
249
250
251
252
253
254
255
256
257
# File 'lib/nokogiri/xml/node.rb', line 248

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

#classesArray<String>

Get the CSS class names of a Node.

This is a convenience function and is equivalent to:

node.kwattr_values("class")

Examples:

node         # => <div class="section title header"></div>
node.classes # => ["section", "title", "header"]

Returns:

  • (Array<String>)

    The CSS classes present in the Node's class attribute. If the attribute is empty or non-existent, the return value is an empty array.

See Also:



457
458
459
# File 'lib/nokogiri/xml/node.rb', line 457

def classes
  kwattr_values("class")
end

#comment?Boolean

Returns true if this is a Comment

Returns:

  • (Boolean)


872
873
874
# File 'lib/nokogiri/xml/node.rb', line 872

def comment?
  type == COMMENT_NODE
end

#contentObject Also known as: text, inner_text

Returns the plaintext content for this Node. Note that entities will always be expanded in the returned string.



1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
# File 'ext/nokogiri/xml_node.c', line 1166

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;
}

#content=(string) ⇒ Object

Set the Node's content to a Text node containing string. The string gets XML escaped, not interpreted as markup.



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

def content=(string)
  self.native_content = encode_special_chars(string.to_s)
end

#create_external_subset(name, external_id, system_id) ⇒ Object

Create an external subset



463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
# File 'ext/nokogiri/xml_node.c', line 463

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 noko_xml_node_wrap(Qnil, (xmlNodePtr)dtd);
}

#create_internal_subset(name, external_id, system_id) ⇒ Object

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">


430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'ext/nokogiri/xml_node.c', line 430

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 noko_xml_node_wrap(Qnil, (xmlNodePtr)dtd);
}

#css(*args) ⇒ Object Originally defined in module Searchable

call-seq: css *rules, [namespace-bindings, custom-pseudo-class]

Search this object for CSS rules. rules must be one or more CSS selectors. For example:

node.css('title')
node.css('body h1.bold')
node.css('div + p.green', 'div#one')

A hash of namespace bindings may be appended. For example:

node.css('bike|tire', {'bike' => 'http://schwinn.com/'})

Custom CSS pseudo classes may also be defined. To define custom pseudo classes, create a class and implement the custom pseudo class you want defined. The first argument to the method will be the current matching NodeSet. Any other arguments are ones that you pass in. For example:

node.css('title:regex("\w+")', Class.new {
  def regex node_set, regex
    node_set.find_all { |node| node['some_attribute'] =~ /#{regex}/ }
  end
}.new)

Note that the CSS query string is case-sensitive with regards to your document type. That is, if you're looking for “H1” in an HTML document, you'll never find anything, since HTML tags will match only lowercase CSS queries. However, “H1” might be found in an XML document, where tags names are case-sensitive (e.g., “H1” is distinct from “h1”).

#css_pathObject

Get the path to this node as a CSS expression



946
947
948
949
950
# File 'lib/nokogiri/xml/node.rb', line 946

def css_path
  path.split(/\//).map { |part|
    part.length == 0 ? nil : part.gsub(/\[(\d+)\]/, ':nth-of-type(\1)')
  }.compact.join(" > ")
end

#decorate!Object

Decorate this node with the decorators set up in this node's Document



105
106
107
# File 'lib/nokogiri/xml/node.rb', line 105

def decorate!
  document.decorate(self)
end

#default_namespace=(url) ⇒ Object

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=



322
323
324
# File 'lib/nokogiri/xml/node.rb', line 322

def default_namespace=(url)
  add_namespace_definition(nil, url)
end

#descriptionObject

Fetch the Nokogiri::HTML::ElementDescription for this node. Returns nil on XML documents and on unknown tags.



914
915
916
917
# File 'lib/nokogiri/xml/node.rb', line 914

def description
  return nil if document.xml?
  Nokogiri::HTML::ElementDescription[name]
end

#do_xinclude(options = XML::ParseOptions::DEFAULT_XML) {|options| ... } ⇒ Object

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.

Yields:

  • (options)


349
350
351
352
353
354
355
356
357
# File 'lib/nokogiri/xml/node.rb', line 349

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

#documentObject

Get the document for this Node



370
371
372
373
374
375
376
# File 'ext/nokogiri/xml_node.c', line 370

static VALUE
document(VALUE self)
{
  xmlNodePtr node;
  Data_Get_Struct(self, xmlNode, node);
  return DOC_RUBY_OBJECT(node->doc);
}

#document?Boolean

Returns true if this is a Document

Returns:

  • (Boolean)


892
893
894
# File 'lib/nokogiri/xml/node.rb', line 892

def document?
  is_a? XML::Document
end

#dupObject #dup(depth) ⇒ Object #dup(depth, new_parent_doc) ⇒ Object Also known as: clone

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.



552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
# File 'ext/nokogiri/xml_node.c', line 552

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; }

  noko_xml_document_pin_node(dup);

  return noko_xml_node_wrap(rb_obj_class(self), dup);
}

#eachObject

Iterate over each attribute name and value pair for this Node.



423
424
425
426
427
# File 'lib/nokogiri/xml/node.rb', line 423

def each
  attribute_nodes.each { |node|
    yield [node.node_name, node.value]
  }
end

#element?Boolean Also known as: elem?

Returns true if this is an Element node

Returns:

  • (Boolean)


927
928
929
# File 'lib/nokogiri/xml/node.rb', line 927

def element?
  type == ELEMENT_NODE
end

#element_childrenObject Also known as: elements

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


752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
# File 'ext/nokogiri/xml_node.c', line 752

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 noko_xml_node_set_wrap(set, document); }

  child = xmlNextElementSibling(child);
  while (NULL != child) {
    xmlXPathNodeSetAddUnique(set, child);
    child = xmlNextElementSibling(child);
  }

  node_set = noko_xml_node_set_wrap(set, document);

  return node_set;
}

#encode_special_chars(string) ⇒ Object

Encode any special characters in string



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
# File 'ext/nokogiri/xml_node.c', line 399

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;
}

#external_subsetObject

Get the external subset



496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
# File 'ext/nokogiri/xml_node.c', line 496

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 noko_xml_node_wrap(Qnil, (xmlNodePtr)dtd);
}

#first_element_childObject

Returns the first child node of this node that is an element.

Example:

@doc.root.first_element_child.element? # => true


809
810
811
812
813
814
815
816
817
818
819
# File 'ext/nokogiri/xml_node.c', line 809

static VALUE
first_element_child(VALUE self)
{
  xmlNodePtr node, child;
  Data_Get_Struct(self, xmlNode, node);

  child = xmlFirstElementChild(node);
  if (!child) { return Qnil; }

  return noko_xml_node_wrap(Qnil, child);
}

#fragment(tags) ⇒ Object

Create a DocumentFragment containing tags that is relative to this context node.



789
790
791
792
# File 'lib/nokogiri/xml/node.rb', line 789

def fragment(tags)
  type = document.html? ? Nokogiri::HTML : Nokogiri::XML
  type::DocumentFragment.new(document, tags, self)
end

#fragment?Boolean

Returns true if this is a DocumentFragment

Returns:

  • (Boolean)


907
908
909
# File 'lib/nokogiri/xml/node.rb', line 907

def fragment?
  type == DOCUMENT_FRAG_NODE
end

#html?Boolean

Returns true if this is an HTML::Document node

Returns:

  • (Boolean)


887
888
889
# File 'lib/nokogiri/xml/node.rb', line 887

def html?
  type == HTML_DOCUMENT_NODE
end

#inner_html(*args) ⇒ Object

Get the inner_html for this node's Node#children



941
942
943
# File 'lib/nokogiri/xml/node.rb', line 941

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

#inner_html=(node_or_tags) ⇒ Object

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=



236
237
238
239
# File 'lib/nokogiri/xml/node.rb', line 236

def inner_html=(node_or_tags)
  self.children = node_or_tags
  self
end

#inspectObject Originally defined in module PP::Node

:nodoc:

#internal_subsetObject

Get the internal subset



521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
# File 'ext/nokogiri/xml_node.c', line 521

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 noko_xml_node_wrap(Qnil, (xmlNodePtr)dtd);
}

#key?(attribute) ⇒ Boolean Also known as: has_attribute?

Returns true if attribute is set

Returns:

  • (Boolean)


849
850
851
852
853
854
855
856
857
858
# File 'ext/nokogiri/xml_node.c', line 849

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;
}

#keysObject

Get the attribute names for this Node.



417
418
419
# File 'lib/nokogiri/xml/node.rb', line 417

def keys
  attribute_nodes.map(&:node_name)
end

#kwattr_add(attribute_name, keywords) ⇒ Node

Ensure that values are present in a keyword attribute.

Any values in keywords that already exist in the Node's attribute values are not added. Note that any existing duplicates in the attribute values are not removed. Compare with #kwattr_append.

A “keyword attribute” is a node attribute that contains a set of space-delimited values. Perhaps the most familiar example of this is the HTML class attribute used to contain CSS classes. But other keyword attributes exist, for instance [`rel`](developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel).

Examples:

Ensure that a Node has “nofollow” in its rel attribute.

node                               # => <a></a>
node.kwattr_add("rel", "nofollow") # => <a rel="nofollow"></a>
node.kwattr_add("rel", "nofollow") # => <a rel="nofollow"></a> # duplicate not added

Ensure that a Node has “nofollow” and “noreferrer” in its rel attribute, via a String argument.

node                                          # => <a rel="nofollow nofollow"></a>
node.kwattr_add("rel", "nofollow noreferrer") # => <a rel="nofollow nofollow noreferrer"></a>
# Note that "nofollow" is not added because it is already present.
# Note also that the pre-existing duplicate "nofollow" is not removed.

Ensure that a Node has “nofollow” and “noreferrer” in its rel attribute, via an Array argument.

node                                               # => <a></a>
node.kwattr_add("rel", ["nofollow", "noreferrer"]) # => <a rel="nofollow noreferrer"></a>

Parameters:

  • attribute_name (String)

    The name of the keyword attribute to be modified.

  • keywords (String, Array<String>)

    Keywords to be added to the attribute named attribute_name. May be a string containing whitespace-delimited values, or an Array of String values. Any values already present will not be added. Any values not present will be added. If the named attribute does not exist, it is created.

Returns:

  • (Node)

    Returns self for ease of chaining method calls.

See Also:

Since:

  • v1.11.0



657
658
659
660
661
662
663
# File 'lib/nokogiri/xml/node.rb', line 657

def kwattr_add(attribute_name, keywords)
  keywords = keywordify(keywords)
  current_kws = kwattr_values(attribute_name)
  new_kws = (current_kws + (keywords - current_kws)).join(" ")
  set_attribute(attribute_name, new_kws)
  self
end

#kwattr_append(attribute_name, keywords) ⇒ Node

Add keywords to a Node's keyword attribute, regardless of duplication. Compare with #kwattr_add.

A “keyword attribute” is a node attribute that contains a set of space-delimited values. Perhaps the most familiar example of this is the HTML class attribute used to contain CSS classes. But other keyword attributes exist, for instance [`rel`](developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel).

Examples:

Append “nofollow” to the rel attribute.

node                                  # => <a></a>
node.kwattr_append("rel", "nofollow") # => <a rel="nofollow"></a>
node.kwattr_append("rel", "nofollow") # => <a rel="nofollow nofollow"></a> # duplicate added!

Append “nofollow” and “noreferrer” to the rel attribute, via a String argument.

node                                             # => <a rel="nofollow"></a>
node.kwattr_append("rel", "nofollow noreferrer") # => <a rel="nofollow nofollow noreferrer"></a>
# Note that "nofollow" is appended even though it is already present.

Append “nofollow” and “noreferrer” to the rel attribute, via an Array argument.

node                                                  # => <a></a>
node.kwattr_append("rel", ["nofollow", "noreferrer"]) # => <a rel="nofollow noreferrer"></a>

Parameters:

  • attribute_name (String)

    The name of the keyword attribute to be modified.

  • keywords (String, Array<String>)

    Keywords to be added to the attribute named attribute_name. May be a string containing whitespace-delimited values, or an Array of String values. All values passed in will be appended to the named attribute even if they are already present in the attribute. If the named attribute does not exist, it is created.

Returns:

  • (Node)

    Returns self for ease of chaining method calls.

See Also:

Since:

  • v1.11.0



709
710
711
712
713
714
715
# File 'lib/nokogiri/xml/node.rb', line 709

def kwattr_append(attribute_name, keywords)
  keywords = keywordify(keywords)
  current_kws = kwattr_values(attribute_name)
  new_kws = (current_kws + keywords).join(" ")
  set_attribute(attribute_name, new_kws)
  self
end

#kwattr_remove(attribute_name, keywords) ⇒ Node

Remove keywords from a keyword attribute. Any matching keywords that exist in the named attribute are removed, including any multiple entries.

If no keywords remain after this operation, or if keywords is nil, the attribute is deleted from the node.

A “keyword attribute” is a node attribute that contains a set of space-delimited values. Perhaps the most familiar example of this is the HTML class attribute used to contain CSS classes. But other keyword attributes exist, for instance [`rel`](developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel).

Examples:

node                                    # => <a rel="nofollow noreferrer">link</a>
node.kwattr_remove("rel", "nofollow")   # => <a rel="noreferrer">link</a>
node.kwattr_remove("rel", "noreferrer") # => <a>link</a> # attribute is deleted when empty

Parameters:

  • attribute_name (String)

    The name of the keyword attribute to be modified.

  • keywords (String, Array<String>)

    Keywords to be removed from the attribute named attribute_name. May be a string containing whitespace-delimited values, or an Array of String values. Any keywords present in the named attribute will be removed. If no keywords remain, or if keywords is nil, the attribute is deleted.

Returns:

  • (Node)

    Returns self for ease of chaining method calls.

See Also:

Since:

  • v1.11.0



755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
# File 'lib/nokogiri/xml/node.rb', line 755

def kwattr_remove(attribute_name, keywords)
  if keywords.nil?
    remove_attribute(attribute_name)
    return self
  end

  keywords = keywordify(keywords)
  current_kws = kwattr_values(attribute_name)
  new_kws = current_kws - keywords
  if new_kws.empty?
    remove_attribute(attribute_name)
  else
    set_attribute(attribute_name, new_kws.join(" "))
  end
  self
end

#kwattr_values(attribute_name) ⇒ Array<String>

Retrieve values from a keyword attribute of a Node.

A “keyword attribute” is a node attribute that contains a set of space-delimited values. Perhaps the most familiar example of this is the HTML class attribute used to contain CSS classes. But other keyword attributes exist, for instance [`rel`](developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel).

Examples:

node                      # => <a rel="nofollow noopener external">link</a>
node.kwattr_values("rel") # => ["nofollow", "noopener", "external"]

Parameters:

  • attribute_name (String)

    The name of the keyword attribute to be inspected.

Returns:

  • (Array<String>)

    The values present in the Node's attribute_name attribute. If the attribute is empty or non-existent, the return value is an empty array.

See Also:

Since:

  • v1.11.0



605
606
607
# File 'lib/nokogiri/xml/node.rb', line 605

def kwattr_values(attribute_name)
  keywordify(get_attribute(attribute_name) || [])
end

#langObject

Searches the language of a node, i.e. the values of the xml:lang attribute or the one carried by the nearest ancestor.



1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
# File 'ext/nokogiri/xml_node.c', line 1210

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 ;
}

#lang=Object

Set the language of a node, i.e. the values of the xml:lang attribute.



1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
# File 'ext/nokogiri/xml_node.c', line 1189

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 ;
}

#last_element_childObject

Returns the last child node of this node that is an element.

Example:

@doc.root.last_element_child.element? # => true


831
832
833
834
835
836
837
838
839
840
841
# File 'ext/nokogiri/xml_node.c', line 831

static VALUE
last_element_child(VALUE self)
{
  xmlNodePtr node, child;
  Data_Get_Struct(self, xmlNode, node);

  child = xmlLastElementChild(node);
  if (!child) { return Qnil; }

  return noko_xml_node_wrap(Qnil, child);
}

#lineObject

Returns the line for this Node



1369
1370
1371
1372
1373
1374
1375
1376
# File 'ext/nokogiri/xml_node.c', line 1369

static VALUE
line(VALUE self)
{
  xmlNodePtr node;
  Data_Get_Struct(self, xmlNode, node);

  return INT2NUM(xmlGetLineNo(node));
}

#line=(num) ⇒ Object

Sets the line for this Node. num must be less than 65535.



1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
# File 'ext/nokogiri/xml_node.c', line 1384

static VALUE
set_line(VALUE self, VALUE num)
{
  xmlNodePtr node;
  int value = NUM2INT(num);

  Data_Get_Struct(self, xmlNode, node);
  if (value < 65535) {
    node->line = value;
  }

  return num;
}

#matches?(selector) ⇒ Boolean

Returns true if this Node matches selector

Returns:

  • (Boolean)


782
783
784
# File 'lib/nokogiri/xml/node.rb', line 782

def matches?(selector)
  ancestors.last.search(selector).include?(self)
end

#namespaceObject

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.



1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
# File 'ext/nokogiri/xml_node.c', line 1047

static VALUE
noko_xml_node_namespace(VALUE rb_node)
{
  xmlNodePtr c_node ;
  Data_Get_Struct(rb_node, xmlNode, c_node);

  if (c_node->ns) {
    return noko_xml_namespace_wrap(c_node->ns, c_node->doc);
  }

  return Qnil ;
}

#namespace=(ns) ⇒ Object

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.



332
333
334
335
336
337
338
339
340
341
342
343
# File 'lib/nokogiri/xml/node.rb', line 332

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

#namespace_definitionsObject

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=”).



1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
# File 'ext/nokogiri/xml_node.c', line 1066

static VALUE
namespace_definitions(VALUE rb_node)
{
  /* this code in the mode of xmlHasProp() */
  xmlNodePtr c_node ;
  xmlNsPtr c_namespace;
  VALUE definitions = rb_ary_new();

  Data_Get_Struct(rb_node, xmlNode, c_node);

  c_namespace = c_node->nsDef;
  if (!c_namespace) {
    return definitions;
  }

  while (c_namespace != NULL) {
    rb_ary_push(definitions, noko_xml_namespace_wrap(c_namespace, c_node->doc));
    c_namespace = c_namespace->next;
  }

  return definitions;
}

#namespace_scopesObject

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



1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
# File 'ext/nokogiri/xml_node.c', line 1098

static VALUE
namespace_scopes(VALUE rb_node)
{
  xmlNodePtr c_node ;
  xmlNsPtr *namespaces;
  VALUE scopes = rb_ary_new();
  int j;

  Data_Get_Struct(rb_node, xmlNode, c_node);

  namespaces = xmlGetNsList(c_node->doc, c_node);
  if (!namespaces) {
    return scopes;
  }

  for (j = 0 ; namespaces[j] != NULL ; ++j) {
    rb_ary_push(scopes, noko_xml_namespace_wrap(namespaces[j], c_node->doc));
  }

  xmlFree(namespaces);
  return scopes;
}

#namespaced_key?(attribute, namespace) ⇒ Boolean

Returns true if attribute is set with namespace

Returns:

  • (Boolean)


866
867
868
869
870
871
872
873
874
875
876
# File 'ext/nokogiri/xml_node.c', line 866

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;
}

#namespacesObject

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.



863
864
865
866
867
868
869
# File 'lib/nokogiri/xml/node.rb', line 863

def namespaces
  namespace_scopes.each_with_object({}) do |ns, hash|
    prefix = ns.prefix
    key = prefix ? "xmlns:#{prefix}" : "xmlns"
    hash[key] = ns.href
  end
end

#content=Object

Set the content for this Node



1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
# File 'ext/nokogiri/xml_node.c', line 1141

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) ;
    noko_xml_document_pin_node(child);
    child = next ;
  }

  xmlNodeSetContent(node, (xmlChar *)StringValueCStr(content));
  return content;
}

#next_elementObject

Returns the next Nokogiri::XML::Element type sibling node.



656
657
658
659
660
661
662
663
664
665
666
# File 'ext/nokogiri/xml_node.c', line 656

static VALUE
next_element(VALUE self)
{
  xmlNodePtr node, sibling;
  Data_Get_Struct(self, xmlNode, node);

  sibling = xmlNextElementSibling(node);
  if (!sibling) { return Qnil; }

  return noko_xml_node_wrap(Qnil, sibling);
}

#next_siblingObject Also known as: next

Returns the next sibling node



620
621
622
623
624
625
626
627
628
629
630
# File 'ext/nokogiri/xml_node.c', line 620

static VALUE
next_sibling(VALUE self)
{
  xmlNodePtr node, sibling;
  Data_Get_Struct(self, xmlNode, node);

  sibling = node->next;
  if (!sibling) { return Qnil; }

  return noko_xml_node_wrap(Qnil, sibling) ;
}

#nameObject Also known as: name

Returns the name for this Node



1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
# File 'ext/nokogiri/xml_node.c', line 1275

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;
}

#name=(new_name) ⇒ Object Also known as: name=

Set the name for this Node



1260
1261
1262
1263
1264
1265
1266
1267
# File 'ext/nokogiri/xml_node.c', line 1260

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;
}

#node_typeObject Also known as: type

Get the type for this Node



1127
1128
1129
1130
1131
1132
1133
# File 'ext/nokogiri/xml_node.c', line 1127

static VALUE
node_type(VALUE self)
{
  xmlNodePtr node;
  Data_Get_Struct(self, xmlNode, node);
  return INT2NUM((long)node->type);
}

#parentObject

Get the parent Node for this Node



1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
# File 'ext/nokogiri/xml_node.c', line 1242

static VALUE
get_parent(VALUE self)
{
  xmlNodePtr node, parent;
  Data_Get_Struct(self, xmlNode, node);

  parent = node->parent;
  if (!parent) { return Qnil; }

  return noko_xml_node_wrap(Qnil, parent) ;
}

#parent=(parent_node) ⇒ Object

Set the parent Node for this Node



311
312
313
314
# File 'lib/nokogiri/xml/node.rb', line 311

def parent=(parent_node)
  parent_node.add_child(self)
  parent_node
end

#parse(string_or_io, options = nil) {|options| ... } ⇒ Object

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.

Yields:

  • (options)


798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
# File 'lib/nokogiri/xml/node.rb', line 798

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?

  # libxml2 does not obey the `recover` option after encountering errors during `in_context`
  # parsing, and so this horrible hack is here to try to emulate recovery behavior.
  #
  # Unfortunately, this means we're no longer parsing "in context" and so namespaces that
  # would have been inherited from the context node won't be handled correctly. This hack was
  # written in 2010, and I regret it, because it's silently degrading functionality in a way
  # that's not easily prevented (or even detected).
  #
  # I think preferable behavior would be to either:
  #
  # a. add an error noting that we "fell back" and pointing the user to turning off the `recover` option
  # b. don't recover, but raise a sensible exception
  #
  # For context and background: https://github.com/sparklemotion/nokogiri/issues/313
  # FIXME bug report: https://github.com/sparklemotion/nokogiri/issues/2092
  error_count = document.errors.length
  node_set = in_context(contents, options.to_i)
  if (node_set.empty? && (document.errors.length > error_count))
    if options.recover?
      fragment = Nokogiri::HTML::DocumentFragment.parse contents
      node_set = fragment.children
    else
      raise document.errors[error_count]
    end
  end
  node_set
end

#pathObject

Returns the path associated with this Node



1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
# File 'ext/nokogiri/xml_node.c', line 1292

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 ;
}

#pointer_idObject

Get the internal pointer number



384
385
386
387
388
389
390
391
# File 'ext/nokogiri/xml_node.c', line 384

static VALUE
pointer_id(VALUE self)
{
  xmlNodePtr node;
  Data_Get_Struct(self, xmlNode, node);

  return INT2NUM((long)(node));
}

#prepend_child(node_or_tags) ⇒ Object

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.



146
147
148
149
150
151
152
153
154
# File 'lib/nokogiri/xml/node.rb', line 146

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

#pretty_print(pp) ⇒ Object Originally defined in module PP::Node

:nodoc:

#previous_elementObject

Returns the previous Nokogiri::XML::Element type sibling node.



674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
# File 'ext/nokogiri/xml_node.c', line 674

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 ? noko_xml_node_wrap(Qnil, sibling) : Qnil ;
}

#previous_siblingObject Also known as: previous

Returns the previous sibling node



638
639
640
641
642
643
644
645
646
647
648
# File 'ext/nokogiri/xml_node.c', line 638

static VALUE
previous_sibling(VALUE self)
{
  xmlNodePtr node, sibling;
  Data_Get_Struct(self, xmlNode, node);

  sibling = node->prev;
  if (!sibling) { return Qnil; }

  return noko_xml_node_wrap(Qnil, sibling);
}

#processing_instruction?Boolean

Returns true if this is a ProcessingInstruction node

Returns:

  • (Boolean)


897
898
899
# File 'lib/nokogiri/xml/node.rb', line 897

def processing_instruction?
  type == PI_NODE
end

#read_only?Boolean

Is this a read only node?

Returns:

  • (Boolean)


921
922
923
924
# File 'lib/nokogiri/xml/node.rb', line 921

def read_only?
  # According to gdome2, these are read-only node types
  [NOTATION_NODE, ENTITY_NODE, ENTITY_DECL].include?(type)
end

#remove_attribute(name) ⇒ Object Also known as: delete

Remove the attribute named name



431
432
433
434
435
# File 'lib/nokogiri/xml/node.rb', line 431

def remove_attribute(name)
  attr = attributes[name].remove if key? name
  clear_xpath_context if Nokogiri.jruby?
  attr
end

#remove_class(names = nil) ⇒ Node

Remove HTML CSS classes from a Node. Any CSS classes in names that exist in the Node's class attribute are removed, including any multiple entries.

If no CSS classes remain after this operation, or if names is nil, the class attribute is deleted from the node.

This is a convenience function and is equivalent to:

node.kwattr_remove("class", names)

Examples:

node                         # => <div class="section header"></div>
node.remove_class("section") # => <div class="header"></div>
node.remove_class("header")  # => <div></div> # attribute is deleted when empty

Parameters:

  • names (String, Array<String>) (defaults to: nil)

    CSS class names to be removed from the Node's class attribute. May be a string containing whitespace-delimited names, or an Array of String names. Any class names already present will be removed. If no CSS classes remain, the class attribute is deleted.

Returns:

  • (Node)

    Returns self for ease of chaining method calls.

See Also:



574
575
576
# File 'lib/nokogiri/xml/node.rb', line 574

def remove_class(names = nil)
  kwattr_remove("class", names)
end

#replace(node_or_tags) ⇒ Object

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.



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
# File 'lib/nokogiri/xml/node.rb', line 266

def replace(node_or_tags)
  raise("Cannot replace a node with no parent") unless parent

  # 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 = parent.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

#search(*args) ⇒ Object Also known as: / Originally defined in module Searchable

call-seq: search *paths, [namespace-bindings, xpath-variable-bindings, custom-handler-class]

Search this object for paths. paths must be one or more XPath or CSS queries:

node.search("div.employee", ".//title")

A hash of namespace bindings may be appended:

node.search('.//bike:tire', {'bike' => 'http://schwinn.com/'})
node.search('bike|tire', {'bike' => 'http://schwinn.com/'})

For XPath queries, a hash of variable bindings may also be appended to the namespace bindings. For example:

node.search('.//address[@domestic=$value]', nil, {:value => 'Yes'})

Custom XPath functions and CSS pseudo-selectors may also be defined. To define custom functions create a class and implement the function you want to define. The first argument to the method will be the current matching NodeSet. Any other arguments are ones that you pass in. Note that this class may appear anywhere in the argument list. For example:

node.search('.//title[regex(., "\w+")]', 'div.employee:regex("[0-9]+")'
  Class.new {
    def regex node_set, regex
      node_set.find_all { |node| node['some_attribute'] =~ /#{regex}/ }
    end
  }.new
)

See Searchable#xpath and Searchable#css for further usage help.

#serialize(*args, &block) ⇒ Object

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


1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
# File 'lib/nokogiri/xml/node.rb', line 1022

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

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.



298
299
300
301
# File 'lib/nokogiri/xml/node.rb', line 298

def swap(node_or_tags)
  replace node_or_tags
  self
end

#text?Boolean

Returns true if this is a Text node

Returns:

  • (Boolean)


902
903
904
# File 'lib/nokogiri/xml/node.rb', line 902

def text?
  type == TEXT_NODE
end

#to_html(options = {}) ⇒ Object

Serialize this Node to HTML

doc.to_html

See Node#write_to for a list of options. For formatted output, use Node#to_xhtml instead.



1045
1046
1047
# File 'lib/nokogiri/xml/node.rb', line 1045

def to_html(options = {})
  to_format SaveOptions::DEFAULT_HTML, options
end

#to_sObject

Turn this node in to a string. If the document is HTML, this method returns html. If the document is XML, this method returns XML.



936
937
938
# File 'lib/nokogiri/xml/node.rb', line 936

def to_s
  document.xml? ? to_xml : to_html
end

#to_xhtml(options = {}) ⇒ Object

Serialize this Node to XHTML using options

doc.to_xhtml(:indent => 5, :encoding => 'UTF-8')

See Node#write_to for a list of options



1066
1067
1068
# File 'lib/nokogiri/xml/node.rb', line 1066

def to_xhtml(options = {})
  to_format SaveOptions::DEFAULT_XHTML, options
end

#to_xml(options = {}) ⇒ Object

Serialize this Node to XML using options

doc.to_xml(:indent => 5, :encoding => 'UTF-8')

See Node#write_to for a list of options



1055
1056
1057
1058
# File 'lib/nokogiri/xml/node.rb', line 1055

def to_xml(options = {})
  options[:save_with] ||= SaveOptions::DEFAULT_XML
  serialize(options)
end

#traverse(&block) ⇒ Object

Yields self and all children to block recursively.



978
979
980
981
# File 'lib/nokogiri/xml/node.rb', line 978

def traverse(&block)
  children.each { |j| j.traverse(&block) }
  block.call(self)
end

Unlink this node from its current context.



590
591
592
593
594
595
596
597
598
# File 'ext/nokogiri/xml_node.c', line 590

static VALUE
unlink_node(VALUE self)
{
  xmlNodePtr node;
  Data_Get_Struct(self, xmlNode, node);
  xmlUnlinkNode(node);
  noko_xml_document_pin_node(node);
  return self;
}

#value?(value) ⇒ Boolean

Does this Node's attributes include <value>

Returns:

  • (Boolean)


411
412
413
# File 'lib/nokogiri/xml/node.rb', line 411

def value?(value)
  values.include? value
end

#valuesObject

Get the attribute values for this Node.



405
406
407
# File 'lib/nokogiri/xml/node.rb', line 405

def values
  attribute_nodes.map(&:value)
end

#wrap(html) ⇒ Object

Add html around this node

Returns self



160
161
162
163
164
165
# File 'lib/nokogiri/xml/node.rb', line 160

def wrap(html)
  new_parent = document.parse(html).first
  add_next_sibling(new_parent)
  new_parent.add_child(self)
  self
end

#write_html_to(io, options = {}) ⇒ Object

Write Node as HTML to io with options

See Node#write_to for a list of options



1114
1115
1116
# File 'lib/nokogiri/xml/node.rb', line 1114

def write_html_to(io, options = {})
  write_format_to SaveOptions::DEFAULT_HTML, io, options
end

#write_to(io, *options) {|config| ... } ⇒ Object

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)

Yields:

  • (config)


1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
# File 'lib/nokogiri/xml/node.rb', line 1087

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] || " "

  # Any string times 0 returns an empty string. Therefore, use the same
  # string instead of generating a new empty string for every node with
  # zero indentation.
  indentation = indent_times.zero? ? "" : (indent_text * indent_times)

  config = SaveOptions.new(save_options.to_i)
  yield config if block_given?

  native_write_to(io, encoding, indentation, config.options)
end

#write_xhtml_to(io, options = {}) ⇒ Object

Write Node as XHTML to io with options

See Node#write_to for a list of options



1122
1123
1124
# File 'lib/nokogiri/xml/node.rb', line 1122

def write_xhtml_to(io, options = {})
  write_format_to SaveOptions::DEFAULT_XHTML, io, options
end

#write_xml_to(io, options = {}) ⇒ Object

Write Node as XML to io with options

doc.write_xml_to io, :encoding => 'UTF-8'

See Node#write_to for a list of options



1132
1133
1134
1135
# File 'lib/nokogiri/xml/node.rb', line 1132

def write_xml_to(io, options = {})
  options[:save_with] ||= SaveOptions::DEFAULT_XML
  write_to io, options
end

#xml?Boolean

Returns true if this is an XML::Document node

Returns:

  • (Boolean)


882
883
884
# File 'lib/nokogiri/xml/node.rb', line 882

def xml?
  type == DOCUMENT_NODE
end

#xpath(*args) ⇒ Object Originally defined in module Searchable

call-seq: xpath *paths, [namespace-bindings, variable-bindings, custom-handler-class]

Search this node for XPath paths. paths must be one or more XPath queries.

node.xpath('.//title')

A hash of namespace bindings may be appended. For example:

node.xpath('.//foo:name', {'foo' => 'http://example.org/'})
node.xpath('.//xmlns:name', node.root.namespaces)

A hash of variable bindings may also be appended to the namespace bindings. For example:

node.xpath('.//address[@domestic=$value]', nil, {:value => 'Yes'})

Custom XPath functions may also be defined. To define custom functions create a class and implement the function you want to define. The first argument to the method will be the current matching NodeSet. Any other arguments are ones that you pass in. Note that this class may appear anywhere in the argument list. For example:

node.xpath('.//title[regex(., "\w+")]', Class.new {
  def regex node_set, regex
    node_set.find_all { |node| node['some_attribute'] =~ /#{regex}/ }
  end
}.new)