jro_apps/redmine Commit - r13181:5326eb233e39

Overrides IssueRelation#to_s....

Jean-Philippe Lang -

r13181:5326eb233e39

parent child

Context file:

r13181:5326eb233e39

Collapse all files

app/models/issue_relation.rb +10 0

             # Redmine - project management software
             # Copyright (C) 2006-2014  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.
             class IssueRelation < ActiveRecord::Base
               # Class used to represent the relations of an issue
               class Relations < Array
                 include Redmine::I18n
                 def initialize(issue, *args)
                   @issue = issue
                   super(*args)
                 end
                 def to_s(*args)
                   map {|relation| "#{l(relation.label_for(@issue))} ##{relation.other_issue(@issue).id}"}.join(', ')
                 end
               end
               belongs_to :issue_from, :class_name => 'Issue'
               belongs_to :issue_to, :class_name => 'Issue'
               TYPE_RELATES      = "relates"
               TYPE_DUPLICATES   = "duplicates"
               TYPE_DUPLICATED   = "duplicated"
               TYPE_BLOCKS       = "blocks"
               TYPE_BLOCKED      = "blocked"
               TYPE_PRECEDES     = "precedes"
               TYPE_FOLLOWS      = "follows"
               TYPE_COPIED_TO    = "copied_to"
               TYPE_COPIED_FROM  = "copied_from"
               TYPES = {
                 TYPE_RELATES =>     { :name => :label_relates_to, :sym_name => :label_relates_to,
                                       :order => 1, :sym => TYPE_RELATES },
                 TYPE_DUPLICATES =>  { :name => :label_duplicates, :sym_name => :label_duplicated_by,
                                       :order => 2, :sym => TYPE_DUPLICATED },
                 TYPE_DUPLICATED =>  { :name => :label_duplicated_by, :sym_name => :label_duplicates,
                                       :order => 3, :sym => TYPE_DUPLICATES, :reverse => TYPE_DUPLICATES },
                 TYPE_BLOCKS =>      { :name => :label_blocks, :sym_name => :label_blocked_by,
                                       :order => 4, :sym => TYPE_BLOCKED },
                 TYPE_BLOCKED =>     { :name => :label_blocked_by, :sym_name => :label_blocks,
                                       :order => 5, :sym => TYPE_BLOCKS, :reverse => TYPE_BLOCKS },
                 TYPE_PRECEDES =>    { :name => :label_precedes, :sym_name => :label_follows,
                                       :order => 6, :sym => TYPE_FOLLOWS },
                 TYPE_FOLLOWS =>     { :name => :label_follows, :sym_name => :label_precedes,
                                       :order => 7, :sym => TYPE_PRECEDES, :reverse => TYPE_PRECEDES },
                 TYPE_COPIED_TO =>   { :name => :label_copied_to, :sym_name => :label_copied_from,
                                       :order => 8, :sym => TYPE_COPIED_FROM },
                 TYPE_COPIED_FROM => { :name => :label_copied_from, :sym_name => :label_copied_to,
                                       :order => 9, :sym => TYPE_COPIED_TO, :reverse => TYPE_COPIED_TO }
               }.freeze
               validates_presence_of :issue_from, :issue_to, :relation_type
               validates_inclusion_of :relation_type, :in => TYPES.keys
               validates_numericality_of :delay, :allow_nil => true
               validates_uniqueness_of :issue_to_id, :scope => :issue_from_id
               validate :validate_issue_relation
               attr_protected :issue_from_id, :issue_to_id
               before_save :handle_issue_order
               after_create  :call_issues_relation_added_callback
               after_destroy :call_issues_relation_removed_callback
               def visible?(user=User.current)
                 (issue_from.nil? || issue_from.visible?(user)) && (issue_to.nil? || issue_to.visible?(user))
               end
               def deletable?(user=User.current)
                 visible?(user) &&
                   ((issue_from.nil? || user.allowed_to?(:manage_issue_relations, issue_from.project)) ||
                     (issue_to.nil? || user.allowed_to?(:manage_issue_relations, issue_to.project)))
               end
               def initialize(attributes=nil, *args)
                 super
                 if new_record?
                   if relation_type.blank?
                     self.relation_type = IssueRelation::TYPE_RELATES
                   end
                 end
               end
               def validate_issue_relation
                 if issue_from && issue_to
                   errors.add :issue_to_id, :invalid if issue_from_id == issue_to_id
                   unless issue_from.project_id == issue_to.project_id ||
                             Setting.cross_project_issue_relations?
                     errors.add :issue_to_id, :not_same_project
                   end
                   # detect circular dependencies depending wether the relation should be reversed
                   if TYPES.has_key?(relation_type) && TYPES[relation_type][:reverse]
                     errors.add :base, :circular_dependency if issue_from.all_dependent_issues.include? issue_to
                   else
                     errors.add :base, :circular_dependency if issue_to.all_dependent_issues.include? issue_from
                   end
                   if issue_from.is_descendant_of?(issue_to) || issue_from.is_ancestor_of?(issue_to)
                     errors.add :base, :cant_link_an_issue_with_a_descendant
                   end
                 end
               end
               def other_issue(issue)
                 (self.issue_from_id == issue.id) ? issue_to : issue_from
               end
               # Returns the relation type for +issue+
               def relation_type_for(issue)
                 if TYPES[relation_type]
                   if self.issue_from_id == issue.id
                     relation_type
                   else
                     TYPES[relation_type][:sym]
                   end
                 end
               end
               def label_for(issue)
                 TYPES[relation_type] ?
                     TYPES[relation_type][(self.issue_from_id == issue.id) ? :name : :sym_name] :
                     :unknow
               end
