Class: REXML::Document

Inherits:
Element show all
Defined in:
lib/rexml/document.rb

Overview

Represents a full XML document, including PIs, a doctype, etc. A Document has a single child that can be accessed by root(). Note that if you want to have an XML declaration written for a document you create, you must add one; REXML documents do not write a default declaration for you. See |DECLARATION| and |write|.

Constant Summary collapse

DECLARATION =

A convenient default XML declaration. If you want an XML declaration, the easiest way to add one is mydoc << Document::DECLARATION DEPRECATED Use: mydoc << XMLDecl.default

XMLDecl.default

Constants inherited from Element

Element::UNDEFINED

Constants included from Namespace

Namespace::NAMESPLIT

Constants included from XMLTokens

XMLTokens::NAME, XMLTokens::NAMECHAR, XMLTokens::NAME_CHAR, XMLTokens::NAME_START_CHAR, XMLTokens::NAME_STR, XMLTokens::NCNAME_STR, XMLTokens::NMTOKEN, XMLTokens::NMTOKENS, XMLTokens::REFERENCE

Instance Attribute Summary collapse

Attributes inherited from Element

#attributes, #context, #elements

Attributes included from Namespace

#prefix

Attributes inherited from Child

#parent

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Element

#[], #add_attribute, #add_attributes, #add_namespace, #add_text, #attribute, #cdatas, #comments, #delete_attribute, #delete_element, #delete_namespace, #each_element, #each_element_with_attribute, #each_element_with_text, #get_elements, #get_text, #has_attributes?, #has_elements?, #has_text?, #ignore_whitespace_nodes, #inspect, #instructions, #namespace, #namespaces, #next_element, #prefixes, #previous_element, #raw, #root_node, #text, #text=, #texts, #whitespace, #xpath

Methods included from Namespace

#fully_expanded_name, #has_name?

Methods inherited from Parent

#[], #[]=, #deep_clone, #delete, #delete_at, #delete_if, #each, #each_index, #index, #insert_after, #insert_before, #parent?, #replace_child, #size, #to_a, #unshift

Methods inherited from Child

#bytes, #next_sibling=, #previous_sibling=, #remove, #replace_with

Methods included from Node

#each_recursive, #find_first_recursive, #indent, #index_in_parent, #next_sibling_node, #parent?, #previous_sibling_node, #to_s

Constructor Details

#initialize(source = nil, context = {}) ⇒ Document

Constructor Documents have their context and Element attributes cloned. Strings are expected to be valid XML documents. IOs are expected to be sources of valid XML documents. this should be a Hash.

Parameters:

  • source (defaults to: nil) —

    if supplied, must be a Document, String, or IO.

  • context (defaults to: {}) —

    if supplied, contains the context of the document;



36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/rexml/document.rb', line 36

def initialize( source = nil, context = {} )
  @entity_expansion_count = 0
  super()
  @context = context
  return if source.nil?
  if source.kind_of? Document
    @context = source.context
    super source
  else
    build(  source )
  end
end

Instance Attribute Details

#entity_expansion_count ⇒ Object (readonly)

Returns the value of attribute entity_expansion_count.



273
274
275
 
# File 'lib/rexml/document.rb', line 273

def entity_expansion_count
  @entity_expansion_count
end

Class Method Details

.entity_expansion_limit ⇒ Object

Get the entity expansion limit. By default the limit is set to 10000.

Deprecated. Use REXML::Security.entity_expansion_limit= instead.



255
256
257
 
# File 'lib/rexml/document.rb', line 255

def Document::entity_expansion_limit
  return Security.entity_expansion_limit
end

.entity_expansion_limit=(val) ⇒ Object

Set the entity expansion limit. By default the limit is set to 10000.

Deprecated. Use REXML::Security.entity_expansion_limit= instead.



248
249
250
 
# File 'lib/rexml/document.rb', line 248

def Document::entity_expansion_limit=( val )
  Security.entity_expansion_limit = val
end

