Module: ApplicationHelper

Defined in:
app/helpers/application_helper.rb

Overview

Copyright © 2008-2013 Michael Dvorkin and contributors.

Fat Free CRM is freely distributable under the terms of MIT license. See MIT-LICENSE file or www.opensource.org/licenses/mit-license.php

Instance Method Summary collapse

Instance Method Details

#address_field(form, object, attribute, extra_styles) ⇒ Object

Render a text field that is part of compound address.



334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'app/helpers/application_helper.rb', line 334

def address_field(form, object, attribute, extra_styles)
  hint = "#{t(attribute)}..."
  if object.send(attribute).blank?
    form.text_field(attribute,
                    style:   "margin-top: 6px; #{extra_styles}",
                    placeholder: hint
    )
  else
    form.text_field(attribute,
                    style:   "margin-top: 6px; #{extra_styles}",
                    placeholder: hint
    )
  end
end

#arrow_for(id) ⇒ Object 



99
100
101
 
# File 'app/helpers/application_helper.rb', line 99

def arrow_for(id)
  content_tag(:span, "►".html_safe, id: "#{id}_arrow", class: :arrow)
end

#avatar_for(model, args = {}) ⇒ Object

Entities can have associated avatars or gravatars. Only calls Gravatar in production env. Gravatar won’t serve default images if they are not publically available: en.gravatar.com/site/implement/images



312
313
314
315
316
317
318
319
320
 
# File 'app/helpers/application_helper.rb', line 312

def avatar_for(model, args = {})
  args = { class: 'gravatar', size: :large }.merge(args)
  if model.respond_to?(:avatar) && model.avatar.present?
    image_tag(model.avatar.image.url(args.delete(:size)), args)
  else
    args = Avatar.size_from_style!(args) # convert size format :large => '75x75'
    gravatar_image_tag(model.email, args)
  end
end

#col(title, value = nil, last = false, email = false, &_block) ⇒ Object

Create a column in the ‘asset_attributes’ table. If a block is given, render it inside the td



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'app/helpers/application_helper.rb', line 417

