XmlBase is a base class for building XML builders. See Builder::XmlMarkup and Builder::XmlEvents for examples.

Methods
Public Class methods
new(indent=0, initial=0)

Create an XML markup builder.

out:Object receiving the markup. out must respond to <<.
indent:Number of spaces used for indentation (0 implies no indentation and no line breaks).
initial:Level of initial indentation.

[ show source ]

    # File lib/builder/xmlbase.rb, line 22
22:     def initialize(indent=0, initial=0)
23:       @indent = indent
24:       @level  = initial
25:     end
Public Instance methods
<<(text)

Append text to the output target without escaping any markup. May be used within the markup brakets as: 

  builder.p { |x| x << "<br/>HI" }   #=>  <p><br/>HI</p>

This is useful when using non-builder enabled software that generates strings. Just insert the string directly into the builder without changing the inserted markup.

It is also useful for stacking builder objects. Builders only use << to append to the target, so by supporting this method/operation builders can use other builders as their targets.

[ show source ]

     # File lib/builder/xmlbase.rb, line 98
 98:     def <<(text)
 99:       _text(text)
100:     end
method_missing(sym, *args, &block)

Create XML markup based on the name of the method. This method is never invoked directly, but is called for each markup method in the markup block.

[ show source ]

    # File lib/builder/xmlbase.rb, line 37
37:     def method_missing(sym, *args, &block)
38:       text = nil
39:       attrs = nil
40:       sym = "#{sym}:#{args.shift}" if args.first.kind_of?(Symbol)
41:       args.each do |arg|
42:         case arg
43:         when Hash
44:           attrs ||= {}
45:           attrs.merge!(arg)
46:         else
47:           text ||= ''
48:           text << arg.to_s
49:         end
50:       end
51:       if block
52:         unless text.nil?
53:           raise ArgumentError, "XmlMarkup cannot mix a text argument with a block"
54:         end
55:         _capture_outer_self(block) if @self.nil?
56:         _indent
57:         _start_tag(sym, attrs)
58:         _newline
59:         _nested_structures(block)
60:         _indent
61:         _end_tag(sym)
62:         _newline
63:       elsif text.nil?
64:         _indent
65:         _start_tag(sym, attrs, true)
66:         _newline
67:       else
68:         _indent
69:         _start_tag(sym, attrs)
70:         text! text
71:         _end_tag(sym)
72:         _newline
73:       end
74:       @target
75:     end
nil?()

For some reason, nil? is sent to the XmlMarkup object. If nil? is not defined and method_missing is invoked, some strange kind of recursion happens. Since nil? won’t ever be an XML tag, it is pretty safe to define it here. (Note: this is an example of cargo cult programming, cf. fishbowl.pastiche.org/2004/10/13/cargo_cult_programming).

[ show source ]

     # File lib/builder/xmlbase.rb, line 108
108:     def nil?
109:       false
110:     end
tag!(sym, *args, &block)

Create a tag named sym. Other than the first argument which is the tag name, the arguements are the same as the tags implemented via method_missing.

[ show source ]

    # File lib/builder/xmlbase.rb, line 30
30:     def tag!(sym, *args, &block)
31:       self.__send__(sym, *args, &block)
32:     end
text!(text)

Append text to the output target. Escape any markup. May be used within the markup brakets as: 

  builder.p { |b| b.br; b.text! "HI" }   #=>  <p><br/>HI</p>

[ show source ]

    # File lib/builder/xmlbase.rb, line 81
81:     def text!(text)
82:       _text(_escape(text))
83:     end