.entity_expansion_text_limit ⇒ Object

Get the entity expansion limit. By default the limit is set to 10240.

Deprecated. Use REXML::Security.entity_expansion_text_limit instead.



269
270
271
 
# File 'lib/rexml/document.rb', line 269

def Document::entity_expansion_text_limit
  return Security.entity_expansion_text_limit
end

.entity_expansion_text_limit=(val) ⇒ Object

Set the entity expansion limit. By default the limit is set to 10240.

Deprecated. Use REXML::Security.entity_expansion_text_limit= instead.



262
263
264
 
# File 'lib/rexml/document.rb', line 262

def Document::entity_expansion_text_limit=( val )
  Security.entity_expansion_text_limit = val
end

.parse_stream(source, listener) ⇒ Object 



241
242
243
 
# File 'lib/rexml/document.rb', line 241

def Document::parse_stream( source, listener )
  Parsers::StreamParser.new( source, listener ).parse
end

Instance Method Details

#add(child) ⇒ Object Also known as: <<

We override this, because XMLDecls and DocTypes must go at the start of the document



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/rexml/document.rb', line 69

def add( child )
  if child.kind_of? XMLDecl
    if @children[0].kind_of? XMLDecl
      @children[0] = child
    else
      @children.unshift child
    end
    child.parent = self
  elsif child.kind_of? DocType
    # Find first Element or DocType node and insert the decl right
    # before it.  If there is no such node, just insert the child at the
    # end.  If there is a child and it is an DocType, then replace it.
    insert_before_index = @children.find_index { |x|
      x.kind_of?(Element) || x.kind_of?(DocType)
    }
    if insert_before_index # Not null = not end of list
      if @children[ insert_before_index ].kind_of? DocType
        @children[ insert_before_index ] = child
      else
        @children[ insert_before_index-1, 0 ] = child
      end
    else  # Insert at end of list
      @children << child
    end
    child.parent = self
  else
    rv = super
    raise "attempted adding second root element to document" if @elements.size > 1
    rv
  end
end

#add_element(arg = nil, arg2 = nil) ⇒ Object 



102
103
104
105
106
 
# File 'lib/rexml/document.rb', line 102

def add_element(arg=nil, arg2=nil)
  rv = super
  raise "attempted adding second root element to document" if @elements.size > 1
  rv
end

#clone ⇒ Object

Should be obvious



54
55
56
 
# File 'lib/rexml/document.rb', line 54

def clone
  Document.new self
end

#doctype ⇒ Object

and nil otherwise.

Returns:

  • the DocType child of the document, if one exists,



118
119
120
 
# File 'lib/rexml/document.rb', line 118

def doctype
  @children.find { |item| item.kind_of? DocType }
end

#document ⇒ Object 



282
283
284
 
# File 'lib/rexml/document.rb', line 282

def document
  self
end

#encoding ⇒ Object

Encoding object. If no XMLDecl has been set, returns the default encoding.

Returns:

  • the XMLDecl encoding of this document as an



139
140
141
 
# File 'lib/rexml/document.rb', line 139

def encoding
  xml_decl().encoding
end

#expanded_name ⇒ Object Also known as: name

According to the XML spec, a root node has no expanded name



59
60
61
62
63
 
# File 'lib/rexml/document.rb', line 59

def expanded_name
  ''
  #d = doc_type
  #d ? d.name : "UNDEFINED"
end

#node_type ⇒ Object 



49
50
51
 
# File 'lib/rexml/document.rb', line 49

def node_type
  :document
end

#record_entity_expansion ⇒ Object 



275
276
277
278
279
280
 
# File 'lib/rexml/document.rb', line 275

def record_entity_expansion
  @entity_expansion_count += 1
  if @entity_expansion_count > Security.entity_expansion_limit
    raise "number of entity expansions exceeded, processing aborted."
  end
end

#root ⇒ Object

has no children.

Returns:

  • the root Element of the document, or nil if this document



110
111
112
113
114
 
# File 'lib/rexml/document.rb', line 110

def root
  elements[1]
  #self
  #@children.find { |item| item.kind_of? Element }
end

#stand_alone? ⇒ Boolean

If no XMLDecl has been set, returns the default setting.

Returns:

  • (Boolean) —

    the XMLDecl standalone value of this document as a String.



145
146
147
 
# File 'lib/rexml/document.rb', line 145

def stand_alone?
  xml_decl().stand_alone?
end

#version ⇒ Object

If no XMLDecl has been set, returns the default version.

Returns:

  • the XMLDecl version of this document as a String.



132
133
134
 
# File 'lib/rexml/document.rb', line 132

def version
  xml_decl().version
end

#write(*arguments) ⇒ Object

:call-seq:

doc.write(output=$stdout, indent=-1, transtive=false, ie_hack=false, encoding=nil)
doc.write(options={:output => $stdout, :indent => -1, :transtive => false, :ie_hack => false, :encoding => nil})

Write the XML tree out, optionally with indent. This writes out the entire XML document, including XML declarations, doctype declarations, and processing instructions (if any are given).

A controversial point is whether Document should always write the XML declaration (<?xml version=‘1.0’?>) whether or not one is given by the user (or source document). REXML does not write one if one was not specified, because it adds unnecessary bandwidth to applications such as XML-RPC.

Accept Nth argument style and options Hash style as argument. The recommended style is options Hash style for one or more arguments case.

Examples

Document.new("<a><b/></a>").write

output = ""
Document.new("<a><b/></a>").write(output)

output = ""
Document.new("<a><b/></a>").write(:output => output, :indent => 2)

See also the classes in the rexml/formatters package for the proper way to change the default formatting of XML output.

Examples

output = ""
tr = Transitive.new
tr.write(Document.new("<a><b/></a>"), output)
output

output an object which supports ‘<< string’; this is where the document will be written.

indent

An integer. If -1, no indenting will be used; otherwise, the indentation will be twice this number of spaces, and children will be indented an additional amount. For a value of 3, every item will be indented 3 more levels, or 6 more spaces (2 * 3). Defaults to -1

transitive

If transitive is true and indent is >= 0, then the output will be pretty-printed in such a way that the added whitespace does not affect the absolute value of the document – that is, it leaves the value and number of Text nodes in the document unchanged.

ie_hack

This hack inserts a space before the /> on empty tags to address a limitation of Internet Explorer. Defaults to false

encoding

Encoding name as String. Change output encoding to specified encoding instead of encoding in XML declaration. Defaults to nil. It means encoding in XML declaration is used.



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/rexml/document.rb', line 205

def write(*arguments)
  if arguments.size == 1 and arguments[0].class == Hash
    options = arguments[0]

    output     = options[:output]
    indent     = options[:indent]
    transitive = options[:transitive]
    ie_hack    = options[:ie_hack]
    encoding   = options[:encoding]
  else
    output, indent, transitive, ie_hack, encoding, = *arguments
  end

  output   ||= $stdout
  indent   ||= -1
  transitive = false if transitive.nil?
  ie_hack    = false if ie_hack.nil?
  encoding ||= xml_decl.encoding

  if encoding != 'UTF-8' && !output.kind_of?(Output)
    output = Output.new( output, encoding )
  end
  formatter = if indent > -1
      if transitive
        require_relative "formatters/transitive"
        REXML::Formatters::Transitive.new( indent, ie_hack )
      else
        REXML::Formatters::Pretty.new( indent, ie_hack )
      end
    else
      REXML::Formatters::Default.new( ie_hack )
    end
  formatter.write( self, output )
end

#xml_decl ⇒ Object

set, the default declaration is returned.

Returns:

  • the XMLDecl of this document; if no XMLDecl has been



124
125
126
127
128
 
# File 'lib/rexml/document.rb', line 124

def xml_decl
  rv = @children[0]
  return rv if rv.kind_of? XMLDecl
  @children.unshift(XMLDecl.default)[0]
end