ditz 0.3 → 0.4

data/Changelog

@@ -1,3 +1,12 @@
+== 0.4 / 2008-07-27
+* bugfix: HOME environment variable now correctly detected on windows
+* hooks loaded from both home directory and project directory
+* added bash shell completion
+* plugin architecture for tighter SCM integration, etc
+* 'ditz grep' should also grep against comments, log messages, etc
+* added man page
+* removed ditz-convert-from-monolith
+* lots of HTML output tweaking
 == 0.3 / 2008-06-04
 * readline support for all text entry
 * hook system. Use ditz -l to see possible hooks.

data/README.txt

@@ -7,17 +7,28 @@ 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 directory on disk, with files written in a line-based and human-
-editable format. This directory is kept under version control alongside
-project code. Changes in issue state is handled by version control like code
-change: included as part of a commit, merged with changes from other
-developers, conflict-resolved in the standard manner, etc.
+distributed version control systems like git, darcs, Mercurial, and Bazaar. It
+can also be used with centralized systems like SVN.
+
+Ditz maintains an issue database directory on disk, with files written in a
+line-based and human-editable format. This directory can be kept under version
+control, alongside project code.
+
+There are different ways to use ditz:
+
+ 1. Treat issue change the same as code change: include it as part of commits,
+    and merge it with changes from other developers. (Resolving conflicts in
+    the usual manner.)
+ 2. Keep the issue database in the repository but in a separate branch. Issue
+    changes can be managed by your VCS, but is not tied directly to commits.
+ 3. Keep the issue database separate and not under VCS at all.
+
+Your particular usage will depend on what you want to get out of ditz.
 
 Ditz provides a simple, console-based interface for creating and updating the
-issue database files, and some rudimentary HTML generation capabilities for
-producing world-readable status pages. It offers no central public method of
-bug submission.
+issue database file, and some rudimentary HTML generation capabilities for
+producing world-readable status pages. It currently offers no central public
+method of bug submission.
 
 == SYNOPSIS
 
@@ -30,7 +41,7 @@ bug submission.
 
 # where am i?
 4. ditz status
-5. ditz todo
+5. ditz todo (or simply "ditz")
 
 # do work
 6. write code
@@ -94,7 +105,7 @@ http://ditz.rubyforge.org/ditz/issue-0704dafe4aef96279364013aba177a0971d425cb.ht
 
 == REQUIREMENTS
 
-* trollop >= 1.7
+* trollop >= 1.8.2
 
 == INSTALLATION
 

data/Rakefile

@@ -17,29 +17,15 @@ Hoe.new('ditz', Ditz::VERSION) do |p|
   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']]
+  p.extra_deps = [['trollop', '>= 1.8.2']]
 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 "rsync -essh -cavz #{t.prerequisites * ' '} wmorgan@rubyforge.org:/var/www/gforge-projects/ditz/"
 end
 
-task :upload_webpage_images => (SCREENSHOTS + SCREENSHOTS_SMALL) do |t|
-  sh "rsync -essh -cavs #{t.prerequisites * ' '} wmorgan@rubyforge.org:/var/www/gforge-projects/ditz/"
-end
-
 task :upload_report do |t|
   sh "ruby -Ilib bin/ditz html ditz"
   sh "rsync -essh -cavz ditz wmorgan@rubyforge.org:/var/www/gforge-projects/ditz/"

data/ReleaseNotes

@@ -1,3 +1,32 @@
+0.4
+---
+- Command-line completion scripts are now included for bash and zsh. To
+  activate, source the relevant file in $GEMDIR/ditz-0.4/contrib/completion/.
+
+- Hooks can now be set on a per-project basis. Make a .ditz/hooks directory in
+  your project root and place them there. These will be loaded after any
+  hooks in ~/.ditz/hooks, so they can override or simply supplement.
+
+- The plugin system is done. There's currently one plugin, for git integration.
+  To enable it, add the line "- git" in a .ditz-plugins file in your project
+  root. The git plugin currently has the following features:
+
+  - Issues can have a git branch assigned to them with "ditz set-branch".
+  - Git commit messages can have a Ditz-issue: header auto-filled if you
+    commit with "ditz commit <issue>" (i.e. instead of git commit).
+  - In both HTML and screen output, commits from the assigned branch, and
+    commits with the corresponding Ditz-issue: header in the log message,
+    will be listed for each issue.
+
+  Note that the plugin system is independent of the hook system. In order
+  to auto-add ditz files to the git index upon modification, you must set
+  up hooks. Example hooks for git are at:
+    http://hackety.org/2008/06/26/gitHooksForDitz.html
+
+  Also note that as soon as a feature branch is merged back into master, ditz
+  loses the ability to distinguish its commits. So the Ditz-issue: approach
+  is probably better if you want a long-term record.
+
 0.3
 ---
 Ditz now works from project subdirectories, and you can have a .ditz-config in

