Class: Ditz::Operator

Inherits:
Object show all
Defined in:
lib/operator.rb

Defined Under Namespace

Classes: Error

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.has_operation?(op) ⇒ Boolean

Returns:

  • (Boolean) 


23
 
# File 'lib/operator.rb', line 23

def has_operation? op; @operations.member? op_to_method(op) end

.method_to_op(meth) ⇒ Object 



12
 
# File 'lib/operator.rb', line 12

def method_to_op meth; meth.to_s.gsub("_", "-") end

.op_to_method(op) ⇒ Object 



13
 
# File 'lib/operator.rb', line 13

def op_to_method op; op.gsub("-", "_").intern end

.operation(method, desc) ⇒ Object 



15
16
17
18
 
# File 'lib/operator.rb', line 15

def operation method, desc
  @operations ||= {}
  @operations[method] = desc
end

.operations ⇒ Object 



20
21
22
 
# File 'lib/operator.rb', line 20

def operations
  @operations.map { |k, v| [method_to_op(k), v] }.sort_by { |k, v| k }
end

Instance Method Details

#actually_do_todo(project, config, release, full) ⇒ Object 



173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/operator.rb', line 173

def actually_do_todo project, config, release, full
  parse_releases_arg(project, release).each do |r, bugs, feats|
    if r
      puts "Version #{r.name} (#{r.status}):"
    else
      puts "Unassigned:"
    end
    issues = bugs + feats
    issues = issues.select { |i| i.open? } unless full
    print todo_list_for(issues.sort_by { |i| i.sort_order })
    puts
  end
end

#add(project, config) ⇒ Object 



48
49
50
51
52
53
54
55
 
# File 'lib/operator.rb', line 48

def add project, config
  issue = Issue.create_interactively(:args => [config, project]) or return
  comment = ask_multiline "Comments"
  issue.log "created", config.user, comment
  project.add_issue issue
  project.assign_issue_names!
  puts "Added issue #{issue.name}."
end

#add_component(project, config) ⇒ Object 



74
75
76
77
78
 
# File 'lib/operator.rb', line 74

def add_component project, config
  component = Component.create_interactively(:args => [project, config]) or return
  project.add_component component
  puts "Added component #{component.name}."
end

#add_reference(project, config, issue_name) ⇒ Object 



81
82
83
84
85
86
87
 
# File 'lib/operator.rb', line 81

def add_reference project, config, issue_name
  issue = project.issue_for issue_name
  reference = ask "Reference"
  comment = ask_multiline "Comments"
  issue.add_reference reference, config.user, comment
  puts "Added reference to #{issue.name}"
end

#add_release(project, config) ⇒ Object 



65
66
67
68
69
70
71
 
# File 'lib/operator.rb', line 65

def add_release project, config
  release = Release.create_interactively(:args => [project, config]) or return
  comment = ask_multiline "Comments"
  release.log "created", config.user, comment
  project.add_release release
  puts "Added release #{release.name}."
end

#assign(project, config, issue_name) ⇒ Object 



245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/operator.rb', line 245

def assign project, config, issue_name
  issue = project.issue_for issue_name
  puts "Issue #{issue.name} currently " + if issue.release
    "assigned to release #{issue.release}."
  else
    "not assigned to any release."
  end
  release = ask_for_selection project.releases, "release", :name
  comment = ask_multiline "Comments"
  issue.assign_to_release release, config.user, comment
  puts "Assigned #{issue.name} to #{release.name}"
end

#changelog(project, config, relnames) ⇒ Object 



291
292
293
294
295
296
297
 
# File 'lib/operator.rb', line 291

def changelog project, config, relnames
  parse_releases_arg(project, relnames).each do |r, bugs, feats|
    puts "== #{r.name} / #{r.release_time.pretty_date}" if r.released?
    feats.select { |f| f.closed? }.each { |i| puts "* #{i.title}" }
    bugs.select { |f| f.closed? }.each { |i| puts "* bugfix: #{i.title}" }
  end
end

#close(project, config, name) ⇒ Object 



235
236
237
238
239
240
241
242
 
# File 'lib/operator.rb', line 235

def close project, config, name
  issue = project.issue_for name
  puts "Closing issue #{issue.name}: #{issue.title}."
  disp = ask_for_selection Issue::DISPOSITIONS, "disposition", lambda { |x| Issue::DISPOSITION_STRINGS[x] || x.to_s }
  comment = ask_multiline "Comments"
  issue.close disp, config.user, comment
  puts "Closed issue #{issue.name} with disposition #{issue.disposition_string}."
end

#comment(project, config, issue_name) ⇒ Object 



267
268
269
270
271
272
 
# File 'lib/operator.rb', line 267

def comment project, config, issue_name
  issue = project.issue_for issue_name
  comment = ask_multiline "Comments"
  issue.log "commented", config.user, comment
  puts "Comments recorded for #{issue.name}."
end

#do(op, *a) ⇒ Object 



26
 
# File 'lib/operator.rb', line 26

def do op, *a; send self.class.op_to_method(op), *a end

#drop(project, config, issue_name) ⇒ Object 



58
59
60
61
62
 
