Class: Wunderbar::XmlMarkup

Inherits:
BuilderClass show all
Defined in:
lib/wunderbar/builder.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BuilderClass

#websocket

Methods inherited from BuilderBase

#get_binding, #set_variables_from_params

Constructor Details

#initialize(args = {}) ⇒ XmlMarkup

Returns a new instance of XmlMarkup.



128
129
130
131
132
133
134
135
136
137
 
# File 'lib/wunderbar/builder.rb', line 128

def initialize(args={})
  @_scope = args.delete(:scope)
  @_indent = args.delete(:indent) || Wunderbar.option[:indent]
  @_width = args.delete(:width) || Wunderbar.option[:width]
  @_pdf = false
  @doc = Node.new(nil)
  @node = @doc
  @indentation_enabled = true
  @spaced = false
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *args, &block) ⇒ Object

forward to Wunderbar or @_scope



142
143
144
145
146
147
148
149
150
 
# File 'lib/wunderbar/builder.rb', line 142

def method_missing(method, *args, &block)
  if Wunderbar.respond_to? method
    Wunderbar.send method, *args, &block
  elsif @_scope and @_scope.respond_to? method
    @_scope.send method, *args, &block
  else
    super
  end
end

Instance Attribute Details

#_width ⇒ Object

Returns the value of attribute _width.



139
140
141
 
# File 'lib/wunderbar/builder.rb', line 139

def _width
  @_width
end

Class Method Details

.dump(content, args = {}) ⇒ Object

convenience method for taking an XML node or string and formatting it



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/wunderbar/builder.rb', line 109

def self.dump(content, args={})
  markup = self.new(args)

  if Nokogiri::XML::Document === content and content.root.name == 'html'
    markup.declare! :DOCTYPE, :html
  end

  unless Nokogiri::XML::Node === content
    if defined? Nokogiri::HTML5.fragment
      content = Nokogiri::HTML5.fragment(content.to_s)
    else
      content = Nokogiri::HTML.fragment(content.to_s)
    end
  end

  markup[content]
  markup.target!
end

Instance Method Details

#<<(data) ⇒ Object

insert verbatim



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/wunderbar/builder.rb', line 285

def <<(data)
  if defined? Nokogiri
    if not String === data or data.include? '<' or data.include? '&'
      # https://github.com/google/gumbo-parser/issues/266
      data = Nokogiri::HTML::fragment(data.to_s).to_xml

      # fix CDATA in most cases (notably scripts)
      data.gsub!(/<!\[CDATA\[(.*?)\]\]>/m) do
        if $1.include? '<' or $1.include? '&'
          "//<![CDATA[\n#{$1}\n//]]>"
        else
          $1
        end
      end

      # fix CDATA for style elements
      data.gsub!(/<style([^>])*>\/\/<!\[CDATA\[\n(.*?)\s+\/\/\]\]>/m) do
        if $2.include? '<' or $2.include? '&'
          "<style#{$1}>/*<![CDATA[*/\n#{$2.gsub("\n\Z",'')}\n/*]]>*/"
        else
          $1
        end
      end
    end
  end

  if String === data
    @node.children << data
  else
    @node.add_child data
  end
end

#[](*children) ⇒ Object 



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/wunderbar/builder.rb', line 318

def [](*children)
  if children.length == 1
    if children.first.respond_to? :root
      children = [children.first.root]
    elsif defined? Nokogiri::XML::DocumentFragment and
      Nokogiri::XML::DocumentFragment === children.first
    then
      children = children.first.children
    end
  end

  # remove leading and trailing space
  if children.first.text? and children.first.text.strip.empty?
    children.shift
  end

  if not children.empty?
    children.pop if children.last.text? and children.last.text.strip.empty?
  end

  children.map do |child|
    if child.text? or child.cdata?
      text = child.text
      if not @indentation_enabled
        text! text
      elsif text.strip.empty?
        text! "" if text.count("\n")>1
      else
        indented_text! text
      end
    elsif child.comment?
      comment! child.text.sub(/\A /,'').sub(/ \Z/, '')
    elsif HtmlMarkup.flatten? child.children
      # disable indentation on the entire element
      compact! { tag!(child) {self[*child.children]} }
    elsif child.children.empty? and HtmlMarkup::VOID.include? child.name
      tag!(child)
    elsif child.children.all?(&:text?)
      tag!(child, child.text.strip)
    elsif child.children.any?(&:cdata?) and child.text =~ /[<&]/
      self << child
    elsif child.name == 'pre'
      compact! { tag!(child) {self[*child.children]} }
    elsif child.name == 'head'
      head = tag!(child) {self[*child.children]}
      html = @doc.children.last
      if html.name == :html
        head.parent.children.pop
        html.children.unshift head
        head.parent = html
      end
      head
    else
      tag!(child) {self[*child.children]}
    end
  end
