Class: Ditz::Issue

Inherits:
ModelObject show all
Defined in:
lib/model-objects.rb

Defined Under Namespace

Classes: Error

Constant Summary collapse

INTERPOLATED_FIELDS =

these are the fields we interpolate issue names on

[:title, :desc, :log_events]
STATUS_SORT_ORDER = 
{ :unstarted => 2, :paused => 1, :in_progress => 0, :closed => 3 }
STATUS_WIDGET = 
{ :unstarted => "_", :in_progress => ">", :paused => "=", :closed => "x" }
DISPOSITIONS = 
[ :fixed, :wontfix, :reorg ]
TYPES = 
[ :bugfix, :feature, :task ]
TYPE_ORDER = 
{ :bugfix => 0, :feature => 1, :task => 2 }
TYPE_LETTER = 
{ 'b' => :bugfix, 'f' => :feature, 't' => :task }
STATUSES = 
STATUS_WIDGET.keys
STATUS_STRINGS = 
{ :in_progress => "in progress", :wontfix => "won't fix" }
DISPOSITION_STRINGS = 
{ :wontfix => "won't fix", :reorg => "reorganized" }

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from ModelObject

#changed!, #changed?, changes_are_logged, create_interactively, #each_modelobject, field, field_names, from, inherited, #initialize, #inspect, #log, #save!, #to_s, #to_yaml, #to_yaml_type, #unchanged!, yaml_domain, yaml_other_thing

Constructor Details

This class inherits a constructor from Ditz::ModelObject

Instance Attribute Details

#name ⇒ Object

Returns the value of attribute name.



125
126
127
 
# File 'lib/model-objects.rb', line 125

def name
  @name
end

#pathname ⇒ Object

Returns the value of attribute pathname.



125
126
127
 
# File 'lib/model-objects.rb', line 125

def pathname
  @pathname
end

#project ⇒ Object

Returns the value of attribute project.



125
126
127
 
# File 'lib/model-objects.rb', line 125

def project
  @project
end

Instance Method Details

#assign_to_component(component, who, comment) ⇒ Object 



241
242
243
244
 
# File 'lib/model-objects.rb', line 241

def assign_to_component component, who, comment
  log "assigned to component #{component.name} from #{self.component}", who, comment
  self.component = component.name
end

#assign_to_release(release, who, comment) ⇒ Object 



236
237
238
239
 
# File 'lib/model-objects.rb', line 236

def assign_to_release release, who, comment
  log "assigned to release #{release.name} from #{self.release || 'unassigned'}", who, comment
  self.release = release.name
end

#bug? ⇒ Boolean

Returns:

  • (Boolean) 


189
 
# File 'lib/model-objects.rb', line 189

def bug?; type == :bugfix end

#change(hash, who, comment) ⇒ Object 



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/model-objects.rb', line 213

def change hash, who, comment
  what = []
  if title != hash[:title]
    what << "changed title"
    self.title = hash[:title]
  end

  if desc != hash[:description]
    what << "changed description"
    self.desc = hash[:description]
  end

  if reporter != hash[:reporter]
    what << "changed reporter"
    self.reporter = hash[:reporter]
  end

  unless what.empty?
    log what.join(", "), who, comment
    true
  end
end

#close(disp, who, comment) ⇒ Object

Raises:



198
199
200
201
202
203
 
# File 'lib/model-objects.rb', line 198

def close disp, who, comment
  raise Error, "unknown disposition #{disp}" unless DISPOSITIONS.member? disp
  log "closed issue with disposition #{disp}", who, comment
  self.status = :closed
  self.disposition = disp
end

#closed? ⇒ Boolean

Returns:

  • (Boolean) 


186
 
# File 'lib/model-objects.rb', line 186

def closed?; status == :closed end

#deserialized_form_of(field, value) ⇒ Object 



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/model-objects.rb', line 158

