Module: Sinatra::MarkupPlugin::FormHelpers

Defined in:
lib/sinatra/markup_plugin/form_helpers.rb

Instance Method Summary collapse

Instance Method Details

#button_tag(caption, options = {}) ⇒ Object

Constructs a button input from the given options button_tag “Cancel”, :class => ‘clear’



142
143
144
145
 
# File 'lib/sinatra/markup_plugin/form_helpers.rb', line 142

def button_tag(caption, options = {})
  options.reverse_merge!(:value => caption)
  input_tag(:button, options)
end

#check_box_tag(name, options = {}) ⇒ Object

Constructs a check_box from the given options check_box_tag :remember_me, :value => ‘Yes’



114
115
116
117
 
# File 'lib/sinatra/markup_plugin/form_helpers.rb', line 114

def check_box_tag(name, options={})
  options.reverse_merge!(:name => name, :value => '1')
  input_tag(:checkbox, options)
end

#error_messages_for(record, options = {}) ⇒ Object

Constructs list html for the errors for a given object error_messages_for @user



45
46
47
48
49
50
51
52
53
 
# File 'lib/sinatra/markup_plugin/form_helpers.rb', line 45

def error_messages_for(record, options={})
  return "" if record.blank? or record.errors.none?
  options.reverse_merge!(:header_message => "The #{record.class.to_s.downcase} could not be saved!")
  error_messages = record.errors.full_messages
  error_items = error_messages.collect { |er| content_tag(:li, er) }.join("\n")
  error_html = content_tag(:p, options.delete(:header_message))
  error_html << content_tag(:ul, error_items, :class => 'errors-list')
  content_tag(:div, error_html, :class => 'field-errors')
end

#field_set_tag(*args, &block) ⇒ Object

Constructs a field_set to group fields with given options field_set_tag(“Office”, :class => ‘office-set’) parameters: legend_text=nil, options={}



35
36
37
38
39
40
41
 
# File 'lib/sinatra/markup_plugin/form_helpers.rb', line 35

def field_set_tag(*args, &block)
  options = args.extract_options!
  legend_text = args[0].is_a?(String) ? args.first : nil
  legend_html = legend_text.blank? ? '' : content_tag(:legend, legend_text)
  field_set_content = legend_html + capture_html(&block)
  concat_content content_tag('fieldset', field_set_content, options)
end

#fields_for(object, settings = {}, &block) ⇒ Object

Constructs form fields for an object using given or default form_builder Used within an existing form to allow alternate objects within one form fields_for @user.assignment do |assignment| … end fields_for :assignment do |assigment| … end



17
18
19
20
21
 
# File 'lib/sinatra/markup_plugin/form_helpers.rb', line 17

def fields_for(object, settings={}, &block)
  builder_class = configured_form_builder_class(settings[:builder])
  fields_html = capture_html(builder_class.new(self, object), &block)
  concat_content fields_html
end

#file_field_tag(name, options = {}) ⇒ Object

Constructs a file field input from the given options file_field_tag :photo, :class => ‘long’



128
129
130
131
 
# File 'lib/sinatra/markup_plugin/form_helpers.rb', line 128

def file_field_tag(name, options={})
  options.reverse_merge!(:name => name)
  input_tag(:file, options)
end

#form_for(object, url, settings = {}, &block) ⇒ Object

Constructs a form for object using given or default form_builder form_for :user, ‘/register’ do |f| … end form_for @user, ‘/register’, :id => ‘register’ do |f| … end



7
8
9
10
11
 
# File 'lib/sinatra/markup_plugin/form_helpers.rb', line 7

def form_for(object, url, settings={}, &block)
  builder_class = configured_form_builder_class(settings[:builder])
  form_html = capture_html(builder_class.new(self, object), &block)
  form_tag(url, settings) { form_html }
end

#form_tag(url, options = {}, &block) ⇒ Object

Constructs a form without object based on options form_tag ‘/register’ do … end



25
26
27
28
29
30
 
# File 'lib/sinatra/markup_plugin/form_helpers.rb', line 25

def form_tag(url, options={}, &block)
  options.reverse_merge!(:method => 'post', :action => url)
  options[:enctype] = "multipart/form-data" if options.delete(:multipart)
  inner_form_html = hidden_form_method_field(options[:method]) + capture_html(&block)
  concat_content content_tag('form', inner_form_html, options)
end

