ditz 0.1

data/Changelog

@@ -0,0 +1,2 @@
+== 0.1 / 2008-04-02
+* Initial release!

data/README.txt

@@ -0,0 +1,117 @@
+== ditz
+
+by William Morgan <wmorgan-ditz@masanjin.net>
+
+http://ditz.rubyforge.org
+
+== DESCRIPTION
+
+Ditz is a simple, light-weight distributed issue tracker designed to work with
+distributed version control systems like darcs and git. Ditz maintains an issue
+database file on disk, written in a line-based and human-editable format. This
+file can be kept under version control alongside project code, and issue state
+change can then be handled like code changes: modified as part of a commit,
+merged with other state changes from other developers, conflict-resolved in the
+standard manner, etc.
+
+Ditz provides a simple, console-based interface for creating and updating the
+issue database file, and some rudimentary HTML generation capabilities for
+producing world-readable status pages. It offers no central public method of
+bug submission.
+
+== SYNOPSIS
+
+# set up project. creates the bugs.yaml file.
+1. ditz init
+2. ditz add-release
+
+# add an issue
+3. ditz add
+
+# where am i?
+4. ditz status
+5. ditz todo
+
+# do work
+6. write code
+7. ditz close <issue-id>
+8. commit
+9. goto 3
+
+# finished!
+10. ditz release <release-name>
+
+== THE DITZ DATA MODEL
+
+Ditz includes the bare minimum set of features necessary for open-source
+development. Features like time spent, priority, assignment of tasks to
+developers, due dates, etc. are purposely excluded.
+
+A ditz project consists of issues, releases and components.
+
+Issues:
+  Issues are the fundamental currency of issue tracking. A ditz issue is either
+  a feature or a bug, but this distinction doesn't affect anything other than
+  how they're displayed.
+
+  Each issue belongs to exactly one component, and is part of zero or one
+  releases.
+
+  Each issues has an exportable id, in the form of 40 random hex characters.
+  This id is "guaranteed" to be unique across all possible issues and
+  developers, present and future. Issue ids are typically not exposed to the
+  user.
+
+  Issues also have a non-exportable name, which is short and human-readable.
+  All ditz commands use issue names instead of issue ids. Issue ids may change
+  in certain circumstances, specifically after a "ditz drop" command.
+
+Components:
+  There is always one "general" component, named after the project itself. In
+  the simplest case, this is the only component, and the user is never bothered
+  with the question of which component to assign an issue to.
+
+  Components simply provide a way of organizing issues, and have no real
+  functionality. Issues are assigned names derived form the component they're
+  assigned to.
+
+Releases:
+  A release is the primary grouping mechanism for issues. Status commands like
+  "ditz status" and "ditz todo" always group issues by release. When a release
+  is 100% complete, it can be marked as released, in which case the associated
+  issues will cease appearing in ditz status and todo messages.
+
+== FUTURE WORK
+
+In future releases, Ditz will have a plugin architecture to allow tighter
+integration with specific SCMs and developer communication channels. (See
+http://ditz.rubyforge.org/ditz/issue-0704dafe4aef96279364013aba177a0971d425cb.html)
+
+== LEARNING MORE
+
+* ditz help
+* find $DITZ_INSTALL_DIR -type f | xargs cat
+
+== REQUIREMENTS
+
+* trollop >= 1.7
+
+== INSTALLATION
+
+Download tarballs from http://rubyforge.org/projects/ditz/, or command your
+computer to "gem install ditz".
+
+== LICENSE
+
+Copyright (c) 2008 William Morgan.
+
+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 3 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.
+

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'hoe'
+
+$:.unshift "lib"
+require 'ditz'
+
+class Hoe
+  def extra_deps; @extra_deps.reject { |x| Array(x).first == "hoe" } end
+end # thanks to "Mike H"
+
+Hoe.new('ditz', Ditz::VERSION) do |p|
+  p.rubyforge_name = 'ditz'
+  p.author = "William Morgan"
+  p.summary = "A simple issue tracker designed to integrate well with distributed version control systems like git and darcs. State is saved to a YAML file kept under version control, allowing issues to be closed/added/modified as part of a commit."
+
+  p.description = p.paragraphs_of('README.txt', 4..5, 9..18).join("\n\n").gsub(/== SYNOPSIS/, "Synopsis")
+  p.url = "http://ditz.rubyforge.org"
+  p.changes = p.paragraphs_of('Changelog', 0..0).join("\n\n")
+  p.email = "wmorgan-ditz@masanjin.net"
+  p.extra_deps = [['trollop', '>= 1.7']]
+end
+
+WWW_FILES = FileList["www/*"] + %w(README.txt)
+SCREENSHOTS = FileList["www/ss?.png"]
+SCREENSHOTS_SMALL = []
+SCREENSHOTS.each do |fn|
+  fn =~ /ss(\d+)\.png/
+  sfn = "www/ss#{$1}-small.png"
+  file sfn => [fn] do |t|
+    sh "cat #{fn} | pngtopnm | pnmscale -xysize 320 240 | pnmtopng > #{sfn}"
+  end
+  SCREENSHOTS_SMALL << sfn
+end
+
+task :upload_webpage => WWW_FILES do |t|
+  sh "scp -C #{t.prerequisites * ' '} wmorgan@rubyforge.org:/var/www/gforge-projects/ditz/"
+end
+
+task :upload_webpage_images => (SCREENSHOTS + SCREENSHOTS_SMALL) do |t|
+  sh "scp -C #{t.prerequisites * ' '} wmorgan@rubyforge.org:/var/www/gforge-projects/ditz/"
+end
+
+task :upload_report do |t|
+  sh "ditz html ditz"
+  sh "scp -Cr ditz wmorgan@rubyforge.org:/var/www/gforge-projects/ditz/"
+end
+
+# vim: syntax=ruby

data/bin/ditz

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'trollop'; include Trollop
+require "ditz"
+
+$opts = options do
+  version "ditz #{Ditz::VERSION} (c) 2008 William Morgan"
+  opt :issue_file, "Issue database file", :default => "bugs.yaml"
+  opt :config_file, "Configuration file", :default => File.join(ENV["HOME"], ".ditz-config")
+  opt :verbose, "Verbose output", :default => false
+end
+
+cmd = ARGV.shift or die "expecting a ditz command"
+op = Ditz::Operator.new
+
+case cmd # special cases: init and help
+when "init"
+  fn = $opts[:issue_file]
+  die "#{fn} already exists" if File.exists? fn
+  project = op.init
+  project.save! fn
+  puts "Ok, #{fn} created successfully."
+  exit
+when "help"
+  op.help
+  exit
+end
+
+Ditz::debug "loading issues from #{$opts[:issue_file]}"
+project = begin
+  Ditz::Project.from $opts[:issue_file]
+rescue SystemCallError, Ditz::Project::Error => e
+  die "#{e.message} (use 'init' to initialize)"
+end
+
+project.validate!
+project.assign_issue_names!
+project.each_modelobject { |o| o.after_deserialize project }
+
+config = begin
+  fn = ".ditz-config"
+  if File.exists? fn
+    Ditz::debug "loading config from #{fn}"
+    Ditz::Config.from fn
+  else
+    Ditz::debug "loading config from #{$opts[:config_file]}"
+    Ditz::Config.from $opts[:config_file]
+  end
+rescue SystemCallError, Ditz::ModelObject::ModelError => e
+  puts <<EOS
+I wasn't able to find a configuration file #{$opts[:config_file]}.
+We'll set it up right now.
+EOS
+  Ditz::Config.create_interactively
+end
+
+unless op.has_operation? cmd
+  die "no such command: #{cmd}"
+end
+
+## talk about the law of unintended consequences. 'gets' requires this.
+args = []
+args << ARGV.shift until ARGV.empty?
+
+Ditz::debug "executing command #{cmd}"
+op.do cmd, project, config, *args
+
+dirty = project.each_modelobject { |o| break true if o.changed? } || false
+if dirty
+  Ditz::debug "project is dirty, saving"
+  project.each_modelobject { |o| o.before_serialize project }
+  project.save! $opts[:issue_file]
+end
+config.save! $opts[:config_file] if config.changed?
+
+# vim: syntax=ruby

data/lib/component.rhtml

@@ -0,0 +1,18 @@
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<title>Component <%= component.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 %> component: <%= component.name %></h1>
+
+<%= render "issue_table", :show_component => false, :show_release => true %>
+
+<p class="footer">Generated <%= Time.now %> by <a href="http://ditz.rubyforge.org/">ditz</a>.
+</body>
+</html>

data/lib/ditz.rb

@@ -0,0 +1,13 @@
+module Ditz
+
+VERSION = "0.1"
+
+def debug s
+  puts "# #{s}" if $opts[:verbose]
+end
+module_function :debug
+
+end
+
+require 'model-objects'
+require 'operator'

data/lib/html.rb

@@ -0,0 +1,41 @@
+require 'erb'
+
+module Ditz
+
+## pass through any variables needed for template generation, and add a bunch
+## of HTML formatting utility methods.
+class ErbHtml
+  def initialize template_dir, template_name, links, mapping={}
+    @template_name = template_name
+    @template_dir = template_dir
+    @links = links
+    @mapping = mapping
+
+    @@erbs ||= {}
+    @@erbs[template_name] ||= ERB.new(IO.readlines(File.join(template_dir, "#{template_name}.rhtml")).join)
+  end
+
+  def h o; o.to_s.gsub("&", "&amp;").gsub("<", "&lt;").gsub(">", "&gt;") end
+  def p o; "<p>" + h(o.to_s).gsub("\n\n", "</p><p>") + "</p>" end
+  def obscured_email e; h e.gsub(/@.*?(>|$)/, "@...\\1") end
+  def link_to o, name
+    dest = @links[o]
+    dest = o if dest.nil? && o.is_a?(String)
+    raise ArgumentError, "no link for #{o.inspect}" unless dest
+    "<a href=\"#{dest}\">#{name}</a>"
+  end
+
+  def render template_name, morevars={}
+    ErbHtml.new(@template_dir, template_name, @links, @mapping.merge(morevars)).to_s
+  end
+
+  def method_missing meth, *a
+    @mapping.member?(meth) ? @mapping[meth] : super
+  end
+
+  def to_s
+    @@erbs[@template_name].result binding
+  end
+end
+
+end

data/lib/index.rhtml

@@ -0,0 +1,83 @@
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<title><%= project.name %> Issue Tracker</title>
+<meta http-equiv="Content-Type" content="text/html; charset=utf8" />
+<link rel="stylesheet" href="style.css" type="text/css" />
+</head>
+<body>
+
+<h1><%= project.name %> Issue Tracker</h1>
+
+<h2>Upcoming Releases</h2>
+<% if upcoming_releases.empty? %>
+  <p>No upcoming releases.</p>
+<% else %>
+  <ul>
+  <% upcoming_releases.each do |r| %>
+    <%
+      issues = project.issues_for_release r
+      num_done = issues.count_of { |i| i.closed? }
+      pct_done = issues.size == 0 ? 100 : (100.0 * num_done / issues.size)
+      num_bugs_todo = issues.count_of { |i| i.bug? && i.open? }
+      num_feats_todo = issues.count_of { |i| i.feature? && i.open? }
+    %>
+    <li>
+      <%= link_to r, "Release #{r.name}" %>: 
+      <% if issues.empty? %>
+        no issues
+      <% else %>
+        <%= sprintf "%.0f%%", pct_done %> complete;
+        <%= "bug".pluralize num_bugs_todo %> and 
+        <%= "feature".pluralize num_feats_todo %> open.
+      <% end %>
+    </li>
+  <% end %>
+  </ul>
+<% end %>
+
+<h2>Past Releases</h2>
+<% if past_releases.empty? %>
+  <p>No past releases.</p>
+<% else %>
+  <ul>
+  <% past_releases.each do |r| %>
+    <li><%= link_to r, "Release #{r.name}" %>, released <%= r.release_time.pretty_date %>. </li>
+  <% end %>
+  </ul>
+<% end %>
+
+<h2>Unassigned issues</h2>
+<%
+  issues = project.unassigned_issues
+  open_issues = issues.select { |i| i.open? }
+%>
+<p>
+  <%= link_to "unassigned", "unassigned issue".pluralize(issues.size).ucfirst %>; <%= open_issues.size.to_pretty_s %> open.
+</p>
+
+<% if components.size > 1 %>
+  <h2>Open Issues by component</h2>
+  <ul>
+  <% components.each do |c| %>
+    <%
+      open_issues = project.issues_for_component(c).select { |i| i.open? }
+      num_bugs_todo = open_issues.count_of { |i| i.bug? }
+      num_feats_todo = open_issues.count_of { |i| i.feature? }
+    %>
+    <li>
+      <%= link_to c, c.name %>:
+      <% if open_issues.empty? %>
+        no open issues.
+      <% else %>
+        <%= "open bug".pluralize num_bugs_todo %> and
+        <%= "open feature".pluralize num_feats_todo %>.
+      <% end %>
+    </li>
+  <% end %>
+  </ul>
+<% end %>
+
+<p class="footer">Generated <%= Time.now %> by <a href="http://ditz.rubyforge.org/">ditz</a>.
+
+</body>
+</html>

data/lib/issue.rhtml

@@ -0,0 +1,106 @@
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<title><%= issue.title %></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><%= issue.title %></h1>
+
+<%=
+  project.issues.inject(p(issue.desc)) do |s, i|
+    s.gsub(/\{issue #{i.id}\}/, link_to(i, i.title))
+  end.gsub(/\{issue \w+\}/, "[unknown issue]")
+%>
+
+<table>
+  <tr>
+    <td class="attrname">Id:</td>
+    <td class="attrval"><%= issue.id %></td>
+  </tr>
+
+  <tr>
+    <td class="attrname">Type:</td>
+    <td class="attrval"><%= issue.type %></td>
+  </tr>
+
+  <tr>
+    <td class="attrname">Creation time:</td>
+    <td class="attrval"><%= issue.creation_time %></td>
+  </tr>
+
+  <tr>
+    <td class="attrname">Creator:</td>
+    <td class="attrval"><%=obscured_email issue.reporter %></td>
+  </tr>
+
+  <% unless issue.references.empty? %>
+  <tr>
+    <td class="attrname">References:</td>
+    <td class="attrval">
+      <% issue.references.each_with_index do |r, i| %>
+        [<%= i + 1 %>] <%= link_to r, r %><br/>
+      <% end %>
+    </td>
+  </tr>
+
+  <% end %>
+
+  <tr>
+    <td class="attrname">Release:</td>
+    <td class="attrval">
+      <% if release %>
+        <%= link_to release, release.name %>
+        <% if release.released? %>
+          (released <%= release.release_time.pretty_date %>)
+        <% else %>
+          (unreleased)
+        <% end %>
+      <% else %>
+        <%= link_to "unassigned", "unassigned" %>
+      <% end %>
+    </td>
+  </tr>
+
+  <tr>
+    <td class="attrname">Component:</td>
+    <td class="attrval"><%= link_to component, component.name %></td>
+  </tr>
+
+  <tr>
+    <td class="attrname">Status:</td>
+    <td class="attrval"> 
+      <%= issue.status_string %><% if issue.closed? %>: <%= issue.disposition_string %><% end %>
+    </td>
+  </tr>
+</table>
+
+<h2>Issue log</h2>
+
+<table>
+<% issue.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>