# File 'lib/operator.rb', line 58

def drop project, config, issue_name
  issue = project.issue_for issue_name
  project.drop_issue issue
  puts "Dropped #{issue.name}. Note that other issue names may have changed."
end

#edit(project, config, issue_name) ⇒ Object 



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/operator.rb', line 377

def edit project, config, issue_name
  issue = project.issue_for issue_name
  data = { :title => issue.title, :description => issue.desc,
           :reporter => issue.reporter }

  f = Tempfile.new("ditz")
  f.puts data.to_yaml
  f.close
  editor = ENV["EDITOR"] || "/usr/bin/vi"
  cmd = "#{editor} #{f.path.inspect}"
  Ditz::debug "running: #{cmd}"

  mtime = File.mtime f.path
  system cmd or raise Error, "cannot execute command: #{cmd.inspect}"
  if File.mtime(f.path) == mtime
    puts "Aborted."
    return
  end

  comment = ask_multiline "Comments"
  begin
    edits = YAML.load_file f.path
    if issue.change edits, config.user, comment
      puts "Changed recorded."
    else
      puts "No changes."
    end
  end
end

#format_log_events(events) ⇒ Object 



211
212
213
214
215
216
 
# File 'lib/operator.rb', line 211

def format_log_events events
  return "none" if events.empty?
  events.map do |time, who, what, comment|
    "- #{time.pretty} :: #{who}\n  #{what}#{comment.multiline "  > "}"
  end.join("\n")
end

#grep(project, config, match) ⇒ Object 



370
371
372
373
374
 
# File 'lib/operator.rb', line 370

def grep project, config, match
  re = /#{match}/
  issues = project.issues.select { |i| i.title =~ re || i.desc =~ re }
  print_todo issues
end

#help ⇒ Object 



37
38
39
40
41
42
43
44
45
 
# File 'lib/operator.rb', line 37

def help
  puts <<EOS
Registered commands:
EOS
  ops = self.class.operations
  len = ops.map { |name, desc| name.to_s.length }.max
  ops.each { |name, desc| printf "%#{len}s: %s\n", name, desc }
  puts
end

#html(project, config, dir = "html") ⇒ Object 



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/operator.rb', line 300

def html project, config, dir="html"
  #FileUtils.rm_rf dir
  Dir.mkdir dir unless File.exists? dir

  ## find the ERB templates. this is my brilliant approach
  ## to the 'gem datadir' problem.
  template_dir = $:.find { |p| File.exists? File.join(p, "index.rhtml") }

  FileUtils.cp File.join(template_dir, "style.css"), dir

  ## build up links
  links = {}
  project.releases.each { |r| links[r] = "release-#{r.name}.html" }
  project.issues.each { |i| links[i] = "issue-#{i.id}.html" }
  project.components.each { |c| links[c] = "component-#{c.name}.html" }
  links["unassigned"] = "unassigned.html" # special case: unassigned
  links["index"] = "index.html" # special case: index

  project.issues.each do |issue|
    fn = File.join dir, links[issue]
    puts "Generating #{fn}..."
    File.open(fn, "w") do |f|
      f.puts ErbHtml.new(template_dir, "issue", links, :issue => issue,
        :release => (issue.release ? project.release_for(issue.release) : nil),
        :component => project.component_for(issue.component),
        :project => project)
    end
  end

  project.releases.each do |r|
    fn = File.join dir, links[r]
    puts "Generating #{fn}..."
    File.open(fn, "w") do |f|
      f.puts ErbHtml.new(template_dir, "release", links, :release => r,
        :issues => project.issues_for_release(r), :project => project)
    end
  end

  project.components.each do |c|
    fn = File.join dir, links[c]
    puts "Generating #{fn}..."
    File.open(fn, "w") do |f|
      f.puts ErbHtml.new(template_dir, "component", links, :component => c,
        :issues => project.issues_for_component(c), :project => project)
    end
  end

  fn = File.join dir, links["unassigned"]
  puts "Generating #{fn}..."
  File.open(fn, "w") do |f|
    f.puts ErbHtml.new(template_dir, "unassigned", links,
      :issues => project.unassigned_issues, :project => project)
  end

  past_rels, upcoming_rels = project.releases.partition { |r| r.released? }
  fn = File.join dir, links["index"]
  puts "Generating #{fn}..."
  File.open(fn, "w") do |f|
    f.puts ErbHtml.new(template_dir, "index", links, :project => project,
      :past_releases => past_rels, :upcoming_releases => upcoming_rels,
      :components => project.components)
  end
end

#init ⇒ Object 



32
33
34
 
# File 'lib/operator.rb', line 32

def init
  Project.create_interactively
end

#parse_releases_arg(project, releases_arg) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/operator.rb', line 89

