Module: Formtastic::Inputs::Base::Timeish

Included in:
DateSelectInput, DatetimeSelectInput, TimeSelectInput
Defined in:
lib/formtastic/inputs/base/timeish.rb

Overview

TODO:

Document i18n

TODO:

Check what other Rails options are supported (start_year, end_year, use_month_numbers, use_short_month, add_month_numbers, prompt), write tests for them, and otherwise support them

TODO:

Could we take the rendering from Rails' helpers and inject better HTML in and around it rather than re-inventing the whee?

Timeish inputs (:date_select, :datetime_select, :time_select) are similar to the Rails date and time helpers (date_select, datetime_select, time_select), rendering a series of <select> tags for each fragment (year, month, day, hour, minute, seconds). The fragments are then re-combined to a date by ActiveRecord through multi-parameter assignment.

The mark-up produced by Rails is simple but far from ideal, with no way to label the individual fragments for accessibility, no fieldset to group the related fields, and no legend describing the group. Formtastic addresses this within the standard <li> wrapper with a <fieldset> with a <legend> as a label, followed by an ordered list (<ol>) of list items (<li>), one for each fragment (year, month, ...). Each <li> fragment contains a <label> (eg "Year") for the fragment, and a <select> containing <option>s (eg a range of years).

In the supplied formtastic.css file, the resulting mark-up is styled to appear a lot like a standard Rails date time select by:

  • styling the legend to look like the other labels (to the left hand side of the selects)
  • floating the <li> fragments against each other as a single line
  • hiding the <label> of each fragment with display:none

Examples:

:date_select input with full form context and sample HTMl output


<%= semantic_form_for(@post) do |f| %>
  <%= f.inputs do %>
    ...
    <%= f.input :publish_at, :as => :date_select %>
  <% end %>
<% end %>

<form...>
  <fieldset class="inputs">
    <ol>
      <li class="date">
        <fieldset class="fragments">
          <ol class="fragments-group">
            <li class="fragment">
              <label for="post_publish_at_1i">Year</label>
              <select id="post_publish_at_1i" name="post[publish_at_1i]">...</select>
            </li>
            <li class="fragment">
              <label for="post_publish_at_2i">Month</label>
              <select id="post_publish_at_2i" name="post[publish_at_2i]">...</select>
            </li>
            <li class="fragment">
              <label for="post_publish_at_3i">Day</label>
              <select id="post_publish_at_3i" name="post[publish_at_3i]">...</select>
            </li>
          </ol>
        </fieldset>
      </li>
    </ol>
  </fieldset>
</form>

:time_select input

<%= f.input :publish_at, :as => :time_select %>

:datetime_select input

<%= f.input :publish_at, :as => :datetime_select %>

Change the labels for each fragment

<%= f.input :publish_at, :as => :date_select, :labels => { :year => "Y", :month => "M", :day => "D" }  %>

Suppress the labels for all fragments

<%= f.input :publish_at, :as => :date_select, :labels => false  %>

Skip a fragment (defaults to 1, skips all following fragments)

<%= f.input :publish_at, :as => :datetime_select, :discard_minute => true  %>
<%= f.input :publish_at, :as => :datetime_select, :discard_hour => true  %>
<%= f.input :publish_at, :as => :datetime_select, :discard_day => true  %>
<%= f.input :publish_at, :as => :datetime_select, :discard_month => true  %>
<%= f.input :publish_at, :as => :datetime_select, :discard_year => true  %>

Change the order

<%= f.input :publish_at, :as => :date_select, :order => [:month, :day, :year]  %>

Include seconds with times (excluded by default)

<%= f.input :publish_at, :as => :time_select, :include_seconds => true %>

Specify if there should be a blank option at the start of each select or not. Note that, unlike select inputs, :include_blank does not accept a string value.

<%= f.input :publish_at, :as => :time_select, :include_blank => true %>
<%= f.input :publish_at, :as => :time_select, :include_blank => false %>

Instance Method Summary (collapse)

Instance Method Details

- (Object) date_fragments



119
120
121
# File 'lib/formtastic/inputs/base/timeish.rb', line 119

def date_fragments
  options[:order] || i18n_date_fragments || default_date_fragments
end

- (Object) default_date_fragments



123
124
125
# File 'lib/formtastic/inputs/base/timeish.rb', line 123

def default_date_fragments
  [:year, :month, :day]
end

- (Object) fragment_id(fragment)



146
147
148
# File 'lib/formtastic/inputs/base/timeish.rb', line 146

def fragment_id(fragment)
  "#{input_html_options[:id]}_#{position(fragment)}i"
end

- (Object) fragment_input_html(fragment)



163
164
165
166
# File 'lib/formtastic/inputs/base/timeish.rb', line 163

