ditz 0.1

data/lib/operator.rb

@@ -0,0 +1,408 @@
+require 'tempfile'
+require 'fileutils'
+
+require "html"
+
+module Ditz
+
+class Operator
+  class Error < StandardError; end
+
+  class << self
+    def method_to_op meth; meth.to_s.gsub("_", "-") end
+    def op_to_method op; op.gsub("-", "_").intern end
+
+    def operation method, desc
+      @operations ||= {}
+      @operations[method] = desc
+    end
+
+    def operations
+      @operations.map { |k, v| [method_to_op(k), v] }.sort_by { |k, v| k }
+    end
+    def has_operation? op; @operations.member? op_to_method(op) end
+  end
+
+  def do op, *a; send self.class.op_to_method(op), *a end
+  %w(operations has_operation?).each do |m|
+    define_method(m) { |*a| self.class.send m, *a }
+  end
+
+  operation :init, "Initialize the issue database for a new project"
+  def init
+    Project.create_interactively
+  end
+
+  operation :help, "List all registered commands"
+  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
+
+  operation :add, "Add a bug/feature request"
+  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
+
+  operation :drop, "Drop a bug/feature request"
+  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
+
+  operation :add_release, "Add a release"
+  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
+
+  operation :add_component, "Add a component"
+  def add_component project, config
+    component = Component.create_interactively(:args => [project, config]) or return
+    project.add_component component
+    puts "Added component #{component.name}."
+  end
+
+  operation :add_reference, "Add a reference to an issue"
+  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
+
+  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
+
+  operation :status, "Show project status"
+  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
+
+  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
+
+  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
+
+  operation :todo, "Generate todo list"
+  def todo project, config, release=nil
+    actually_do_todo project, config, release, false
+  end
+
+  operation :todo_full, "Generate full todo list, including completed items"
+  def todo_full project, config, release=nil
+    actually_do_todo project, config, release, true
+  end
+
+  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
+
+  operation :show, "Describe a single issue"
+  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
+
+  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
+
+  operation :start, "Start work on an issue"
+  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
+
+  operation :stop, "Stop work on an issue"
+  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
+
+  operation :close, "Close an issue"
+  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
+
+  operation :assign, "Assign an issue to a release"
+  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
+
+  operation :unassign, "Unassign an issue from any releases"
+  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
+
+  operation :comment, "Comment on an issue"
+  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
+
+  operation :releases, "Show releases"
+  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
+
+  operation :release, "Release a release"
+  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
+
+  operation :changelog, "Generate a changelog for a release"
+  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
+
+  operation :html, "Generate html status pages"
+  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
+
+  operation :validate, "Validate project status"
+  def validate project, config
+    ## a no-op
+  end
+
+  operation :grep, "Show issues matching a string or regular expression"
+  def grep project, config, match
+    re = /#{match}/
+    issues = project.issues.select { |i| i.title =~ re || i.desc =~ re }
+    print_todo issues
+  end
+
+  operation :edit, "Edit an issue"
+  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
+end
+
+end

data/lib/release.rhtml

@@ -0,0 +1,67 @@
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<title><%= project.name %> release <%= release.name %></title>
+<meta http-equiv="Content-Type" content="text/html; charset=utf8" />
+<link rel="stylesheet" href="style.css" type="text/css" />
+</head>
+<body>
+
+<%= link_to "index", "&laquo; #{project.name} project page" %>
+
+<h1><%= project.name %> release <%= release.name %></h1>
+
+<p>
+<table>
+  <tr>
+    <td class="attrname">Status:</td>
+    <td class="attrval"><%= release.status %></td>
+  </tr>
+  <% if release.released? %>
+    <tr>
+      <td class="attrname">Release time:</td>
+      <td class="attrval"><%= release.release_time %></td>
+    </tr>
+  <% end %>
+  <tr>
+    <%
+      num_done = issues.count_of { |i| i.closed? }
+      pct_done = issues.size == 0 ? 100 : (100.0 * num_done / issues.size)
+    %>
+    <td class="attrname">Completion:</td>
+    <td class="attrval"><%= sprintf "%.0f%%", pct_done %></td>
+  </tr>
+</table>
+</p>
+
+<h2>Issues</h2>
+<% if issues.empty? %>
+  <p>No issues assigned to this release.</p>
+<% else %>
+  <%= render "issue_table", :show_component => false, :show_release => false %>
+<% end %>
+
+<h2>Release log</h2>
+<table>
+<% release.log_events.each_with_index do |(time, who, what, comment), i| %>
+<% if i % 2 == 0 %>
+  <tr class="logentryeven">
+<% else %>
+  <tr class="logentryodd">
+<% end %>
+  <td class="logtime"><%=h time %></td>
+  <td class="logwho"><%=obscured_email who %></td>
+  <td class="logwhat"><%=h what %></td>
+  </tr>
+  <tr><td colspan="3" class="logcomment">
+    <% if comment.empty? %>
+    <% else %>
+      <%=p comment %>
+    <% end %>
+  </td></tr>
+<% end %>
+</table>
+
+<p class="footer">Generated <%= Time.now %> by <a href="http://ditz.rubyforge.org/">ditz</a>.
+
+</body>
+</html>