Extended maintenance of Ruby versions 1.8.7 and 1.9.2 ended on July 31, 2014. Read more

In Files

  • rexml/formatters/transitive.rb

Class/Module Index [+]



The Transitive formatter writes an XML document that parses to an identical document as the source document. This means that no extra whitespace nodes are inserted, and whitespace within text nodes is preserved. Within these constraints, the document is pretty-printed, with whitespace inserted into the metadata to introduce formatting.

Note that this is only useful if the original XML is not already formatted. Since this formatter does not alter whitespace nodes, the results of formatting already formatted XML will be odd.

Public Class Methods

new( indentation=2 ) click to toggle source
               # File rexml/formatters/transitive.rb, line 15
def initialize( indentation=2 )
  @indentation = indentation
  @level = 0

Protected Instance Methods

write_element( node, output ) click to toggle source
               # File rexml/formatters/transitive.rb, line 21
def write_element( node, output )
  output << "<#{node.expanded_name}"

  node.attributes.each_attribute do |attr|
    output << " "
    attr.write( output )
  end unless node.attributes.empty?

  output << "\n"
  output << ' '*@level
  if node.children.empty?
    output << "/" 
    output << ">"
    # If compact and all children are text, and if the formatted output
    # is less than the specified width, then try to print everything on
    # one line
    skip = false
    @level += @indentation
    node.children.each { |child|
      write( child, output )
    @level -= @indentation
    output << "</#{node.expanded_name}"
    output << "\n"
    output << ' '*@level
  output << ">"
write_text( node, output ) click to toggle source
               # File rexml/formatters/transitive.rb, line 51
def write_text( node, output )
  output << node.to_s()

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.

blog comments powered by Disqus