Class: Nokogiri::HTML5::DocumentFragment

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `::Nokogiri::HTML4::DocumentFragment`, `::Nokogiri::XML::DocumentFragment`, `::Nokogiri::XML::Node`
Instance Chain: self, `::Nokogiri::HTML4::DocumentFragment`, `::Nokogiri::XML::DocumentFragment`, `::Nokogiri::XML::Node`, Enumerable, `::Nokogiri::ClassResolver`, `::Nokogiri::XML::Searchable`, `::Nokogiri::XML::PP::Node`
Inherits:	Nokogiri::HTML4::DocumentFragment `::Object` Nokogiri::XML::Node Nokogiri::XML::DocumentFragment Nokogiri::HTML4::DocumentFragment Nokogiri::HTML5::DocumentFragment
Defined in:	lib/nokogiri/html5/document_fragment.rb

Overview

Since v1.12.0

💡 ::Nokogiri::HTML5 functionality is not available when running JRuby.

Constant Summary

Class Method Summary

.new(doc, tags = nil, context = nil, options = {}) ⇒ DocumentFragment constructor

Create a document fragment.
.parse(tags, **options)

Parse an ::Nokogiri::HTML5 document fragment from tags, returning a Nodeset.

`::Nokogiri::HTML4::DocumentFragment` - Inherited

.new	It’s recommended to use either .parse or XML::Node#parse rather than call this method directly.
.parse	Parse an `::Nokogiri::HTML4` fragment.

`::Nokogiri::XML::DocumentFragment` - Inherited

.new	Alias for XML::EntityReference.new.
.parse	Create a `::Nokogiri::XML::DocumentFragment` from `tags`

`::Nokogiri::XML::Node` - Inherited

.new	documented in lib/nokogiri/xml/node.rb.

Instance Attribute Summary

#document rw
#errors rw
#quirks_mode readonly

Get the parser’s quirks mode value.

`::Nokogiri::XML::DocumentFragment` - Inherited

#errors	A list of `::Nokogiri::XML::SyntaxError` found when parsing a document.
#parse_options	The options used to parse the document fragment.
#errors=

`::Nokogiri::XML::Node` - Inherited

#blank?	Returns `true` if the node is an empty or whitespace-only text or cdata node, else `false`.
#cdata?	Returns true if this is a CDATA.
#children	:category: Traversing Document Structure.
#children=	Set the content for this `Node` `node_or_tags`
#comment?	Returns true if this is a Comment.
#content	[Returns].
#content=	Set the content of this node to `input`.
#default_namespace=	Adds a default namespace supplied as a string `url` href, to self.
#document	:category: Traversing Document Structure.
#document?	Returns true if this is a `Document`.
#elem?	Alias for XML::Node#element?.
#element?	Returns true if this is an Element node.
#fragment?	Returns true if this is a `DocumentFragment`.
#html?	Returns true if this is an `::Nokogiri::HTML4::Document` or `Document` node.
#inner_html	Get the inner_html for this node’s `Node#children`
#inner_html=	Set the content for this `Node` to `node_or_tags`.
#inner_text	Alias for XML::Node#content.
#lang	Searches the language of a node, i.e.
#lang=	Set the language of a node, i.e.
#line	Returns The line number of this `Node`.
#line=	Sets the line for this `Node`.
#name	Alias for XML::Node#node_name.
#namespace	Returns The Namespace of the element or attribute node, or `nil` if there is no namespace.
#namespace=	Set the default namespace on this node (as would be defined with an “xmlns=” attribute in `::Nokogiri::XML` source), as a Namespace object `ns`.
#native_content=	Set the content of this node to `input`.
#next	Alias for XML::Node#next_sibling.
#next=	Alias for XML::Node#add_next_sibling.
#node_name	Returns the name for this `Node`.
#node_name=	Set the name for this `Node`.
#parent	Get the parent `Node` for this `Node`.
#parent=	Set the parent `Node` for this `Node`.
#previous	Alias for XML::Node#previous_sibling.
#previous=	Alias for XML::Node#add_previous_sibling.
#processing_instruction?	Returns true if this is a ProcessingInstruction node.
#read_only?	Is this a read only node?
#text	Alias for XML::Node#content.
#text?	Returns true if this is a Text node.
#to_str	Alias for XML::Node#content.
#xml?	Returns true if this is an `::Nokogiri::XML::Document` node.
#prepend_newline?, #data_ptr?

Instance Method Summary

#extract_params(params) Internal use only
#serialize(options = {}, &block) Internal use only

`::Nokogiri::XML::DocumentFragment` - Inherited

