Module: ProjectsHelper

Defined in:
app/helpers/projects_helper.rb

Overview

Redmine - project management software Copyright (C) 2006-2021 Jean-Philippe Lang

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Instance Method Summary collapse

Instance Method Details


167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
# File 'app/helpers/projects_helper.rb', line 167

def bookmark_link(project, user = User.current)
  return '' unless user && user.logged?

  @jump_box ||= Redmine::ProjectJumpBox.new user
  bookmarked = @jump_box.bookmark?(project)
  css = +"icon bookmark "

  if bookmarked
    css << "icon-bookmark"
    method = "delete"
    text = l(:button_project_bookmark_delete)
  else
    css << "icon-bookmark-off"
    method = "post"
    text = l(:button_project_bookmark)
  end

  url = bookmark_project_path(project)
  link_to text, url, remote: true, method: method, class: css
end

#format_version_sharing(sharing) ⇒ Object


117
118
119
120
# File 'app/helpers/projects_helper.rb', line 117

def format_version_sharing(sharing)
  sharing = 'none' unless Version::VERSION_SHARINGS.include?(sharing)
  l("label_version_sharing_#{sharing}")
end

#grouped_project_list(projects, query, &block) ⇒ Object


188
189
190
191
192
193
194
195
# File 'app/helpers/projects_helper.rb', line 188

def grouped_project_list(projects, query, &block)
  ancestors = []
  grouped_query_results(projects, query) do |project, group_name, group_count, group_totals|
    ancestors.pop while ancestors.any? && !project.is_descendant_of?(ancestors.last)
    yield project, ancestors.size, group_name, group_count, group_totals
    ancestors << project unless project.leaf?
  end
end

#parent_project_select_tag(project) ⇒ Object


49
50
51
52
53
54
55
56
57
58
59
60
61
# File 'app/helpers/projects_helper.rb', line 49

def parent_project_select_tag(project)
  selected = project.parent
  # retrieve the requested parent project
  parent_id = (params[:project] && params[:project][:parent_id]) || params[:parent_id]
  if parent_id
    selected = (parent_id.blank? ? nil : Project.find(parent_id))
  end

  options = +''
  options << "<option value=''>&nbsp;</option>" if project.allowed_parents.include?(nil)
  options << project_tree_options_for_select(project.allowed_parents.compact, :selected => selected)
  ('select', options.html_safe, :name => 'project[parent_id]', :id => 'project_parent_id')
end

#project_default_assigned_to_options(project) ⇒ Object


112
113
114
115
# File 'app/helpers/projects_helper.rb', line 112

def project_default_assigned_to_options(project)
  assignable_users = (project.assignable_users.to_a + [project.default_assigned_to]).uniq.compact
  principals_options_for_select(assignable_users, project.default_assigned_to)
end

#project_default_version_options(project) ⇒ Object


104
105
106
107
108
109
110
# File 'app/helpers/projects_helper.rb', line 104

def project_default_version_options(project)
  versions = project.shared_versions.open.to_a
  if project.default_version && !versions.include?(project.default_version)
    versions << project.default_version
  end
  version_options_for_select(versions, project.default_version)
end

#project_settings_tabsObject


21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# File 'app/helpers/projects_helper.rb', line 21

def project_settings_tabs
  tabs =
    [
      {:name => 'info', :action => :edit_project,
       :partial => 'projects/edit', :label => :label_project},
      {:name => 'members', :action => :manage_members,
       :partial => 'projects/settings/members', :label => :label_member_plural},
      {:name => 'issues', :action => :edit_project, :module => :issue_tracking,
       :partial => 'projects/settings/issues', :label => :label_issue_tracking},
      {:name => 'versions', :action => :manage_versions,
       :partial => 'projects/settings/versions', :label => :label_version_plural,
       :url => {:tab => 'versions', :version_status => params[:version_status],
                :version_name => params[:version_name]}},
      {:name => 'categories', :action => :manage_categories,
       :partial => 'projects/settings/issue_categories',
       :label => :label_issue_category_plural},
      {:name => 'repositories', :action => :manage_repository,
       :partial => 'projects/settings/repositories', :label => :label_repository_plural},
      {:name => 'boards', :action => :manage_boards,
       :partial => 'projects/settings/boards', :label => :label_board_plural},
      {:name => 'activities', :action => :manage_project_activities,
       :partial => 'projects/settings/activities', :label => :label_time_tracking}
    ]
  tabs.
    select {|tab| User.current.allowed_to?(tab[:action], @project)}.
    select {|tab| tab[:module].nil? || @project.module_enabled?(tab[:module])}
