Module: ActiveScaffold::Helpers::ActionLinkHelpers
- Included in:
- ViewHelpers
- Defined in:
- lib/active_scaffold/helpers/action_link_helpers.rb
Overview
All extra helpers that should be included in the View. Also a dumping ground for uncategorized helpers.
Constant Summary collapse
- NESTED_PARAMS =
params which mustn’t be copying to nested links
%i[eid embedded association parent_scaffold].freeze
Instance Method Summary collapse
- #action_link_authorized?(link, *args) ⇒ Boolean
- #action_link_html(link, url, html_options, record) ⇒ Object
- #action_link_html_options(link, record, options) ⇒ Object
- #action_link_selected?(link, record) ⇒ Boolean
- #action_link_text(link, options) ⇒ Object
-
#action_link_to_inline_form(link, record) ⇒ Object
setup the action link to inline form.
- #action_link_url(link, record) ⇒ Object
- #action_link_url_options(link, record) ⇒ Object
- #add_query_string_to_cached_url(link, url) ⇒ Object
- #cache_action_link_url?(link, record) ⇒ Boolean
- #cache_action_link_url_options?(link, record) ⇒ Boolean
- #cached_action_link_url(link, record) ⇒ Object
- #cached_action_link_url_options(link, record) ⇒ Object
- #column_link_authorized?(link, column, record, associated) ⇒ Boolean
- #configure_column_link(link, record, associated, actions = nil) ⇒ Object
- #display_action_link(link, content, record, options) ⇒ Object
- #display_action_links(action_links, record, options, &block) ⇒ Object
- #display_dynamic_action_group(action_link, links, record_or_ul_options = nil, ul_options = nil) ⇒ Object
- #get_action_link_id(link, record = nil, column = nil) ⇒ Object
- #query_string_for_action_links(link) ⇒ Object
- #render_action_link(link, record = nil, options = {}) ⇒ Object
- #replace_id_params_in_action_link_url(link, record, url) ⇒ Object
- #replaced_action_link_url_options(link, record) ⇒ Object
- #skip_action_link?(link, *args) ⇒ Boolean
- #sti_record?(record) ⇒ Boolean
- #url_options_for_nested_link(column, record, link, url_options) ⇒ Object
- #url_options_for_sti_link(column, record, link, url_options) ⇒ Object
Instance Method Details
#action_link_authorized?(link, *args) ⇒ Boolean
13 14 15 16 17 18 19 20 21 |
# File 'lib/active_scaffold/helpers/action_link_helpers.rb', line 13 def (link, *args) auth, reason = if link.security_method_set? || controller.respond_to?(link.security_method, true) controller.send(link.security_method, *args) else args.empty? ? true : args.first.(:crud_type => link.crud_type, :action => link.action, :reason => true) end [auth, reason] end |
#action_link_html(link, url, html_options, record) ⇒ Object
363 364 365 366 367 368 369 370 371 |
# File 'lib/active_scaffold/helpers/action_link_helpers.rb', line 363 def action_link_html(link, url, , record) label = .delete(:link) label ||= link.label if url.nil? content_tag(:a, label, ) else link_to(label, url, ) end end |
#action_link_html_options(link, record, options) ⇒ Object
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 |
# File 'lib/active_scaffold/helpers/action_link_helpers.rb', line 310 def (link, record, ) link_id = get_action_link_id(link, record) = link..merge(:class => [link.[:class], link.action.to_s].compact.join(' ')) [:link] = action_link_text(link, ) # Needs to be in html_options to as the adding _method to the url is no longer supported by Rails [:method] = link.method if link.method != :get [:data] ||= {} [:data][:confirm] = link.confirm(h(record.try(:to_label))) if link.confirm? if ![:page] && ![:popup] && ([:inline] || link.inline?) [:class] << ' as_action' [:data][:position] = link.position if link.position [:data][:action] = link.action [:data][:cancel_refresh] = true if link.refresh_on_close [:data][:keep_open] = true if link.keep_open? [:remote] = true end if link.toggle [:class] << ' toggle' [:class] << ' active' if action_link_selected?(link, record) end [:target] = '_blank' if ![:page] && ![:inline] && ([:popup] || link.popup?) [:id] = link_id if link.dhtml_confirm? unless link.inline? [:class] << ' as_action' [:page_link] = 'true' end [:dhtml_confirm] = link.dhtml_confirm.value [:onclick] = link.dhtml_confirm.onclick_function(controller, link_id) end end |
#action_link_selected?(link, record) ⇒ Boolean
304 305 306 307 308 |
# File 'lib/active_scaffold/helpers/action_link_helpers.rb', line 304 def action_link_selected?(link, record) , = (link, record) safe_params = (Rails.version < '4.2' ? params.to_h : params.to_unsafe_h) ( - safe_params.to_a).blank? && .all? { |k, _| params[k].nil? } end |
#action_link_text(link, options) ⇒ Object
282 283 284 285 |
# File 'lib/active_scaffold/helpers/action_link_helpers.rb', line 282 def action_link_text(link, ) text = image_tag(link.image[:name], :size => link.image[:size], :alt => [:link] || link.label, :title => [:link] || link.label) if link.image text || [:link] end |
#action_link_to_inline_form(link, record) ⇒ Object
setup the action link to inline form
97 98 99 100 101 102 103 104 105 106 |
# File 'lib/active_scaffold/helpers/action_link_helpers.rb', line 97 def action_link_to_inline_form(link, record) link = link.clone associated = record.send(link.column.association.name) if link.column.association.try(:polymorphic?) link.controller = controller_path_for_activerecord(associated.class) return link if link.controller.nil? end link = configure_column_link(link, record, associated) if link.action.nil? link end |
#action_link_url(link, record) ⇒ Object
206 207 208 209 210 |
# File 'lib/active_scaffold/helpers/action_link_helpers.rb', line 206 def action_link_url(link, record) url = replace_id_params_in_action_link_url(link, record, cached_action_link_url(link, record)) url = add_query_string_to_cached_url(link, url) if @action_links_urls[link.name_to_cache] url end |
#action_link_url_options(link, record) ⇒ Object
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 |
# File 'lib/active_scaffold/helpers/action_link_helpers.rb', line 260 def (link, record) = {:action => link.action} [:id] = '--ID--' unless record.nil? [:controller] = link.controller.to_s if link.controller .merge! link.parameters if link.parameters if link.dynamic_parameters.is_a?(Proc) if record.nil? .merge! instance_exec(&link.dynamic_parameters) else .merge! instance_exec(record, &link.dynamic_parameters) end end if link.nested_link? (link.column, record, link, ) elsif nested? [nested.param_name] = '--CHILD_ID--' end (link.column, record, link, ) unless record.nil? || active_scaffold_config.sti_children.nil? [:_method] = link.method if !link.confirm? && link.inline? && link.method != :get end |
#add_query_string_to_cached_url(link, url) ⇒ Object
195 196 197 198 199 200 201 202 203 204 |
# File 'lib/active_scaffold/helpers/action_link_helpers.rb', line 195 def add_query_string_to_cached_url(link, url) query_string, non_nested_query_string = query_string_for_action_links(link) nested_params = (!link.nested_link? && non_nested_query_string) if query_string || nested_params url << (url.include?('?') ? '&' : '?') url << query_string if query_string url << non_nested_query_string if nested_params end url end |
#cache_action_link_url?(link, record) ⇒ Boolean
162 163 164 |
# File 'lib/active_scaffold/helpers/action_link_helpers.rb', line 162 def cache_action_link_url?(link, record) active_scaffold_config.cache_action_link_urls && link.type == :member && !link.dynamic_parameters.is_a?(Proc) && !sti_record?(record) end |
#cache_action_link_url_options?(link, record) ⇒ Boolean
245 246 247 |
# File 'lib/active_scaffold/helpers/action_link_helpers.rb', line 245 def (link, record) active_scaffold_config.cache_action_link_urls && (link.type == :collection || !link.dynamic_parameters.is_a?(Proc)) && !sti_record?(record) end |
#cached_action_link_url(link, record) ⇒ Object
166 167 168 169 170 171 172 173 174 175 176 177 |
# File 'lib/active_scaffold/helpers/action_link_helpers.rb', line 166 def cached_action_link_url(link, record) @action_links_urls ||= {} @action_links_urls[link.name_to_cache] || begin = (link, record) if cache_action_link_url?(link, record) @action_links_urls[link.name_to_cache] = url_for() else .merge! eid: nil, embedded: nil if link.nested_link? url_for(params_for()) end end end |
#cached_action_link_url_options(link, record) ⇒ Object
249 250 251 252 253 254 255 256 257 258 |
# File 'lib/active_scaffold/helpers/action_link_helpers.rb', line 249 def (link, record) @action_links_url_options ||= {} @action_links_url_options[link.name_to_cache] || begin = (link, record) if (link, record) @action_links_url_options[link.name_to_cache] = end end end |
#column_link_authorized?(link, column, record, associated) ⇒ Boolean
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 |
# File 'lib/active_scaffold/helpers/action_link_helpers.rb', line 137 def (link, column, record, associated) if column.association = if column.association.collection? || (associated.respond_to?(:blank?) && associated.blank?) column.association.klass else associated end , reason = .(:crud_type => link.crud_type, :reason => true) if link.crud_type == :create && , reason = record.(:crud_type => :update, :column => column.name, :reason => true) end [, reason] else (link, record) end end |
#configure_column_link(link, record, associated, actions = nil) ⇒ Object
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'lib/active_scaffold/helpers/action_link_helpers.rb', line 108 def configure_column_link(link, record, associated, actions = nil) actions ||= link.column.actions_for_association_links 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 unless (link, link.column, record, associated)[0] link.action = nil # if action is edit and is not authorized, fallback to show if it's enabled if link.crud_type == :update && actions.include?(:show) link = configure_column_link(link, record, associated, [:show]) end end link end |
#display_action_link(link, content, record, options) ⇒ Object
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
# File 'lib/active_scaffold/helpers/action_link_helpers.rb', line 60 def display_action_link(link, content, record, ) if content html_classes = hover_via_click? ? 'hover_click ' : '' if ([:level]).zero? html_classes << 'action_group' group_tag = :div else html_classes << 'top' if [:first_action] group_tag = :li end content = content_tag(group_tag, :class => (html_classes if html_classes.present?), :onclick => ('' if hover_via_click?)) do content_tag(:div, as_(link.label), :class => link.name.to_s.downcase) << content_tag(:ul, content) end else content = render_action_link(link, record, ) content = content_tag(:li, content, :class => ('top' if [:first_action])) unless ([:level]).zero? end content = content_tag([:level_0_tag], content, [:options_level_0_tag]) if ([:level]).zero? && [:level_0_tag] content end |
#display_action_links(action_links, record, options, &block) ⇒ Object
32 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 |
# File 'lib/active_scaffold/helpers/action_link_helpers.rb', line 32 def display_action_links(action_links, record, , &block) [:level_0_tag] ||= nil [:options_level_0_tag] ||= nil [:level] ||= 0 [:first_action] = true output = ActiveSupport::SafeBuffer.new action_links.each(:reverse => .delete(:reverse), :groups => true) do |link| if link.is_a? ActiveScaffold::DataStructures::ActionLinks unless link.empty? [:level] += 1 content = display_action_links(link, record, , &block) [:level] -= 1 if content.present? output << display_action_link(link, content, record, ) [:first_action] = false end end elsif !skip_action_link?(link, *Array([:for])) , reason = (link, *Array([:for])) next if ! && [:skip_unauthorized] output << display_action_link(link, nil, record, .merge(:authorized => , :not_authorized_reason => reason)) [:first_action] = false end end output end |
#display_dynamic_action_group(action_link, links, record_or_ul_options = nil, ul_options = nil) ⇒ Object
23 24 25 26 27 28 29 30 |
# File 'lib/active_scaffold/helpers/action_link_helpers.rb', line 23 def display_dynamic_action_group(action_link, links, = nil, = nil) = if .nil? && .is_a?(Hash) record = unless .is_a?(Hash) html = content_tag :ul, do safe_join links.map { |link| content_tag :li, link } end raw "ActiveScaffold.display_dynamic_action_group('#{get_action_link_id action_link, record}', '#{escape_javascript html}');" end |
#get_action_link_id(link, record = nil, column = nil) ⇒ Object
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 |
# File 'lib/active_scaffold/helpers/action_link_helpers.rb', line 347 def get_action_link_id(link, record = nil, column = nil) column ||= link.column if column.try(:association) && record id = if column.association.collection? "#{column.association.name}-#{record.id}" elsif record.send(column.association.name).present? "#{column.association.name}-#{record.send(column.association.name).id}-#{record.id}" else "#{column.association.name}-#{record.id}" end end id ||= record.try(:id) || (nested? ? nested_parent_id : '') action_id = "#{id_from_controller("#{link.controller}-") if params[:parent_controller] || (link.controller && link.controller != controller.controller_path)}#{link.action}" action_link_id(action_id, id) end |
#query_string_for_action_links(link) ⇒ Object
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 |
# File 'lib/active_scaffold/helpers/action_link_helpers.rb', line 212 def query_string_for_action_links(link) if defined?(@query_string) && link.parameters.none? { |k, _| @query_string_params.include? k } return [@query_string, @non_nested_query_string] end keep = true @query_string_params ||= Set.new = {} = {} params_for.except(:controller, :action, :id).each do |key, value| @query_string_params << key if link.parameters.include? key keep = false next end if NESTED_PARAMS.include?(key) || conditions_from_params.include?(key) || (nested? && nested.param_name == key) [key] = value else [key] = value end end query_string = .to_query if .present? if .present? non_nested_query_string = "#{'&' if query_string}#{.to_query}" end if keep @query_string = query_string @non_nested_query_string = non_nested_query_string end [query_string, non_nested_query_string] end |
#render_action_link(link, record = nil, options = {}) ⇒ Object
81 82 83 84 85 86 87 88 89 90 91 92 93 94 |
# File 'lib/active_scaffold/helpers/action_link_helpers.rb', line 81 def render_action_link(link, record = nil, = {}) if link.action.nil? || link.column.try(:association).try(:polymorphic?) link = action_link_to_inline_form(link, record) if link.column.try(:association) [:authorized] = false if link.action.nil? || link.controller.nil? .delete :link if link.crud_type == :create end if link.action.nil? || (link.type == :member && .key?(:authorized) && ![:authorized]) action_link_html(link, nil, {:link => action_link_text(link, ), :class => "disabled #{link.action}#{" #{link.[:class]}" if link.[:class].present?}", :title => [:not_authorized_reason]}, record) else url = action_link_url(link, record) = (link, record, ) action_link_html(link, url, , record) end end |
#replace_id_params_in_action_link_url(link, record, url) ⇒ Object
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 |
# File 'lib/active_scaffold/helpers/action_link_helpers.rb', line 179 def replace_id_params_in_action_link_url(link, record, url) url = record ? url.sub('--ID--', record.to_param.to_s) : url.clone if link.column.try(:association).try(:singular?) child_id = record.send(link.column.association.name).try(:to_param) if child_id.present? url.sub!('--CHILD_ID--', child_id) else url.sub!(/\w+=--CHILD_ID--&?/, '') url.sub!(/\?$/, '') end elsif nested? url.sub!('--CHILD_ID--', params[nested.param_name].to_s) end url end |
#replaced_action_link_url_options(link, record) ⇒ Object
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 |
# File 'lib/active_scaffold/helpers/action_link_helpers.rb', line 287 def (link, record) url = (link, record) url[:controller] ||= params[:controller] , = url.partition { |_, v| v.nil? } replacements = {} replacements['--ID--'] = record.id.to_s if record if link.column.try(:association).try(:singular?) replacements['--CHILD_ID--'] = record.send(link.column.association.name).try(:id).to_s elsif nested? replacements['--CHILD_ID--'] = params[nested.param_name].to_s end .collect! do |k, v| [k.to_s, replacements[v] || v] end [, ] end |
#skip_action_link?(link, *args) ⇒ Boolean
9 10 11 |
# File 'lib/active_scaffold/helpers/action_link_helpers.rb', line 9 def skip_action_link?(link, *args) !link.ignore_method.nil? && controller.respond_to?(link.ignore_method, true) && controller.send(link.ignore_method, *args) end |
#sti_record?(record) ⇒ Boolean
155 156 157 158 159 160 |
# File 'lib/active_scaffold/helpers/action_link_helpers.rb', line 155 def sti_record?(record) return unless active_scaffold_config.active_record? model = active_scaffold_config.model record && model.columns_hash.include?(model.inheritance_column) && record[model.inheritance_column].present? && !record.instance_of?(model) end |
#url_options_for_nested_link(column, record, link, url_options) ⇒ Object
373 374 375 376 377 378 379 380 381 382 383 384 |
# File 'lib/active_scaffold/helpers/action_link_helpers.rb', line 373 def (column, record, link, ) if column.try(:association) [:parent_scaffold] = controller_path [column.model.name.foreign_key.to_sym] = .delete(:id) [:id] = if column.association.singular? && [:action].to_sym != :index '--CHILD_ID--' end elsif link.parameters && link.parameters[:named_scope] [:parent_scaffold] = controller_path [active_scaffold_config.model.name.foreign_key.to_sym] = .delete(:id) end end |
#url_options_for_sti_link(column, record, link, url_options) ⇒ Object
386 387 388 389 390 391 392 393 394 395 |
# File 'lib/active_scaffold/helpers/action_link_helpers.rb', line 386 def (column, record, link, ) # need to find out controller of current record type and set parameters # it's quite difficult to detect an sti link # if link.column.nil? we are sure that it isn't a singular association inline autolink # however that will not work if a sti parent is a singular association inline autolink return unless link.column.nil? return if (sti_controller_path = controller_path_for_activerecord(record.class)).nil? [:controller] = sti_controller_path [:parent_sti] = controller_path end |