end

#clear! ⇒ Object 



188
189
190
191
 
# File 'lib/wunderbar/builder.rb', line 188

def clear!
  @doc.children.clear
  @node = @doc
end

#comment!(text) ⇒ Object 



172
173
174
 
# File 'lib/wunderbar/builder.rb', line 172

def comment! text
  @node.children << CommentNode.new(text)
end

#compact!(&block) ⇒ Object 



193
194
195
196
197
198
199
200
 
# File 'lib/wunderbar/builder.rb', line 193

def compact!(&block)
  begin
    indentation_enabled, @indentation_enabled = @indentation_enabled, false
    block.call
  ensure
    @indentation_enabled = indentation_enabled
  end
end

#declare!(*args) ⇒ Object 



168
169
170
 
# File 'lib/wunderbar/builder.rb', line 168

def declare! *args
  @node.children << DocTypeNode.new(*args)
end

#indented_text!(text) ⇒ Object 



176
177
178
179
180
181
182
 
# File 'lib/wunderbar/builder.rb', line 176

def indented_text!(text)
  return if text.length == 0 and not @spaced
  text = IndentedTextNode.new(text)
  text.extend SpacedNode if @spaced
  @node.children << text
  @spaced = false
end

#methods ⇒ Object 



152
153
154
155
156
 
# File 'lib/wunderbar/builder.rb', line 152

def methods
  result = super + Wunderbar.methods
  result += @_scope.methods if @_scope
  result.uniq
end

#pdf=(value) ⇒ Object 



262
263
264
 
# File 'lib/wunderbar/builder.rb', line 262

def pdf=(value)
  @_pdf = value
end

#pdf? ⇒ Boolean

Returns:

  • (Boolean) 


266
267
268
 
# File 'lib/wunderbar/builder.rb', line 266

def pdf?
  @_pdf
end

#respond_to?(method) ⇒ Boolean

Returns:

  • (Boolean) 


158
159
160
161
162
 
# File 'lib/wunderbar/builder.rb', line 158

def respond_to?(method)
  respond true if Wunderbar.respond_to? method
  respond true if @_scope and @_scope.respond_to? method
  super
end

#spaced! ⇒ Object 



202
203
204
 
# File 'lib/wunderbar/builder.rb', line 202

def spaced!
  @spaced = true
end

#system(command, opts = {}) ⇒ Object

execute a system command, echoing stdin, stdout, and stderr



271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/wunderbar/builder.rb', line 271

def system(command, opts={})
  tag  = opts[:tag]  || 'pre'
  output_class = opts[:class] || {}
  output_class[:stdin]  ||= '_stdin'
  output_class[:stdout] ||= '_stdout'
  output_class[:stderr] ||= '_stderr'
  output_class[:hilite] ||= '_stdout _hilite'

  super do |kind, line|
    tag! tag, line, class: output_class[kind]
  end
end

#tag!(sym, *args, &block) ⇒ Object

avoid method_missing overhead for the most common case



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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/wunderbar/builder.rb', line 207

def tag!(sym, *args, &block)
  current_node = @node

  if sym.respond_to? :children
    node = sym
    attributes = node.attributes
    if node.attribute_nodes.any?(&:namespace)
      attributes = Hash[node.attribute_nodes.map { |attr| 
        name = attr.name
        name = "#{attr.namespace.prefix}:#{name}" if attr.namespace
        [name, attr.value]
      }]
    end

    attributes.merge!(node.namespaces) if node.namespaces
    args.push attributes
    if node.namespace and node.namespace.prefix
      sym = "#{node.namespace.prefix}:#{node.name}"
    else
      sym = node.name
    end

    unless Class === args.first
      args.unshift PreformattedNode if sym == 'pre'
      args.unshift ScriptNode if sym == 'script'
      args.unshift StyleNode if sym == 'style'
    end
  end

  if Class === args.first and args.first < Node
    node = args.shift.new sym, *args
  else
    node = Node.new sym, *args
  end

  node.extend CompactNode unless @indentation_enabled

  if @spaced
    node.extend SpacedNode
    @spaced = false
  end

  node.text = args.first if String === args.first
  @node.add_child node
  @node = node
  if block
    block.call(self)
    @node.children << nil if @node.children.empty?
  end

  node
ensure
  @node = current_node
end

#target! ⇒ Object 



184
185
186
 
# File 'lib/wunderbar/builder.rb', line 184

def target!
  "#{@doc.serialize(indent: ' ' * @_indent, width: @_width).join("\n")}\n"
end

#text!(text) ⇒ Object 



164
165
166
 
# File 'lib/wunderbar/builder.rb', line 164

def text! text
  @node.children << TextNode.new(text)
end