#css	Search this fragment for `::Nokogiri::CSS` `rules`.
#deconstruct	Returns the root nodes of this document fragment as an array, to use in pattern matching.
#dup, #fragment,
#initialize	Create a new `DocumentFragment` from `tags`.
#name	return the name for `DocumentFragment`.
#search	Search this fragment for `paths`.
#serialize	Alias for XML::DocumentFragment#to_s.
#to_html	Convert this `DocumentFragment` to html See XML::NodeSet#to_html
#to_s	Convert this `DocumentFragment` to a string.
#to_xhtml	Convert this `DocumentFragment` to xhtml See XML::NodeSet#to_xhtml
#to_xml	Convert this `DocumentFragment` to xml See XML::NodeSet#to_xml
#namespace_declarations	fix for issue 770.

`::Nokogiri::XML::Node` - Inherited

#<<	Add `node_or_tags` as a child of this `Node`.
#<=>	Compare two `Node` objects with respect to their `Document`.
#==	`::Nokogiri::Test` to see if this `Node` is equal to `other`
#[]	Fetch an attribute from this node.
#[]=	Update the attribute `name` to `value`, or create the attribute if it does not exist.
#accept	Accept a visitor.
#add_child	Add `node_or_tags` as a child of this `Node`.
#add_class	Ensure HTML `::Nokogiri::CSS` classes are present on `self`.
#add_namespace	Alias for XML::Node#add_namespace_definition.
#add_namespace_definition	:category: Manipulating Document Structure.
#add_next_sibling	Insert `node_or_tags` after this `Node` (as a sibling).
#add_previous_sibling	Insert `node_or_tags` before this `Node` (as a sibling).
#after	Insert `node_or_tags` after this node (as a sibling).
#ancestors	Get a list of ancestor `Node` for this `Node`.
#append_class	Add HTML `::Nokogiri::CSS` classes to `self`, regardless of duplication.
#attr	Alias for XML::Node#[].
#attribute	:category: Working With `Node` Attributes.
#attribute_nodes	:category: Working With `Node` Attributes.
#attribute_with_ns	:category: Working With `Node` Attributes.
#attributes	Fetch this node’s attributes.
#before	Insert `node_or_tags` before this node (as a sibling).
#canonicalize,
#child	:category: Traversing Document Structure.
#classes	Fetch CSS class names of a `Node`.
#clone	Clone this node.
#create_external_subset	Create an external subset.
#create_internal_subset	Create the internal subset of a document.
#css_path	Get the path to this node as a `::Nokogiri::CSS` expression.
#deconstruct_keys	Returns a hash describing the `Node`, to use in pattern matching.
#decorate!	Decorate this node with the decorators set up in this node’s `Document`.
#delete	Alias for XML::Node#remove_attribute.
#description	Fetch the `::Nokogiri::HTML4::ElementDescription` for this node.
#do_xinclude	Do xinclude substitution on the subtree below node.
#dup	Duplicate this node.
#each	Iterate over each attribute name and value pair for this `Node`.
#element_children	[Returns].
#elements	Alias for XML::Node#element_children.
#encode_special_chars	Encode any special characters in `string`
#external_subset	Get the external subset.
#first_element_child	Returns The first child `Node` that is an element.
#fragment	Create a `DocumentFragment` containing `tags` that is relative to this context node.
#get_attribute	Alias for XML::Node#[].
#has_attribute?	Alias for XML::Node#key?.
#initialize	Create a new node with `name` that belongs to #document.
#internal_subset	Get the internal subset.
#key?	Returns true if `attribute` is set.
#keys	Get the attribute names for this `Node`.
#kwattr_add	Ensure that values are present in a keyword attribute.
#kwattr_append	Add keywords to a Node’s keyword attribute, regardless of duplication.
#kwattr_remove	Remove keywords from a keyword attribute.
#kwattr_values	Fetch values from a keyword attribute of a `Node`.
#last_element_child	Returns The last child `Node` that is an element.
#matches?	Returns true if this `Node` matches `selector`
#namespace_definitions	[Returns].
#namespace_scopes	Returns Array of all the Namespaces on this node and its ancestors.
#namespaced_key?	Returns true if `attribute` is set with `namespace`
#namespaces	Fetch all the namespaces on this node and its ancestors.
#next_element	Returns the next `::Nokogiri::XML::Element` type sibling node.
#next_sibling	Returns the next sibling node.
#node_type	Get the type for this `Node`.
#parse	Parse `string_or_io` as a document fragment within the context of this node.
#path	Returns the path associated with this `Node`.
#pointer_id	[Returns].
#prepend_child	Add `node_or_tags` as the first child of this `Node`.
#previous_element	Returns the previous `::Nokogiri::XML::Element` type sibling node.
#previous_sibling	Returns the previous sibling node.
#remove	Alias for XML::Node#unlink.
#remove_attribute	Remove the attribute named `name`
#remove_class	Remove HTML `::Nokogiri::CSS` classes from this node.
#replace	Replace this `Node` with `node_or_tags`.
#serialize	Serialize Node using `options`.
#set_attribute	Alias for XML::Node#[]=.
#swap	Swap this `Node` for `node_or_tags`
#to_html	Serialize this `Node` to `::Nokogiri::HTML`.
#to_s	Turn this node in to a string.
#to_xhtml	Serialize this `Node` to XHTML using `options`
#to_xml	Serialize this `Node` to `::Nokogiri::XML` using `options`
#traverse	Yields self and all children to `block` recursively.
#type	Alias for XML::Node#node_type.
#unlink	Unlink this node from its current context.
#value?	Does this Node’s attributes include <value>.
#values	Get the attribute values for this `Node`.
#wrap	Wrap this `Node` with the node parsed from `markup` or a dup of the `node`.
#write_html_to	Write Node as `::Nokogiri::HTML` to `io` with `options`
#write_to	Serialize this node or document to `io`.
#write_xhtml_to	Write Node as XHTML to `io` with `options`
#write_xml_to	Write Node as `::Nokogiri::XML` to `io` with `options`
#add_child_node_and_reparent_attrs, #add_sibling,
#compare	Compare this `Node` to `other` with respect to their `Document`.
#dump_html	Returns the `Node` as html.
#get	Get the value for `attribute`
#html_standard_serialize,
#in_context	TODO: DOCUMENT ME.
#inspect_attributes, #keywordify,
#native_write_to	Write this `Node` to `io` with `encoding` and `options`
#process_xincludes	Loads and substitutes all xinclude elements below the node.
#set	Set the `property` to `value`
#set_namespace	Set the namespace to `namespace`
#to_format, #write_format_to, #add_child_node, #add_next_sibling_node, #add_previous_sibling_node, #replace_node

