Module: ActiveScaffold::Helpers::ListColumnHelpers
- Included in:
- ViewHelpers
- Defined in:
- lib/active_scaffold/helpers/list_column_helpers.rb,
lib/active_scaffold/bridges/dragonfly/list_ui.rb,
lib/active_scaffold/bridges/paperclip/list_ui.rb,
lib/active_scaffold/bridges/carrierwave/list_ui.rb,
lib/active_scaffold/bridges/file_column/list_ui.rb
Overview
Helpers that assist with the rendering of a List Column
Instance Method Summary (collapse)
-
- (Object) action_link_to_inline_form(column, record, associated, text)
setup the action link to inline form.
- - (Object) active_scaffold_column_carrierwave(column, record)
- - (Object) active_scaffold_column_checkbox(column, record)
- - (Object) active_scaffold_column_download_link(column, record, label = nil)
- - (Object) active_scaffold_column_download_link_with_filename(column, record)
- - (Object) active_scaffold_column_dragonfly(column, record)
- - (Object) active_scaffold_column_paperclip(column, record)
-
- (Object) active_scaffold_column_text(column, record)
Overrides.
- - (Object) active_scaffold_column_thumbnail(column, record)
- - (Object) active_scaffold_inplace_edit(record, column, options = {})
- - (Object) cache_association(value, column)
-
- (Object) clean_column_value(v)
There are two basic ways to clean a column's value: h() and sanitize().
- - (Object) column_heading_value(column, sorting, sort_direction)
- - (Boolean) column_link_authorized?(link, column, record, associated)
- - (Object) column_override(column) (also: #column_override?)
- - (Object) configure_column_link(link, associated, actions)
- - (Object) format_association_value(value, column, size)
-
- (Object) format_column_value(record, column, value = nil)
Formatting.
- - (Object) format_number_value(value, options = {})
- - (Object) format_value(column_value, options = {})
- - (Object) get_column_value(record, column)
-
- (Boolean) inplace_edit?(record, column)
Inline Edit =
. - - (Boolean) inplace_edit_cloning?(column)
- - (Object) inplace_edit_control(column)
- - (Object) inplace_edit_control_css_class
- - (Object) inplace_edit_tag_attributes(column)
- - (Object) mark_column_heading
-
- (Object) override_column_ui(list_ui)
(also: #override_column_ui?)
the naming convention for overriding column types with helpers.
- - (Object) render_column_heading(column, sorting, sort_direction)
-
- (Object) render_list_column(text, column, record)
TODO: move empty_field_text and logic in here? TODO: we need to distinguish between the automatic links we create and the ones that the dev specified.
- - (Object) render_nested_view(action_links, url_options, record)
Instance Method Details
- (Object) action_link_to_inline_form(column, record, associated, text)
setup the action link to inline form
62 63 64 65 66 67 68 69 70 71 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 62 def action_link_to_inline_form(column, record, associated, text) link = column.link.clone link.label = text if column.polymorphic_association? polymorphic_controller = controller_path_for_activerecord(record.send(column.association.name).class) return link if polymorphic_controller.nil? link.controller = polymorphic_controller end configure_column_link(link, associated, column.actions_for_association_links) end |
- (Object) active_scaffold_column_carrierwave(column, record)
4 5 6 7 8 9 10 11 12 13 14 |
# File 'lib/active_scaffold/bridges/carrierwave/list_ui.rb', line 4 def active_scaffold_column_carrierwave(column, record) carrierwave = record.send("#{column.name}") return nil unless !carrierwave.file.blank? thumbnail_style = ActiveScaffold::Bridges::Carrierwave::CarrierwaveBridgeHelpers.thumbnail_style content = if carrierwave.versions.keys.include?(thumbnail_style) image_tag(carrierwave.url(thumbnail_style), :border => 0).html_safe else record.send(record.send(:_mounter, column.name).send(:serialization_column)) end link_to(content, carrierwave.url, :target => '_blank') end |
- (Object) active_scaffold_column_checkbox(column, record)
128 129 130 131 132 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 128 def active_scaffold_column_checkbox(column, record) = {:disabled => true, :id => nil, :object => record} .delete(:disabled) if inplace_edit?(record, column) check_box(:record, column.name, ) end |
- (Object) active_scaffold_column_download_link(column, record, label = nil)
10 11 12 13 14 |
# File 'lib/active_scaffold/bridges/file_column/list_ui.rb', line 10 def active_scaffold_column_download_link(column, record, label = nil) return nil if record.send(column.name).nil? label||=as_(:download) link_to( label, url_for_file_column(record, column.name.to_s), :popup => true) end |
- (Object) active_scaffold_column_download_link_with_filename(column, record)
5 6 7 8 |
# File 'lib/active_scaffold/bridges/file_column/list_ui.rb', line 5 def active_scaffold_column_download_link_with_filename(column, record) return nil if record.send(column.name).nil? active_scaffold_column_download_link(column, record, File.basename(record.send(column.name))) end |
- (Object) active_scaffold_column_dragonfly(column, record)
4 5 6 7 8 9 10 11 12 13 |
# File 'lib/active_scaffold/bridges/dragonfly/list_ui.rb', line 4 def active_scaffold_column_dragonfly(column, record) = record.send("#{column.name}") return nil unless .present? content = if .image? image_tag(.thumb(column.[:thumb] || ActiveScaffold::Bridges::Dragonfly::DragonflyBridgeHelpers.thumbnail_style).url, :border => 0) else .name end link_to(content, .remote_url, {'data-popup' => true, :target => '_blank'}) end |
- (Object) active_scaffold_column_paperclip(column, record)
4 5 6 7 8 9 10 11 12 13 |
# File 'lib/active_scaffold/bridges/paperclip/list_ui.rb', line 4 def active_scaffold_column_paperclip(column, record) paperclip = record.send("#{column.name}") return nil unless paperclip.file? content = if paperclip.styles.include?(ActiveScaffold::Bridges::Paperclip::PaperclipBridgeHelpers.thumbnail_style) image_tag(paperclip.url(ActiveScaffold::Bridges::Paperclip::PaperclipBridgeHelpers.thumbnail_style), :border => 0) else paperclip.original_filename end link_to(content, paperclip.url, {'data-popup' => true, :target => '_blank'}) end |
- (Object) active_scaffold_column_text(column, record)
Overrides
124 125 126 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 124 def active_scaffold_column_text(column, record) clean_column_value(truncate(record.send(column.name), :length => column.[:truncate] || 50)) end |
- (Object) active_scaffold_column_thumbnail(column, record)
16 17 18 19 20 21 22 |
# File 'lib/active_scaffold/bridges/file_column/list_ui.rb', line 16 def active_scaffold_column_thumbnail(column, record) return nil if record.send(column.name).nil? link_to( image_tag(url_for_file_column(record, column.name.to_s, "thumb"), :border => 0), url_for_file_column(record, column.name.to_s), :popup => true) end |
- (Object) active_scaffold_inplace_edit(record, column, options = {})
253 254 255 256 257 258 259 260 261 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 253 def active_scaffold_inplace_edit(record, column, = {}) formatted_column = [:formatted_column] || format_column_value(record, column) = {:id => record.id.to_s, :action => 'update_column', :name => column.name.to_s} = {:id => element_cell_id(), :class => "in_place_editor_field", :title => as_(:click_to_edit), 'data-ie_id' => record.id.to_s} content_tag(:span, as_(:click_to_edit), :class => 'handle') << content_tag(:span, formatted_column, ) end |
- (Object) cache_association(value, column)
225 226 227 228 229 230 231 232 233 234 235 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 225 def cache_association(value, column) # we are not using eager loading, cache firsts records in order not to query the database in a future unless value.loaded? # load at least one record, is needed for column_empty? and checking permissions if column.associated_limit.nil? Rails.logger.warn "ActiveScaffold: Enable eager loading for #{column.name} association to reduce SQL queries" else value.target = value.find(:all, :limit => column.associated_limit + 1, :select => column.select_columns) end end end |
- (Object) clean_column_value(v)
There are two basic ways to clean a column's value: h() and sanitize(). The latter is useful when the column contains valid html data, and you want to just disable any scripting. People can always use field overrides to clean data one way or the other, but having this override lets people decide which way it should happen by default.
Why is it not a configuration option? Because it seems like a somewhat rare request. But it could eventually be an option in config.list (and config.show, I guess).
117 118 119 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 117 def clean_column_value(v) h(v) end |
- (Object) column_heading_value(column, sorting, sort_direction)
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 325 def column_heading_value(column, sorting, sort_direction) if column.sortable? = {:id => nil, :class => "as_sort", 'data-page-history' => controller_id, :remote => true, :method => :get} = params_for(:action => :index, :page => 1, :sort => column.name, :sort_direction => sort_direction) link_to column.label, , else if column.name != :marked content_tag(:p, column.label) else mark_column_heading end end end |
- (Boolean) column_link_authorized?(link, column, record, associated)
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 93 def (link, column, record, associated) if column.association = if associated.nil? || (associated.respond_to?(:blank?) && associated.blank?) column.association.klass elsif [:has_many, :has_and_belongs_to_many].include? column.association.macro associated.first else associated end = .(:crud_type => link.crud_type) = and record.(:crud_type => :update, :column => column.name) if link.crud_type == :create else record.(:crud_type => link.crud_type) end end |
- (Object) column_override(column) Also known as: column_override?
134 135 136 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 134 def column_override(column) override_helper column, 'column' end |
- (Object) configure_column_link(link, associated, actions)
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 73 def configure_column_link(link, associated, actions) if column_empty?(associated) # if association is empty, we only can link to create form if actions.include?(:new) link.action = 'new' link.crud_type = :create link.label = as_(:create_new) end elsif actions.include?(:edit) link.action = 'edit' link.crud_type = :update elsif actions.include?(:show) link.action = 'show' link.crud_type = :read elsif actions.include?(:list) link.action = 'index' link.crud_type = :read end link if link.action.present? end |
- (Object) format_association_value(value, column, size)
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 186 def format_association_value(value, column, size) format_value case column.association.macro when :has_one, :belongs_to if column.polymorphic_association? "#{value.class.model_name.human}: #{value.to_label}" else value.to_label end when :has_many, :has_and_belongs_to_many if column.associated_limit.nil? firsts = value.collect { |v| v.to_label } else firsts = value.first(column.associated_limit) firsts.collect! { |v| v.to_label } firsts[column.associated_limit] = '…' if value.size > column.associated_limit end if column.associated_limit == 0 size if column.associated_number? else joined_associated = firsts.join(active_scaffold_config.list.association_join_text) joined_associated << " (#{size})" if column.associated_number? and column.associated_limit and value.size > column.associated_limit joined_associated end end end |
- (Object) format_column_value(record, column, value = nil)
Formatting
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 149 def format_column_value(record, column, value = nil) value ||= record.send(column.name) unless record.nil? if value && column.association # cache association size before calling column_empty? associated_size = value.size if column.plural_association? and column.associated_number? # get count before cache association cache_association(value, column) if column.plural_association? end if column.association.nil? or column_empty?(value) if column.form_ui == :select && column.[:options] text, val = column.[:options].find {|text, val| (val.nil? ? text : val).to_s == value.to_s} value = active_scaffold_translated_option(column, text, val).first if text end if value.is_a? Numeric format_number_value(value, column.) else format_value(value, column.) end else format_association_value(value, column, associated_size) end end |
- (Object) format_number_value(value, options = {})
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 170 def format_number_value(value, = {}) value = case [:format] when :size number_to_human_size(value, [:i18n_options] || {}) when :percentage number_to_percentage(value, [:i18n_options] || {}) when :currency number_to_currency(value, [:i18n_options] || {}) when :i18n_number number_with_delimiter(value, [:i18n_options] || {}) else value end clean_column_value(value) end |
- (Object) format_value(column_value, options = {})
212 213 214 215 216 217 218 219 220 221 222 223 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 212 def format_value(column_value, = {}) value = if column_empty?(column_value) active_scaffold_config.list.empty_field_text elsif column_value.is_a?(Time) || column_value.is_a?(Date) l(column_value, :format => [:format] || :default) elsif [FalseClass, TrueClass].include?(column_value.class) as_(column_value.to_s.to_sym) else column_value.to_s end clean_column_value(value) end |
- (Object) get_column_value(record, column)
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 6 def get_column_value(record, column) begin # check for an override helper value = if (method = column_override(column)) # we only pass the record as the argument. we previously also passed the formatted_value, # but mike perham pointed out that prohibited the usage of overrides to improve on the # performance of our default formatting. see issue #138. send(method, record) # second, check if the dev has specified a valid list_ui for this column elsif column.list_ui and (method = override_column_ui(column.list_ui)) send(method, column, record) elsif column.column and (method = override_column_ui(column.column.type)) send(method, column, record) else format_column_value(record, column) end value = ' '.html_safe if value.nil? or (value.respond_to?(:empty?) and value.empty?) # fix for IE 6 return value rescue Exception => e logger.error Time.now.to_s + "#{e.inspect} -- on the ActiveScaffold column = :#{column.name} in #{controller.class}" raise e end end |
- (Boolean) inplace_edit?(record, column)
Inline Edit =
241 242 243 244 245 246 247 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 241 def inplace_edit?(record, column) if column.inplace_edit editable = controller.send(:update_authorized?, record) if controller.respond_to?(:update_authorized?) editable = record.(:crud_type => :update, :column => column.name) if editable.nil? || editable == true editable end end |
- (Boolean) inplace_edit_cloning?(column)
249 250 251 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 249 def inplace_edit_cloning?(column) column.inplace_edit != :ajax and (override_form_field?(column) or column.form_ui or (column.column and override_input?(column.column.type))) end |
- (Object) inplace_edit_control(column)
263 264 265 266 267 268 269 270 271 272 273 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 263 def inplace_edit_control(column) if inplace_edit?(active_scaffold_config.model, column) and inplace_edit_cloning?(column) old_record, @record = @record, new_model column = column.clone column. = column..clone column.form_ui = :select if (column.association && column.form_ui.nil?) content_tag(:div, active_scaffold_input_for(column), :style => "display:none;", :class => inplace_edit_control_css_class).tap do @record = old_record end end end |
- (Object) inplace_edit_control_css_class
275 276 277 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 275 def inplace_edit_control_css_class "as_inplace_pattern" end |
- (Object) inplace_edit_tag_attributes(column)
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 279 def inplace_edit_tag_attributes(column) = {} ['data-ie_url'] = url_for({:controller => params_for[:controller], :action => "update_column", :column => column.name, :id => '__id__'}) ['data-ie_cancel_text'] = column.[:cancel_text] || as_(:cancel) ['data-ie_loading_text'] = column.[:loading_text] || as_(:loading) ['data-ie_save_text'] = column.[:save_text] || as_(:update) ['data-ie_saving_text'] = column.[:saving_text] || as_(:saving) ['data-ie_rows'] = column.[:rows] || 5 if column.column.try(:type) == :text ['data-ie_cols'] = column.[:cols] if column.[:cols] ['data-ie_size'] = column.[:size] if column.[:size] if column.list_ui == :checkbox ['data-ie_mode'] = :inline_checkbox elsif inplace_edit_cloning?(column) ['data-ie_mode'] = :clone elsif column.inplace_edit == :ajax url = url_for(:controller => params_for[:controller], :action => 'render_field', :id => '__id__', :column => column.name, :update_column => column.name, :in_place_editing => true) plural = column.plural_association? && !override_form_field?(column) && [:select, :record_select].include?(column.form_ui) ['data-ie_render_url'] = url ['data-ie_mode'] = :ajax ['data-ie_plural'] = plural end end |
- (Object) mark_column_heading
304 305 306 307 308 309 310 311 312 313 314 315 316 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 304 def mark_column_heading if active_scaffold_config.mark.mark_all_mode == :page then all_marked = true @page.items.each do |record| all_marked = false if !marked_records.entries.include?(record.id) end else all_marked = (marked_records.length >= @page.pager.count) end = {:id => "#{controller_id}_mark_heading", :class => "mark_heading in_place_editor_field"} ['data-ie_url'] = url_for({:controller => params_for[:controller], :action => 'mark_all', :eid => params[:eid]}) content_tag(:span, check_box_tag("#{controller_id}_mark_heading_span_input", !all_marked, all_marked), ) end |
- (Object) override_column_ui(list_ui) Also known as: override_column_ui?
the naming convention for overriding column types with helpers
140 141 142 143 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 140 def override_column_ui(list_ui) method = "active_scaffold_column_#{list_ui}" method if respond_to? method end |
- (Object) render_column_heading(column, sorting, sort_direction)
318 319 320 321 322 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 318 def render_column_heading(column, sorting, sort_direction) = {:id => active_scaffold_column_header_id(column), :class => column_heading_class(column, sorting), :title => column.description} .merge!(inplace_edit_tag_attributes(column)) if column.inplace_edit content_tag(:th, column_heading_value(column, sorting, sort_direction) + inplace_edit_control(column), ) end |
- (Object) render_list_column(text, column, record)
TODO: move empty_field_text and logic in here? TODO: we need to distinguish between the automatic links we create and the ones that the dev specified. some logic may not apply if the dev specified the link.
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 33 def render_list_column(text, column, record) if column.link link = column.link associated = record.send(column.association.name) if column.association = params_for(:action => nil, :id => record.id) # setup automatic link if column.autolink? && column.singular_association? # link to inline form link = action_link_to_inline_form(column, record, associated, text) return text if link.nil? else [:link] = text end if (link, column, record, associated) render_action_link(link, , record) else "<a class='disabled'>#{text}</a>".html_safe end elsif inplace_edit?(record, column) active_scaffold_inplace_edit(record, column, {:formatted_column => text}) elsif active_scaffold_config.list.wrap_tag content_tag active_scaffold_config.list.wrap_tag, text else text end end |
- (Object) render_nested_view(action_links, url_options, record)
342 343 344 345 346 347 348 349 350 351 352 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 342 def render_nested_view(action_links, , record) rendered = [] action_links.member.each do |link| if link.nested_link? && link.column && @nested_auto_open[link.column.name] && @records.length <= @nested_auto_open[link.column.name] && controller.respond_to?(:render_component_into_view) = {:adapter => '_list_inline_adapter', :format => :js}.merge((link, , record, = {:reuse_eid => true})) link_id = get_action_link_id(, record, link.column) rendered << (controller.send(:render_component_into_view, ) + javascript_tag("ActiveScaffold.ActionLink.get('#{link_id}').set_opened();")) end end rendered.join(' ').html_safe end |