Module: ActiveScaffold::Helpers::ListColumnHelpers
- Included in:
- ViewHelpers
- Defined in:
- lib/active_scaffold/bridges/file_column/list_ui.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/helpers/list_column_helpers.rb
Overview
Helpers that assist with the rendering of a List Column
Instance Method Summary collapse
- #active_scaffold_column_carrierwave(record, column) ⇒ Object
- #active_scaffold_column_checkbox(record, column) ⇒ Object
- #active_scaffold_column_download_link(record, column, label = nil) ⇒ Object
- #active_scaffold_column_download_link_with_filename(record, column) ⇒ Object
- #active_scaffold_column_dragonfly(record, column) ⇒ Object
- #active_scaffold_column_fulltext(record, column) ⇒ Object
- #active_scaffold_column_marked(record, column) ⇒ Object
- #active_scaffold_column_paperclip(record, column) ⇒ Object
- #active_scaffold_column_percentage(record, column) ⇒ Object
-
#active_scaffold_column_text(record, column) ⇒ Object
Overrides.
- #active_scaffold_column_thumbnail(record, column) ⇒ Object
- #active_scaffold_inplace_edit(record, column, options = {}) ⇒ Object
- #active_scaffold_inplace_edit_tag_options(record, column) ⇒ Object
- #all_marked? ⇒ Boolean
- #cache_association(association, column, size) ⇒ Object
-
#clean_column_value(v) ⇒ Object
There are two basic ways to clean a column’s value: h() and sanitize().
- #column_heading_attributes(column, sorting, sort_direction) ⇒ Object
- #column_heading_label(column) ⇒ Object
- #column_heading_value(column, sorting, sort_direction) ⇒ Object
- #column_override(column) ⇒ Object (also: #column_override?)
- #dragonfly_url_for_attachment(attachment, record, column) ⇒ Object
- #format_association_value(value, column, size) ⇒ Object
- #format_collection_association_value(value, column, label_method, size) ⇒ Object
-
#format_column_value(record, column, value = nil) ⇒ Object
Formatting.
- #format_number_value(value, options = {}) ⇒ Object
- #format_singular_association_value(value, column, label_method) ⇒ Object
- #format_value(column_value, options = {}) ⇒ Object
- #get_column_method(record, column) ⇒ Object
- #get_column_value(record, column) ⇒ Object
-
#inplace_edit?(record, column) ⇒ Boolean
= Inline Edit = ==========.
- #inplace_edit_cloning?(column) ⇒ Boolean
- #inplace_edit_control(column) ⇒ Object
- #inplace_edit_control_css_class ⇒ Object
- #inplace_edit_data(column) ⇒ Object
- #mark_column_heading ⇒ Object
-
#override_column_ui(list_ui) ⇒ Object
(also: #override_column_ui?)
the naming convention for overriding column types with helpers.
- #render_column_heading(column, sorting, sort_direction) ⇒ Object
-
#render_list_column(text, column, record) ⇒ Object
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.
Instance Method Details
#active_scaffold_column_carrierwave(record, column) ⇒ Object
4 5 6 7 8 9 10 11 12 13 14 15 |
# File 'lib/active_scaffold/bridges/carrierwave/list_ui.rb', line 4 def active_scaffold_column_carrierwave(record, column) carrierwave = record.send("#{column.name}") return nil if 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 |
#active_scaffold_column_checkbox(record, column) ⇒ Object
82 83 84 85 86 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 82 def active_scaffold_column_checkbox(record, column) = {:disabled => true, :id => nil, :object => record} .delete(:disabled) if inplace_edit?(record, column) check_box(:record, column.name, ) end |
#active_scaffold_column_download_link(record, column, label = nil) ⇒ Object
10 11 12 13 14 |
# File 'lib/active_scaffold/bridges/file_column/list_ui.rb', line 10 def active_scaffold_column_download_link(record, column, 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 |
#active_scaffold_column_download_link_with_filename(record, column) ⇒ Object
5 6 7 8 |
# File 'lib/active_scaffold/bridges/file_column/list_ui.rb', line 5 def active_scaffold_column_download_link_with_filename(record, column) return nil if record.send(column.name).nil? active_scaffold_column_download_link(record, column, File.basename(record.send(column.name))) end |
#active_scaffold_column_dragonfly(record, column) ⇒ Object
4 5 6 7 8 9 10 11 12 13 14 |
# File 'lib/active_scaffold/bridges/dragonfly/list_ui.rb', line 4 def active_scaffold_column_dragonfly(record, column) = 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, (, record, column), :target => '_blank') end |
#active_scaffold_column_fulltext(record, column) ⇒ Object
73 74 75 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 73 def active_scaffold_column_fulltext(record, column) clean_column_value(record.send(column.name)) end |
#active_scaffold_column_marked(record, column) ⇒ Object
77 78 79 80 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 77 def active_scaffold_column_marked(record, column) = {:id => nil, :object => record} content_tag(:span, check_box(:record, column.name, ), :class => 'in_place_editor_field', :data => {:ie_id => record.to_param}) end |
#active_scaffold_column_paperclip(record, column) ⇒ Object
4 5 6 7 8 9 10 11 12 13 14 |
# File 'lib/active_scaffold/bridges/paperclip/list_ui.rb', line 4 def active_scaffold_column_paperclip(record, column) 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, :target => '_blank') end |
#active_scaffold_column_percentage(record, column) ⇒ Object
88 89 90 91 92 93 94 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 88 def active_scaffold_column_percentage(record, column) = column.[:slider] || {} = .merge(min: record.send([:min_method])) if [:min_method] = .merge(max: record.send([:max_method])) if [:max_method] value = record.send([:value_method]) if [:value_method] .merge(value: value || record.send(column.name)) end |
#active_scaffold_column_text(record, column) ⇒ Object
Overrides
68 69 70 71 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 68 def active_scaffold_column_text(record, column) # `to_s` is necessary to convert objects in serialized columns to string before truncation. clean_column_value(truncate(record.send(column.name).to_s, :length => column.[:truncate] || 50)) end |
#active_scaffold_column_thumbnail(record, column) ⇒ Object
16 17 18 19 20 21 22 |
# File 'lib/active_scaffold/bridges/file_column/list_ui.rb', line 16 def active_scaffold_column_thumbnail(record, column) 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 |
#active_scaffold_inplace_edit(record, column, options = {}) ⇒ Object
234 235 236 237 238 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 234 def active_scaffold_inplace_edit(record, column, = {}) formatted_column = [:formatted_column] || format_column_value(record, column) content_tag(:span, as_(:inplace_edit_handle), :class => 'handle') << content_tag(:span, formatted_column, (record, column)) end |
#active_scaffold_inplace_edit_tag_options(record, column) ⇒ Object
226 227 228 229 230 231 232 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 226 def (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.to_param}} [:data][:ie_update] = column.inplace_edit if column.inplace_edit != true end |
#all_marked? ⇒ Boolean
285 286 287 288 289 290 291 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 285 def all_marked? if active_scaffold_config.mark.mark_all_mode == :page @page.items.detect { |record| !marked_records.include?(record.id) }.nil? else marked_records.length >= @page.pager.count.to_i end end |
#cache_association(association, column, size) ⇒ Object
200 201 202 203 204 205 206 207 208 209 210 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 200 def cache_association(association, column, size) # we are not using eager loading, cache firsts records in order not to query the database for whole association in a future if column.associated_limit.nil? logger.warn "ActiveScaffold: Enable eager loading for #{column.name} association to reduce SQL queries" elsif column.associated_limit > 0 # load at least one record more, is needed to display '...' association.target = association.reader.limit(column.associated_limit + 1).select(column.select_associated_columns || "#{association.klass.quoted_table_name}.*").to_a elsif @cache_associations association.target = [] end end |
#clean_column_value(v) ⇒ Object
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).
61 62 63 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 61 def clean_column_value(v) h(v) end |
#column_heading_attributes(column, sorting, sort_direction) ⇒ Object
301 302 303 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 301 def column_heading_attributes(column, sorting, sort_direction) {:id => active_scaffold_column_header_id(column), :class => column_heading_class(column, sorting), :title => (column.description).presence} end |
#column_heading_label(column) ⇒ Object
337 338 339 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 337 def column_heading_label(column) column.label end |
#column_heading_value(column, sorting, sort_direction) ⇒ Object
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 318 def column_heading_value(column, sorting, sort_direction) if column.name == :as_marked mark_column_heading elsif column.sortable? = {:id => nil, :class => 'as_sort', 'data-page-history' => controller_id, :remote => true, :method => :get} # :id needed because rails reuse it even if we delete from params (like do_refresh_list does) = params_for(:action => :index, :page => 1, :id => params[:id], :sort => column.name, :sort_direction => sort_direction) unless active_scaffold_config.store_user_settings .merge!(:search => search_params) if search_params.present? end link_to column_heading_label(column), , else content_tag(:p, column_heading_label(column)) end end |
#column_override(column) ⇒ Object Also known as: column_override?
96 97 98 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 96 def column_override(column) override_helper column, 'column' end |
#dragonfly_url_for_attachment(attachment, record, column) ⇒ Object
16 17 18 19 |
# File 'lib/active_scaffold/bridges/dragonfly/list_ui.rb', line 16 def (, record, column) url_method = column.[:private_store] ? :url : :remote_url .send(url_method) end |
#format_association_value(value, column, size) ⇒ Object
175 176 177 178 179 180 181 182 183 184 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 175 def format_association_value(value, column, size) method = column.[:label_method] || :to_label value = if column.association.collection? format_collection_association_value(value, column, method, size) elsif value format_singular_association_value(value, column, method) end format_value value end |
#format_collection_association_value(value, column, label_method, size) ⇒ Object
152 153 154 155 156 157 158 159 160 161 162 163 164 165 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 152 def format_collection_association_value(value, column, label_method, size) if column.associated_limit.nil? firsts = value.collect(&label_method) elsif column.associated_limit == 0 size if column.associated_number? else firsts = value.first(column.associated_limit) firsts.collect!(&label_method) firsts << '…' if value.size > column.associated_limit text = firsts.join(h(active_scaffold_config.list.association_join_text)).html_safe text << " (#{size})" if column.associated_number? && column.associated_limit && value.size > column.associated_limit text end end |
#format_column_value(record, column, value = nil) ⇒ Object
Formatting
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 113 def format_column_value(record, column, value = nil) value ||= record.send(column.name) unless record.nil? if column.association.nil? if [:select, :radio].include?(column.form_ui) && 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 if column.plural_association? associated_size = value.size if column.associated_number? # get count before cache association cache_association(record.association(column.name), column, associated_size) unless value.loaded? end format_association_value(value, column, associated_size) end end |
#format_number_value(value, options = {}) ⇒ Object
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 134 def format_number_value(value, = {}) if 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 send("number_with_#{value.is_a?(Integer) ? 'delimiter' : 'precision'}", value, [:i18n_options] || {}) else value end end clean_column_value(value) end |
#format_singular_association_value(value, column, label_method) ⇒ Object
167 168 169 170 171 172 173 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 167 def format_singular_association_value(value, column, label_method) if column.polymorphic_association? "#{value.class.model_name.human}: #{value.send(label_method)}" else value.send(label_method) end end |
#format_value(column_value, options = {}) ⇒ Object
186 187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 186 def format_value(column_value, = {}) value = if column_empty?(column_value) 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 |
#get_column_method(record, column) ⇒ Object
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 16 def get_column_method(record, column) # check for an override helper column.list_method ||= begin 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. method # second, check if the dev has specified a valid list_ui for this column elsif column.list_ui && (method = override_column_ui(column.list_ui)) method elsif column.column && (method = override_column_ui(column.column.type)) method else :format_column_value end end end |
#get_column_value(record, column) ⇒ Object
6 7 8 9 10 11 12 13 14 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 6 def get_column_value(record, column) method = get_column_method(record, column) value = send(method, record, column) value = ' '.html_safe if value.nil? || value.blank? # fix for IE 6 return value rescue StandardError => e logger.error "#{e.class.name}: #{e.} -- on the ActiveScaffold column = :#{column.name} in #{controller.class}, record: #{record.inspect}" raise e end |
#inplace_edit?(record, column) ⇒ Boolean
Inline Edit =
216 217 218 219 220 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 216 def inplace_edit?(record, column) return unless column.inplace_edit editable = controller.send(:update_authorized?, record) if controller.respond_to?(:update_authorized?, true) editable || record.(:crud_type => :update, :column => column.name) end |
#inplace_edit_cloning?(column) ⇒ Boolean
222 223 224 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 222 def inplace_edit_cloning?(column) column.inplace_edit != :ajax && (override_form_field?(column) || column.form_ui || (column.column && override_input?(column.column.type))) end |
#inplace_edit_control(column) ⇒ Object
240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 240 def inplace_edit_control(column) return unless inplace_edit?(active_scaffold_config.model, column) && inplace_edit_cloning?(column) old_record, @record = @record, active_scaffold_config.model.new # TODO: remove when relying on @record is removed column = column.clone column. = column..clone column.form_ui = :select if column.association && column.form_ui.nil? = (column).merge(:object => active_scaffold_config.model.new) [:class] = "#{[:class]} inplace_field" [:"data-id"] = [:id] [:id] = nil content_tag(:div, active_scaffold_input_for(column, nil, ), :style => 'display:none;', :class => inplace_edit_control_css_class).tap do @record = old_record # TODO: remove when relying on @record is removed end end |
#inplace_edit_control_css_class ⇒ Object
255 256 257 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 255 def inplace_edit_control_css_class 'as_inplace_pattern' end |
#inplace_edit_data(column) ⇒ Object
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 259 def inplace_edit_data(column) data = {} data[:ie_url] = url_for(params_for(: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] data[:ie_use_html] = column.[:use_html] if column.[:use_html] 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__', :update_column => column.name) 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 data end |
#mark_column_heading ⇒ Object
293 294 295 296 297 298 299 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 293 def mark_column_heading = { :id => "#{controller_id}_mark_heading", :class => 'mark_heading in_place_editor_field' } content_tag(:span, check_box_tag("#{controller_id}_mark_heading_span_input", '1', all_marked?), ) end |
#override_column_ui(list_ui) ⇒ Object Also known as: override_column_ui?
the naming convention for overriding column types with helpers
102 103 104 105 106 107 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 102 def override_column_ui(list_ui) @_column_ui_overrides ||= {} return @_column_ui_overrides[list_ui] if @_column_ui_overrides.include? list_ui method = "active_scaffold_column_#{list_ui}" @_column_ui_overrides[list_ui] = (method if respond_to? method) end |
#render_column_heading(column, sorting, sort_direction) ⇒ Object
305 306 307 308 309 310 311 312 313 314 315 316 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 305 def render_column_heading(column, sorting, sort_direction) = column_heading_attributes(column, sorting, sort_direction) if column.name == :as_marked [:data] = { :ie_mode => :inline_checkbox, :ie_url => url_for(params_for(:action => 'mark', :id => '__id__')) } else [:data] = inplace_edit_data(column) if column.inplace_edit end content_tag(:th, column_heading_value(column, sorting, sort_direction) + inplace_edit_control(column), ) end |
#render_list_column(text, column, record) ⇒ Object
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.
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 37 def render_list_column(text, column, record) if column.link && !skip_action_link?(column.link, record) link = column.link associated = record.send(column.association.name) if column.association render_action_link(link, record, :link => text, :authorized => link.action.nil? || (link, column, record, associated)) elsif inplace_edit?(record, column) active_scaffold_inplace_edit(record, column, :formatted_column => text) elsif active_scaffold_config.actions.include?(:list) && active_scaffold_config.list.wrap_tag content_tag active_scaffold_config.list.wrap_tag, text else text end rescue StandardError => e logger.error "#{e.class.name}: #{e.} -- on the ActiveScaffold column = :#{column.name} in #{controller.class}" raise e end |