`::Nokogiri::ClassResolver` - Included

#related_class

Find a class constant within the.

`::Nokogiri::XML::Searchable` - Included

#%	Alias for XML::Searchable#at.
#/	Alias for XML::Searchable#search.
#>	Search this node’s immediate children using `::Nokogiri::CSS` selector `selector`
#at	Search this object for `paths`, and return only the first result.
#at_css	Search this object for `::Nokogiri::CSS` `rules`, and return only the first match.
#at_xpath	Search this node for XPath `paths`, and return only the first match.
#css	Search this object for `::Nokogiri::CSS` `rules`.
#search	Search this object for `paths`.
#xpath	Search this node for XPath `paths`.
#css_internal, #css_rules_to_xpath, #xpath_impl, #xpath_internal, #xpath_query_from_css_rule, #extract_params

`::Nokogiri::XML::PP::Node` - Included

#inspect, #pretty_print

Constructor Details

.new(doc, tags = nil, context = nil, options = {}) ⇒ `DocumentFragment`

Create a document fragment.

[ GitHub ]

# File 'lib/nokogiri/html5/document_fragment.rb', line 80


def initialize(doc, tags = nil, context = nil, options = {}) # rubocop:disable Lint/MissingSuper
  @document = doc
  @errors = []
  return self unless tags

  tags = Nokogiri::HTML5.read_and_encode(tags, nil)

  context = options.delete(:context) if options.key?(:context)

  options[:max_attributes] ||= Nokogiri::Gumbo::DEFAULT_MAX_ATTRIBUTES
  options[:max_errors] ||= options.delete(:max_parse_errors) || Nokogiri::Gumbo::DEFAULT_MAX_ERRORS
  options[:max_tree_depth] ||= Nokogiri::Gumbo::DEFAULT_MAX_TREE_DEPTH

  Nokogiri::Gumbo.fragment(self, tags, context, **options)
end

Class Method Details

.parse(tags, options) .parse(tags, encoding = nil, options)

Parse an ::Nokogiri::HTML5 document fragment from tags, returning a Nodeset.

Parameters

tags [String, IO] The HTML5 document fragment to parse.
encoding [String] The name of the encoding to use when parsing the document fragment. (default nil)

Also see ::Nokogiri::HTML5 for a longer explanation of how encoding is handled by the parser.

Options

:context [String, Nokogiri::XML::Node] The context in which to parse the document fragment. (default “body”)
:max_errors [Integer] The maximum number of parse errors to record. (default Gumbo::DEFAULT_MAX_ERRORS which is currently 0)
:max_tree_depth [Integer] The maximum depth of the parse tree. (default Gumbo::DEFAULT_MAX_TREE_DEPTH)
:max_attributes [Integer] The maximum number of attributes allowed on an element. (default Gumbo::DEFAULT_MAX_ATTRIBUTES)
:parse_noscript_content_as_text [Boolean] Whether to parse the content of noscript elements as text. (default false)