def parse_releases_arg project, releases_arg
  ret = []

  releases, show_unassigned, force_show = case releases_arg
    when nil; [project.releases, true, false]
    when "unassigned"; [[], true, true]
    else
      [[project.release_for(releases_arg)], false, true]
    end

  releases.each do |r|
    next if r.released? unless force_show

    bugs = project.issues.
      select { |i| i.type == :bugfix && i.release == r.name }
    feats = project.issues.
      select { |i| i.type == :feature && i.release == r.name }

    #next if bugs.empty? && feats.empty? unless force_show

    ret << [r, bugs, feats]
  end

  return ret unless show_unassigned

  bugs = project.issues.select { |i| i.type == :bugfix && i.release.nil? }
  feats = project.issues.select { |i| i.type == :feature && i.release.nil? }

  return ret if bugs.empty? && feats.empty? unless force_show
  ret << [nil, bugs, feats]
end

#release(project, config, release_name) ⇒ Object 



283
284
285
286
287
288
 
# File 'lib/operator.rb', line 283

def release project, config, release_name
  release = project.release_for release_name
  comment = ask_multiline "Comments"
  release.release! project, config.user, comment
  puts "Release #{release.name} released!"
end

#releases(project, config) ⇒ Object 



275
276
277
278
279
280
 
# File 'lib/operator.rb', line 275

def releases project, config
  project.releases.each do |r|
    status = r.released? ? "released #{r.release_time.pretty_date}" : r.status
    puts "#{r.name} (#{status})"
  end
end

#show(project, config, name) ⇒ Object 



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/operator.rb', line 188

def show project, config, name
  issue = project.issue_for name
  status = case issue.status
  when :closed
    "#{issue.status_string}: #{issue.disposition_string}"
  else
    issue.status_string
  end
  puts <<EOS
#{"Issue #{issue.name}".underline}
    Title: #{issue.title}
Description: #{issue.interpolated_desc(project.issues).multiline "  "}
   Status: #{status}
  Creator: #{issue.reporter}
      Age: #{issue.creation_time.ago}
  Release: #{issue.release}
 References: #{issue.references.listify "  "}

Event log:
#{format_log_events issue.log_events}
EOS
end

#start(project, config, name) ⇒ Object 



219
220
221
222
223
224
 
# File 'lib/operator.rb', line 219

def start project, config, name
  issue = project.issue_for name
  comment = ask_multiline "Comments"
  issue.start_work config.user, comment
  puts "Recorded start of work for #{issue.name}."
end

#status(project, config, release = nil) ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/operator.rb', line 122

def status project, config, release=nil
  if project.releases.empty?
    puts "No releases."
    return
  end

  parse_releases_arg(project, release).each do |r, bugs, feats|
    title, bar = [r ? r.name : "unassigned", status_bar_for(bugs + feats)]

    ncbugs = bugs.count_of { |b| b.closed? }
    ncfeats = feats.count_of { |f| f.closed? }
    pcbugs = 100.0 * (bugs.empty? ? 1.0 : ncbugs.to_f / bugs.size)
    pcfeats = 100.0 * (feats.empty? ? 1.0 : ncfeats.to_f / feats.size)

    special = if bugs.empty? && feats.empty?
      "(no issues)"
    elsif ncbugs == bugs.size && ncfeats == feats.size
      "(ready for release)"
    else
      bar
    end

    printf "%-10s %2d/%2d (%3.0f%%) bugs, %2d/%2d (%3.0f%%) features %s\n",
      title, ncbugs, bugs.size, pcbugs, ncfeats, feats.size, pcfeats, special
  end
end

#status_bar_for(issues) ⇒ Object 



149
150
151
152
153
154
 
# File 'lib/operator.rb', line 149

def status_bar_for issues
  Issue::STATUS_WIDGET.
    sort_by { |k, v| -Issue::STATUS_SORT_ORDER[k] }.
    map { |k, v| v * issues.count_of { |i| i.status == k } }.
    join
end

#stop(project, config, name) ⇒ Object 



227
228
229
230
231
232
 
# File 'lib/operator.rb', line 227

def stop project, config, name
  issue = project.issue_for name
  comment = ask_multiline "Comments"
  issue.stop_work config.user, comment
  puts "Recorded work stop for #{issue.name}."
end

#todo(project, config, release = nil) ⇒ Object 



164
165
166
 
# File 'lib/operator.rb', line 164

def todo project, config, release=nil
  actually_do_todo project, config, release, false
end

#todo_full(project, config, release = nil) ⇒ Object 



169
170
171
 
# File 'lib/operator.rb', line 169

def todo_full project, config, release=nil
  actually_do_todo project, config, release, true
end

#todo_list_for(issues) ⇒ Object 



156
157
158
159
160
161
 
# File 'lib/operator.rb', line 156

def todo_list_for issues
  name_len = issues.max_of { |i| i.name.length }
  issues.map do |i|
    sprintf "%s %#{name_len}s: %s\n", i.status_widget, i.name, i.title
  end.join
end

#unassign(project, config, issue_name) ⇒ Object 



259
260
261
262
263
264
 
# File 'lib/operator.rb', line 259

def unassign project, config, issue_name
  issue = project.issue_for issue_name
  comment = ask_multiline "Comments"
  issue.unassign config.user, comment
  puts "Unassigned #{issue.name}."
end

#validate(project, config) ⇒ Object 



365
366
367
 
# File 'lib/operator.rb', line 365

def validate project, config
  ## a no-op
end