def fragment_input_html(fragment)
  opts = input_options.merge(:prefix => fragment_prefix, :field_name => fragment_name(fragment), :default => value, :include_blank => include_blank?)
  template.send(:select_#{fragment}", value, opts, input_html_options.merge(:id => fragment_id(fragment)))
end

- (Object) fragment_label(fragment)



135
136
137
138
139
140
141
142
143
144
# File 'lib/formtastic/inputs/base/timeish.rb', line 135

def fragment_label(fragment)
  labels_from_options = options.key?(:labels) ? options[:labels] : {}
  if !labels_from_options
    ''
  elsif labels_from_options.key?(fragment)
    labels_from_options[fragment]
  else
    ::I18n.t(fragment.to_s, :default => fragment.to_s.humanize, :scope => [:datetime, :prompts])
  end
end

- (Object) fragment_label_html(fragment)



154
155
156
157
# File 'lib/formtastic/inputs/base/timeish.rb', line 154

def fragment_label_html(fragment)
  text = fragment_label(fragment)
  text.blank? ? "".html_safe : template.(:label, text, :for => fragment_id(fragment))
end

- (Object) fragment_name(fragment)



150
151
152
# File 'lib/formtastic/inputs/base/timeish.rb', line 150

def fragment_name(fragment)
  "#{method}(#{position(fragment)}i)"
end

- (Object) fragment_prefix



168
169
170
171
172
173
174
# File 'lib/formtastic/inputs/base/timeish.rb', line 168

def fragment_prefix
  if builder.options.key?(:index)
    object_name + "[#{builder.options[:index]}]"
  else
    object_name
  end
end

- (Object) fragment_wrapping(&block)



127
128
129
# File 'lib/formtastic/inputs/base/timeish.rb', line 127

def fragment_wrapping(&block)
  template.(:li, template.capture(&block), fragment_wrapping_html_options)
end

- (Object) fragment_wrapping_html_options



131
132
133
# File 'lib/formtastic/inputs/base/timeish.rb', line 131

def fragment_wrapping_html_options
  { :class => 'fragment' }
end

- (Object) fragments



111
112
113
# File 'lib/formtastic/inputs/base/timeish.rb', line 111

def fragments
  date_fragments + time_fragments
end

- (Object) fragments_inner_wrapping(&block)



220
221
222
223
224
# File 'lib/formtastic/inputs/base/timeish.rb', line 220

def fragments_inner_wrapping(&block)
  template.(:ol,
    template.capture(&block)
  )
end

- (Object) fragments_label



209
210
211
212
213
214
215
216
217
218
# File 'lib/formtastic/inputs/base/timeish.rb', line 209

def fragments_label
  if render_label?
    template.(:legend, 
      builder.label(method, label_text, :for => fragment_id(fragments.first)), 
      :class => "label"
    )
  else
    "".html_safe
  end
end

- (Object) fragments_wrapping(&block)



198
199
200
201
202
203
# File 'lib/formtastic/inputs/base/timeish.rb', line 198

def fragments_wrapping(&block)
  template.(:fieldset,
    template.capture(&block).html_safe, 
    fragments_wrapping_html_options
  )
end

- (Object) fragments_wrapping_html_options



205
206
207
# File 'lib/formtastic/inputs/base/timeish.rb', line 205

def fragments_wrapping_html_options
  { :class => "fragments" }
end

- (Object) hidden_field_name(fragment)



230
231
232
233
234
235
236
# File 'lib/formtastic/inputs/base/timeish.rb', line 230

def hidden_field_name(fragment)
  if builder.options.key?(:index)
    "#{object_name}[#{builder.options[:index]}][#{fragment_name(fragment)}]"
  else
    "#{object_name}[#{fragment_name(fragment)}]"
  end
end

- (Object) hidden_fragments



226
227
228
# File 'lib/formtastic/inputs/base/timeish.rb', line 226

def hidden_fragments
  "".html_safe
end

- (Object) i18n_date_fragments



189
190
191
192
193
194
195
196
# File 'lib/formtastic/inputs/base/timeish.rb', line 189

def i18n_date_fragments
  order = ::I18n.t(:order, :scope => [:date])
  if order.is_a?(Array)
    order.map &:to_sym
  else
    nil
  end
end

- (Boolean) include_blank?

TODO extract to BlankOptions or similar -- Select uses similar code

Returns:

  • (Boolean)


177
178
179
# File 'lib/formtastic/inputs/base/timeish.rb', line 177

def include_blank?
  options.key?(:include_blank) ? options[:include_blank] : builder.include_blank_for_select_by_default
end

- (Object) position(fragment)



185
186
187
# File 'lib/formtastic/inputs/base/timeish.rb', line 185

def position(fragment)
  positions[fragment]
end

- (Object) positions



181
182
183
# File 'lib/formtastic/inputs/base/timeish.rb', line 181

def positions
  { :year => 1, :month => 2, :day => 3, :hour => 4, :minute => 5, :second => 6 }
end

- (Object) time_fragments



115
116
117
# File 'lib/formtastic/inputs/base/timeish.rb', line 115

def time_fragments
  options[:include_seconds] ? [:hour, :minute, :second] : [:hour, :minute]
end

- (Object) to_html



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
# File 'lib/formtastic/inputs/base/timeish.rb', line 93

def to_html
  input_wrapping do
    fragments_wrapping do
      hidden_fragments <<
      fragments_label <<
      template.(:ol,
        fragments.map do |fragment|
          fragment_wrapping do
            fragment_label_html(fragment) <<
            fragment_input_html(fragment)
          end
        end.join.html_safe, # TODO is this safe?
        { :class => 'fragments-group' } # TODO refactor to fragments_group_wrapping
      )
    end
  end
end

- (Object) value



159
160
161
# File 'lib/formtastic/inputs/base/timeish.rb', line 159

def value
  object.send(method) if object && object.respond_to?(method)
end