SoundSoftware Code Site

# Redmine - project management software

# Copyright (C) 2006-2011  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.

module IssuesHelper

  include ApplicationHelper

  def issue_list(issues, &block)

    ancestors = []

    issues.each do |issue|

      while (ancestors.any? && !issue.is_descendant_of?(ancestors.last))

        ancestors.pop

      end

      yield issue, ancestors.size

      ancestors << issue unless issue.leaf?

    end

  end

  # Renders a HTML/CSS tooltip

  #

  # To use, a trigger div is needed.  This is a div with the class of "tooltip"

  # that contains this method wrapped in a span with the class of "tip"

  #

  #    <div class="tooltip"><%= link_to_issue(issue) %>

  #      <span class="tip"><%= render_issue_tooltip(issue) %></span>

  #    </div>

  #

  def render_issue_tooltip(issue)

    @cached_label_status ||= l(:field_status)

    @cached_label_start_date ||= l(:field_start_date)

    @cached_label_due_date ||= l(:field_due_date)

    @cached_label_assigned_to ||= l(:field_assigned_to)

    @cached_label_priority ||= l(:field_priority)

    @cached_label_project ||= l(:field_project)

    link_to_issue(issue) + "<br /><br />" +

      "<strong>#{@cached_label_project}</strong>: #{link_to_project(issue.project)}<br />" +

      "<strong>#{@cached_label_status}</strong>: #{issue.status.name}<br />" +

      "<strong>#{@cached_label_start_date}</strong>: #{format_date(issue.start_date)}<br />" +

      "<strong>#{@cached_label_due_date}</strong>: #{format_date(issue.due_date)}<br />" +

      "<strong>#{@cached_label_assigned_to}</strong>: #{issue.assigned_to}<br />" +

      "<strong>#{@cached_label_priority}</strong>: #{issue.priority.name}"

  end

  def issue_heading(issue)

    h("#{issue.tracker} ##{issue.id}")

  end

  def render_issue_subject_with_tree(issue)

    s = ''

    ancestors = issue.root? ? [] : issue.ancestors.visible.all

    ancestors.each do |ancestor|

      s << '<div>' + content_tag('p', link_to_issue(ancestor))

    end

    s << '<div>'

    subject = h(issue.subject)

    if issue.is_private?

      subject = content_tag('span', l(:field_is_private), :class => 'private') + ' ' + subject

    end

    s << content_tag('h3', subject)

    s << '</div>' * (ancestors.size + 1)

    s

  end

  def render_descendants_tree(issue)

    s = '<form><table class="list issues">'

    issue_list(issue.descendants.visible.sort_by(&:lft)) do |child, level|

      s << content_tag('tr',

             content_tag('td', check_box_tag("ids[]", child.id, false, :id => nil), :class => 'checkbox') +

             content_tag('td', link_to_issue(child, :truncate => 60), :class => 'subject') +

             content_tag('td', h(child.status)) +

             content_tag('td', link_to_user(child.assigned_to)) +

             content_tag('td', progress_bar(child.done_ratio, :width => '80px')),

             :class => "issue issue-#{child.id} hascontextmenu #{level > 0 ? "idnt idnt-#{level}" : nil}")

    end

    s << '</form></table>'

    s

  end

  def render_custom_fields_rows(issue)

    return if issue.custom_field_values.empty?

    ordered_values = []

    half = (issue.custom_field_values.size / 2.0).ceil

    half.times do |i|

      ordered_values << issue.custom_field_values[i]

      ordered_values << issue.custom_field_values[i + half]

    end

    s = "<tr>\n"

    n = 0

    ordered_values.compact.each do |value|

      s << "</tr>\n<tr>\n" if n > 0 && (n % 2) == 0

      s << "\t<th>#{ h(value.custom_field.name) }:</th><td>#{ simple_format_without_paragraph(h(show_value(value))) }</td>\n"

      n += 1

    end

    s << "</tr>\n"

    s

  end

  def issues_destroy_confirmation_message(issues)

    issues = [issues] unless issues.is_a?(Array)

    message = l(:text_issues_destroy_confirmation)

    descendant_count = issues.inject(0) {|memo, i| memo += (i.right - i.left - 1)/2}

    if descendant_count > 0

      issues.each do |issue|

        next if issue.root?

        issues.each do |other_issue|

          descendant_count -= 1 if issue.is_descendant_of?(other_issue)

        end

      end

      if descendant_count > 0

        message << "\n" + l(:text_issues_destroy_descendants_confirmation, :count => descendant_count)

      end

    end

    message

  end

  def sidebar_queries

    unless @sidebar_queries

      # User can see public queries and his own queries

      visible = ARCondition.new(["is_public = ? OR user_id = ?", true, (User.current.logged? ? User.current.id : 0)])

      # Project specific queries and global queries

      visible << (@project.nil? ? ["project_id IS NULL"] : ["project_id IS NULL OR project_id = ?", @project.id])

      @sidebar_queries = Query.find(:all,

                                    :select => 'id, name, is_public',

                                    :order => "name ASC",

                                    :conditions => visible.conditions)

    end

    @sidebar_queries

  end

  def query_links(title, queries)

    # links to #index on issues/show

    url_params = controller_name == 'issues' ? {:controller => 'issues', :action => 'index', :project_id => @project} : params

    content_tag('h3', title) +

      queries.collect {|query|

          link_to(h(query.name), url_params.merge(:query_id => query))

        }.join('<br />')

  end

  def render_sidebar_queries

    out = ''

    queries = sidebar_queries.select {|q| !q.is_public?}

    out << query_links(l(:label_my_queries), queries) if queries.any?

    queries = sidebar_queries.select {|q| q.is_public?}

    out << query_links(l(:label_query_plural), queries) if queries.any?

    out

  end

  def show_detail(detail, no_html=false)

    case detail.property

    when 'attr'

      field = detail.prop_key.to_s.gsub(/\_id$/, "")

      label = l(("field_" + field).to_sym)

      case

      when ['due_date', 'start_date'].include?(detail.prop_key)

        value = format_date(detail.value.to_date) if detail.value

        old_value = format_date(detail.old_value.to_date) if detail.old_value

      when ['project_id', 'status_id', 'tracker_id', 'assigned_to_id', 'priority_id', 'category_id', 'fixed_version_id'].include?(detail.prop_key)

        value = find_name_by_reflection(field, detail.value)

        old_value = find_name_by_reflection(field, detail.old_value)

      when detail.prop_key == 'estimated_hours'

        value = "%0.02f" % detail.value.to_f unless detail.value.blank?

        old_value = "%0.02f" % detail.old_value.to_f unless detail.old_value.blank?

      when detail.prop_key == 'parent_id'

        label = l(:field_parent_issue)

        value = "##{detail.value}" unless detail.value.blank?

        old_value = "##{detail.old_value}" unless detail.old_value.blank?

      when detail.prop_key == 'is_private'

        value = l(detail.value == "0" ? :general_text_No : :general_text_Yes) unless detail.value.blank?

        old_value = l(detail.old_value == "0" ? :general_text_No : :general_text_Yes) unless detail.old_value.blank?

      end

    when 'cf'

      custom_field = CustomField.find_by_id(detail.prop_key)

      if custom_field

        label = custom_field.name

        value = format_value(detail.value, custom_field.field_format) if detail.value

        old_value = format_value(detail.old_value, custom_field.field_format) if detail.old_value

      end

    when 'attachment'

      label = l(:label_attachment)

    end

    call_hook(:helper_issues_show_detail_after_setting, {:detail => detail, :label => label, :value => value, :old_value => old_value })

    label ||= detail.prop_key

    value ||= detail.value

    old_value ||= detail.old_value

    unless no_html

      label = content_tag('strong', label)

      old_value = content_tag("i", h(old_value)) if detail.old_value

      old_value = content_tag("strike", old_value) if detail.old_value and (!detail.value or detail.value.empty?)

      if detail.property == 'attachment' && !value.blank? && a = Attachment.find_by_id(detail.prop_key)

        # Link to the attachment if it has not been removed

        value = link_to_attachment(a)

      else

        value = content_tag("i", h(value)) if value

      end

    end

    if detail.property == 'attr' && detail.prop_key == 'description'

      s = l(:text_journal_changed_no_detail, :label => label)

      unless no_html

        diff_link = link_to 'diff',

          {:controller => 'journals', :action => 'diff', :id => detail.journal_id, :detail_id => detail.id},

          :title => l(:label_view_diff)

        s << " (#{ diff_link })"

      end

      s

    elsif !detail.value.blank?

      case detail.property

      when 'attr', 'cf'

        if !detail.old_value.blank?

          l(:text_journal_changed, :label => label, :old => old_value, :new => value)

        else

          l(:text_journal_set_to, :label => label, :value => value)

        end

      when 'attachment'

        l(:text_journal_added, :label => label, :value => value)

      end

    else

      l(:text_journal_deleted, :label => label, :old => old_value)

    end

  end

  # Find the name of an associated record stored in the field attribute

  def find_name_by_reflection(field, id)

    association = Issue.reflect_on_association(field.to_sym)

    if association

      record = association.class_name.constantize.find_by_id(id)

      return record.name if record

    end

  end

  # Renders issue children recursively

  def render_api_issue_children(issue, api)

    return if issue.leaf?

    api.array :children do

      issue.children.each do |child|

        api.issue(:id => child.id) do

          api.tracker(:id => child.tracker_id, :name => child.tracker.name) unless child.tracker.nil?

          api.subject child.subject

          render_api_issue_children(child, api)

        end

      end

    end

  end

  def issues_to_csv(issues, project = nil)

    ic = Iconv.new(l(:general_csv_encoding), 'UTF-8')

    decimal_separator = l(:general_csv_decimal_separator)

    export = FCSV.generate(:col_sep => l(:general_csv_separator)) do |csv|

      # csv header fields

      headers = [ "#",

                  l(:field_status),

                  l(:field_project),

                  l(:field_tracker),

                  l(:field_priority),

                  l(:field_subject),

                  l(:field_assigned_to),

                  l(:field_category),

                  l(:field_fixed_version),

                  l(:field_author),

                  l(:field_start_date),

                  l(:field_due_date),

                  l(:field_done_ratio),

                  l(:field_estimated_hours),

                  l(:field_parent_issue),

                  l(:field_created_on),

                  l(:field_updated_on)

                  ]

      # Export project custom fields if project is given

      # otherwise export custom fields marked as "For all projects"

      custom_fields = project.nil? ? IssueCustomField.for_all : project.all_issue_custom_fields

      custom_fields.each {|f| headers << f.name}

      # Description in the last column

      headers << l(:field_description)

      csv << headers.collect {|c| begin; ic.iconv(c.to_s); rescue; c.to_s; end }

      # csv lines

      issues.each do |issue|

        fields = [issue.id,

                  issue.status.name,

                  issue.project.name,

                  issue.tracker.name,

                  issue.priority.name,

                  issue.subject,

                  issue.assigned_to,

                  issue.category,

                  issue.fixed_version,

                  issue.author.name,

                  format_date(issue.start_date),

                  format_date(issue.due_date),

                  issue.done_ratio,

                  issue.estimated_hours.to_s.gsub('.', decimal_separator),

                  issue.parent_id,

                  format_time(issue.created_on),

                  format_time(issue.updated_on)

                  ]

        custom_fields.each {|f| fields << show_value(issue.custom_value_for(f)) }

        fields << issue.description

        csv << fields.collect {|c| begin; ic.iconv(c.to_s); rescue; c.to_s; end }

      end

    end

    export

  end

end