ditz 0.4 → 0.5

data/lib/plugins/git-sync.rb

@@ -0,0 +1,83 @@
+## git-sync ditz plugin
+## 
+## This plugin is useful for when you want synchronized, non-distributed issue
+## coordination with other developers, and you're using git. It allows you to
+## synchronize issue updates with other developers by using the 'ditz sync'
+## command, which does all the git work of sending and receiving issue change
+## for you. However, you have to set things up in a very specific way for this
+## to work:
+##
+## 1. Your ditz state must be on a separate branch. I recommend calling it
+##    'bugs'. Create this branch, do a ditz init, and push it to the remote
+##    repo. (This means you won't be able to mingle issue change and code
+##    change in the same commits. If you care.)
+## 2. Make a checkout of the bugs branch in a separate directory, but NOT in
+##    your code checkout. If you're developing in a directory called "project",
+##    I recommend making a ../project-bugs/ directory, cloning the repo there
+##    as well, and keeping that directory checked out to the 'bugs' branch.
+##    (There are various complicated things you can do to make that directory
+##    share git objects with your code directory, but I wouldn't bother unless
+##    you really care about disk space. Just make it an independent clone.)
+## 3. Set that directory as your issue-dir in your .ditz-config file in your
+##    code checkout directory. (This file should be in .gitignore, btw.)
+## 4. Run 'ditz reconfigure' and fill in the local branch name, remote
+##    branch name, and remote repo for the issue tracking branch.
+##
+## Once that's set up, 'ditz sync' will change to the bugs checkout dir, bundle
+## up any changes you've made to issue status, push them to the remote repo,
+## and pull any new changes in too. All ditz commands will read from your bugs
+## directory, so you should be able to use ditz without caring about where
+## things are anymore.
+##
+## This complicated setup is necessary to avoid accidentally mingling code
+## change and issue change. With this setup, issue change is synchronized,
+## but how you synchronize code is still up to you.
+##
+## Usage:
+##   0. read all the above text very carefully
+##   1. add a line "- git-sync" to the .ditz-plugins file in the project
+##      root
+##   2. run 'ditz reconfigure' and answer its questions
+##   3. run 'ditz sync' with abandon
+
+module Ditz
+
+class Config
+  field :git_sync_local_branch, :prompt => "Local bugs branch name for ditz sync", :default => "bugs"
+  field :git_sync_remote_branch, :prompt => "Remote bugs branch name for ditz sync", :default => "bugs"
+  field :git_sync_remote_repo, :prompt => "Remote bugs repo name for ditz sync", :default => "origin"
+end
+
+class Operator
+  operation :sync, "Sync the repo containing ditz via git" do
+    opt :dry_run, "Dry run: print the commants, but don't execute them", :short => "n"
+  end
+  def sync project, config, opts
+    unless config.git_sync_local_branch
+      $stderr.puts "Please run ditz reconfigure and set the local and remote branch names"
+      return
+    end
+
+    Dir.chdir $project_root
+    puts "[in #{$project_root}]"
+    sh "git add *.yaml", :force => true, :fake => opts[:dry_run]
+    sh "git commit -m 'issue updates'", :force => true, :fake => opts[:dry_run]
+    sh "git pull", :fake => opts[:dry_run]
+    sh "git push #{config.git_sync_remote_repo} #{config.git_sync_local_branch}:#{config.git_sync_remote_branch}", :fake => opts[:dry_run]
+    puts
+    puts "Ditz issue state synchronized."
+  end
+
+  private
+
+  def sh s, opts={}
+    puts "+ #{s}"
+    return if opts[:fake]
+    unless system(s) || opts[:force]
+      $stderr.puts "non-zero (#{$?.exitstatus}) exit code: #{s}"
+      exit(-1)
+    end
+  end
+end
+
+end

data/lib/plugins/git.rb

@@ -1,3 +1,31 @@
+## git ditz plugin
+## 
+## This plugin allows issues to be associated with git commits and git
+## branches.  Git commits can be easily tagged with a ditz issue with the 'ditz
+## commit' command, and both 'ditz show' and the ditz HTML output will then
+## contain a list of associated commits for each issue.
+##
+## Issues can also be assigned a single git feature branch. In this case, all
+## commits on that branch will listed as commits for that issue. This
+## particular feature is fairly rudimentary, however---it assumes the reference
+## point is the 'master' branch, and once the feature branch is merged back
+## into master, the list of commits disappears.
+##
+## Two configuration variables are added, which, when specified, are used to
+## construct HTML links for the git commit id and branch names in the generated
+## HTML output.
+##
+## Commands added:
+##   ditz set-branch: set the git branch of an issue
+##   ditz commit: run git-commit, and insert the issue id into the commit
+##     message.
+##
+## Usage: 
+##   1. add a line "- git" to the .ditz-plugins file in the project root
+##   2. run ditz reconfigure, and enter the URL prefixes, if any, from
+##      which to create commit and branch links.
+##   3. use 'ditz commit' with abandon.
+
 require 'time'
 
 module Ditz