data/bin/ditz

@@ -19,19 +19,16 @@ require "ditz"
 
 PROJECT_FN = "project.yaml"
 CONFIG_FN = ".ditz-config"
+PLUGIN_FN = ".ditz-plugins"
 
-## helper for recursive search
-def find_dir_containing target, start=Pathname.new(".")
-  return start if (start + target).exist?
-  unless start.parent.realpath == start.realpath
-    find_dir_containing target, start.parent
-  end
-end
+config_dir = Ditz::find_dir_containing CONFIG_FN
+plugin_dir = Ditz::find_dir_containing PLUGIN_FN
 
 $opts = options do
   version "ditz #{Ditz::VERSION}"
   opt :issue_dir, "Issue database dir", :default => "bugs"
-  opt :config_file, "Configuration file", :default => File.join(ENV["HOME"], CONFIG_FN)
+  opt :config_file, "Configuration file", :default => File.join(config_dir || ".", CONFIG_FN)
+  opt :plugins_file, "Plugins file", :default => File.join(plugin_dir || ".", PLUGIN_FN)
   opt :verbose, "Verbose output", :default => false
   opt :no_comment, "Skip asking for a comment", :default => false
   opt :list_hooks, "List all hooks and descriptions, and quit.", :short => 'l', :default => false
@@ -76,22 +73,36 @@ if $opts[:list_hooks]
   exit 0
 end
 
-local_config_dir = find_dir_containing CONFIG_FN
+plugins = begin
+  Ditz::debug "loading plugins from #{$opts[:plugins_file]}"
+  YAML::load_file$opts[:plugins_file]
+rescue SystemCallError => e
+  Ditz::debug "can't load plugins file: #{e.message}"
+  []
+end
+
+plugins.each do |p|
+  fn = Ditz::find_ditz_file "plugins/#{p}.rb"
+  Ditz::debug "loading plugin #{p.inspect} from #{fn}"
+  load fn
+end
+
 config = begin
-  if local_config_dir
-    fn = local_config_dir + CONFIG_FN
-    Ditz::debug "loading local config from #{fn}"
-    Ditz::Config.from fn
+  Ditz::debug "loading config from #{$opts[:config_file]}"
+  Ditz::Config.from $opts[:config_file]
+rescue SystemCallError => e
+  if ARGV.member? "<options>"
+    ## special case here. if we're asking for tab completion, and the config
+    ## file doesn't exist, don't do the interactive building. just make a
+    ## fake empty one and carry on.
+    Ditz::Config.new
   else
-    Ditz::debug "loading global config from #{$opts[:config_file]}"
-    Ditz::Config.from $opts[:config_file]
-  end
-rescue SystemCallError, Ditz::ModelObject::ModelError => e
-  puts <<EOS
+    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.save! $opts[:config_file]
+    Ditz::Config.create_interactively.save! $opts[:config_file]
+  end
 end
 
 cmd = ARGV.shift || "todo"
@@ -111,7 +122,7 @@ when "help"
   exit
 end
 
-project_root = find_dir_containing(issue_dir + PROJECT_FN)
+project_root = Ditz::find_dir_containing(issue_dir + PROJECT_FN)
 die "No #{issue_dir} directory---use 'ditz init' to initialize" unless project_root
 project_root += issue_dir
 
@@ -149,6 +160,7 @@ begin
 rescue Ditz::Operator::Error => e
   die e.message
 rescue Errno::EPIPE, Interrupt
+  puts
   exit 1
 end
 

data/contrib/completion/_ditz.zsh

