Module: ApplicationHelper

Extended by:
Forwardable
Includes:
GravatarHelper::PublicMethods, Redmine::Helpers::URL, Redmine::Hook::Helper, Redmine::I18n, Redmine::Pagination::Helper, Redmine::SudoMode::Helper, Redmine::Themes::Helper, Redmine::WikiFormatting::Macros::Definitions
Included in:
IssuesHelper, QueriesHelper, Redmine::Hook::ViewListener, TimelogHelper, UsersHelper
Defined in:
app/helpers/application_helper.rb

Overview

Since:

  • 0.4.0

Constant Summary collapse 

{
  'CustomValue'  => -> (custom_value) { link_to_record(custom_value.customized) },
  'Document'     => -> (document)     { link_to(document.title, document_path(document)) },
  'Group'        => -> (group)        { link_to(group.name, group_path(group)) },
  'Issue'        => -> (issue)        { link_to_issue(issue, :subject => false) },
  'Message'      => -> (message)      { link_to_message(message) },
  'News'         => -> (news)         { link_to(news.title, news_path(news)) },
  'Project'      => -> (project)      { link_to_project(project) },
  'User'         => -> (user)         { link_to_user(user) },
  'Version'      => -> (version)      { link_to_version(version) },
  'WikiPage'     => -> (wiki_page)    { link_to(wiki_page.pretty_title, project_wiki_page_path(wiki_page.project, wiki_page.title)) }
}
{
  # Custom list, since project/version attachments are listed in the files
  # view and not in the project/milestone view
  'Project'      => -> (project)      { link_to(l(:project_module_files), project_files_path(project)) },
  'Version'      => -> (version)      { link_to(l(:project_module_files), project_files_path(version.project)) },
}
%r{
      <a( [^>]+?)?>(?<tag_content>.*?)</a>|
      (?<leading>[\s\(,\-\[\>]|^)
      (?<esc>!)?
      (?<project_prefix>(?<project_identifier>[a-z0-9\-_]+):)?
      (?<prefix>attachment|document|version|forum|news|message|project|commit|source|export|user)?
      (
        (
          (?<sep1>\#\#?)|
          (
            (?<repo_prefix>(?<repo_identifier>[a-z0-9\-_]+)\|)?
            (?<sep2>r)
          )
        )
        (
          (?<identifier1>\d+)
          (?<comment_suffix>
            (\#note)?
            -(?<comment_id>\d+)
          )?
        )|
        (
        (?<sep3>:)
        (?<identifier2>[^"\s<>][^\s<>]*?|"[^"]+?")
        )|
        (
        (?<sep4>@)
        (?<identifier3>[A-Za-z0-9_\-@\.]*)
        )
      )
      (?=
        (?=[[:punct:]][^A-Za-z0-9_/])|
        ,|
        \s|
        \]|
        <|
        $)
}x
HEADING_RE = 
/(<h(\d)( [^>]+)?>(.+?)<\/h(\d)>)/i
MACROS_RE = 
/(
 (!)?                        # escaping
 (
 \{\{                        # opening tag
 ([\w]+)                     # macro name
 (\(([^\n\r]*?)\))?          # optional arguments
 ([\n\r].*?[\n\r])?          # optional block of text
 \}\}                        # closing tag
 )
)/mx
MACRO_SUB_RE = 
/(
\{\{
macro\((\d+)\)
\}\}
)/x
TOC_RE = 
/<p>\{\{((<|&lt;)|(>|&gt;))?toc\}\}<\/p>/i

Instance Method Summary collapse

Methods included from Redmine::Helpers::URL

#uri_with_safe_scheme?

Methods included from Redmine::Hook::Helper

#call_hook

Methods included from Redmine::Themes::Helper

#current_theme, #heads_for_theme

Methods included from Redmine::SudoMode::Helper

#hash_to_hidden_fields

Methods included from Redmine::Pagination::Helper

#pagination_links_each, #pagination_links_full, #per_page_links, #per_page_options

Methods included from Redmine::I18n

#current_language, #day_letter, #day_name, #find_language, #format_date, #format_hours, #format_time, #l, #l_hours, #l_hours_short, #l_or_humanize, #languages_options, #ll, #lu, #month_name, #set_language_if_valid, #valid_languages

Methods included from GravatarHelper::PublicMethods

#gravatar, #gravatar_api_url, #gravatar_for, #gravatar_url

Methods included from Redmine::WikiFormatting::Macros::Definitions

#exec_macro, #extract_macro_options, #macro_exists?

Instance Method Details

#accesskey(s) ⇒ Object

Since:

  • 0.6.0



656
657
658
659
660
661
662
 
# File 'app/helpers/application_helper.rb', line 656

def accesskey(s)
  @used_accesskeys ||= []
  key = Redmine::AccessKeys.key_for(s)
  return nil if @used_accesskeys.include?(key)
  @used_accesskeys << key
  key
end

#actions_dropdown(&block) ⇒ Object

Since:

  • 4.0.0



626
627
628
629
630
631
632
633
634
635
 
# File 'app/helpers/application_helper.rb', line 626

def actions_dropdown(&block)
  content = capture(&block)
  if content.present?
    trigger = content_tag('span', l(:button_actions), :class => 'icon-only icon-actions', :title => l(:button_actions))
    trigger = content_tag('span', trigger, :class => 'drdn-trigger')
    content = content_tag('div', content, :class => 'drdn-items')
    content = content_tag('div', content, :class => 'drdn-content')
    content_tag('span', trigger + content, :class => 'drdn')
  end
end

#anchor(text) ⇒ Object

Since:

  • 1.4.0



514
515
516
 
# File 'app/helpers/application_helper.rb', line 514

def anchor(text)
  text.to_s.tr(' ', '_')
end

#api_meta(options) ⇒ Object

Returns options or nil if nometa param or X-Redmine-Nometa header was set in the request

Since:

  • 1.1.0



1546
1547
1548
1549
1550
1551
1552
1553
1554
 
# File 'app/helpers/application_helper.rb', line 1546

def api_meta(options)
  if params[:nometa].present? || request.headers['X-Redmine-Nometa']
    # compatibility mode for activeresource clients that raise
    # an error when deserializing an array with attributes
    nil
  else
    options
  end
end

#authoring(created, author, options = {}) ⇒ Object

Since:

  • 0.6.0



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

def authoring(created, author, options={})
  l(options[:label] || :label_added_time_by, :author => link_to_user(author), :age => time_tag(created)).html_safe
end

#authorize_for(controller, action) ⇒ Object

Return true if user is authorized for controller/action, otherwise false



37
38
39
 
# File 'app/helpers/application_helper.rb', line 37

def authorize_for(controller, action)
  User.current.allowed_to?({:controller => controller, :action => action}, @project)
end

#avatar(user, options = { }) ⇒ Object

Returns the avatar image tag for the given user if avatars are enabled user can be a User or a string that will be scanned for an email address (eg. 'joe <joe@foo.bar>')

Since:

  • 0.8.0



1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
 
# File 'app/helpers/application_helper.rb', line 1468

def avatar(user, options = { })
  if Setting.gravatar_enabled?
    options.merge!(:default => Setting.gravatar_default)
    email = nil
    if user.respond_to?(:mail)
      email = user.mail
    elsif user.to_s =~ %r{<(.+?)>}
      email = $1
    end
    if email.present?
      gravatar(email.to_s.downcase, options) rescue nil
    elsif user.is_a?(AnonymousUser)
      image_tag 'anonymous.png',
                GravatarHelper::DEFAULT_OPTIONS
                  .except(:default, :rating, :ssl).merge(options)
    else
      nil
    end
  else
    ''
  end
end

#avatar_edit_link(user, options = {}) ⇒ Object

Returns a link to edit user's avatar if avatars are enabled

Since:

  • 3.1.0



1492
1493
1494
1495
1496
1497
 
# File 'app/helpers/application_helper.rb', line 1492

def avatar_edit_link(user, options={})
  if Setting.gravatar_enabled?
    url = "https://gravatar.com"
    link_to avatar(user, {:title => l(:button_edit)}.merge(options)), url, :target => '_blank'
  end
end

#back_url ⇒ Object

Since:

  • 2.1.0



1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
 
# File 'app/helpers/application_helper.rb', line 1295

def back_url
  url = params[:back_url]
  if url.nil? && referer = request.env['HTTP_REFERER']
    url = CGI.unescape(referer.to_s)
    # URLs that contains the utf8=[checkmark] parameter added by Rails are
    # parsed as invalid by URI.parse so the redirect to the back URL would
    # not be accepted (ApplicationController#validate_back_url would return
    # false)
    url.gsub!(/(\?|&)utf8=\u2713&?/, '\1')
  end
  url
end

#back_url_hidden_field_tag ⇒ Object

Since:

  • 0.7.0



1308
1309
1310
1311
 
# File 'app/helpers/application_helper.rb', line 1308

def back_url_hidden_field_tag
  url = back_url
  hidden_field_tag('back_url', url, :id => nil) unless url.blank?
end

#body_css_classes ⇒ Object

Returns the theme, controller name, and action as css classes for the HTML body.

Since:

  • 1.0.1



639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'app/helpers/application_helper.rb', line 639

def body_css_classes
  css = []
  if theme = Redmine::Themes.theme(Setting.ui_theme)
    css << 'theme-' + theme.name
  end

  css << 'project-' + @project.identifier if @project && @project.identifier.present?
  css << 'has-main-menu' if display_main_menu?(@project)
  css << 'controller-' + controller_name
  css << 'action-' + action_name
  css << 'avatars-' + (Setting.gravatar_enabled? ? 'on' : 'off')
  if UserPreference::TEXTAREA_FONT_OPTIONS.include?(User.current.pref.textarea_font)
    css << "textarea-#{User.current.pref.textarea_font}"
  end
  css.join(' ')
end

#breadcrumb(*args) ⇒ Object

Since:

  • 0.7.0



559
560
561
562
 
# File 'app/helpers/application_helper.rb', line 559

def breadcrumb(*args)
  elements = args.flatten
  elements.any? ? content_tag('p', (args.join(" \xc2\xbb ") + " \xc2\xbb ").html_safe, :class => 'breadcrumb') : nil
end

#bulk_edit_error_messages(items) ⇒ Object

Returns an array of error messages for bulk edited items (issues, time entries)

Since:

  • 4.0.0



1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
 
# File 'app/helpers/application_helper.rb', line 1575

def bulk_edit_error_messages(items)
  messages = {}
  items.each do |item|
    item.errors.full_messages.each do |message|
      messages[message] ||= []
      messages[message] << item
    end
  end
  messages.map { |message, items|
    "#{message}: " + items.map {|i| "##{i.id}"}.join(', ')
  }
end

#calendar_for(field_id) ⇒ Object 



1370
1371
1372
1373
 
# File 'app/helpers/application_helper.rb', line 1370

def calendar_for(field_id)
  include_calendar_headers_tags
  javascript_tag("$(function() { $('##{field_id}').addClass('date').datepickerFallback(datepickerOptions); });")
end

#cancel_button_tag(fallback_url) ⇒ Object

Since:

  • 4.0.0



1313
1314
1315
1316
 
# File 'app/helpers/application_helper.rb', line 1313

def cancel_button_tag(fallback_url)
  url = back_url.blank? ? fallback_url : back_url
  link_to l(:button_cancel), url
end

#catch_macros(text) ⇒ Object

Extracts macros from text

Since:

  • 2.1.0



1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
 
# File 'app/helpers/application_helper.rb', line 1151

def catch_macros(text)
  macros = {}
  text.gsub!(MACROS_RE) do
    all, macro = $1, $4.downcase
    if macro_exists?(macro) || all =~ MACRO_SUB_RE
      index = macros.size
      macros[index] = all
      "{{macro(#{index})}}"
    else
      all
    end
  end
  macros
end

#check_all_links(form_name) ⇒ Object 



1318
1319
1320
1321
1322
 
# File 'app/helpers/application_helper.rb', line 1318

def check_all_links(form_name)
  link_to_function(l(:button_check_all), "checkAll('#{form_name}', true)") +
  " | ".html_safe +
  link_to_function(l(:button_uncheck_all), "checkAll('#{form_name}', false)")
end

#checked_image(checked = true) ⇒ Object

Since:

  • 1.0.0



1348
1349
1350
1351
1352
 
# File 'app/helpers/application_helper.rb', line 1348

def checked_image(checked=true)
  if checked
    @checked_image_tag ||= content_tag(:span, nil, :class => 'icon-only icon-checked')
  end
end

#context_menu ⇒ Object

Since:

  • 1.0.0



1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
 
# File 'app/helpers/application_helper.rb', line 1354

def context_menu
  unless @context_menu_included
    content_for :header_tags do
      javascript_include_tag('context_menu') +
        stylesheet_link_tag('context_menu')
    end
    if l(:direction) == 'rtl'
      content_for :header_tags do
        stylesheet_link_tag('context_menu_rtl')
      end
    end
    @context_menu_included = true
  end
  nil
end

#default_search_project_scope ⇒ Object

Returns the default scope for the quick search form Could be 'all', 'my_projects', 'subprojects' or nil (current project)

Since:

  • 3.4.0



394
395
396
397
398
 
# File 'app/helpers/application_helper.rb', line 394

def default_search_project_scope
  if @project && !@project.leaf?
    'subprojects'
  end
end

#delete_link(url, options = {}) ⇒ Object

Since:

  • 2.1.0



1272
1273
1274
1275
1276
1277
1278
1279
1280
 
# File 'app/helpers/application_helper.rb', line 1272

def delete_link(url, options={})
  options = {
    :method => :delete,
    :data => {:confirm => l(:text_are_you_sure)},
    :class => 'icon icon-del'
  }.merge(options)

  link_to l(:button_delete), url, options
end

#due_date_distance_in_words(date) ⇒ Object

Since:

  • 0.8.0



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

def due_date_distance_in_words(date)
  if date
    l((date < User.current.today ? :label_roadmap_overdue : :label_roadmap_due_in), distance_of_date_in_words(User.current.today, date))
  end
end

#email_delivery_enabled? ⇒ Boolean

Returns:

  • (Boolean)

Since:

  • 1.3.0



1462
1463
1464
 
# File 'app/helpers/application_helper.rb', line 1462

def email_delivery_enabled?
  !!ActionMailer::Base.perform_deliveries
end

#error_messages_for(*objects) ⇒ Object

Render the error messages for the given objects

Since:

  • 1.4.0



1253
1254
1255
1256
1257
 
# File 'app/helpers/application_helper.rb', line 1253

def error_messages_for(*objects)
  objects = objects.map {|o| o.is_a?(String) ? instance_variable_get("@#{o}") : o}.compact
  errors = objects.map {|o| o.errors.full_messages}.flatten
  render_error_messages(errors)
end

#export_csv_encoding_select_tag ⇒ Object

Since:

  • 4.0.0



1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
 
# File 'app/helpers/application_helper.rb', line 1561

def export_csv_encoding_select_tag
  return if l(:general_csv_encoding).casecmp('UTF-8') == 0
  options = [l(:general_csv_encoding), 'UTF-8']
  content_tag(:p) do
    concat(
      content_tag(:label) do
        concat l(:label_encoding) + ' '
        concat select_tag('encoding', options_for_select(options, l(:general_csv_encoding)))
      end
    )
  end
end

#favicon ⇒ Object

Since:

  • 1.0.1



1512
1513
1514
 
# File 'app/helpers/application_helper.rb', line 1512

def favicon
  "<link rel='shortcut icon' href='#{favicon_path}' />".html_safe
end

#favicon_path ⇒ Object

Returns the path to the favicon

Since:

  • 2.5.0



1517
1518
1519
1520
 
# File 'app/helpers/application_helper.rb', line 1517

def favicon_path
  icon = (current_theme && current_theme.favicon?) ? current_theme.favicon_path : '/favicon.ico'
  image_path(icon)
end

#favicon_url ⇒ Object

Returns the full URL to the favicon

Since:

  • 2.5.0



1523
1524
1525
1526
1527
1528
 
# File 'app/helpers/application_helper.rb', line 1523

def favicon_url
  # TODO: use #image_url introduced in Rails4
  path = favicon_path
  base = url_for(:controller => 'welcome', :action => 'index', :only_path => false)
  base.sub(%r{/+$},'') + '/' + path.sub(%r{^/+},'')
end

#format_activity_day(date) ⇒ Object

Since:

  • 0.8.0



293
294
295
 
# File 'app/helpers/application_helper.rb', line 293

def format_activity_day(date)
  date == User.current.today ? l(:label_today).titleize : format_date(date)
end

#format_activity_description(text) ⇒ Object

Since:

  • 0.8.0



297
298
299
300
 
# File 'app/helpers/application_helper.rb', line 297

def format_activity_description(text)
  h(text.to_s.truncate(120).gsub(%r{[\r\n]*<(pre|code)>.*$}m, '...')
     ).gsub(/[\r\n]+/, "<br />").html_safe
end

#format_activity_title(text) ⇒ Object

Used to format item titles on the activity view

Since:

  • 0.8.0



289
290
291
 
# File 'app/helpers/application_helper.rb', line 289

def format_activity_title(text)
  text
end

#format_changeset_comments(changeset, options = {}) ⇒ Object

Since:

  • 3.4.0



310
311
312
313
 
# File 'app/helpers/application_helper.rb', line 310

def format_changeset_comments(changeset, options={})
  method = options[:short] ? :short_comments : :comments
  textilizable changeset, method, :formatting => Setting.commit_logs_formatting?
end

#format_object(object, html = true, &block) ⇒ Object

Helper that formats object for html or text rendering

Since:

  • 2.5.0



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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'app/helpers/application_helper.rb', line 215

def format_object(object, html=true, &block)
  if block_given?
    object = yield object
  end
  case object.class.name
  when 'Array'
    formatted_objects = object.map {|o| format_object(o, html)}
    html ? safe_join(formatted_objects, ', ') : formatted_objects.join(', ')
  when 'Time'
    format_time(object)
  when 'Date'
    format_date(object)
  when 'Fixnum'
    object.to_s
  when 'Float'
    sprintf "%.2f", object
  when 'User'
    html ? link_to_user(object) : object.to_s
  when 'Project'
    html ? link_to_project(object) : object.to_s
  when 'Version'
    html ? link_to_version(object) : object.to_s
  when 'TrueClass'
    l(:general_text_Yes)
  when 'FalseClass'
    l(:general_text_No)
  when 'Issue'
    object.visible? && html ? link_to_issue(object) : "##{object.id}"
  when 'Attachment'
    html ? link_to_attachment(object) : object.filename
  when 'CustomValue', 'CustomFieldValue'
    if object.custom_field
      f = object.custom_field.format.formatted_custom_value(self, object, html)
      if f.nil? || f.is_a?(String)
        f
      else
        format_object(f, html, &block)
      end
    else
      object.value.to_s
    end
  else
    html ? h(object) : object.to_s
  end
end

#format_version_name(version) ⇒ Object

Since:

  • 0.9.0



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

def format_version_name(version)
  if version.project == @project
    h(version)
  else
    h("#{version.project} - #{version}")
  end
end

#generate_csv(&block) ⇒ Object

Since:

  • 3.1.0



1556
1557
1558
1559
 
# File 'app/helpers/application_helper.rb', line 1556

def generate_csv(&block)
  decimal_separator = l(:general_csv_decimal_separator)
  encoding = l(:general_csv_encoding)
end

#html_hours(text) ⇒ Object

Since:

  • 0.7.0



518
519
520
 
# File 'app/helpers/application_helper.rb', line 518

def html_hours(text)
  text.gsub(%r{(\d+)([\.:])(\d+)}, '<span class="hours hours-int">\1</span><span class="hours hours-dec">\2\3</span>').html_safe
end

#html_title(*args) ⇒ Object

Sets the html title Returns the html title when called without arguments Current project name and app_title and automatically appended Exemples:

html_title 'Foo', 'Bar'
html_title # => 'Foo - Bar - My Project - Redmine'

Since:

  • 0.6.0



614
615
616
617
618
619
620
621
622
623
624
 
# File 'app/helpers/application_helper.rb', line 614

def html_title(*args)
  if args.empty?
    title = @html_title || []
    title << @project.name if @project
    title << Setting.app_title unless Setting.app_title == title.last
    title.reject(&:blank?).join(' - ')
  else
    @html_title ||= []
    @html_title += args
  end
end

#image_tag(source, options = {}) ⇒ Object

Overrides Rails' image_tag with themes and plugins support. Examples:

image_tag('image.png') # => picks image.png from the current theme or defaults
image_tag('image.png', :plugin => 'foo) # => picks image.png from plugin's assets

Since:

  • 2.0.0



1426
1427
1428
1429
1430
1431
1432
1433
 
# File 'app/helpers/application_helper.rb', line 1426

def image_tag(source, options={})
  if plugin = options.delete(:plugin)
    source = "/plugin_assets/#{plugin}/images/#{source}"
  elsif current_theme && current_theme.images.include?(source)
    source = current_theme.image_path(source)
  end
  super source, options
end

#include_calendar_headers_tags ⇒ Object

Since:

  • 0.7.0



1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
 
# File 'app/helpers/application_helper.rb', line 1375

def include_calendar_headers_tags
  unless @calendar_headers_tags_included
    tags = ''.html_safe
    @calendar_headers_tags_included = true
    content_for :header_tags do
      start_of_week = Setting.start_of_week
      start_of_week = l(:general_first_day_of_week, :default => '1') if start_of_week.blank?
      # Redmine uses 1..7 (monday..sunday) in settings and locales
      # JQuery uses 0..6 (sunday..saturday), 7 needs to be changed to 0
      start_of_week = start_of_week.to_i % 7
      tags << javascript_tag(
                 "var datepickerOptions={dateFormat: 'yy-mm-dd', firstDay: #{start_of_week}, " +
                   "showOn: 'button', buttonImageOnly: true, buttonImage: '" +
                   path_to_image('/images/calendar.png') +
                   "', showButtonPanel: true, showWeek: true, showOtherMonths: true, " +
                   "selectOtherMonths: true, changeMonth: true, changeYear: true, " +
                   "beforeShow: beforeShowDatePicker};")
      jquery_locale = l('jquery.locale', :default => current_language.to_s)
      unless jquery_locale == 'en'
        tags << javascript_include_tag("i18n/datepicker-#{jquery_locale}.js")
      end
      tags
    end
  end
end

#include_in_api_response?(arg) ⇒ Boolean

Returns true if arg is expected in the API response

Returns:

  • (Boolean)

Since:

  • 1.1.0



1535
1536
1537
1538
1539
1540
1541
1542
 
# File 'app/helpers/application_helper.rb', line 1535

def include_in_api_response?(arg)
  unless @included_in_api_response
    param = params[:include]
    @included_in_api_response = param.is_a?(Array) ? param.collect(&:to_s) : param.to_s.split(',')
    @included_in_api_response.collect!(&:strip)
  end
  @included_in_api_response.include?(arg.to_s)
end

#inject_macros(text, obj, macros, execute = true) ⇒ Object

Executes and replaces macros in text

Since:

  • 2.1.0



1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
 
# File 'app/helpers/application_helper.rb', line 1167

def inject_macros(text, obj, macros, execute=true)
  text.gsub!(MACRO_SUB_RE) do
    all, index = $1, $2.to_i
    orig = macros.delete(index)
    if execute && orig && orig =~ MACROS_RE
      esc, all, macro, args, block = $2, $3, $4.downcase, $6.to_s, $7.try(:strip)
      if esc.nil?
        h(exec_macro(macro, obj, args, block) || all)
      else
        h(all)
      end
    elsif orig
      h(orig)
    else
      h(all)
    end
  end
end

#javascript_heads ⇒ Object

Returns the javascript tags that are included in the html layout head

Since:

  • 1.2.0



1504
1505
1506
1507
1508
1509
1510
 
# File 'app/helpers/application_helper.rb', line 1504

def javascript_heads
  tags = javascript_include_tag('jquery-1.11.1-ui-1.11.0-ujs-4.3.1', 'application', 'responsive')
  unless User.current.pref.warn_on_leaving_unsaved == '0'
    tags << "\n".html_safe + javascript_tag("$(window).load(function(){ warnLeavingUnsaved('#{escape_javascript l(:text_warn_on_leaving_unsaved)}'); });")
  end
  tags
end

#javascript_include_tag(*sources) ⇒ Object

Overrides Rails' javascript_include_tag with plugins support Examples:

javascript_include_tag('scripts') # => picks scripts.js from defaults
javascript_include_tag('scripts', :plugin => 'foo) # => picks scripts.js from plugin's assets

Since:

  • 2.0.0



1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
 
# File 'app/helpers/application_helper.rb', line 1440

def javascript_include_tag(*sources)
  options = sources.last.is_a?(Hash) ? sources.pop : {}
  if plugin = options.delete(:plugin)
    sources = sources.map do |source|
      if plugin
        "/plugin_assets/#{plugin}/javascripts/#{source}"
      else
        source
      end
    end
  end
  super *sources, options
end

#labelled_fields_for(*args, &proc) ⇒ Object

Since:

  • 1.4.0



1245
1246
1247
1248
1249
1250
 
# File 'app/helpers/application_helper.rb', line 1245

def labelled_fields_for(*args, &proc)
  args << {} unless args.last.is_a?(Hash)
  options = args.last
  options.merge!({:builder => Redmine::Views::LabelledFormBuilder})
  fields_for(*args, &proc)
end

#labelled_form_for(*args, &proc) ⇒ Object

Since:

  • 1.3.0



1235
1236
1237
1238
1239
1240
1241
1242
1243
 
# File 'app/helpers/application_helper.rb', line 1235

def labelled_form_for(*args, &proc)
  args << {} unless args.last.is_a?(Hash)
  options = args.last
  if args.first.is_a?(Symbol)
    options.merge!(:as => args.shift)
  end
  options.merge!({:builder => Redmine::Views::LabelledFormBuilder})
  form_for(*args, &proc)
end

#lang_options_for_select(blank = true) ⇒ Object 



1231
1232
1233
 
# File 'app/helpers/application_helper.rb', line 1231

def lang_options_for_select(blank=true)
  (blank ? [["(auto)", ""]] : []) + languages_options
end

#link_to_attachment(attachment, options = {}) ⇒ Object

Generates a link to an attachment. Options:

  • :text - Link text (default to attachment filename)

  • :download - Force download (default: false)

Since:

  • 0.8.0



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

def link_to_attachment(attachment, options={})
  text = options.delete(:text) || attachment.filename
  if options.delete(:download)
    route_method = :download_named_attachment_url
    options[:filename] = attachment.filename
  else
    route_method = :attachment_url
    # make sure we don't have an extraneous :filename in the options
    options.delete(:filename)
  end
  html_options = options.slice!(:only_path, :filename)
  options[:only_path] = true unless options.key?(:only_path)
  url = send(route_method, attachment, options)
  link_to text, url, html_options
end

#link_to_attachment_container(attachment_container) ⇒ Object

Since:

  • 4.0.0



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

def link_to_attachment_container(attachment_container)
  if link = ATTACHMENT_CONTAINER_LINK[attachment_container.class.name] ||
            RECORD_LINK[attachment_container.class.name]
    self.instance_exec(attachment_container, &link)
  end
end

#link_to_context_menu ⇒ Object

Since:

  • 4.0.0



1286
1287
1288
 
# File 'app/helpers/application_helper.rb', line 1286

def link_to_context_menu
  link_to l(:button_actions), '#', title: l(:button_actions), class: 'icon-only icon-actions js-contextmenu'
end

#link_to_function(name, function, html_options = {}) ⇒ Object

Since:

  • 2.1.0



1282
1283
1284
 
# File 'app/helpers/application_helper.rb', line 1282

def link_to_function(name, function, html_options={})
  content_tag(:a, name, {:href => '#', :onclick => "#{function}; return false;"}.merge(html_options))
end

#link_to_if_authorized(name, options = {}, html_options = nil, *parameters_for_method_reference) ⇒ Object

Display a link if user is authorized

Parameters:

  • name (String) —

    Anchor text (passed to link_to)

  • options (Hash) (defaults to: {}) —

    Hash params. This will checked by authorize_for to see if the user is authorized

  • html_options (optional, Hash) (defaults to: nil) —

    Options passed to link_to

  • parameters_for_method_reference (optional, Hash) —

    Extra parameters for link_to



47
48
49
 
# File 'app/helpers/application_helper.rb', line 47

def link_to_if_authorized(name, options = {}, html_options = nil, *parameters_for_method_reference)
  link_to(name, options, html_options, *parameters_for_method_reference) if authorize_for(options[:controller] || params[:controller], options[:action])
end

#link_to_issue(issue, options = {}) ⇒ Object

Displays a link to issue with its subject. Examples:

link_to_issue(issue)                        # => Defect #6: This is the subject
link_to_issue(issue, :truncate => 6)        # => Defect #6: This i...
link_to_issue(issue, :subject => false)     # => Defect #6
link_to_issue(issue, :project => true)      # => Foo - Defect #6
link_to_issue(issue, :subject => false, :tracker => false)     # => #6

Since:

  • 0.5.0



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'app/helpers/application_helper.rb', line 75

def link_to_issue(issue, options={})
  title = nil
  subject = nil
  text = options[:tracker] == false ? "##{issue.id}" : "#{issue.tracker} ##{issue.id}"
  if options[:subject] == false
    title = issue.subject.truncate(60)
  else
    subject = issue.subject
    if truncate_length = options[:truncate]
      subject = subject.truncate(truncate_length)
    end
  end
  only_path = options[:only_path].nil? ? true : options[:only_path]
  s = link_to(text, issue_url(issue, :only_path => only_path),
              :class => issue.css_classes, :title => title)
  s << h(": #{subject}") if subject
  s = h("#{issue.project} - ") + s if options[:project]
  s
end

#link_to_message(message, options = {}, html_options = nil) ⇒ Object

Generates a link to a message

Since:

  • 1.2.0



133
134
135
136
137
138
139
140
141
142
143
 
# File 'app/helpers/application_helper.rb', line 133

def link_to_message(message, options={}, html_options = nil)
  link_to(
    message.subject.truncate(60),
    board_message_url(message.board_id, message.parent_id || message.id, {
      :r => (message.parent_id && message.id),
      :anchor => (message.parent_id ? "message-#{message.id}" : nil),
      :only_path => true
    }.merge(options)),
    html_options
  )
end

#link_to_project(project, options = {}, html_options = nil) ⇒ Object

Generates a link to a project if active Examples:

link_to_project(project)                          # => link to the specified project overview
link_to_project(project, {:only_path => false}, :class => "project") # => 3rd arg adds html options
link_to_project(project, {}, :class => "project") # => html options with default url (project overview)

Since:

  • 1.0.1



152
153
154
155
156
157
158
159
160
 
# File 'app/helpers/application_helper.rb', line 152

def link_to_project(project, options={}, html_options = nil)
  if project.archived?
    h(project.name)
  else
    link_to project.name,
      project_url(project, {:only_path => true}.merge(options)),
      html_options
  end
end

#link_to_project_settings(project, options = {}, html_options = nil) ⇒ Object

Generates a link to a project settings if active

Since:

  • 2.3.0



163
164
165
166
167
168
169
170
171
 
# File 'app/helpers/application_helper.rb', line 163

def link_to_project_settings(project, options={}, html_options=nil)
  if project.active?
    link_to project.name, settings_project_path(project, options), html_options
  elsif project.archived?
    h(project.name)
  else
    link_to project.name, project_path(project, options), html_options
  end
end

#link_to_record(record) ⇒ Object

Since:

  • 4.0.0



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

def link_to_record(record)
  if link = RECORD_LINK[record.class.name]
    self.instance_exec(record, &link)
  end
end

#link_to_revision(revision, repository, options = {}) ⇒ Object

Generates a link to a SCM revision Options:

  • :text - Link text (default to the formatted revision)

Since:

  • 0.9.0



118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'app/helpers/application_helper.rb', line 118

def link_to_revision(revision, repository, options={})
  if repository.is_a?(Project)
    repository = repository.repository
  end
  text = options.delete(:text) || format_revision(revision)
  rev = revision.respond_to?(:identifier) ? revision.identifier : revision
  link_to(
      h(text),
      {:controller => 'repositories', :action => 'revision', :id => repository.project, :repository_id => repository.identifier_param, :rev => rev},
      :title => l(:label_revision_id, format_revision(revision)),
      :accesskey => options[:accesskey]
    )
end

#link_to_user(user, options = {}) ⇒ Object

Displays a link to user's account page if active



52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'app/helpers/application_helper.rb', line 52

def link_to_user(user, options={})
  if user.is_a?(User)
    name = h(user.name(options[:format]))
    if user.active? || (User.current.admin? && user.logged?)
      only_path = options[:only_path].nil? ? true : options[:only_path]
      link_to name, user_url(user, :only_path => only_path), :class => user.css_classes
    else
      name
    end
  else
    h(user.to_s)
  end
end

#link_to_version(version, options = {}) ⇒ Object

Generates a link to a version

Since:

  • 2.6.0



174
175
176
177
178
 
# File 'app/helpers/application_helper.rb', line 174

def link_to_version(version, options = {})
  return '' unless version && version.is_a?(Version)
  options = {:title => format_date(version.effective_date)}.merge(options)
  link_to_if version.visible?, format_version_name(version), version_path(version), options
end

#option_tag(name, text, value, selected = nil, options = {}) ⇒ Object

Since:

  • 2.4.0



496
497
498
 
# File 'app/helpers/application_helper.rb', line 496

def option_tag(name, text, value, selected=nil, options={})
  content_tag 'option', value, options.merge(:value => value, :selected => (value == selected))
end

#other_formats_links {|Redmine::Views::OtherFormatsBuilder.new(self)| ... } ⇒ Object

Yields:

Since:

  • 0.9.0



564
565
566
567
568
 
# File 'app/helpers/application_helper.rb', line 564

def other_formats_links(&block)
  concat('<p class="other-formats">'.html_safe + l(:label_export_to))
  yield Redmine::Views::OtherFormatsBuilder.new(self)
  concat('</p>'.html_safe)
end

#page_header_title ⇒ Object

Since:

  • 0.9.0



570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'app/helpers/application_helper.rb', line 570

def page_header_title
  if @project.nil? || @project.new_record?
    h(Setting.app_title)
  else
    b = []
    ancestors = (@project.root? ? [] : @project.ancestors.visible.to_a)
    if ancestors.any?
      root = ancestors.shift
      b << link_to_project(root, {:jump => current_menu_item}, :class => 'root')
      if ancestors.size > 2
        b << "\xe2\x80\xa6"
        ancestors = ancestors[-2, 2]
      end
      b += ancestors.collect {|p| link_to_project(p, {:jump => current_menu_item}, :class => 'ancestor') }
    end
    b << content_tag(:span, h(@project), class: 'current-project')
    if b.size > 1
      separator = content_tag(:span, ' &raquo; '.html_safe, class: 'separator')
      path = safe_join(b[0..-2], separator) + separator
      b = [content_tag(:span, path.html_safe, class: 'breadcrumbs'), b[-1]]
    end
    safe_join b
  end
end

#parse_headings(text, project, obj, attr, only_path, options) ⇒ Object

Headings and TOC Adds ids and links to headings unless options is set to false

Since:

  • 1.1.0



1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
 
# File 'app/helpers/application_helper.rb', line 1114

def parse_headings(text, project, obj, attr, only_path, options)
  return if options[:headings] == false

  text.gsub!(HEADING_RE) do
    level, attrs, content = $2.to_i, $3, $4
    item = strip_tags(content).strip
    anchor = sanitize_anchor_name(item)
    # used for single-file wiki export
    anchor = "#{obj.page.title}_#{anchor}" if options[:wiki_links] == :anchor && (obj.is_a?(WikiContent) || obj.is_a?(WikiContent::Version))
    @heading_anchors[anchor] ||= 0
    idx = (@heading_anchors[anchor] += 1)
    if idx > 1
      anchor = "#{anchor}-#{idx}"
    end
    @parsed_headings << [level, anchor, item]
    "<a name=\"#{anchor}\"></a>\n<h#{level} #{attrs}>#{content}<a href=\"##{anchor}\" class=\"wiki-anchor\">&para;</a></h#{level}>"
  end
end

#parse_hires_images(text, project, obj, attr, only_path, options) ⇒ Object

add srcset attribute to img tags if filename includes @2x, @3x, etc. to support hires displays

Since:

  • 3.4.0



748
749
750
751
752
753
 
# File 'app/helpers/application_helper.rb', line 748

def parse_hires_images(text, project, obj, attr, only_path, options)
  text.gsub!(/src="([^"]+@(\dx)\.(bmp|gif|jpg|jpe|jpeg|png))"/i) do |m|
    filename, dpr = $1, $2
    m + " srcset=\"#{filename} #{dpr}\""
  end
end

#parse_inline_attachments(text, project, obj, attr, only_path, options) ⇒ Object

Since:

  • 1.0.0



755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
 
# File 'app/helpers/application_helper.rb', line 755

def parse_inline_attachments(text, project, obj, attr, only_path, options)
  return if options[:inline_attachments] == false

  # when using an image link, try to use an attachment, if possible
  attachments = options[:attachments] || []
  attachments += obj.attachments if obj.respond_to?(:attachments)
  if attachments.present?
    text.gsub!(/src="([^\/"]+\.(bmp|gif|jpg|jpe|jpeg|png))"(\s+alt="([^"]*)")?/i) do |m|
      filename, ext, alt, alttext = $1.downcase, $2, $3, $4
      # search for the picture in attachments
      if found = Attachment.latest_attach(attachments, CGI.unescape(filename))
        image_url = download_named_attachment_url(found, found.filename, :only_path => only_path)
        desc = found.description.to_s.gsub('"', '')
        if !desc.blank? && alttext.blank?
          alt = " title=\"#{desc}\" alt=\"#{desc}\""
        end
        "src=\"#{image_url}\"#{alt}"
      else
        m
      end
    end
  end
end

#parse_non_pre_blocks(text, obj, macros) ⇒ Object

Since:

  • 1.0.0



714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
 
# File 'app/helpers/application_helper.rb', line 714

def parse_non_pre_blocks(text, obj, macros)
  s = StringScanner.new(text)
  tags = []
  parsed = ''
  while !s.eos?
    s.scan(/(.*?)(<(\/)?(pre|code)(.*?)>|\z)/im)
    text, full_tag, closing, tag = s[1], s[2], s[3], s[4]
    if tags.empty?
      yield text
      inject_macros(text, obj, macros) if macros.any?
    else
      inject_macros(text, obj, macros, false) if macros.any?
    end
    parsed << text
    if tag
      if closing
        if tags.last && tags.last.casecmp(tag) == 0
          tags.pop
        end
      else
        tags << tag.downcase
      end
      parsed << full_tag
    end
  end
  # Close any non closing tags
  while tag = tags.pop
    parsed << "</#{tag}>"
  end
  parsed
end

#parse_redmine_links(text, default_project, obj, attr, only_path, options) ⇒ Object

Redmine links

Examples:

Issues:
  #52 -> Link to issue #52
  ##52 -> Link to issue #52, including the issue's subject
Changesets:
  r52 -> Link to revision 52
  commit:a85130f -> Link to scmid starting with a85130f
Documents:
  document#17 -> Link to document with id 17
  document:Greetings -> Link to the document with title "Greetings"
  document:"Some document" -> Link to the document with title "Some document"
Versions:
  version#3 -> Link to version with id 3
  version:1.0.0 -> Link to version named "1.0.0"
  version:"1.0 beta 2" -> Link to version named "1.0 beta 2"
Attachments:
  attachment:file.zip -> Link to the attachment of the current object named file.zip
Source files:
  source:some/file -> Link to the file located at /some/file in the project's repository
  source:some/file@52 -> Link to the file's revision 52
  source:some/file#L120 -> Link to line 120 of the file
  source:some/file@52#L120 -> Link to line 120 of the file's revision 52
  export:some/file -> Force the download of the file
Forums:
  forum#1 -> Link to forum with id 1
  forum:Support -> Link to forum named "Support"
  forum:"Technical Support" -> Link to forum named "Technical Support"
Forum messages:
  message#1218 -> Link to message with id 1218
Projects:
  project:someproject -> Link to project named "someproject"
  project#3 -> Link to project with id 3
News:
  news#2 -> Link to news item with id 1
  news:Greetings -> Link to news item named "Greetings"
  news:"First Release" -> Link to news item named "First Release"
Users:
  user:jsmith -> Link to user with login jsmith
  @jsmith -> Link to user with login jsmith
  user#2 -> Link to user with id 2

Links can refer other objects from other projects, using project identifier:
  identifier:r52
  identifier:document:"Some document"
  identifier:version:1.0.0
  identifier:source:some/file

Since:

  • 1.0.0



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
 
# File 'app/helpers/application_helper.rb', line 888

def parse_redmine_links(text, default_project, obj, attr, only_path, options)
  text.gsub!(LINKS_RE) do |_|
    tag_content = $~[:tag_content]
    leading = $~[:leading]
    esc = $~[:esc]
    project_prefix = $~[:project_prefix]
    project_identifier = $~[:project_identifier]
    prefix = $~[:prefix]
    repo_prefix = $~[:repo_prefix]
    repo_identifier = $~[:repo_identifier]
    sep = $~[:sep1] || $~[:sep2] || $~[:sep3] || $~[:sep4]
    identifier = $~[:identifier1] || $~[:identifier2] || $~[:identifier3]
    comment_suffix = $~[:comment_suffix]
    comment_id = $~[:comment_id]

    if tag_content
      $&
    else
      link = nil
      project = default_project
      if project_identifier
        project = Project.visible.find_by_identifier(project_identifier)
      end
      if esc.nil?
        if prefix.nil? && sep == 'r'
          if project
            repository = nil
            if repo_identifier
              repository = project.repositories.detect {|repo| repo.identifier == repo_identifier}
            else
              repository = project.repository
            end
            # project.changesets.visible raises an SQL error because of a double join on repositories
            if repository &&
                 (changeset = Changeset.visible.
                                  find_by_repository_id_and_revision(repository.id, identifier))
              link = link_to(h("#{project_prefix}#{repo_prefix}r#{identifier}"),
                             {:only_path => only_path, :controller => 'repositories',
                              :action => 'revision', :id => project,
                              :repository_id => repository.identifier_param,
                              :rev => changeset.revision},
                             :class => 'changeset',
                             :title => truncate_single_line_raw(changeset.comments, 100))
            end
          end
        elsif sep == '#' || sep == '##'
          oid = identifier.to_i
          case prefix
          when nil
            if oid.to_s == identifier &&
              issue = Issue.visible.find_by_id(oid)
              anchor = comment_id ? "note-#{comment_id}" : nil
              url = issue_url(issue, :only_path => only_path, :anchor => anchor)
              link = if sep == '##'
                link_to("#{issue.tracker.name} ##{oid}#{comment_suffix}",
                        url,
                        :class => issue.css_classes,
                        :title => "#{issue.tracker.name}: #{issue.subject.truncate(100)} (#{issue.status.name})") + ": #{issue.subject}"
              else
                link_to("##{oid}#{comment_suffix}",
                        url,
                        :class => issue.css_classes,
                        :title => "#{issue.tracker.name}: #{issue.subject.truncate(100)} (#{issue.status.name})")
              end
            end
          when 'document'
            if document = Document.visible.find_by_id(oid)
              link = link_to(document.title, document_url(document, :only_path => only_path), :class => 'document')
            end
          when 'version'
            if version = Version.visible.find_by_id(oid)
              link = link_to(version.name, version_url(version, :only_path => only_path), :class => 'version')
            end
          when 'message'
            if message = Message.visible.find_by_id(oid)
              link = link_to_message(message, {:only_path => only_path}, :class => 'message')
            end
          when 'forum'
            if board = Board.visible.find_by_id(oid)
              link = link_to(board.name, project_board_url(board.project, board, :only_path => only_path), :class => 'board')
            end
          when 'news'
            if news = News.visible.find_by_id(oid)
              link = link_to(news.title, news_url(news, :only_path => only_path), :class => 'news')
            end
          when 'project'
            if p = Project.visible.find_by_id(oid)
              link = link_to_project(p, {:only_path => only_path}, :class => 'project')
            end
          when 'user'
            u = User.visible.find_by(:id => oid, :type => 'User')
            link = link_to_user(u, :only_path => only_path) if u
          end
        elsif sep == ':'
          name = remove_double_quotes(identifier)
          case prefix
          when 'document'
            if project && document = project.documents.visible.find_by_title(name)
              link = link_to(document.title, document_url(document, :only_path => only_path), :class => 'document')
            end
          when 'version'
            if project && version = project.versions.visible.find_by_name(name)
              link = link_to(version.name, version_url(version, :only_path => only_path), :class => 'version')
            end
          when 'forum'
            if project && board = project.boards.visible.find_by_name(name)
              link = link_to(board.name, project_board_url(board.project, board, :only_path => only_path), :class => 'board')
            end
          when 'news'
            if project && news = project.news.visible.find_by_title(name)
              link = link_to(news.title, news_url(news, :only_path => only_path), :class => 'news')
            end
          when 'commit', 'source', 'export'
            if project
              repository = nil
              if name =~ %r{^(([a-z0-9\-_]+)\|)(.+)$}
                repo_prefix, repo_identifier, name = $1, $2, $3
                repository = project.repositories.detect {|repo| repo.identifier == repo_identifier}
              else
                repository = project.repository
              end
              if prefix == 'commit'
                if repository && (changeset = Changeset.visible.where("repository_id = ? AND scmid LIKE ?", repository.id, "#{name}%").first)
                  link = link_to h("#{project_prefix}#{repo_prefix}#{name}"), {:only_path => only_path, :controller => 'repositories', :action => 'revision', :id => project, :repository_id => repository.identifier_param, :rev => changeset.identifier},
                                               :class => 'changeset',
                                               :title => truncate_single_line_raw(changeset.comments, 100)
                end
              else
                if repository && User.current.allowed_to?(:browse_repository, project)
                  name =~ %r{^[/\\]*(.*?)(@([^/\\@]+?))?(#(L\d+))?$}
                  path, rev, anchor = $1, $3, $5
                  link = link_to h("#{project_prefix}#{prefix}:#{repo_prefix}#{name}"), {:only_path => only_path, :controller => 'repositories', :action => (prefix == 'export' ? 'raw' : 'entry'), :id => project, :repository_id => repository.identifier_param,
                                                          :path => to_path_param(path),
                                                          :rev => rev,
                                                          :anchor => anchor},
                                                         :class => (prefix == 'export' ? 'source download' : 'source')
                end
              end
              repo_prefix = nil
            end
          when 'attachment'
            attachments = options[:attachments] || []
            attachments += obj.attachments if obj.respond_to?(:attachments)
            if attachments && attachment = Attachment.latest_attach(attachments, name)
              link = link_to_attachment(attachment, :only_path => only_path, :class => 'attachment')
            end
          when 'project'
            if p = Project.visible.where("identifier = :s OR LOWER(name) = :s", :s => name.downcase).first
              link = link_to_project(p, {:only_path => only_path}, :class => 'project')
            end
          when 'user'
            u = User.visible.find_by("LOWER(login) = :s AND type = 'User'", :s => name.downcase)
            link = link_to_user(u, :only_path => only_path) if u
          end
        elsif sep == "@"
          name = remove_double_quotes(identifier)
          u = User.visible.find_by("LOWER(login) = :s AND type = 'User'", :s => name.downcase)
          link = link_to_user(u, :only_path => only_path) if u
        end
      end
      (leading + (link || "#{project_prefix}#{prefix}#{repo_prefix}#{sep}#{identifier}#{comment_suffix}"))
    end
  end
end

#parse_sections(text, project, obj, attr, only_path, options) ⇒ Object

Since:

  • 1.3.0



1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
 
# File 'app/helpers/application_helper.rb', line 1094

def parse_sections(text, project, obj, attr, only_path, options)
  return unless options[:edit_section_links]
  text.gsub!(HEADING_RE) do
    heading, level = $1, $2
    @current_section += 1
    if @current_section > 1
      content_tag('div',
        link_to(l(:button_edit_section), options[:edit_section_links].merge(:section => @current_section),
                :class => 'icon-only icon-edit'),
        :class => "contextual heading-#{level}",
        :title => l(:button_edit_section),
        :id => "section-#{@current_section}") + heading.html_safe
    else
      heading
    end
  end
end

#parse_wiki_links(text, project, obj, attr, only_path, options) ⇒ Object

Wiki links

Examples:

[[mypage]]
[[mypage|mytext]]

wiki links can refer other project wikis, using project name or identifier:

[[project:]] -> wiki starting page
[[project:|mytext]]
[[project:mypage]]
[[project:mypage|mytext]]

Since:

  • 1.0.0



789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
 
# File 'app/helpers/application_helper.rb', line 789

def parse_wiki_links(text, project, obj, attr, only_path, options)
  text.gsub!(/(!)?(\[\[([^\]\n\|]+)(\|([^\]\n\|]+))?\]\])/) do |m|
    link_project = project
    esc, all, page, title = $1, $2, $3, $5
    if esc.nil?
      page = CGI.unescapeHTML(page)
      if page =~ /^\#(.+)$/
        anchor = sanitize_anchor_name($1)
        url = "##{anchor}"
        next link_to(title.present? ? title.html_safe : h(page), url, :class => 'wiki-page')
      end

      if page =~ /^([^\:]+)\:(.*)$/
        identifier, page = $1, $2
        link_project = Project.find_by_identifier(identifier) || Project.find_by_name(identifier)
        title ||= identifier if page.blank?
      end

      if link_project && link_project.wiki && User.current.allowed_to?(:view_wiki_pages, link_project)
        # extract anchor
        anchor = nil
        if page =~ /^(.+?)\#(.+)$/
          page, anchor = $1, $2
        end
        anchor = sanitize_anchor_name(anchor) if anchor.present?
        # check if page exists
        wiki_page = link_project.wiki.find_page(page)
        url = if anchor.present? && wiki_page.present? && (obj.is_a?(WikiContent) || obj.is_a?(WikiContent::Version)) && obj.page == wiki_page
          "##{anchor}"
        else
          case options[:wiki_links]
          when :local; "#{page.present? ? Wiki.titleize(page) : ''}.html" + (anchor.present? ? "##{anchor}" : '')
          when :anchor; "##{page.present? ? Wiki.titleize(page) : title}" + (anchor.present? ? "_#{anchor}" : '') # used for single-file wiki export
          else
            wiki_page_id = page.present? ? Wiki.titleize(page) : nil
            parent = wiki_page.nil? && obj.is_a?(WikiContent) && obj.page && project == link_project ? obj.page.title : nil
            url_for(:only_path => only_path, :controller => 'wiki', :action => 'show', :project_id => link_project,
             :id => wiki_page_id, :version => nil, :anchor => anchor, :parent => parent)
          end
        end
        link_to(title.present? ? title.html_safe : h(page), url, :class => ('wiki-page' + (wiki_page ? '' : ' new')))
      else
        # project or wiki doesn't exist
        all
      end
    else
      all
    end
  end
end

#principals_check_box_tags(name, principals) ⇒ Object

Since:

  • 0.9.0



471
472
473
474
475
476
477
 
# File 'app/helpers/application_helper.rb', line 471

def principals_check_box_tags(name, principals)
  s = ''
  principals.each do |principal|
    s << "<label>#{ check_box_tag name, principal.id, false, :id => nil } #{h principal}</label>\n"
  end
  s.html_safe
end

#principals_options_for_select(collection, selected = nil) ⇒ Object

Returns a string for users/groups option tags

Since:

  • 1.3.0



480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'app/helpers/application_helper.rb', line 480

def principals_options_for_select(collection, selected=nil)
  s = ''
  if collection.include?(User.current)
    s << content_tag('option', "<< #{l(:label_me)} >>", :value => User.current.id)
  end
  groups = ''
  collection.sort.each do |element|
    selected_attribute = ' selected="selected"' if option_value_selected?(element, selected) || element.id.to_s == selected
    (element.is_a?(Group) ? groups : s) << %(<option value="#{element.id}"#{selected_attribute}>#{h element.name}</option>)
  end
  unless groups.empty?
    s << %(<optgroup label="#{h(l(:label_group_plural))}">#{groups}</optgroup>)
  end
  s.html_safe
end

#progress_bar(pcts, options = {}) ⇒ Object

Since:

  • 0.6.1



1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
 
# File 'app/helpers/application_helper.rb', line 1331

def progress_bar(pcts, options={})
  pcts = [pcts, pcts] unless pcts.is_a?(Array)
  pcts = pcts.collect(&:round)
  pcts[1] = pcts[1] - pcts[0]
  pcts << (100 - pcts[1] - pcts[0])
  titles = options[:titles].to_a
  titles[0] = "#{pcts[0]}%" if titles[0].blank?
  legend = options[:legend] || ''
  content_tag('table',
    content_tag('tr',
      (pcts[0] > 0 ? content_tag('td', '', :style => "width: #{pcts[0]}%;", :class => 'closed', :title => titles[0]) : ''.html_safe) +
      (pcts[1] > 0 ? content_tag('td', '', :style => "width: #{pcts[1]}%;", :class => 'done', :title => titles[1]) : ''.html_safe) +
      (pcts[2] > 0 ? content_tag('td', '', :style => "width: #{pcts[2]}%;", :class => 'todo', :title => titles[2]) : ''.html_safe)
    ), :class => "progress progress-#{pcts[0]}").html_safe +
    content_tag('p', legend, :class => 'percent').html_safe
end

#project_tree(projects, options = {}, &block) ⇒ Object

Yields the given block for each project with its level in the tree

Wrapper for Project#project_tree

Since:

  • 0.9.0



467
468
469
 
# File 'app/helpers/application_helper.rb', line 467

def project_tree(projects, options={}, &block)
  Project.project_tree(projects, options, &block)
end

#project_tree_options_for_select(projects, options = {}) ⇒ Object

Since:

  • 0.9.0



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'app/helpers/application_helper.rb', line 442

def project_tree_options_for_select(projects, options = {})
  s = ''.html_safe
  if blank_text = options[:include_blank]
    if blank_text == true
      blank_text = '&nbsp;'.html_safe
    end
    s << content_tag('option', blank_text, :value => '')
  end
  project_tree(projects) do |project, level|
    name_prefix = (level > 0 ? '&nbsp;' * 2 * level + '&#187; ' : '').html_safe
    tag_options = {:value => project.id}
    if project == options[:selected] || (options[:selected].respond_to?(:include?) && options[:selected].include?(project))
      tag_options[:selected] = 'selected'
    else
      tag_options[:selected] = nil
    end
    tag_options.merge!(yield(project)) if block_given?
    s << content_tag('option', name_prefix + h(project), tag_options)
  end
  s.html_safe
end

#projects_for_jump_box(user = User.current) ⇒ Object

Returns an array of projects that are displayed in the quick-jump box

Since:

  • 3.4.0



401
402
403
404
405
406
407
 
# File 'app/helpers/application_helper.rb', line 401

def projects_for_jump_box(user=User.current)
  if user.logged?
    user.projects.active.select(:id, :name, :identifier, :lft, :rgt).to_a
  else
    []
  end
end

#raw_json(arg) ⇒ Object

Helper to render JSON in views

Since:

  • 2.1.2



1291
1292
1293
 
# File 'app/helpers/application_helper.rb', line 1291

def raw_json(arg)
  arg.to_json.to_s.gsub('/', '\/').html_safe
end

#render_error_messages(errors) ⇒ Object

Renders a list of error messages

Since:

  • 3.3.0



1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
 
# File 'app/helpers/application_helper.rb', line 1260

def render_error_messages(errors)
  html = ""
  if errors.present?
    html << "<div id='errorExplanation'><ul>\n"
    errors.each do |error|
      html << "<li>#{h error}</li>\n"
    end
    html << "</ul></div>\n"
  end
  html.html_safe
end

#render_flash_messages ⇒ Object

Renders flash messages

Since:

  • 0.8.1



371
372
373
374
375
376
377
 
# File 'app/helpers/application_helper.rb', line 371

def render_flash_messages
  s = ''
  flash.each do |k,v|
    s << content_tag('div', v.html_safe, :class => "flash #{k}", :id => "flash_#{k}")
  end
  s.html_safe
end

#render_page_hierarchy(pages, node = nil, options = {}) ⇒ Object

Since:

  • 0.8.0



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'app/helpers/application_helper.rb', line 354

def render_page_hierarchy(pages, node=nil, options={})
  content = ''
  if pages[node]
    content << "<ul class=\"pages-hierarchy\">\n"
    pages[node].each do |page|
      content << "<li>"
      content << link_to(h(page.pretty_title), {:controller => 'wiki', :action => 'show', :project_id => page.project, :id => page.title, :version => nil},
                         :title => (options[:timestamp] && page.updated_on ? l(:label_updated_time, distance_of_time_in_words(Time.now, page.updated_on)) : nil))
      content << "\n" + render_page_hierarchy(pages, page.id, options) if pages[page.id]
      content << "</li>\n"
    end
    content << "</ul>\n"
  end
  content.html_safe
end

#render_project_jump_box ⇒ Object

Renders the project quick-jump box

Since:

  • 0.9.0



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'app/helpers/application_helper.rb', line 421

def render_project_jump_box
  projects = projects_for_jump_box(User.current)
  if @project && @project.persisted?
    text = @project.name_was
  end
  text ||= l(:label_jump_to_a_project)
  url = autocomplete_projects_path(:format => 'js', :jump => current_menu_item)

  trigger = content_tag('span', text, :class => 'drdn-trigger')
  q = text_field_tag('q', '', :id => 'projects-quick-search', :class => 'autocomplete', :data => {:automcomplete_url => url}, :autocomplete => 'off')
  all = link_to(l(:label_project_all), projects_path(:jump => current_menu_item), :class => (@project.nil? && controller.class.main_menu ? 'selected' : nil))
  content = content_tag('div',
        content_tag('div', q, :class => 'quick-search') +
        content_tag('div', render_projects_for_jump_box(projects, @project), :class => 'drdn-items projects selection') +
        content_tag('div', all, :class => 'drdn-items all-projects selection'),
      :class => 'drdn-content'
    )

  content_tag('div', trigger + content, :id => "project-jump", :class => "drdn")
end

#render_project_nested_lists(projects, &block) ⇒ Object

Renders a tree of projects as a nested set of unordered lists The given collection may be a subset of the whole project tree (eg. some intermediate nodes are private and can not be seen)

Since:

  • 2.1.0



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'app/helpers/application_helper.rb', line 324

def render_project_nested_lists(projects, &block)
  s = ''
  if projects.any?
    ancestors = []
    original_project = @project
    projects.sort_by(&:lft).each do |project|
      # set the project environment to please macros.
      @project = project
      if (ancestors.empty? || project.is_descendant_of?(ancestors.last))
        s << "<ul class='projects #{ ancestors.empty? ? 'root' : nil}'>\n"
      else
        ancestors.pop
        s << "</li>"
        while (ancestors.any? && !project.is_descendant_of?(ancestors.last))
          ancestors.pop
          s << "</ul></li>\n"
        end
      end
      classes = (ancestors.empty? ? 'root' : 'child')
      s << "<li class='#{classes}'><div class='#{classes}'>"
      s << h(block_given? ? capture(project, &block) : project.name)
      s << "</div>\n"
      ancestors << project
    end
    s << ("</li></ul>\n" * ancestors.size)
    @project = original_project
  end
  s.html_safe
end

#render_projects_for_jump_box(projects, selected = nil) ⇒ Object

Since:

  • 3.4.0



409
410
411
412
413
414
415
416
417
418
 
# File 'app/helpers/application_helper.rb', line 409

def render_projects_for_jump_box(projects, selected=nil)
  jump = params[:jump].presence || current_menu_item
  s = ''.html_safe
  project_tree(projects) do |project, level|
    padding = level * 16
    text = content_tag('span', project.name, :style => "padding-left:#{padding}px;")
    s << link_to(text, project_path(project, :jump => jump), :title => project.name, :class => (project == selected ? 'selected' : nil))
  end
  s
end

#render_tabs(tabs, selected = params[:tab]) ⇒ Object

Renders tabs and their content

Since:

  • 0.9.0



380
381
382
383
384
385
386
387
388
389
390
 
# File 'app/helpers/application_helper.rb', line 380

def render_tabs(tabs, selected=params[:tab])
  if tabs.any?
    unless tabs.detect {|tab| tab[:name] == selected}
      selected = nil
    end
    selected ||= tabs.first[:name]
    render :partial => 'common/tabs', :locals => {:tabs => tabs, :selected_tab => selected}
  else
    content_tag 'p', l(:label_no_data), :class => "nodata"
  end
end

#reorder_handle(object, options = {}) ⇒ Object

Since:

  • 3.3.0



548
549
550
551
552
553
554
555
556
557
 
# File 'app/helpers/application_helper.rb', line 548

def reorder_handle(object, options={})
  data = {
    :reorder_url => options[:url] || url_for(object),
    :reorder_param => options[:param] || object.class.name.underscore
  }
  content_tag('span', '',
    :class => "sort-handle",
    :data => data,
    :title => l(:button_sort))
end

#replace_toc(text, headings) ⇒ Object

Renders the TOC with given headings

Since:

  • 1.1.0



1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
 
# File 'app/helpers/application_helper.rb', line 1189

def replace_toc(text, headings)
  text.gsub!(TOC_RE) do
    left_align, right_align = $2, $3
    # Keep only the 4 first levels
    headings = headings.select{|level, anchor, item| level <= 4}
    if headings.empty?
      ''
    else
      div_class = 'toc'
      div_class << ' right' if right_align
      div_class << ' left' if left_align
      out = "<ul class=\"#{div_class}\"><li><strong>#{l :label_table_of_contents}</strong></li><li>"
      root = headings.map(&:first).min
      current = root
      started = false
      headings.each do |level, anchor, item|
        if level > current
          out << '<ul><li>' * (level - current)
        elsif level < current
          out << "</li></ul>\n" * (current - level) + "</li><li>"
        elsif started
          out << '</li><li>'
        end
        out << "<a href=\"##{anchor}\">#{item}</a>"
        current = level
        started = true
      end
      out << '</li></ul>' * (current - root)
      out << '</li></ul>'
    end
  end
end

#robot_exclusion_tag ⇒ Object

Since:

  • 1.2.0



1530
1531
1532
 
# File 'app/helpers/application_helper.rb', line 1530

def robot_exclusion_tag
  '<meta name="robots" content="noindex,follow,noarchive" />'.html_safe
end

#sanitize_anchor_name(anchor) ⇒ Object

Since:

  • 1.2.2



1499
1500
1501
 
# File 'app/helpers/application_helper.rb', line 1499

def sanitize_anchor_name(anchor)
  anchor.gsub(%r{[^\s\-\p{Word}]}, '').gsub(%r{\s+(\-+\s*)?}, '-')
end

#sidebar_content? ⇒ Boolean

Returns:

  • (Boolean)

Since:

  • 2.0.0



1454
1455
1456
 
# File 'app/helpers/application_helper.rb', line 1454

def sidebar_content?
  content_for?(:sidebar) || view_layouts_base_sidebar_hook_response.present?
end

#simple_format_without_paragraph(text) ⇒ Object

Same as Rails' simple_format helper without using paragraphs

Since:

  • 0.5.1



1223
1224
1225
1226
1227
1228
1229
 
# File 'app/helpers/application_helper.rb', line 1223

def simple_format_without_paragraph(text)
  text.to_s.
    gsub(/\r\n?/, "\n").                    # \r\n and \r -> \n
    gsub(/\n\n+/, "<br /><br />").          # 2+ newline  -> 2 br
    gsub(/([^\n]\n)(?=[^\n])/, '\1<br />'). # 1 newline   -> br
    html_safe
end

#stylesheet_link_tag(*sources) ⇒ Object

Overrides Rails' stylesheet_link_tag with themes and plugins support. Examples:

stylesheet_link_tag('styles') # => picks styles.css from the current theme or defaults
stylesheet_link_tag('styles', :plugin => 'foo) # => picks styles.css from plugin's assets

Since:

  • 2.0.0



1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
 
# File 'app/helpers/application_helper.rb', line 1406

def stylesheet_link_tag(*sources)
  options = sources.last.is_a?(Hash) ? sources.pop : {}
  plugin = options.delete(:plugin)
  sources = sources.map do |source|
    if plugin
      "/plugin_assets/#{plugin}/stylesheets/#{source}"
    elsif current_theme && current_theme.stylesheets.include?(source)
      current_theme.stylesheet_path(source)
    else
      source
    end
  end
  super *sources, options
end

#syntax_highlight(name, content) ⇒ Object

Since:

  • 0.8.0



539
540
541
 
# File 'app/helpers/application_helper.rb', line 539

def syntax_highlight(name, content)
  Redmine::SyntaxHighlighting.highlight_by_filename(content, name)
end

#syntax_highlight_lines(name, content) ⇒ Object

Since:

  • 1.4.0



535
536
537
 
# File 'app/helpers/application_helper.rb', line 535

def syntax_highlight_lines(name, content)
  syntax_highlight(name, content).each_line.to_a
end

#textilizable(*args) ⇒ Object

Formats text according to system settings. 2 ways to call this method:

  • with a String: textilizable(text, options)

  • with an object and one of its attribute: textilizable(issue, :description, options)



668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'app/helpers/application_helper.rb', line 668

def textilizable(*args)
  options = args.last.is_a?(Hash) ? args.pop : {}
  case args.size
  when 1
    obj = options[:object]
    text = args.shift
  when 2
    obj = args.shift
    attr = args.shift
    text = obj.send(attr).to_s
  else
    raise ArgumentError, 'invalid arguments to textilizable'
  end
  return '' if text.blank?
  project = options[:project] || @project || (obj && obj.respond_to?(:project) ? obj.project : nil)
  @only_path = only_path = options.delete(:only_path) == false ? false : true

  text = text.dup
  macros = catch_macros(text)

  if options[:formatting] == false
    text = h(text)
  else
    formatting = Setting.text_formatting
    text = Redmine::WikiFormatting.to_html(formatting, text, :object => obj, :attribute => attr)
  end

  @parsed_headings = []
  @heading_anchors = {}
  @current_section = 0 if options[:edit_section_links]

  parse_sections(text, project, obj, attr, only_path, options)
  text = parse_non_pre_blocks(text, obj, macros) do |text|
    [:parse_inline_attachments, :parse_hires_images, :parse_wiki_links, :parse_redmine_links].each do |method_name|
      send method_name, text, project, obj, attr, only_path, options
    end
  end
  parse_headings(text, project, obj, attr, only_path, options)

  if @parsed_headings.any?
    replace_toc(text, @parsed_headings)
  end

  text.html_safe
end

#thumbnail_tag(attachment) ⇒ Object

Since:

  • 2.1.0



265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'app/helpers/application_helper.rb', line 265

def thumbnail_tag(attachment)
  thumbnail_size = Setting.thumbnails_size.to_i
  link_to(
    image_tag(
      thumbnail_path(attachment),
      :srcset => "#{thumbnail_path(attachment, :size => thumbnail_size * 2)} 2x",
      :style => "max-width: #{thumbnail_size}px; max-height: #{thumbnail_size}px;"
    ),
    attachment_path(
      attachment
    ),
    :title => attachment.filename
  )
end

#time_tag(time) ⇒ Object

Since:

  • 0.9.0



526
527
528
529
530
531
532
533
 
# File 'app/helpers/application_helper.rb', line 526

def time_tag(time)
  text = distance_of_time_in_words(Time.now, time)
  if @project
    link_to(text, project_activity_path(@project, :from => User.current.time_to_date(time)), :title => format_time(time))
  else
    content_tag('abbr', text, :title => format_time(time))
  end
end

#title(*args) ⇒ Object

Returns a h2 tag and sets the html title with the given arguments

Since:

  • 2.4.0



596
597
598
599
600
601
602
603
604
605
606
 
# File 'app/helpers/application_helper.rb', line 596

def title(*args)
  strings = args.map do |arg|
    if arg.is_a?(Array) && arg.size >= 2
      link_to(*arg)
    else
      h(arg.to_s)
    end
  end
  html_title args.reverse.map {|s| (s.is_a?(Array) ? s.first : s).to_s}
  content_tag('h2', strings.join(' &#187; ').html_safe)
end

#to_path_param(path) ⇒ Object

Since:

  • 0.8.0



543
544
545
546
 
# File 'app/helpers/application_helper.rb', line 543

def to_path_param(path)
  str = path.to_s.split(%r{[/\\]}).select{|p| !p.blank?}.join("/")
  str.blank? ? nil : str
end

#toggle_checkboxes_link(selector) ⇒ Object

Since:

  • 3.0.0



1324
1325
1326
1327
1328
1329
 
# File 'app/helpers/application_helper.rb', line 1324

def toggle_checkboxes_link(selector)
  link_to_function '',
    "toggleCheckboxesBySelector('#{selector}')",
    :title => "#{l(:button_check_all)} / #{l(:button_uncheck_all)}",
    :class => 'icon icon-checked'
end

#toggle_link(name, id, options = {}) ⇒ Object

Since:

  • 0.5.0



280
281
282
283
284
285
286
 
# File 'app/helpers/application_helper.rb', line 280

def toggle_link(name, id, options={})
  onclick = "$('##{id}').toggle(); "
  onclick << (options[:focus] ? "$('##{options[:focus]}').focus(); " : "this.blur(); ")
  onclick << "$(window).scrollTop($('##{options[:focus]}').position().top); " if options[:scroll]
  onclick << "return false;"
  link_to(name, "#", :onclick => onclick)
end

#truncate_lines(string, options = {}) ⇒ Object

Truncates at line break after 250 characters or options

Since:

  • 1.0.0



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

def truncate_lines(string, options={})
  length = options[:length] || 250
  if string.to_s =~ /\A(.{#{length}}.*?)$/m
    "#{$1}..."
  else
    string
  end
end

#truncate_single_line_raw(string, length) ⇒ Object

Since:

  • 2.5.0



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

def truncate_single_line_raw(string, length)
  string.to_s.truncate(length).gsub(%r{[\r\n]+}m, ' ')
end

#view_layouts_base_sidebar_hook_response ⇒ Object

Since:

  • 2.0.0



1458
1459
1460
 
# File 'app/helpers/application_helper.rb', line 1458

def view_layouts_base_sidebar_hook_response
  @view_layouts_base_sidebar_hook_response ||= call_hook(:view_layouts_base_sidebar)
end

#wiki_page_path(page, options = {}) ⇒ Object

Since:

  • 2.2.0



261
262
263
 
# File 'app/helpers/application_helper.rb', line 261

def wiki_page_path(page, options={})
  url_for({:controller => 'wiki', :action => 'show', :project_id => page.project, :id => page.title}.merge(options))
end