+              def to_s(issue=nil)
+                issue ||= issue_from
+                issue_text = block_given? ? yield(other_issue(issue)) : "##{other_issue(issue).try(:id)}"
+                s = []
+                s << l(label_for(issue))
+                s << "(#{l('datetime.distance_in_words.x_days', :count => delay)})" if delay && delay != 0
+                s << issue_text
+                s.join(' ')
+              end
               def css_classes_for(issue)
                 "rel-#{relation_type_for(issue)}"
               end
               def handle_issue_order
                 reverse_if_needed
                 if TYPE_PRECEDES == relation_type
                   self.delay ||= 0
                 else
                   self.delay = nil
                 end
                 set_issue_to_dates
               end
               def set_issue_to_dates
                 soonest_start = self.successor_soonest_start
                 if soonest_start && issue_to
                   issue_to.reschedule_on!(soonest_start)
                 end
               end
               def successor_soonest_start
                 if (TYPE_PRECEDES == self.relation_type) && delay && issue_from &&
                        (issue_from.start_date || issue_from.due_date)
                   (issue_from.due_date || issue_from.start_date) + 1 + delay
                 end
               end
               def <=>(relation)
                 r = TYPES[self.relation_type][:order] <=> TYPES[relation.relation_type][:order]
                 r == 0 ? id <=> relation.id : r
               end
               def init_journals(user)
                 issue_from.init_journal(user) if issue_from
                 issue_to.init_journal(user) if issue_to
               end
               private
               # Reverses the relation if needed so that it gets stored in the proper way
               # Should not be reversed before validation so that it can be displayed back
               # as entered on new relation form
               def reverse_if_needed
                 if TYPES.has_key?(relation_type) && TYPES[relation_type][:reverse]
                   issue_tmp = issue_to
                   self.issue_to = issue_from
                   self.issue_from = issue_tmp
                   self.relation_type = TYPES[relation_type][:reverse]
                 end
               end
               def call_issues_relation_added_callback
                 call_issues_callback :relation_added
               end
               def call_issues_relation_removed_callback
                 call_issues_callback :relation_removed
               end
               def call_issues_callback(name)
                 [issue_from, issue_to].each do |issue|
                   if issue
                     issue.send name, self
                   end
                 end
               end
             end

app/views/issues/_relations.html.erb +1 -4

             <div class="contextual">
             <% if User.current.allowed_to?(:manage_issue_relations, @project) %>
               <%= toggle_link l(:button_add), 'new-relation-form', {:focus => 'relation_issue_to_id'} %>
             <% end %>
             </div>
             <p><strong><%=l(:label_related_issues)%></strong></p>
             <% if @relations.present? %>
             <form>
             <table class="list issues">
             <% @relations.each do |relation| %>
               <% other_issue = relation.other_issue(@issue) -%>
               <tr class="issue hascontextmenu" id="relation-<%= relation.id %>">
               <td class="checkbox"><%= check_box_tag("ids[]", other_issue.id, false, :id => nil) %></td>
               <td class="subject">
-                <%= l(relation.label_for(@issue)) %>
+                <%= relation.to_s(@issue) {|other| link_to_issue(other, :truncate => 60, :project => Setting.cross_project_issue_relations?)}.html_safe %>
-                <%= "(#{l('datetime.distance_in_words.x_days', :count => relation.delay)})" if relation.delay && relation.delay != 0 %>
-                <%= h(other_issue.project) + ' - ' if Setting.cross_project_issue_relations? %>
-                <%= link_to_issue(other_issue, :truncate => 60) %>
               </td>
               <td class="status"><%=h other_issue.status.name %></td>
               <td class="start_date"><%= format_date(other_issue.start_date) %></td>
               <td class="due_date"><%= format_date(other_issue.due_date) %></td>
               <td class="buttons"><%= link_to image_tag('link_break.png'),
                                               relation_path(relation),
                                               :remote => true,
                                               :method => :delete,
                                               :data => {:confirm => l(:text_are_you_sure)},
                                               :title => l(:label_relation_delete) if User.current.allowed_to?(:manage_issue_relations, @project) %></td>
               </tr>
             <% end %>
             </table>
             </form>
             <% end %>
             <%= form_for @relation, {
                              :as => :relation, :remote => true,
                              :url => issue_relations_path(@issue),
                              :method => :post,
                              :html => {:id => 'new-relation-form', :style => 'display: none;'}
                            } do |f| %>
             <%= render :partial => 'issue_relations/form', :locals => {:f => f}%>
             <% end %>