@@ -20,8 +48,8 @@ class Issue
 end
 
 class Config
-  field :git_commit_url_prefix, :prompt => "URL prefix (if any) to link git commits to"
-  field :git_branch_url_prefix, :prompt => "URL prefix (if any) to link git branches to"
+  field :git_commit_url_prefix, :prompt => "URL prefix to link git commits to", :default => ""
+  field :git_branch_url_prefix, :prompt => "URL prefix to link git branches to", :default => ""
 end
 
 class ScreenView
@@ -44,7 +72,7 @@ class HtmlView
     [<<EOS, { :issue => issue, :url_prefix => config.git_branch_url_prefix }]
 <tr>
   <td class='attrname'>Git branch:</td>
-  <td class='attrval'><%= url_prefix ? link_to([url_prefix, issue.git_branch].join, issue.git_branch) : h(issue.git_branch) %></td>
+  <td class='attrval'><%= url_prefix && !url_prefix.blank? ? link_to([url_prefix, issue.git_branch].join, issue.git_branch) : h(issue.git_branch) %></td>
 </tr>
 EOS
   end
@@ -55,17 +83,14 @@ EOS
 
     [<<EOS, { :commits => commits, :url_prefix => config.git_commit_url_prefix }]
 <h2>Commits for this issue</h2>
-<table>
+<table class="log">
 <% commits.each_with_index do |(time, who, hash, msg), i| %>
-<% if i % 2 == 0 %>
-  <tr class="logentryeven">
-<% else %>
-  <tr class="logentryodd">
-<% end %>
-  <td class="logtime"><%=t time %></td>
-  <td class="logwho"><%=obscured_email who %></td>
-  <td class="logwhat"><%=h msg %> [<%= url_prefix ? link_to([url_prefix, hash].join, hash) : hash %>]</td>
+  <tr class="<%= i % 2 == 0 ? "even-row" : "odd-row" %>">
+  <td class="time"><%=t time %></td>
+  <td class="person"><%=obscured_email who %></td>
+  <td class="message"><%=h msg %> [<%= url_prefix && !url_prefix.blank? ? link_to([url_prefix, hash].join, hash) : hash %>]</td>
   </tr>
+  <tr><td></td></tr>
 <% end %>
 </table>
 EOS
@@ -92,9 +117,36 @@ class Operator
     issue.git_branch = branch
   end
 
-  operation :commit, "Runs git-commit and auto-fills the issue name in the commit message", :issue
-  def commit project, config, issue
-    exec "git commit -v -m \"Ditz-issue: #{issue.id}\" -e"
+  operation :commit, "Runs git-commit and auto-fills the issue name in the commit message", :issue do
+    opt :all, "commit all changed files", :short => "-a", :default => false
+    opt :verbose, "show diff between HEAD and what would be committed", \
+      :short => "-v", :default => false
+    opt :message, "Use the given <s> as the commit message.", \
+      :short => "-m", :type => :string
+    opt :edit, "Further edit the message, even if --message is given.", :short => "-e", :default => false
+  end
+
+  def commit project, config, opts, issue
+    opts[:edit] = true if opts[:message].nil?
+
+    args = {
+      :verbose => "--verbose",
+      :all => "--all",
+      :edit => "--edit",
+    }.map { |k, v| opts[k] ? v : "" }.join(" ")
+
+    comment = "# #{issue.name}: #{issue.title}"
+    tag = "Ditz-issue: #{issue.id}"
+    message = if opts[:message] && !opts[:edit]
+      "#{opts[:message]}\n\n#{tag}"
+    elsif opts[:message] && opts[:edit]
+      "#{opts[:message]}\n\n#{comment}\n#{tag}"
+    else
+      "#{comment}\n#{tag}"
+    end
+
+    message = message.gsub("\"", "\\\"")
+    exec "git commit #{args} --message=\"#{message}\""
   end
 end
 

data/lib/plugins/issue-claiming.rb