def deserialized_form_of field, value
  return super unless INTERPOLATED_FIELDS.member? field

  if field == :log_events
    value.map do |time, who, what, comment|
      comment = @project.issues.inject(comment) do |s, i|
        s.gsub(/\{issue #{i.id}\}/, i.name)
      end.gsub(/\{issue \w+\}/, "[unknown issue]")
      [time, who, what, comment]
    end
  else
    @project.issues.inject(value) do |s, i|
      s.gsub(/\{issue #{i.id}\}/, i.name)
    end.gsub(/\{issue \w+\}/, "[unknown issue]")
  end
end

#disposition_string ⇒ Object 



184
 
# File 'lib/model-objects.rb', line 184

def disposition_string; DISPOSITION_STRINGS[disposition] || disposition.to_s end

#feature? ⇒ Boolean

Returns:

  • (Boolean) 


190
 
# File 'lib/model-objects.rb', line 190

def feature?; type == :feature end

#get_component(config, project) ⇒ Object 



257
258
259
260
261
262
263
 
# File 'lib/model-objects.rb', line 257

def get_component config, project
  if project.components.size == 1
    project.components.first
  else
    ask_for_selection project.components, "component", :name
  end.name
end

#get_release(config, project) ⇒ Object 



265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/model-objects.rb', line 265

def get_release config, project
  releases = project.releases.select { |r| r.unreleased? }
  if !releases.empty? && ask_yon("Assign to a release now?")
    if releases.size == 1
      r = releases.first
      puts "Assigning to release #{r.name}."
      r
    else
      ask_for_selection releases, "release", :name
    end.name
  end
end

#get_reporter(config, project) ⇒ Object 



278
279
280
 
# File 'lib/model-objects.rb', line 278

def get_reporter config, project
  reporter = ask "Creator", :default => config.user
end

#get_type(config, project) ⇒ Object 



252
253
254
255
 
# File 'lib/model-objects.rb', line 252

def get_type config, project
  type = ask "Is this a (b)ugfix, a (f)eature, or a (t)ask?", :restrict => /^[bft]$/
  TYPE_LETTER[type]
end

#in_progress? ⇒ Boolean

Returns:

  • (Boolean) 


188
 
# File 'lib/model-objects.rb', line 188

def in_progress?; status == :in_progress end

#make_id(config, project) ⇒ Object

make a unique id



176
177
178
 
# File 'lib/model-objects.rb', line 176

def make_id config, project
  SHA1.hexdigest [Time.now, rand, creation_time, reporter, title, desc].join("\n")
end

#open? ⇒ Boolean

Returns:

  • (Boolean) 


187
 
# File 'lib/model-objects.rb', line 187

def open?; !closed? end

#serialized_form_of(field, value) ⇒ Object 



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/model-objects.rb', line 141

def serialized_form_of field, value
  return super unless INTERPOLATED_FIELDS.member? field

  if field == :log_events
    value.map do |time, who, what, comment|
      comment = @project.issues.inject(comment) do |s, i|
        s.gsub(/\b#{i.name}\b/, "{issue #{i.id}}")
      end
      [time, who, what, comment]
    end
  else
    @project.issues.inject(value) do |s, i|
      s.gsub(/\b#{i.name}\b/, "{issue #{i.id}}")
    end
  end
end

#sort_order ⇒ Object 



180
 
# File 'lib/model-objects.rb', line 180

def sort_order; [STATUS_SORT_ORDER[status], creation_time] end

#start_work(who, comment) ⇒ Object 



192
 
# File 'lib/model-objects.rb', line 192

def start_work who, comment; change_status :in_progress, who, comment end

#status_string ⇒ Object 



183
 
# File 'lib/model-objects.rb', line 183

def status_string; STATUS_STRINGS[status] || status.to_s end

#status_widget ⇒ Object 



181
 
# File 'lib/model-objects.rb', line 181

def status_widget; STATUS_WIDGET[status] end

#stop_work(who, comment) ⇒ Object

Raises:



193
194
195
196
 
# File 'lib/model-objects.rb', line 193

def stop_work who, comment
  raise Error, "unstarted" unless self.status == :in_progress
  change_status :paused, who, comment
end

#unassign(who, comment) ⇒ Object

Raises:



246
247
248
249
250
 
# File 'lib/model-objects.rb', line 246

def unassign who, comment
  raise Error, "not assigned to a release" unless release
  log "unassigned from release #{release}", who, comment
  self.release = nil
end