@@ -0,0 +1,29 @@
+#compdef ditz
+
+ME=ditz
+COMMANDS=--commands
+OPTIONS='<options>'
+
+if (($CURRENT == 2)); then
+  # We're completing the first word after the tool: the command.
+  _wanted command expl "$ME command" \
+    compadd -- $( "$ME" "$COMMANDS" )
+else
+  # Find the options/files/URL/etc. for the current command by using the tool itself.
+      case "${words[$CURRENT]}"; in
+        -*)
+          _wanted args expl "Arguments for $ME ${words[2]}" \
+             compadd -- $( "$ME" "${words[2]}" "$OPTIONS" ; _files )
+            ;;
+        ht*|ft*)
+            _arguments '*:URL:_urls'
+            ;;
+        /*|./*|\~*|../*)
+            _arguments '*:file:_files'
+            ;;
+        *)
+          _wanted args expl "Arguments for $ME ${words[2]}" \
+             compadd -- $( "$ME" "${words[2]}" "$OPTIONS" )
+          ;;
+      esac
+fi

data/contrib/completion/ditz.bash

@@ -0,0 +1,22 @@
+# ditz bash completion
+#
+# author: Christian Garbs
+#
+# based on bzr.simple by Martin Pool
+
+_ditz() 
+{
+    cur=${COMP_WORDS[COMP_CWORD]}
+    if [ $COMP_CWORD -eq 1 ]; then
+	COMPREPLY=( $( compgen -W "$(ditz --commands)" $cur ) )
+    elif [ $COMP_CWORD -eq 2 ]; then
+	cmd=${COMP_WORDS[1]}
+	COMPREPLY=( $( compgen -W "$(ditz "$cmd" '<options>' 2>/dev/null)" $cur ) )
+    elif [ $COMP_CWORD -eq 3 ]; then
+	cmd=${COMP_WORDS[1]}
+	parm1=${COMP_WORDS[2]}
+	COMPREPLY=( $( compgen -W "$(ditz "$cmd" "$parm1" '<options>' 2>/dev/null)" $cur ) )
+    fi 
+}
+
+complete -F _ditz -o default ditz

data/lib/ditz.rb

@@ -1,6 +1,6 @@
 module Ditz
 
-VERSION = "0.3"
+VERSION = "0.4"
 
 def debug s
   puts "# #{s}" if $opts[:verbose]
@@ -14,7 +14,6 @@ end
 def self.has_readline= val
   @has_readline = val
 end
-end
 
 begin
   Ditz::has_readline = false
@@ -24,6 +23,34 @@ rescue LoadError
   # do nothing
 end
 
+def home_dir
+  @home ||=
+    ENV["HOME"] || (ENV["HOMEDRIVE"] && ENV["HOMEPATH"] ? ENV["HOMEDRIVE"] + ENV["HOMEPATH"] : nil) || begin
+    $stderr.puts "warning: can't determine home directory, using '.'"
+    "."
+  end
+end
+
+## helper for recursive search
+def find_dir_containing target, start=Pathname.new(".")
+  return start if (start + target).exist?
+  unless start.parent.realpath == start.realpath
+    find_dir_containing target, start.parent
+  end
+end
+
+## my brilliant solution to the 'gem datadir' problem
+def find_ditz_file fn
+  dir = $:.find { |p| File.exist? File.expand_path(File.join(p, fn)) }
+  raise "can't find #{fn} in any load path" unless dir
+  File.expand_path File.join(dir, fn)
+end
+
+module_function :home_dir, :find_dir_containing, :find_ditz_file
+end
+
 require 'model-objects'
 require 'operator'
+require 'views'
 require 'hook'
+

data/lib/hook.rb

@@ -50,8 +50,15 @@ EOS
 
     def hooks_for name
       if @blocks[name].nil? || @blocks[name].empty?
-        fns = File.join(ENV['HOME'], '.ditz', 'hooks', '*.rb') 
-        Dir[fns].each { |fn| load fn }
+        dirs = [Ditz::home_dir, Ditz::find_dir_containing(".ditz")].compact.map do |d|
+          File.join d, ".ditz", "hooks"
+        end
+        Ditz::debug "looking for hooks in #{dirs.join(" and ")}"
+        files = dirs.map { |d| Dir[File.join(d, "*.rb")] }.flatten
+        files.each do |fn|
+          Ditz::debug "loading hook file #{fn}"
+          load fn
+        end
       end
 
       @blocks[name] || []

data/lib/html.rb

@@ -5,17 +5,41 @@ 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
+  def initialize template_dir, links, binding={}
     @template_dir = template_dir
     @links = links
-    @mapping = mapping
+    @binding = binding
+  end
+
+  ## return an ErbHtml object that has the current binding plus extra_binding merged in
+  def clone_for_binding extra_binding={}
+    extra_binding.empty? ? self : ErbHtml.new(@template_dir, @links, @binding.merge(extra_binding))
+  end
+
+  def render_template template_name, extra_binding={}
+    if extra_binding.empty?
+      @@erbs ||= {}
+      @@erbs[template_name] ||= ERB.new IO.read(File.join(@template_dir, "#{template_name}.rhtml"))
+      @@erbs[template_name].result binding
+    else
+      clone_for_binding(extra_binding).render_template template_name
+    end
+  end
 
-    @@erbs ||= {}
-    @@erbs[template_name] ||= ERB.new(IO.readlines(File.join(template_dir, "#{template_name}.rhtml")).join)
+  def render_string s, extra_binding={}
+    if extra_binding.empty?
+      ERB.new(s).result binding
+    else
+      clone_for_binding(extra_binding).render_string s
+    end
   end
 
+  ###
+  ### the following methods are meant to be called from the ERB itself
+  ###
+
   def h o; o.to_s.gsub("&", "&amp;").gsub("<", "&lt;").gsub(">", "&gt;") end
+  def t o; o.strftime "%Y-%m-%d %H:%M %Z" 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
@@ -24,23 +48,21 @@ class ErbHtml
     raise ArgumentError, "no link for #{o.inspect}" unless dest
     "<a href=\"#{dest}\">#{name}</a>"
   end
+  def fancy_issue_link_for i
+    "<span class=\"issuestatus_#{i.status}\">" + link_to(i, "[#{i.title}]") + "</span>"
+  end
 
   def link_issue_names project, s
     project.issues.inject(s) do |s, i|
-      s.gsub(/\b#{i.name}\b/, link_to(i, i.title))
+      s.gsub(/\b#{i.name}\b/, fancy_issue_link_for(i))
     end
   end
 
-  def render template_name, morevars={}
-    ErbHtml.new(@template_dir, template_name, @links, @mapping.merge(morevars)).to_s
-  end
+  ## render a nested ERB
+  alias :render :render_template
 
   def method_missing meth, *a
-    @mapping.member?(meth) ? @mapping[meth] : super
-  end
-
-  def to_s
-    @@erbs[@template_name].result binding
+    @binding.member?(meth) ? @binding[meth] : super
   end
 end
 

data/lib/index.rhtml

@@ -69,10 +69,13 @@
       open_issues = project.group_issues(project.issues_for_component(c).select { |i| i.open? })
     %>
     <li>
-      <%= link_to c, c.name %>:
       <% if open_issues.empty? %>
+        <span class="dimmed">
+        <%= link_to c, c.name %>:
         no open issues.
+        </span>
       <% else %>
+        <%= link_to c, c.name %>:
         <%= open_issues.map { |n,is| n.to_s.pluralize is.size }.join(' and ') %> open.
       <% end %>
     </li>
@@ -80,6 +83,26 @@
   </ul>
 <% end %>
 
+<h2>Recent activity</h2>
+
+<table>
+<% project.issues.map { |i| i.log_events.map { |e| [e, i] } }.
+      flatten_one_level.
+      sort_by { |e| e.first.first }.
+      reverse[0 ... 10].
+      each do |(date, who, what, comment), i| %>
+  <tr>
+    <td><%= date.pretty_date %></td>
+    <td class="issuename">
+      <%= link_issue_names project, h(i.name) %>
+    <%= what %> by <%= who.shortened_email %></td>
+  </tr>
+  <% if comment && comment =~ /\S/ %>
+    <tr><td></td><td><i><%= link_issue_names project, h(comment) %></i></td></tr>
+  <% end %>
+<% end %>
+</table>
+
 <p class="footer">Generated by <a href="http://ditz.rubyforge.org/">ditz</a>.
 
 </body>