@@ -0,0 +1,174 @@
+## issue-claiming ditz plugin
+## 
+## This plugin allows people to claim issues. This is useful for avoiding
+## duplication of work---you can check to see if someone's claimed an
+## issue before starting to work on it, and you can let people know what
+## you're working on.
+##
+## Commands added:
+##   ditz claim: claim an issue for yourself
+##   ditz unclaim: unclaim a claimed issue
+##   ditz mine: show all issues claimed by you
+##   ditz claimed: show all claimed issues, by developer
+##   ditz unclaimed: show all unclaimed issues
+##
+## Usage:
+##   1. add a line "- issue-claiming" to the .ditz-plugins file in the project
+##      root
+##   2. use the above commands to abandon
+
+module Ditz
+class Issue
+  field :claimer, :ask => false
+
+  def claim who, comment, force=false
+    raise Error, "already claimed by #{claimer}" if claimer && !force
+    log "issue claimed", who, comment
+    self.claimer = who
+  end
+
+  def unclaim who, comment, force=false
+    raise Error, "not claimed" unless claimer
+    raise Error, "can only be unclaimed by #{claimer}" unless claimer == who || force
+    if claimer == who
+      log "issue unclaimed", who, comment
+    else
+      log "unassigned from #{claimer}", who, comment
+    end
+    self.claimer = nil
+  end
+
+  def claimed?; claimer end
+  def unclaimed?; !claimed? end
+end
+
+class ScreenView
+  add_to_view :issue_summary do |issue, config|
+    " Claimed by: #{issue.claimer || 'none'}\n"
+  end
+end
+
+class HtmlView
+  add_to_view :issue_summary do |issue, config|
+    next unless issue.claimer
+    [<<EOS, { :issue => issue }]
+<tr>
+  <td class='attrname'>Claimed by:</td>
+  <td class='attrval'><%= h(issue.claimer) %></td>
+</tr>
+EOS
+  end
+end
+
+class Operator
+  alias :__issue_claiming_start :start
+  def start project, config, opts, issue
+    if issue.claimed? && issue.claimer != config.user
+      raise Error, "issue #{issue.name} claimed by #{issue.claimer}"
+    else
+      __issue_claiming_start project, config, opts, issue
+    end
+  end
+
+  alias :__issue_claiming_stop :stop
+  def stop project, config, opts, issue
+    if issue.claimed? && issue.claimer != config.user
+      raise Error, "issue #{issue.name} claimed by #{issue.claimer}"
+    else
+      __issue_claiming_stop project, config, opts, issue
+    end
+  end
+
+  alias :__issue_claiming_close :close
+  def close project, config, opts, issue
+    if issue.claimed? && issue.claimer != config.user
+      raise Error, "issue #{issue.name} claimed by #{issue.claimer}"
+    else
+      __issue_claiming_close project, config, opts, issue
+    end
+  end
+
+  operation :claim, "Claim an issue for yourself", :issue do
+    opt :force, "Claim this issue even if someone else has claimed it", :default => false
+  end
+  def claim project, config, opts, issue
+    puts "Claiming issue #{issue.name}: #{issue.title}."
+    comment = ask_multiline "Comments" unless $opts[:no_comment]
+    issue.claim config.user, comment, opts[:force]
+    puts "Issue #{issue.name} marked as claimed by #{config.user}"
+  end
+
+  operation :unclaim, "Unclaim a claimed issue", :issue do
+    opt :force, "Unclaim this issue even if it's claimed by someone else", :default => false
+  end
+  def unclaim project, config, opts, issue
+    puts "Unclaiming issue #{issue.name}: #{issue.title}."
+    comment = ask_multiline "Comments" unless $opts[:no_comment]
+    issue.unclaim config.user, comment, opts[:force]
+    puts "Issue #{issue.name} marked as unclaimed."
+  end
+
+  operation :mine, "Show all issues claimed by you", :maybe_release do
+    opt :all, "Show all issues, not just open ones"
+  end
+  def mine project, config, opts, releases
+    releases ||= project.unreleased_releases + [:unassigned]
+    releases = [*releases]
+
+    issues = project.issues.select do |i|
+      r = project.release_for(i.release) || :unassigned
+      releases.member?(r) && i.claimer == config.user && (opts[:all] || i.open?)
+    end
+    if issues.empty?
+      puts "No issues."
+    else
+      print_todo_list_by_release_for project, issues
+    end
+  end
+
+  operation :claimed, "Show claimed issues by claimer", :maybe_release do
+    opt :all, "Show all issues, not just open ones"
+  end
+  def claimed project, config, opts, releases
+    releases ||= project.unreleased_releases + [:unassigned]
+    releases = [*releases]
+
+    issues = project.issues.inject({}) do |h, i|
+      r = project.release_for(i.release) || :unassigned
+      if i.claimed? && (opts[:all] || i.open?) && releases.member?(r)
+        (h[i.claimer] ||= []) << i
+      end
+      h
+    end
+
+    if issues.empty?
+      puts "No issues."
+    else
+      issues.keys.sort.each do |c|
+        puts "#{c}:"
+        puts todo_list_for(issues[c], :show_release => true)
+        puts
+      end
+    end
+  end
+
+  operation :unclaimed, "Show all unclaimed issues", :maybe_release do
+    opt :all, "Show all issues, not just open ones"
+  end
+  def unclaimed project, config, opts, releases
+    releases ||= project.unreleased_releases + [:unassigned]
+    releases = [*releases]
+
+    issues = project.issues.select do |i|
+      r = project.release_for(i.release) || :unassigned
+      releases.member?(r) && i.claimer.nil? && (opts[:all] || i.open?)
+    end
+    if issues.empty?
+      puts "No issues."
+    else
+      print_todo_list_by_release_for project, issues
+    end
+  end
+end
+
+end

