Module: Hpricot::Builder

Defined in:
lib/ext/hpricot/builder.rb

Constant Summary

@@default =
{
  :indent => 0,
  :output_helpers => true,
  :output_xml_instruction => true,
  :output_meta_tag => true,
  :auto_validation => true,
  :tagset => Hpricot::XHTMLTransitional,
  :root_attributes => {
    :xmlns => 'http://www.w3.org/1999/xhtml', :xml:lang' => 'en', :lang => 'en'
  }
}

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Object) set(option, value)



37
38
39
# File 'lib/ext/hpricot/builder.rb', line 37

def self.set(option, value)
  @@default[option] = value
end

Instance Method Details

- (Object) add_child(ele)



41
42
43
44
45
46
# File 'lib/ext/hpricot/builder.rb', line 41

def add_child ele
  ele.parent = self
  self.children ||= []
  self.children << ele
  ele
end

- (Object) build(*a, &b)



120
121
122
# File 'lib/ext/hpricot/builder.rb', line 120

def build(*a, &b)
  Hpricot.build(*a, &b)
end

- (Object) doctype(target, pub, sys)



148
149
150
# File 'lib/ext/hpricot/builder.rb', line 148

def doctype(target, pub, sys)
  add_child DocType.new(target, pub, sys)
end

- (Object) head(*args, &block)

Builds a head tag. Adds a meta tag inside with Content-Type set to text/html; charset=utf-8.



156
157
158
159
160
161
# File 'lib/ext/hpricot/builder.rb', line 156

def head(*args, &block)
  tag!(:head, *args) do
    tag!(:meta, "http-equiv" => "Content-Type", "content" => "text/html; charset=utf-8") if @output_meta_tag
    instance_eval(&block)
  end
end

- (Object) html_tag(sym, *args, &block)

Every HTML tag method goes through an html_tag call. So, calling div is equivalent to calling html_tag(:div). All HTML tags in Hpricot's list are given generated wrappers for this method.

If the @auto_validation setting is on, this method will check for many common mistakes which could lead to invalid XHTML.



130
131
132
133
134
135
136
137
138
# File 'lib/ext/hpricot/builder.rb', line 130

def html_tag(sym, *args, &block)
  if @auto_validation and @tagset.self_closing.include?(sym) and block
    raise InvalidXhtmlError, "the `#{sym}' element is self-closing, please remove the block"
  elsif args.empty? and block.nil?
    CssProxy.new(self, sym)
  else
    tag!(sym, *args, &block)
  end
end

- (Object) tag!(tag, *args, &block)

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



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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# File 'lib/ext/hpricot/builder.rb', line 63

def tag!(tag, *args, &block)
  ele_id = nil
  if @auto_validation and @tagset
      if !@tagset.tagset.has_key?(tag)
          raise InvalidXhtmlError, "no element `#{tag}' for #{tagset.doctype}"
      elsif args.last.respond_to?(:to_hash)
          attrs = args.last.to_hash

          if @tagset.forms.include?(tag) and attrs[:id]
            attrs[:name] ||= attrs[:id]
          end

          attrs.each do |k, v|
              atname = k.to_s.downcase.intern
              unless k =~ /:/ or @tagset.tagset[tag].include? atname
                  raise InvalidXhtmlError, "no attribute `#{k}' on #{tag} elements"
              end
              if atname == :id
                  ele_id = v.to_s
                  if @elements.has_key? ele_id
                      raise InvalidXhtmlError, "id `#{ele_id}' already used (id's must be unique)."
                  end
              end
          end
      end
  end

  # turn arguments into children or attributes
  childs = []
  attrs = args.grep(Hash)
  childs.concat((args - attrs).flatten.map do |x|
    if x.respond_to? :to_html
      Hpricot.make(x.to_html)
    elsif x
      Text.new(x)
    end
  end.flatten)
  attrs = attrs.inject({}) do |hsh, ath|
    ath.each do |k, v|
      hsh[k] = v.to_s if v
    end
    hsh
  end

  # create the element itself
  tag = tag.to_s
  f = Elem.new(tag, attrs, childs, ETag.new(tag))

  # build children from the block
  if block
    build(f, &block)
  end

  add_child f
  f
end

- (Object) text(string) Also known as: <<, concat

Write a string to the HTML stream without escaping it.



54
55
56
57
# File 'lib/ext/hpricot/builder.rb', line 54

def text(string)
  add_child Text.new(string)
  nil
end

- (Object) text!(string)

Write a string to the HTML stream, making sure to escape it.



49
50
51
# File 'lib/ext/hpricot/builder.rb', line 49

def text!(string)
  add_child Text.new(string)
end

- (Object) xhtml_strict(attrs = {}, &block)

Builds an html tag with XHTML 1.0 Strict doctype instead.



172
173
174
175
# File 'lib/ext/hpricot/builder.rb', line 172

def xhtml_strict(attrs = {}, &block)
  # self.tagset = Hpricot::XHTMLStrict
  xhtml_html(attrs, &block)
end

- (Object) xhtml_transitional(attrs = {}, &block)

Builds an html tag. An XML 1.0 instruction and an XHTML 1.0 Transitional doctype are prepended. Also assumes :xmlns => "http://www.w3.org/1999/xhtml", :lang => "en".



166
167
168
169
# File 'lib/ext/hpricot/builder.rb', line 166

def xhtml_transitional(attrs = {}, &block)
  # self.tagset = Hpricot::XHTMLTransitional
  xhtml_html(attrs, &block)
end