W3cubDocs

/Nokogiri

class Nokogiri::XML::DocumentFragment

Parent:
cNokogiriXmlNode

DocumentFragment represents a DocumentFragment node in an xml document.

Public Class Methods

new(document, tags = nil, ctx = nil, options = ParseOptions::DEFAULT_XML) { |options| ... } Show source
# File lib/nokogiri/xml/document_fragment.rb, line 18
def initialize(document, tags = nil, ctx = nil, options = ParseOptions::DEFAULT_XML)
  return self unless tags

  options = Nokogiri::XML::ParseOptions.new(options) if Integer === options
  yield options if block_given?

  children = if ctx
    # Fix for issue#490
    if Nokogiri.jruby?
      # fix for issue #770
      ctx.parse("<root #{namespace_declarations(ctx)}>#{tags}</root>", options).children
    else
      ctx.parse(tags, options)
    end
  else
    wrapper_doc = XML::Document.parse("<root>#{tags}</root>", nil, nil, options)
    self.errors = wrapper_doc.errors
    wrapper_doc.xpath("/root/node()")
  end
  children.each { |child| child.parent = self }
end

Create a new DocumentFragment from tags.

If ctx is present, it is used as a context node for the subtree created, e.g., namespaces will be resolved relative to ctx.

new(document) Show source
static VALUE
new (int argc, VALUE *argv, VALUE klass)
{
  xmlDocPtr xml_doc;
  xmlNodePtr node;
  VALUE document;
  VALUE rest;
  VALUE rb_node;

  rb_scan_args(argc, argv, "1*", &document, &rest);

  Data_Get_Struct(document, xmlDoc, xml_doc);

  node = xmlNewDocFragment(xml_doc->doc);

  noko_xml_document_pin_node(node);

  rb_node = noko_xml_node_wrap(klass, node);
  rb_obj_call_init(rb_node, argc, argv);

  return rb_node;
}

Create a new DocumentFragment element on the document

parse(tags, options = ParseOptions::DEFAULT_XML, &block) Show source
# File lib/nokogiri/xml/document_fragment.rb, line 8
def self.parse(tags, options = ParseOptions::DEFAULT_XML, &block)
  new(XML::Document.new, tags, nil, options, &block)
end

Create a Nokogiri::XML::DocumentFragment from tags

Public Instance Methods

css *rules, [namespace-bindings, custom-pseudo-class] Show source
# File lib/nokogiri/xml/document_fragment.rb, line 105
def css(*args)
  if children.any?
    children.css(*args) # 'children' is a smell here
  else
    NodeSet.new(document)
  end
end

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

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

dup() Show source
# File lib/nokogiri/xml/document_fragment.rb, line 41
def dup
  new_document = document.dup
  new_fragment = self.class.new(new_document)
  children.each do |child|
    child.dup(1, new_document).parent = new_fragment
  end
  new_fragment
end
errors() Show source
# File lib/nokogiri/xml/document_fragment.rb, line 139
def errors
  document.errors
end

A list of Nokogiri::XML::SyntaxError found when parsing a document

fragment(data) Show source
# File lib/nokogiri/xml/document_fragment.rb, line 147
def fragment(data)
  document.fragment(data)
end
name() Show source
# File lib/nokogiri/xml/document_fragment.rb, line 53
def name
  "#document-fragment"
end

return the name for DocumentFragment

# File lib/nokogiri/xml/document_fragment.rb, line 124
def search(*rules)
  rules, handler, ns, binds = extract_params(rules)

  rules.inject(NodeSet.new(document)) do |set, rule|
    set + if Searchable::LOOKS_LIKE_XPATH.match?(rule)
      xpath(*[rule, ns, handler, binds].compact)
    else
      children.css(*[rule, ns, handler].compact) # 'children' is a smell here
    end
  end
end

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

For more information see Nokogiri::XML::Searchable#search

serialize()
Alias for: to_s
to_html(*args) Show source
# File lib/nokogiri/xml/document_fragment.rb, line 66
def to_html(*args)
  if Nokogiri.jruby?
    options = args.first.is_a?(Hash) ? args.shift : {}
    unless options[:save_with]
      options[:save_with] = Node::SaveOptions::NO_DECLARATION | Node::SaveOptions::NO_EMPTY_TAGS | Node::SaveOptions::AS_HTML
    end
    args.insert(0, options)
  end
  children.to_html(*args)
end

Convert this DocumentFragment to html See Nokogiri::XML::NodeSet#to_html

to_s() Show source
# File lib/nokogiri/xml/document_fragment.rb, line 59
def to_s
  children.to_s
end

Convert this DocumentFragment to a string

Also aliased as: serialize
to_xhtml(*args) Show source
# File lib/nokogiri/xml/document_fragment.rb, line 80
def to_xhtml(*args)
  if Nokogiri.jruby?
    options = args.first.is_a?(Hash) ? args.shift : {}
    unless options[:save_with]
      options[:save_with] = Node::SaveOptions::NO_DECLARATION | Node::SaveOptions::NO_EMPTY_TAGS | Node::SaveOptions::AS_XHTML
    end
    args.insert(0, options)
  end
  children.to_xhtml(*args)
end

Convert this DocumentFragment to xhtml See Nokogiri::XML::NodeSet#to_xhtml

to_xml(*args) Show source
# File lib/nokogiri/xml/document_fragment.rb, line 94
def to_xml(*args)
  children.to_xml(*args)
end

Convert this DocumentFragment to xml See Nokogiri::XML::NodeSet#to_xml

© 2008–2018 Aaron Patterson, Mike Dalessio, Charles Nutter, Sergio Arbeo,
Patrick Mahoney, Yoko Harada, Akinori MUSHA, John Shahid, Lars Kanis
Licensed under the MIT License.
https://nokogiri.org/rdoc/Nokogiri/XML/DocumentFragment.html