data/lib/release.rhtml

@@ -1,37 +1,48 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+
 <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" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <link rel="stylesheet" href="style.css" type="text/css" />
 </head>
 <body>
 
-<%= link_to "index", "&laquo; #{project.name} project page" %>
+<div class="main">
 
 <h1><%= project.name %> release <%= release.name %></h1>
+<div class="backptr"><%= link_to "index", "&laquo; #{project.name} project page" %></div>
 
-<p>
 <table>
-  <tr>
-    <td class="attrname">Status:</td>
-    <td class="attrval"><%= release.status %></td>
-  </tr>
-  <% if release.released? %>
+  <tbody>
     <tr>
-      <td class="attrname">Release time:</td>
-      <td class="attrval"><%= release.release_time %></td>
+      <td class="attrname">Status:</td>
+      <td class="attrval"><%= release.status %></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>
+    <% if release.released? %>
+      <tr>
+        <td class="attrname">Release time:</td>
+        <td class="attrval"><%=t release.release_time %></td>
+      </tr>
+    <% end %>
+    <tr>
+      <td class="attrname">Completion:</td>
+      <td>
+      <%
+        num_done = issues.count_of { |i| i.closed? }
+        pct_done = issues.size == 0 ? 1.0 : (num_done.to_f / issues.size.to_f)
+      %>
+      <%= progress_meter pct_done %>
+      <%= sprintf "%.0f%%", pct_done * 100.0 %>
+      </td>
+    </tr>
+    <tr><td></td><td class="attrval">
+      <%= num_done %> / <%= issues.size %> issues
+    </td></tr>
+  </tbody>
 </table>
-</p>
 
 <h2>Issues</h2>
 <% if issues.empty? %>
@@ -40,28 +51,48 @@
   <%= render "issue_table", :show_component => false, :show_release => false %>
 <% end %>
 
+<h2>Recent activity for this release</h2>
+<table class="log">
+  <tbody>
+  <% issues.map { |i| i.log_events.map { |e| [e, i] } }.
+        flatten_one_level.
+        sort_by { |e| e.first.first }.
+        reverse[0 ... 10].
+        each_with_index do |((date, who, what, comment), i), idx| %>
+    <tr class="<%= idx % 2 == 0 ? "even-row" : "odd-row" %>">
+      <td class="date"><%= date.pretty_date %></td>
+      <td class="issuename">
+        <%= issue_link_for i, :status_image => true %>
+      </td>
+      <td> <%= what %> </td>
+    </tr>
+    <tr><td></td></tr>
+  <% end %>
+  </tbody>
+</table>
+
 <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 %>
-      <%= link_issue_names project, p(comment) %>
-    <% end %>
-  </td></tr>
+<table class="log">
+  <tbody>
+<% release.log_events.reverse.each_with_index do |(time, who, what, comment), i| %>
+    <tr class="<%= i % 2 == 0 ? "even-row" : "odd-row" %>">
+    <td class="date"><%=h time %></td>
+    <td class="person"><%=obscured_email who %></td>
+    <td class="message"><%=h what %></td>
+    </tr>
+    <tr><td colspan="3" class="logcomment">
+      <% if comment.empty? %>
+      <% else %>
+        <%= link_issue_names project, comment %>
+      <% end %>
+    </td></tr>
+    <tr><td></td></tr>
 <% end %>
+  </tbody>
 </table>
 
-<p class="footer">Generated by <a href="http://ditz.rubyforge.org/">ditz</a>.
+</div>
+<div class="footer">Generated by <a href="http://ditz.rubyforge.org/">ditz</a>.</div>
 
 </body>
 </html>