#hidden_field_tag(name, options = {}) ⇒ Object

Constructs a hidden field input from the given options hidden_field_tag :session_key, :value => “__secret__”



71
72
73
74
 
# File 'lib/sinatra/markup_plugin/form_helpers.rb', line 71

def hidden_field_tag(name, options={})
  options.reverse_merge!(:name => name)
  input_tag(:hidden, options)
end

#image_submit_tag(source, options = {}) ⇒ Object

Constructs a submit button from the given options submit_tag “Create”, :class => ‘success’



149
150
151
152
 
# File 'lib/sinatra/markup_plugin/form_helpers.rb', line 149

def image_submit_tag(source, options={})
  options.reverse_merge!(:src => image_path(source))
  input_tag(:image, options)
end

#label_tag(name, options = {}, &block) ⇒ Object

Constructs a label tag from the given options label_tag :username, :class => ‘long-label’ label_tag :username, :class => ‘long-label’ do … end



58
59
60
61
62
63
64
65
66
67
 
# File 'lib/sinatra/markup_plugin/form_helpers.rb', line 58

def label_tag(name, options={}, &block)
  options.reverse_merge!(:caption => "#{name.to_s.titleize}: ", :for => name)
  caption_text = options.delete(:caption)
  if block_given? # label with inner content
    label_content = caption_text + capture_html(&block)
    concat_content(content_tag(:label, label_content, options))
  else # regular label
    content_tag(:label, caption_text, options)
  end
end

#password_field_tag(name, options = {}) ⇒ Object

Constructs a password field input from the given options password_field_tag :password, :class => ‘long’



92
93
94
95
 
# File 'lib/sinatra/markup_plugin/form_helpers.rb', line 92

def password_field_tag(name, options={})
  options.reverse_merge!(:name => name)
  input_tag(:password, options)
end

#radio_button_tag(name, options = {}) ⇒ Object

Constructs a radio_button from the given options radio_button_tag :remember_me, :value => ‘true’



121
122
123
124
 
# File 'lib/sinatra/markup_plugin/form_helpers.rb', line 121

def radio_button_tag(name, options={})
  options.reverse_merge!(:name => name)
  input_tag(:radio, options)
end

#select_tag(name, options = {}) ⇒ Object

Constructs a check_box from the given options options = [[‘caption’, ‘value’], [‘Green’, ‘green1’], [‘Blue’, ‘blue1’], [‘Black’, “black1”]] options = [‘option’, ‘red’, ‘yellow’ ] select_tag(:favorite_color, :options => [‘red’, ‘yellow’], :selected => ‘green1’) select_tag(:country, :collection => @countries, :fields => [:name, :code])



102
103
104
105
106
107
108
109
110
 
# File 'lib/sinatra/markup_plugin/form_helpers.rb', line 102

def select_tag(name, options={})
  options.reverse_merge!(:name => name)
  collection, fields = options.delete(:collection), options.delete(:fields)
  options[:options] = options_from_collection(collection, fields) if collection
  options[:options].unshift('') if options.delete(:include_blank)
  select_options_html = options_for_select(options.delete(:options), options.delete(:selected))
  options.merge!(:name => "#{options[:name]}[]") if options[:multiple]
  content_tag(:select, select_options_html, options)
end

#submit_tag(caption = "Submit", options = {}) ⇒ Object

Constructs a submit button from the given options submit_tag “Create”, :class => ‘success’



135
136
137
138
 
# File 'lib/sinatra/markup_plugin/form_helpers.rb', line 135

def submit_tag(caption="Submit", options={})
  options.reverse_merge!(:value => caption)
  input_tag(:submit, options)
end

#text_area_tag(name, options = {}) ⇒ Object

Constructs a text area input from the given options text_area_tag :username, :class => ‘long’, :value => “Demo?”



85
86
87
88
 
# File 'lib/sinatra/markup_plugin/form_helpers.rb', line 85

def text_area_tag(name, options={})
  options.reverse_merge!(:name => name)
  content_tag(:textarea, options.delete(:value).to_s, options)
end

#text_field_tag(name, options = {}) ⇒ Object

Constructs a text field input from the given options text_field_tag :username, :class => ‘long’



78
79
80
81
 
# File 'lib/sinatra/markup_plugin/form_helpers.rb', line 78

def text_field_tag(name, options={})
  options.reverse_merge!(:name => name)
  input_tag(:text, options)
end