test/unit/issue_relation_test.rb +19 0

             # Redmine - project management software
             # Copyright (C) 2006-2014  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.
             require File.expand_path('../../test_helper', __FILE__)
             class IssueRelationTest < ActiveSupport::TestCase
               fixtures :projects,
                        :users,
                        :roles,
                        :members,
                        :member_roles,
                        :issues,
                        :issue_statuses,
                        :issue_relations,
                        :enabled_modules,
                        :enumerations,
                        :trackers,
                        :projects_trackers
               include Redmine::I18n
               def test_create
                 from = Issue.find(1)
                 to = Issue.find(2)
                 relation = IssueRelation.new :issue_from => from, :issue_to => to,
                                              :relation_type => IssueRelation::TYPE_PRECEDES
                 assert relation.save
                 relation.reload
                 assert_equal IssueRelation::TYPE_PRECEDES, relation.relation_type
                 assert_equal from, relation.issue_from
                 assert_equal to, relation.issue_to
               end
               def test_create_minimum
                 relation = IssueRelation.new :issue_from => Issue.find(1), :issue_to => Issue.find(2)
                 assert relation.save
                 assert_equal IssueRelation::TYPE_RELATES, relation.relation_type
               end
               def test_follows_relation_should_be_reversed
                 from = Issue.find(1)
                 to = Issue.find(2)
                 relation = IssueRelation.new :issue_from => from, :issue_to => to,
                                              :relation_type => IssueRelation::TYPE_FOLLOWS
                 assert relation.save
                 relation.reload
                 assert_equal IssueRelation::TYPE_PRECEDES, relation.relation_type
                 assert_equal to, relation.issue_from
                 assert_equal from, relation.issue_to
               end
               def test_follows_relation_should_not_be_reversed_if_validation_fails
                 from = Issue.find(1)
                 to = Issue.find(2)
                 relation = IssueRelation.new :issue_from => from, :issue_to => to,
                                              :relation_type => IssueRelation::TYPE_FOLLOWS,
                                              :delay => 'xx'
                 assert !relation.save
                 assert_equal IssueRelation::TYPE_FOLLOWS, relation.relation_type
                 assert_equal from, relation.issue_from
                 assert_equal to, relation.issue_to
               end
               def test_relation_type_for
                 from = Issue.find(1)
                 to = Issue.find(2)
                 relation = IssueRelation.new :issue_from => from, :issue_to => to,
                                              :relation_type => IssueRelation::TYPE_PRECEDES
                 assert_equal IssueRelation::TYPE_PRECEDES, relation.relation_type_for(from)
                 assert_equal IssueRelation::TYPE_FOLLOWS, relation.relation_type_for(to)
               end
               def test_set_issue_to_dates_without_issue_to
                 r = IssueRelation.new(:issue_from => Issue.new(:start_date => Date.today),
                                       :relation_type => IssueRelation::TYPE_PRECEDES,
                                       :delay => 1)
                 assert_nil r.set_issue_to_dates
               end
               def test_set_issue_to_dates_without_issues
                 r = IssueRelation.new(:relation_type => IssueRelation::TYPE_PRECEDES, :delay => 1)
                 assert_nil r.set_issue_to_dates
               end
               def test_validates_circular_dependency
                 IssueRelation.delete_all
                 assert IssueRelation.create!(
                          :issue_from => Issue.find(1), :issue_to => Issue.find(2),
                          :relation_type => IssueRelation::TYPE_PRECEDES
                        )
                 assert IssueRelation.create!(
                          :issue_from => Issue.find(2), :issue_to => Issue.find(3),
                          :relation_type => IssueRelation::TYPE_PRECEDES
                        )
                 r = IssueRelation.new(
                       :issue_from => Issue.find(3), :issue_to => Issue.find(1),
                       :relation_type => IssueRelation::TYPE_PRECEDES
                     )
                 assert !r.save
                 assert_not_equal [], r.errors[:base]
               end
               def test_validates_circular_dependency_of_subtask
                 set_language_if_valid 'en'
                 issue1 = Issue.generate!
                 issue2 = Issue.generate!
                 IssueRelation.create!(
                   :issue_from => issue1, :issue_to => issue2,
                   :relation_type => IssueRelation::TYPE_PRECEDES
                 )
                 child = Issue.generate!(:parent_issue_id => issue2.id)
                 issue1.reload
                 child.reload
                 r = IssueRelation.new(
                       :issue_from => child, :issue_to => issue1,
                       :relation_type => IssueRelation::TYPE_PRECEDES
                     )
                 assert !r.save
                 assert_include 'This relation would create a circular dependency', r.errors.full_messages
               end
               def test_subtasks_should_allow_precedes_relation
                 parent = Issue.generate!
                 child1 = Issue.generate!(:parent_issue_id => parent.id)
                 child2 = Issue.generate!(:parent_issue_id => parent.id)
                 r = IssueRelation.new(
                       :issue_from => child1, :issue_to => child2,
                       :relation_type => IssueRelation::TYPE_PRECEDES
                     )
                 assert r.valid?
                 assert r.save
               end
               def test_validates_circular_dependency_on_reverse_relations
                 IssueRelation.delete_all
                 assert IssueRelation.create!(
                          :issue_from => Issue.find(1), :issue_to => Issue.find(3),
                          :relation_type => IssueRelation::TYPE_BLOCKS
                        )
                 assert IssueRelation.create!(
                          :issue_from => Issue.find(1), :issue_to => Issue.find(2),
                          :relation_type => IssueRelation::TYPE_BLOCKED
                        )
                 r = IssueRelation.new(
                       :issue_from => Issue.find(2), :issue_to => Issue.find(1),
                       :relation_type => IssueRelation::TYPE_BLOCKED
                     )
                 assert !r.save
                 assert_not_equal [], r.errors[:base]
               end
               def test_create_with_initialized_journals_should_create_journals
                 from = Issue.find(1)
                 to   = Issue.find(2)
                 from_journals = from.journals.size
                 to_journals   = to.journals.size
                 relation = IssueRelation.new(:issue_from => from, :issue_to => to,
                                              :relation_type => IssueRelation::TYPE_PRECEDES)
                 relation.init_journals User.find(1)
                 assert relation.save
                 from.reload
                 to.reload
                 relation.reload
                 assert_equal from.journals.size, (from_journals + 1)
                 assert_equal to.journals.size, (to_journals + 1)
                 assert_equal 'relation', from.journals.last.details.last.property
                 assert_equal 'precedes', from.journals.last.details.last.prop_key
                 assert_equal '2', from.journals.last.details.last.value
                 assert_nil   from.journals.last.details.last.old_value
                 assert_equal 'relation', to.journals.last.details.last.property
                 assert_equal 'follows', to.journals.last.details.last.prop_key
                 assert_equal '1', to.journals.last.details.last.value
                 assert_nil   to.journals.last.details.last.old_value
               end
               def test_destroy_with_initialized_journals_should_create_journals
                 relation = IssueRelation.find(1)
                 from = relation.issue_from
                 to   = relation.issue_to
                 from_journals = from.journals.size
                 to_journals   = to.journals.size
                 relation.init_journals User.find(1)
                 assert relation.destroy
                 from.reload
                 to.reload
                 assert_equal from.journals.size, (from_journals + 1)
                 assert_equal to.journals.size, (to_journals + 1)
                 assert_equal 'relation', from.journals.last.details.last.property
                 assert_equal 'blocks', from.journals.last.details.last.prop_key
                 assert_equal '9', from.journals.last.details.last.old_value
                 assert_nil   from.journals.last.details.last.value
                 assert_equal 'relation', to.journals.last.details.last.property
                 assert_equal 'blocked', to.journals.last.details.last.prop_key
                 assert_equal '10', to.journals.last.details.last.old_value
                 assert_nil   to.journals.last.details.last.value
               end
+              def test_to_s_should_return_the_relation_string
+                set_language_if_valid 'en'
+                relation = IssueRelation.find(1)
+                assert_equal "Blocks #9", relation.to_s(relation.issue_from)
+                assert_equal "Blocked by #10", relation.to_s(relation.issue_to)
+              end
+              def test_to_s_without_argument_should_return_the_relation_string_for_issue_from
+                set_language_if_valid 'en'
+                relation = IssueRelation.find(1)
+                assert_equal "Blocks #9", relation.to_s
+              end
+              def test_to_s_should_accept_a_block_as_custom_issue_formatting
+                set_language_if_valid 'en'
+                relation = IssueRelation.find(1)
+                assert_equal "Blocks Bug #9", relation.to_s {|issue| "#{issue.tracker} ##{issue.id}"}
+              end
             end

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages