Class: IssueRelation

Inherits:
ActiveRecord::Base
  • Object
show all
Includes:
Redmine::SafeAttributes, Redmine::Utils::DateCalculation
Defined in:
app/models/issue_relation.rb

Overview

Redmine - project management software Copyright (C) 2006-2020 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.

Defined Under Namespace

Classes: Relations

Constant Summary collapse

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

Instance Method Summary collapse

Methods included from Redmine::Utils::DateCalculation

#add_working_days, #next_working_date, #non_working_week_days, #working_days

Methods included from Redmine::SafeAttributes

#delete_unsafe_attributes, included, #safe_attribute?, #safe_attribute_names

Constructor Details

#initialize(attributes = nil, *args) ⇒ IssueRelation

Returns a new instance of IssueRelation.


114
115
116
117
118
119
120
121
# File 'app/models/issue_relation.rb', line 114

def initialize(attributes=nil, *args)
  super
  if new_record?
    if relation_type.blank?
      self.relation_type = IssueRelation::TYPE_RELATES
    end
  end
end

Instance Method Details

#<=>(relation) ⇒ Object


201
202
203
204
# File 'app/models/issue_relation.rb', line 201

def <=>(relation)
  r = TYPES[self.relation_type][:order] <=> TYPES[relation.relation_type][:order]
  r == 0 ? id <=> relation.id : r
end

#css_classes_for(issue) ⇒ Object


172
173
174
# File 'app/models/issue_relation.rb', line 172

def css_classes_for(issue)
  "rel-#{relation_type_for(issue)}"
end

#deletable?(user = User.current) ⇒ Boolean

Returns:

  • (Boolean)

108
109
110
111
112
# File 'app/models/issue_relation.rb', line 108

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

#handle_issue_orderObject


176
177
178
179
180
181
182
183
184
185
# File 'app/models/issue_relation.rb', line 176

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

#init_journals(user) ⇒ Object


206
207
208
209
# File 'app/models/issue_relation.rb', line 206

def init_journals(user)
  issue_from.init_journal(user) if issue_from
  issue_to.init_journal(user) if issue_to
end

#label_for(issue) ⇒ Object


154
155
156
157
158
159
160
# File 'app/models/issue_relation.rb', line 154

def label_for(issue)
  if TYPES[relation_type]
    TYPES[relation_type][(self.issue_from_id == issue.id) ? :name : :sym_name]
  else
    :unknow
  end
end

#other_issue(issue) ⇒ Object


139
140
141
# File 'app/models/issue_relation.rb', line 139

def other_issue(issue)
  (self.issue_from_id == issue.id) ? issue_to : issue_from
end

#relation_type_for(issue) ⇒ Object

Returns the relation type for issue


144
145
146
147
148
149
150
151
152
# File 'app/models/issue_relation.rb', line 144

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

#safe_attributes=(attrs, user = User.current) ⇒ Object


86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
# File 'app/models/issue_relation.rb', line 86

def safe_attributes=(attrs, user=User.current)
  if attrs.respond_to?(:to_unsafe_hash)
    attrs = attrs.to_unsafe_hash
  end

  return unless attrs.is_a?(Hash)
  attrs = attrs.deep_dup

  if issue_id = attrs.delete('issue_to_id')
    if issue_id.to_s.strip.match(/\A#?(\d+)\z/)
      issue_id = $1.to_i
      self.issue_to = Issue.visible(user).find_by_id(issue_id)
    end
  end

  super(attrs)
end

#set_issue_to_dates(journal = nil) ⇒ Object


187
188
189
190
191
192
# File 'app/models/issue_relation.rb', line 187

def set_issue_to_dates(journal=nil)
  soonest_start = self.successor_soonest_start
  if soonest_start && issue_to
    issue_to.reschedule_on!(soonest_start, journal)
  end
end

#successor_soonest_startObject


194
195
196
197
198
199
# File 'app/models/issue_relation.rb', line 194

def successor_soonest_start
  if (TYPE_PRECEDES == self.relation_type) && delay && issue_from &&
         (issue_from.start_date || issue_from.due_date)
    add_working_days((issue_from.due_date || issue_from.start_date), (1 + delay))
  end
end

#to_s(issue = nil) ⇒ Object


162
163
164
165
166
167
168
169
170
# File 'app/models/issue_relation.rb', line 162

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

#validate_issue_relationObject


123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
# File 'app/models/issue_relation.rb', line 123

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
    if circular_dependency?
      errors.add :base, :circular_dependency
    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

#visible?(user = User.current) ⇒ Boolean

Returns:

  • (Boolean)

104
105
106
# File 'app/models/issue_relation.rb', line 104

def visible?(user=User.current)
  (issue_from.nil? || issue_from.visible?(user)) && (issue_to.nil? || issue_to.visible?(user))
end