Class: REXML::Document
- 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
- @@entity_expansion_limit =
10_000
Constants inherited from Element
Constants included from Namespace
Constants included from XMLTokens
XMLTokens::NAME, XMLTokens::NAMECHAR, XMLTokens::NAME_STR, XMLTokens::NCNAME_STR, XMLTokens::NMTOKEN, XMLTokens::NMTOKENS, XMLTokens::REFERENCE
Instance Attribute Summary collapse
-
#entity_expansion_count ⇒ Object
readonly
Returns the value of attribute entity_expansion_count.
Attributes inherited from Element
#attributes, #context, #elements
Attributes included from Namespace
Attributes inherited from Child
Class Method Summary collapse
-
.entity_expansion_limit ⇒ Object
Get the entity expansion limit.
-
.entity_expansion_limit=(val) ⇒ Object
Set the entity expansion limit.
- .parse_stream(source, listener) ⇒ Object
Instance Method Summary collapse
-
#add(child) ⇒ Object
(also: #<<)
We override this, because XMLDecls and DocTypes must go at the start of the document.
- #add_element(arg = nil, arg2 = nil) ⇒ Object
-
#clone ⇒ Object
Should be obvious.
-
#doctype ⇒ Object
and nil otherwise.
-
#encoding ⇒ Object
Encoding object.
-
#expanded_name ⇒ Object
(also: #name)
According to the XML spec, a root node has no expanded name.
-
#initialize(source = nil, context = {}) ⇒ Document
constructor
Constructor Documents have their context and Element attributes cloned.
- #node_type ⇒ Object
- #record_entity_expansion ⇒ Object
-
#root ⇒ Object
has no children.
-
#stand_alone? ⇒ Boolean
If no XMLDecl has been set, returns the default setting.
-
#version ⇒ Object
If no XMLDecl has been set, returns the default version.
-
#write(output = $stdout, indent = -1,, transitive = false, ie_hack = false) ⇒ Object
Write the XML tree out, optionally with indent.
-
#xml_decl ⇒ Object
set, the default declaration is returned.
Methods inherited from Element
#add_attribute, #add_attributes, #add_namespace, #add_text, #attribute, #cdatas, #comments, #delete_attribute, #delete_element, #delete_namespace, #document, #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, #document, #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.
34 35 36 37 38 39 40 41 42 43 44 45 |
# File 'lib/rexml/document.rb', line 34 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
220 221 222 |
# File 'lib/rexml/document.rb', line 220 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.
216 217 218 |
# File 'lib/rexml/document.rb', line 216 def Document::entity_expansion_limit return @@entity_expansion_limit 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
67 68 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 |
# File 'lib/rexml/document.rb', line 67 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
100 101 102 103 104 |
# File 'lib/rexml/document.rb', line 100 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
52 53 54 |
# File 'lib/rexml/document.rb', line 52 def clone Document.new self end |
#doctype ⇒ Object
and nil otherwise.
116 117 118 |
# File 'lib/rexml/document.rb', line 116 def doctype @children.find { |item| item.kind_of? DocType } end |
#encoding ⇒ Object
Encoding object. If no XMLDecl has been set, returns the default encoding.
137 138 139 |
# File 'lib/rexml/document.rb', line 137 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
57 58 59 60 61 |
# File 'lib/rexml/document.rb', line 57 def '' #d = doc_type #d ? d.name : "UNDEFINED" end |
#node_type ⇒ Object
47 48 49 |
# File 'lib/rexml/document.rb', line 47 def node_type :document end |
#record_entity_expansion ⇒ Object
222 223 224 225 226 227 |
# File 'lib/rexml/document.rb', line 222 def record_entity_expansion @entity_expansion_count += 1 if @entity_expansion_count > @@entity_expansion_limit raise "number of entity expansions exceeded, processing aborted." end end |
#root ⇒ Object
has no children.
108 109 110 111 112 |
# File 'lib/rexml/document.rb', line 108 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.
143 144 145 |
# File 'lib/rexml/document.rb', line 143 def stand_alone? xml_decl().stand_alone? end |
#version ⇒ Object
If no XMLDecl has been set, returns the default version.
130 131 132 |
# File 'lib/rexml/document.rb', line 130 def version xml_decl().version end |
#write(output = $stdout, indent = -1,, transitive = false, ie_hack = false) ⇒ Object
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.
See also the classes in the rexml/formatters package for the proper way to change the default formatting of XML output
Examples
Document.new("<a><b/></a>").serialize
output_string = ""
tr = Transitive.new( output_string )
Document.new("<a><b/></a>").serialize( tr )
- 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
-
Internet Explorer is the worst piece of crap to have ever been written, with the possible exception of Windows itself. Since IE is unable to parse proper XML, we have to provide a hack to generate XML that IE's limited abilities can handle. This hack inserts a space before the /> on empty tags. Defaults to false
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'lib/rexml/document.rb', line 186 def write( output=$stdout, indent=-1, transitive=false, ie_hack=false ) if xml_decl.encoding != 'UTF-8' && !output.kind_of?(Output) output = Output.new( output, xml_decl.encoding ) end formatter = if indent > -1 if transitive require "rexml/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 |