def col(title, value = nil, last = false, email = false, &_block)
  last_class = (last ? 'last' : nil)
  out = content_tag(:th, title, class: last_class)
  if block_given?
    out << content_tag(:td, class: last_class) do
      yield
    end
  else
    # Parse and format urls as links.
    fmt_value = (value.to_s || "").gsub("\n", "<br />")
    fmt_value = if email
                  link_to_email(fmt_value)
                else
                  fmt_value.gsub(/((http|ftp|https):\/\/[\w\-_]+(\.[\w\-_]+)+([\w\-\.,@?^=%&amp;:\/\+#]*[\w\-\@?^=%&amp;\/\+#])?)/, "<a href=\"\\1\">\\1</a>")
    end
    out << content_tag(:td, fmt_value, class: last_class)
  end
  out
end

#confirm_delete(model, params = {}) ⇒ Object 



223
224
225
226
227
228
229
230
 
# File 'app/helpers/application_helper.rb', line 223

def confirm_delete(model, params = {})
  question = %(<span class="warn">#{t(:confirm_delete, model.class.to_s.downcase)}</span>)
  yes = link_to(t(:yes_button), params[:url] || model, method: :delete)
  no = link_to_function(t(:no_button), "$('#menu').html($('#confirm').html());")
  text = "$('#confirm').html( $('#menu').html() );\n"
  text << "$('#menu').html('#{question} #{yes} : #{no}');"
  text.html_safe
end

#current_view_name ⇒ Object

Return name of current view



453
454
455
456
457
 
# File 'app/helpers/application_helper.rb', line 453

def current_view_name
  controller = params['controller']
  action = (params['action'] == 'show') ? 'show' : 'index' # create update redraw filter index actions all use index view
  current_user.pref[:"#{controller}_#{action}_view"]
end

#entity_filter_checkbox(name, value, count) ⇒ Object 



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'app/helpers/application_helper.rb', line 397

def entity_filter_checkbox(name, value, count)
  checked = (session["#{controller_name}_filter"].present? ? session["#{controller_name}_filter"].split(",").include?(value.to_s) : count.to_i > 0)
  url = url_for(action: :filter)
  onclick = %{
    var query = $('#query').val(),
        values = [];
    $('input[name=&quot;#{h name}[]&quot;]').filter(':checked').each(function () {
      values.push(this.value);
    });
    $('#loading').show();
    $.post('#{url}', {#{h name}: values.join(','), query: query}, function () {
      $('#loading').hide();
    });
  }.html_safe
  check_box_tag("#{name}[]", value, checked, id: value, onclick: onclick)
end

#exposed ⇒ Object 



195
196
197
 
# File 'app/helpers/application_helper.rb', line 195

def exposed
  { style: "display:block;"      }
end

#generate_js_for_popups(related, *assets) ⇒ Object 



69
70
71
72
73
 
# File 'app/helpers/application_helper.rb', line 69

def generate_js_for_popups(related, *assets)
  assets.map do |asset|
    render(partial: "shared/select_popup", locals: { related: related, popup: asset })
  end.join
end

#get_browser_timezone_offset ⇒ Object

Ajax helper to pass browser timezone offset to the server.



302
303
304
305
306
 
# File 'app/helpers/application_helper.rb', line 302

def get_browser_timezone_offset
  unless session[:timezone_offset]
    "$.get('#{timezone_path}', {offset: (new Date()).getTimezoneOffset()});"
  end
end

#get_default_permissions_intro(access, text) ⇒ Object

Returns default permissions intro.



324
325
326
327
328
329
330
 
# File 'app/helpers/application_helper.rb', line 324

def get_default_permissions_intro(access, text)
  case access
    when "Private" then t(:permissions_intro_private, text)
    when "Public"  then t(:permissions_intro_public,  text)
    when "Shared"  then t(:permissions_intro_shared,  text)
  end
end

#get_icon(name) ⇒ Object

Translate List name to FontAwesome icon text



505
506
507
508
509
510
511
512
513
514
515
 
# File 'app/helpers/application_helper.rb', line 505

def get_icon(name)
  case name
    when "tasks" then "fa-check-square-o"
    when "campaigns" then "fa-bar-chart-o"
    when "leads" then "fa-tasks"
    when "accounts" then "fa-users"
    when "contacts" then "fa-user"
    when "opportunities" then "fa-money"
    when "team" then "fa-globe"
  end
end

#group_options ⇒ Object 



389
390
391
 
# File 'app/helpers/application_helper.rb', line 389

def group_options
  Group.all.map { |g| [g.name, g.id] }
end

#hidden ⇒ Object 



191
192
193
 
# File 'app/helpers/application_helper.rb', line 191

def hidden
  { style: "display:none;"       }
end

#hidden_if(you_ask) ⇒ Object 



213
214
215
 
# File 'app/helpers/application_helper.rb', line 213

def hidden_if(you_ask)
  you_ask ? hidden : exposed
end

#invisible ⇒ Object 



199
200
201
 
# File 'app/helpers/application_helper.rb', line 199

def invisible
  { style: "visibility:hidden;"  }
end

#invisible_if(you_ask) ⇒ Object 



218
219
220
 
# File 'app/helpers/application_helper.rb', line 218

def invisible_if(you_ask)
  you_ask ? invisible : visible
end

#jumpbox(current) ⇒ Object 



177
178
179
180
181
182
183
 
# File 'app/helpers/application_helper.rb', line 177

def jumpbox(current)
  tabs = [:campaigns, :accounts, :leads, :contacts, :opportunities]
  current = tabs.first unless tabs.include?(current)
  tabs.map do |tab|
    link_to_function(t("tab_#{tab}"), "crm.jumper('#{tab}')", "html-data" => tab, class: (tab == current ? 'selected' : ''))
  end.join(" | ").html_safe
end

#link_to_cancel(url, params = {}) ⇒ Object 



141
142
143
144
145
146
147
 
# File 'app/helpers/application_helper.rb', line 141

def link_to_cancel(url, params = {})
  url = params[:url] if params[:url]
  link_to(t(:cancel),
          url + "#{url.include?('?') ? '&' : '?'}cancel=true",
          remote: true
  )
end

#link_to_close(url) ⇒ Object 



150
151
152
153
154
155
156
 
# File 'app/helpers/application_helper.rb', line 150

def link_to_close(url)
  link_to("x", url + "#{url.include?('?') ? '&' : '?'}cancel=true",
          remote: true,
          class: "close",
          title: t(:close_form)
  )
end

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



116
117
118
119
120
121
122
123
124
125
126
 
# File 'app/helpers/application_helper.rb', line 116

def link_to_delete(record, options = {})
  object = record.is_a?(Array) ? record.last : record
  confirm = options[:confirm] || nil

  link_to(t(:delete) + "!",
          options[:url] || url_for(record),
          method: :delete,
          remote: true,
          confirm: confirm
  )
end

#link_to_discard(object) ⇒ Object 



129
130
131
132
133
134
135
136
137
138
 
# File 'app/helpers/application_helper.rb', line 129

def link_to_discard(object)
  current_url = (request.xhr? ? request.referer : request.fullpath)
  parent, parent_id = current_url.scan(%r{/(\w+)/(\d+)}).flatten

  link_to(t(:discard),
          url_for(controller: parent, action: :discard, id: parent_id, attachment: object.class.name, attachment_id: object.id),
          method:  :post,
          remote:  true
  )
end

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



104
105
106
107
108
109
110
111
112
113
 
# File 'app/helpers/application_helper.rb', line 104

def link_to_edit(record, options = {})
  object = record.is_a?(Array) ? record.last : record

  name = (params[:klass_name] || object.class.name).underscore.downcase
  link_to(t(:edit),
          options[:url] || polymorphic_url(record, action: :edit),
          remote:  true,
          onclick: "this.href = this.href.split('?')[0] + '?previous='+crm.find_form('edit_#{h name}');".html_safe
  )
end

#link_to_email(email, length = nil, &_block) ⇒ Object

Bcc: to dropbox address if the dropbox has been set up.



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'app/helpers/application_helper.rb', line 160

def link_to_email(email, length = nil, &_block)
  name = (length ? truncate(email, length: length) : email)
  if Setting.email_dropbox && Setting.email_dropbox[:address].present?
    mailto = "#{email}?bcc=#{Setting.email_dropbox[:address]}"
  else
    mailto = email
  end
  if block_given?
    link_to("mailto:#{mailto}", title: email) do
      yield
    end
  else
    link_to(h(name), "mailto:#{mailto}", title: email)
  end
end

#link_to_inline(id, url, options = {}) ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'app/helpers/application_helper.rb', line 85

def link_to_inline(id, url, options = {})
  text = options[:text] || t(id, default: id.to_s.titleize)
  text = (arrow_for(id) + text) unless options[:plain]
  related = (options[:related] ? "&related=#{options[:related]}" : '')

  link_to(text,
          url + "#{url.include?('?') ? '&' : '?'}cancel=false" + related,
          remote: true,
          onclick: "this.href = this.href.replace(/cancel=(true|false)/,'cancel='+ ($('##{id}').css('display') != 'none'));",
          class: options[:class]
  )
end

#links_to_export(action = :index) ⇒ Object

Helper to display links to supported data export formats.



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'app/helpers/application_helper.rb', line 361

def links_to_export(action = :index)
  token = current_user.single_access_token
  url_params = { action: action }
  url_params.merge!(id: params[:id]) unless params[:id].blank?
  url_params.merge!(query: params[:query]) unless params[:query].blank?
  url_params.merge!(q: params[:q]) unless params[:q].blank?
  url_params.merge!(view: @view) unless @view.blank? # tasks
  url_params.merge!(id: params[:id]) unless params[:id].blank?

  exports = %w(xls csv).map do |format|
    link_to(format.upcase, url_params.merge(format: format), title: I18n.t(:"to_#{format}")) unless action.to_s == "show"
  end

  feeds = %w(rss atom).map do |format|
    link_to(format.upcase, url_params.merge(format: format, authentication_credentials: token), title: I18n.t(:"to_#{format}"))
  end

  links = %w(perm).map do |format|
    link_to(format.upcase, url_params, title: I18n.t(:"to_#{format}"))
  end

  (exports + feeds + links).compact.join(' | ')
end

#list_of_entities ⇒ Object 



393
394
395
 
# File 'app/helpers/application_helper.rb', line 393

def list_of_entities
  ENTITIES
end

#load_select_popups_for(related, *assets) ⇒ Object 



62
63
64
65
66
67
 
# File 'app/helpers/application_helper.rb', line 62

def load_select_popups_for(related, *assets)
  js = generate_js_for_popups(related, *assets)
  content_for(:javascript_epilogue) do
    raw "$(function() { #{js} });"
  end
end

#one_submit_only(_form = '') ⇒ Object 



208
209
210
 
# File 'app/helpers/application_helper.rb', line 208

def one_submit_only(_form = '')
  { onsubmit: "$('#'+this.id+' input[type=submit]').prop('disabled', true)".html_safe }
end

#options_menu_item(option, key, url = send("redraw_#{controller.controller_name}_path")) ⇒ Object 



286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'app/helpers/application_helper.rb', line 286

def options_menu_item(option, key, url = send("redraw_#{controller.controller_name}_path"))
  name = t("option_#{key}")
  "{ name: \"#{name.titleize}\", on_select: function() {" +
    %{
      if ($('##{option}').html() != '#{name}') {
        $('##{option}').html('#{name}');
        $('#loading').show();
        $.get('#{url}', {#{option}: '#{key}', query: $('#query').val()}, function () {
          $('#loading').hide();
        });
      }
    } + "}}"
end

#paginate(options = {}) ⇒ Object

Ajaxification FTW! e.g. collection = Opportunity.my.scope

options = { renderer: {...} , params: {...}



521
522
523
524
525
526
 
# File 'app/helpers/application_helper.rb', line 521

def paginate(options = {})
  collection = options.delete(:collection)
  options = { params: { action: 'index'}}.merge(options) if params['action'] == 'filter'
  options = { renderer: RemoteLinkPaginationHelper::LinkRenderer }.merge(options)
  will_paginate(collection, options)
end

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

We need this because standard Rails [select] turns &#9733; into &amp;#9733;



77
78
79
80
81
82
 
# File 'app/helpers/application_helper.rb', line 77

def rating_select(name, options = {})
  stars = Hash[(1..5).map { |star| [star, "&#9733;" * star] }].sort
  options_for_select = %(<option value="0"#{options[:selected].to_i == 0 ? ' selected="selected"' : ''}>#{t :select_none}</option>)
  options_for_select << stars.map { |star| %(<option value="#{star.first}"#{options[:selected] == star.first ? ' selected="selected"' : ''}>#{star.last}</option>) }.join
  select_tag name, options_for_select.html_safe, options
end

#redraw(option, value, url = send("redraw_#{controller.controller_name}_path")) ⇒ Object

Ajax helper to refresh current index page once the user selects an option.



270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'app/helpers/application_helper.rb', line 270

def redraw(option, value, url = send("redraw_#{controller.controller_name}_path"))
  if value.is_a?(Array)
    param, value = value.first, value.last
  end
  %{
    if ($('##{option}').html() != '#{value}') {
      $('##{option}').html('#{value}');
      $('#loading').show();
      $.post('#{url}', {#{option}: '#{param || value}'}, function () {
        $('#loading').hide();
      });
    }
  }
end

#refresh_sidebar(action = nil, shake = nil) ⇒ Object

Reresh sidebar using the action view within the current controller.



239
240
241
 
# File 'app/helpers/application_helper.rb', line 239

def refresh_sidebar(action = nil, shake = nil)
  refresh_sidebar_for(controller.controller_name, action, shake)
end

#refresh_sidebar_for(view, action = nil, shake = nil) ⇒ Object

Refresh sidebar using the action view within an arbitrary controller.



245
246
247
248
249
250
 
# File 'app/helpers/application_helper.rb', line 245

def refresh_sidebar_for(view, action = nil, shake = nil)
  text = ""
  text << "$('#sidebar').html('#{ j render(partial: 'layouts/sidebar', locals: { view: view, action: action }) }');"
  text << "$('##{j shake.to_s}').effect('shake', { duration:200, distance: 3 });" if shake
  text.html_safe
end

#section(related, assets) ⇒ Object 



47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'app/helpers/application_helper.rb', line 47

def section(related, assets)
  asset = assets.to_s.singularize
  create_id  = "create_#{asset}"
  select_id  = "select_#{asset}"
  create_url = controller.send(:"new_#{asset}_path")

  html = tag(:br)
  html << content_tag(:div, link_to(t(select_id), "#", id: select_id), class: "subtitle_tools")
  html << content_tag(:div, "&nbsp;|&nbsp;".html_safe, class: "subtitle_tools")
  html << content_tag(:div, link_to_inline(create_id, create_url, related: dom_id(related), text: t(create_id)), class: "subtitle_tools")
  html << content_tag(:div, t(assets), class: :subtitle, id: "create_#{asset}_title")
  html << content_tag(:div, "", class: :remote, id: create_id, style: "display:none;")
end

#section_title(id, hidden = true, text = nil, info_text = nil) ⇒ Object

Combines the ‘subtitle’ helper with the small info text on the same line.



439
440
441
442
443
444
445
446
447
448
449
 
# File 'app/helpers/application_helper.rb', line 439

def section_title(id, hidden = true, text = nil, info_text = nil)
  text = id.to_s.split("_").last.capitalize if text.nil?
  content_tag("div", class: "subtitle show_attributes") do
    content = link_to("<small>#{ hidden ? '&#9658;' : '&#9660;' }</small> #{sanitize text}".html_safe,
                      url_for(controller: :home, action: :toggle, id: id),
                      remote:  true,
                      onclick: "crm.flip_subtitle(this)"
    )
    content << content_tag("small", info_text.to_s, class: "subtitle_inline_info", id: "#{id}_intro", style: hidden ? "" : "display:none;")
  end
end

#show_flash(options = { sticky: false }) ⇒ Object

Show existing flash or embed hidden paragraph ready for flash



25
26
27
28
29
30
31
32
33
34
 
# File 'app/helpers/application_helper.rb', line 25

def show_flash(options = { sticky: false })
  [:error, :warning, :info, :notice].each do |type|
    if flash[type]
      html = content_tag(:div, h(flash[type]), id: "flash")
      flash[type] = nil
      return html << content_tag(:script, "crm.flash('#{type}', #{options[:sticky]})".html_safe, type: "text/javascript")
    end
  end
  content_tag(:p, nil, id: "flash", style: "display:none;")
end

#shown_on_landing_page? ⇒ Boolean

Return true if:

- it's an Ajax request made from the asset landing page (i.e. create opportunity
  from a contact landing page) OR
- we're actually showing asset landing page.

Returns:

  • (Boolean) 


354
355
356
357
 
# File 'app/helpers/application_helper.rb', line 354

def shown_on_landing_page?
  !!((request.xhr? && request.referer =~ %r{/\w+/\d+}) ||
     (!request.xhr? && request.fullpath =~ %r{/\w+/\d+}))
end

#spacer(width = 10) ⇒ Object 



233
234
235
 
# File 'app/helpers/application_helper.rb', line 233

def spacer(width = 10)
  image_tag "1x1.gif", width: width, height: 1, alt: nil
end

#styles_for(*models) ⇒ Object 



186
187
188
 
# File 'app/helpers/application_helper.rb', line 186

def styles_for(*models)
  render partial: "shared/inline_styles", locals: { models: models }
end

#subtitle(id, hidden = true, text = id.to_s.split("_").last.capitalize) ⇒ Object 



37
38
39
40
41
42
43
44
 
# File 'app/helpers/application_helper.rb', line 37

def subtitle(id, hidden = true, text = id.to_s.split("_").last.capitalize)
  content_tag("div",
              link_to("<small>#{ hidden ? '&#9658;' : '&#9660;' }</small> #{sanitize text}".html_safe,
                      url_for(controller: :home, action: :toggle, id: id),
                      remote: true,
                      onclick: "crm.flip_subtitle(this)"
              ), class: "subtitle")
end

#tabless_layout? ⇒ Boolean

Returns:

  • (Boolean) 


18
19
20
21
 
# File 'app/helpers/application_helper.rb', line 18

def tabless_layout?
  %w(authentications passwords).include?(controller.controller_name) ||
    ((controller.controller_name == "users") && (%w(create new).include?(controller.action_name)))
end

#tabs(tabs = nil) ⇒ Object 



7
8
9
10
11
12
13
14
15
 
# File 'app/helpers/application_helper.rb', line 7

def tabs(tabs = nil)
  tabs ||= controller_path =~ /admin/ ? FatFreeCRM::Tabs.admin : FatFreeCRM::Tabs.main
  if tabs
    @current_tab ||= tabs.first[:text] # Select first tab by default.
    tabs.each { |tab| tab[:active] = (@current_tab == tab[:text] || @current_tab == tab[:url][:controller]) }
  else
    fail FatFreeCRM::MissingSettings, "Tab settings are missing, please run <b>rake ffcrm:setup</b> command."
  end
end

#template_for_current_view ⇒ Object

Get template in current context with current view name



461
462
463
464
465
466
 
# File 'app/helpers/application_helper.rb', line 461

def template_for_current_view
  controller = params['controller']
  action = (params['action'] == 'show') ? 'show' : 'index' # create update redraw filter index actions all use index view
  template = FatFreeCRM::ViewFactory.template_for_current_view(controller: controller, action: action, name: current_view_name)
  template
end

#timeago(time, options = {}) ⇒ Object

Generate the html for $.timeago function <span class=“timeago” datetime=“2008-07-17T09:24:17Z”>July 17, 2008</span>



498
499
500
501
 
# File 'app/helpers/application_helper.rb', line 498

def timeago(time, options = {})
  options[:class] ||= "timeago"
  content_tag(:span, h(time.to_s), options.merge(title: time.getutc.iso8601)) if time
end

#user_options ⇒ Object 



385
386
387
 
# File 'app/helpers/application_helper.rb', line 385

def user_options
  User.all.map { |u| [u.full_name, u.id] }
end

#view_buttons ⇒ Object

Generate buttons for available views given the current context



470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'app/helpers/application_helper.rb', line 470

def view_buttons
  controller = params['controller']
  action = (params['action'] == 'show') ? 'show' : 'index' # create update redraw filter index actions all use index view
  views = FatFreeCRM::ViewFactory.views_for(controller: controller, action: action)
  return nil unless views.size > 1
  lis = ''.html_safe
  content_tag :ul, class: 'format-buttons' do
    views.collect do |view|
      classes = if (current_view_name == view.name) || (current_view_name.nil? && view.template.nil?) # nil indicates default template.
                  "#{h view.name}-button active"
                else
                  "#{h view.name}-button"
        end
      lis << content_tag(:li) do
        url = (action == "index") ? send("redraw_#{controller}_path") : send("#{controller.singularize}_path")
        link_to('#', title: t(view.name, default: h(view.title)), :"data-view" => h(view.name), :"data-url" => h(url), :"data-context" => action, class: classes) do
          icon = view.icon || 'fa-bars'
          content_tag(:i, nil, class: "fa #{h icon}")
        end
      end
    end
    lis
  end
end

#visible ⇒ Object 



203
204
205
 
# File 'app/helpers/application_helper.rb', line 203

def visible
  { style: "visibility:visible;" }
end

#web_presence_icons(person) ⇒ Object

Display web presence mini-icons for Contact or Lead.



254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'app/helpers/application_helper.rb', line 254

def web_presence_icons(person)
  [:blog, :linkedin, :facebook, :twitter, :skype].map do |site|
    url = person.send(site)
    unless url.blank?
      if site == :skype
        url = "callto:" << url
      else
        url = "http://" << url unless url.match(/^https?:\/\//)
      end
      link_to(image_tag("#{site}.gif", size: "15x15"), h(url), :"data-popup" => true, title: t(:open_in_window, h(url)))
    end
  end.compact.join("\n").html_safe
end