Module: Erector::Convenience

Included in:
AbstractWidget, HTMLWidget, Widget
Defined in:
lib/erector/convenience.rb

Instance Method Summary collapse

Instance Method Details

#css(href, options = {}) ⇒ Object

Convenience method to emit a css file link, which looks like this: <link href=“erector.css” rel=“stylesheet” type=“text/css” /> The parameter is the full contents of the href attribute, including any “.css” extension.

If you want to emit raw CSS inline, use the #style method instead.



50
51
52
 
# File 'lib/erector/convenience.rb', line 50

def css(href, options = {})
  link({:rel => 'stylesheet', :type => 'text/css', :href => href}.merge(options))
end

#dom_id ⇒ Object

makes a unique id based on the widget’s class name and object id that you can use as the HTML id of an emitted element



94
95
96
 
# File 'lib/erector/convenience.rb', line 94

def dom_id
  "#{self.class.name.gsub(/:+/,"_")}_#{self.object_id}"
end

#javascript(value = nil, attributes = {}) ⇒ Object

Emits a javascript block inside a script tag, wrapped in CDATA doohickeys like all the cool JS kids do.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/erector/convenience.rb', line 62

def javascript(value = nil, attributes = {})
  if value.is_a?(Hash)
    attributes = value
    value      = nil
  elsif block_given? && value
    raise ArgumentError, "You can't pass both a block and a value to javascript -- please choose one."
  end

  script(attributes.merge(:type => "text/javascript")) do
    # Shouldn't this be a "cdata" HtmlPart?
    # (maybe, but the syntax is specific to javascript; it isn't
    # really a generic XML CDATA section.  Specifically,
    # ]]> within value is not treated as ending the
    # CDATA section by Firefox2 when parsing text/html,
    # although I guess we could refuse to generate ]]>
    # there, for the benefit of XML/XHTML parsers).
    output << raw("\n// <![CDATA[\n")
    if block_given?
      yield
    else
      output << raw(value)
    end
    output << raw("\n// ]]>")
    output.append_newline # this forces a newline even if we're not in pretty mode
  end

  output << raw("\n")
end

#join(array, separator) ⇒ Object

Emits the result of joining the elements in array with the separator. The array elements and separator can be Erector::Widget objects, which are rendered, or strings, which are html-escaped and output.



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/erector/convenience.rb', line 26

def join(array, separator)
  first = true
  array.each do |item|
    if !first
      if separator.is_a? Widget
        widget separator
      else
        text separator
      end
    end
    first = false
    if item.is_a? Widget
      widget item
    else
      text item
    end
  end
end

#to_pretty(options = {}) ⇒ Object

Render (like to_html) but adding newlines and indentation. You may just want to call to_html(:prettyprint => true) so you can pass in other rendering options as well.



6
7
8
 
# File 'lib/erector/convenience.rb', line 6

def to_pretty(options = {})
  emit(options.merge(:prettyprint => true))
end

#to_text(options = {}) ⇒ Object

Render (like to_html) but stripping all tags and inserting some appropriate formatting. Currently we format p, br, ol, ul, and li tags.



13
14
15
16
17
18
19
20
21
 
# File 'lib/erector/convenience.rb', line 13

def to_text(options = {})
  # TODO: make text output a first class rendering strategy, like HTML is now,
  # so we can do things like nested lists and numbered lists
  html = to_html(options.merge(:prettyprint => false))
  html.gsub!(/^<p[^>]*>/m, '')
  html.gsub!(/(<(ul|ol)>)?<li>/, "\n* ")
  html.gsub!(/<(\/?(ul|ol|p|br))[^>]*( \/)?>/, "\n")
  CGI.unescapeHTML(html.gsub(/<[^>]*>/, ''))
end

#url(href, options = {}) ⇒ Object

Convenience method to emit an anchor tag whose href and text are the same, e.g. <a href=“example.com”>example.com</a>



56
57
58
 
# File 'lib/erector/convenience.rb', line 56

def url(href, options = {})
  a href, ({:href => href}.merge(options))
end