end

#render_api_includes(project, api) ⇒ Object


135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# File 'app/helpers/projects_helper.rb', line 135

def render_api_includes(project, api)
  api.array :trackers do
    project.rolled_up_trackers(false).visible.each do |tracker|
      api.tracker(:id => tracker.id, :name => tracker.name)
    end
  end if include_in_api_response?('trackers')

  api.array :issue_categories do
    project.issue_categories.each do |category|
      api.issue_category(:id => category.id, :name => category.name)
    end
  end if include_in_api_response?('issue_categories')

  api.array :time_entry_activities do
    project.activities.each do |activity|
      api.time_entry_activity(:id => activity.id, :name => activity.name)
    end
  end if include_in_api_response?('time_entry_activities')

  api.array :enabled_modules do
    project.enabled_modules.each do |enabled_module|
      api.enabled_module(:id => enabled_module.id, :name => enabled_module.name)
    end
  end if include_in_api_response?('enabled_modules')

  api.array :issue_custom_fields do
    project.issue_custom_fields.each do |custom_field|
      api.custom_field(:id => custom_field.id, :name => custom_field.name)
    end
  end if include_in_api_response?('issue_custom_fields')
end

#render_boards_tree(boards, parent = nil, level = 0, &block) ⇒ Object


122
123
124
125
126
127
128
129
130
131
132
133
# File 'app/helpers/projects_helper.rb', line 122

def render_boards_tree(boards, parent=nil, level=0, &block)
  selection = boards.select {|b| b.parent == parent}
  return '' if selection.empty?

  s = ''.html_safe
  selection.each do |board|
    node = capture(board, level, &block)
    node << render_boards_tree(boards, board, level+1, &block)
    s << ('div', node)
  end
  ('div', s, :class => 'sort-level')
end

63
64
65
66
67
68
69
70
71
72
# File 'app/helpers/projects_helper.rb', line 63

def render_project_action_links
  links = (+"").html_safe
  if User.current.allowed_to?(:add_project, nil, :global => true)
    links << link_to(l(:label_project_new), new_project_path, :class => 'icon icon-add')
  end
  if User.current.admin?
    links << link_to(l(:label_administration), admin_projects_path, :class => 'icon icon-settings')
  end
  links
end

#render_project_hierarchy(projects) ⇒ Object

Renders the projects index


75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'app/helpers/projects_helper.rb', line 75

def render_project_hierarchy(projects)
  bookmarked_project_ids = User.current.bookmarked_project_ids
  render_project_nested_lists(projects) do |project|
    classes = project.css_classes.split
    classes += %w(icon icon-user my-project) if User.current.member_of?(project)
    classes += %w(icon icon-bookmarked-project) if bookmarked_project_ids.include?(project.id)
    s = link_to_project(project, {}, :class => classes.uniq.join(' '))
    if project.description.present?
      s << ('div', textilizable(project.short_description, :project => project), :class => 'wiki description')
    end
    s
  end
end

#version_options_for_select(versions, selected = nil) ⇒ Object

Returns a set of options for a select field, grouped by project.


90
91
92
93
94
95
96
97
98
99
100
101
102
# File 'app/helpers/projects_helper.rb', line 90

def version_options_for_select(versions, selected=nil)
  grouped = Hash.new {|h, k| h[k] = []}
  versions.each do |version|
    grouped[version.project.name] << [version.name, version.id]
  end

  selected = selected.is_a?(Version) ? selected.id : selected
  if grouped.keys.size > 1
    grouped_options_for_select(grouped, selected)
  else
    options_for_select((grouped.values.first || []), selected)
  end
end