Also see ::Nokogiri::HTML5 for a longer explanation of the options.

Returns

Nokogiri::XML::NodeSet

A node set containing the root nodes of the parsed fragment.

[ GitHub ]

# File 'lib/nokogiri/html5/document_fragment.rb', line 53


def parse(tags, encoding = nil, positional_options_hash = nil, **options)
  unless positional_options_hash.nil?
    warn("Nokogiri::HTML5::DocumentFragment.parse: Passing options as an explicit hash is deprecated. Use keyword arguments instead. This will become an error in a future release.", uplevel: 1, category: :deprecated)
    options.merge!(positional_options_hash)
  end

  context = options.delete(:context)

  document = HTML5::Document.new
  document.encoding = "UTF-8"
  tags = HTML5.read_and_encode(tags, encoding)

  new(document, tags, context, options)
end

Instance Attribute Details

#document (rw)

[ GitHub ]

# File 'lib/nokogiri/html5/document_fragment.rb', line 69


attr_accessor :document

#errors (rw)

[ GitHub ]

# File 'lib/nokogiri/html5/document_fragment.rb', line 70


attr_accessor :errors

#quirks_mode (readonly)

Get the parser’s quirks mode value. See QuirksMode.

This method returns nil if the parser was not invoked (e.g., ‘Nokogiri::HTML5::DocumentFragment.new(doc)`).

Since v1.14.0

[ GitHub ]

# File 'lib/nokogiri/html5/document_fragment.rb', line 77


attr_reader :quirks_mode

Instance Method Details

#extract_params(params)

This method is for internal use only.

[ GitHub ]

# File 'lib/nokogiri/html5/document_fragment.rb', line 102


def extract_params(params) # :nodoc:
  handler = params.find do |param|
    ![Hash, String, Symbol].include?(param.class)
  end
  params -= [handler] if handler

  hashes = []
  while Hash === params.last || params.last.nil?
    hashes << params.pop
    break if params.empty?
  end
  ns, binds = hashes.reverse

  ns ||=
    begin
      ns = {}
      children.each { |child| ns.merge!(child.namespaces) }
      ns
    end

  [params, handler, ns, binds]
end

#serialize(options = {}, &block)

This method is for internal use only.

[ GitHub ]

# File 'lib/nokogiri/html5/document_fragment.rb', line 96


def serialize(options = {}, &block) # :nodoc:
  # Bypass XML::Document.serialize which doesn't support options even
  # though XML::Node.serialize does!
  XML::Node.instance_method(:serialize).bind_call(self, options, &block)
end

Class: Nokogiri::HTML5::DocumentFragment

Overview

Constant Summary

::Nokogiri::XML::PP::Node - Included

::Nokogiri::XML::Searchable - Included

::Nokogiri::ClassResolver - Included

::Nokogiri::XML::Node - Inherited

Class Method Summary

::Nokogiri::HTML4::DocumentFragment - Inherited

::Nokogiri::XML::DocumentFragment - Inherited

::Nokogiri::XML::Node - Inherited

Instance Attribute Summary

::Nokogiri::XML::DocumentFragment - Inherited

::Nokogiri::XML::Node - Inherited

Instance Method Summary

::Nokogiri::XML::DocumentFragment - Inherited

::Nokogiri::XML::Node - Inherited

::Nokogiri::ClassResolver - Included

::Nokogiri::XML::Searchable - Included

::Nokogiri::XML::PP::Node - Included

Constructor Details

.new(doc, tags = nil, context = nil, options = {}) ⇒ DocumentFragment

Class Method Details

.parse(tags, **options) .parse(tags, encoding = nil, **options)

Instance Attribute Details

#document (rw)

#errors (rw)

#quirks_mode (readonly)

Instance Method Details

#extract_params(params)

#serialize(options = {}, &block)

`::Nokogiri::XML::PP::Node` - Included

`::Nokogiri::XML::Searchable` - Included

`::Nokogiri::ClassResolver` - Included

`::Nokogiri::XML::Node` - Inherited

`::Nokogiri::HTML4::DocumentFragment` - Inherited

`::Nokogiri::XML::DocumentFragment` - Inherited

`::Nokogiri::XML::Node` - Inherited

`::Nokogiri::XML::DocumentFragment` - Inherited

`::Nokogiri::XML::Node` - Inherited

`::Nokogiri::XML::DocumentFragment` - Inherited

`::Nokogiri::XML::Node` - Inherited

`::Nokogiri::ClassResolver` - Included

`::Nokogiri::XML::Searchable` - Included

`::Nokogiri::XML::PP::Node` - Included

.new(doc, tags = nil, context = nil, options = {}) ⇒ `DocumentFragment`

.parse(tags, options) .parse(tags, encoding = nil, options)