ohac-ditz 0.5.1

data/lib/ditz/views.rb

@@ -0,0 +1,191 @@
+require "ditz/view"
+require "ditz/html"
+require 'time'
+
+module Ditz
+
+class ScreenView < View
+  def initialize project, config, device=$stdout
+    @device = device
+    @config = config
+  end
+
+  def format_log_events events
+    return "none" if events.empty?
+    events.reverse.map do |time, who, what, comment|
+      "- #{what} (#{who.shortened_email}, #{time.ago} ago)" +
+      (comment =~ /\S/ ? "\n" + comment.gsub(/^/, "  > ") : "")
+    end.join("\n")
+  end
+  private :format_log_events
+
+  def render_issue issue
+    status = case issue.status
+    when :closed
+      "#{issue.status_string}: #{issue.disposition_string}"
+    else
+      issue.status_string
+    end
+    desc = if issue.desc.size < 80 - "Description: ".length
+      issue.desc
+    else
+      "\n" + issue.desc.gsub(/^/, "  ") + "\n"
+    end
+    run_pager @config
+    @device.puts <<EOS
+#{"Issue #{issue.name}".underline}
+      Title: #{issue.title}
+Description: #{desc}
+       Type: #{issue.type}
+     Status: #{status}
+    Creator: #{issue.reporter}
+        Age: #{issue.creation_time.ago}
+    Release: #{issue.release}
+ References: #{issue.references.listify "  "}
+ Identifier: #{issue.id}
+EOS
+
+    self.class.view_additions_for(:issue_summary).each { |b| @device.print(b[issue, @config] || next) }
+    puts
+    self.class.view_additions_for(:issue_details).each { |b| @device.print(b[issue, @config] || next)  }
+
+    @device.puts <<EOS
+Event log:
+#{format_log_events issue.log_events}
+EOS
+  end
+end
+
+class HtmlView < View
+  SUPPORT_FILES = %w(style.css blue-check.png red-check.png green-check.png green-bar.png yellow-bar.png)
+
+  def initialize project, config, dir
+    @project = project
+    @config = config
+    @dir = dir
+    @template_dir = File.dirname Ditz::find_ditz_file("../share/ditz/index.rhtml")
+  end
+
+  def render_all
+    Dir.mkdir @dir unless File.exists? @dir
+    SUPPORT_FILES.each { |f| FileUtils.cp File.join(@template_dir, f), @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}..."
+
+      extra_summary = self.class.view_additions_for(:issue_summary).map { |b| b[issue, @config] }.compact
+      extra_details = self.class.view_additions_for(:issue_details).map { |b| b[issue, @config] }.compact
+
+      erb = ErbHtml.new(@template_dir, links, :issue => issue,
+        :release => (issue.release ? @project.release_for(issue.release) : nil),
+        :component => @project.component_for(issue.component),
+        :project => @project)
+
+      extra_summary_html = extra_summary.map { |string, extra_binding| erb.render_string string, extra_binding }.join
+      extra_details_html = extra_details.map { |string, extra_binding| erb.render_string string, extra_binding }.join
+
+      File.open(fn, "w") { |f| f.puts erb.render_template("issue", { :extra_summary_html => extra_summary_html, :extra_details_html => extra_details_html }) }
+    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, links, :release => r,
+          :issues => @project.issues_for_release(r), :project => @project).
+          render_template("release")
+      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, links, :component => c,
+          :issues => @project.issues_for_component(c), :project => @project).
+          render_template("component")
+      end
+    end
+
+    fn = File.join @dir, links["unassigned"]
+    #puts "Generating #{fn}..."
+    File.open(fn, "w") do |f|
+      f.puts ErbHtml.new(@template_dir, links,
+        :issues => @project.unassigned_issues, :project => @project).
+        render_template("unassigned")
+    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, links, :project => @project,
+        :past_releases => past_rels, :upcoming_releases => upcoming_rels,
+        :components => @project.components).
+        render_template("index")
+    end
+    puts "Local generated URL: file://#{File.expand_path(fn)}"
+  end
+end
+
+class BaetleView < View
+  def initialize project, config, dir
+    @project = project
+    @config = config
+    @dir = dir
+  end
+  
+  def render_all
+    Dir.mkdir @dir unless File.exists? @dir
+    fn = File.join @dir, "baetle.rdf"
+    File.open(fn, "w") { |f| 
+        f.puts <<EOS
+@prefix baetle: <http://xmlns.com/baetle/#> .
+@prefix wf: <http://www.w3.org/2005/01/wf/flow#> .
+@prefix sioc: <http://rdfs.org/sioc/ns#> .
+@prefix dc: <http://purl.org/dc/elements/1.1/> .
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#>.
+@prefix : <#> .
+
+EOS
+        @project.issues.each do |issue|
+          # id
+          f.print ":#{issue.id} a "
+          f.print case issue.type 
+                when :bugfix, :bug; "baetle:Bug"
+                when :feature; "baetle:Enhancement"
+                when :task; "wf:Task"
+                end
+          f.puts " ;"
+          # title
+          f.puts "    baetle:title #{issue.title.dump} ;"
+          # summary
+          f.puts "    baetle:description #{issue.desc.dump} ; "
+          # state
+          f.print "    wf:state baetle:" 
+          f.print case issue.status
+                  when :unstarted; "New"
+                  when :in_progress; "Started"
+                  when :closed; "Closed"
+                  when :paused; "Later"
+                  end
+          f.puts " ;"
+          # created
+          f.puts "    baetle:created #{issue.creation_time.xmlschema.dump}^^xsd:dateTime ."
+          f.puts
+        end
+      }
+    puts "Local generated URL: file://#{File.expand_path(fn)}"
+  end
+end
+
+end

data/lib/ditz.rb

@@ -0,0 +1,110 @@
+require 'pathname'
+require 'trollop'
+
+module Ditz
+
+VERSION = "0.5"
+attr_accessor :verbose
+module_function :verbose, :verbose=
+
+def debug s
+  puts "# #{s}" if $verbose || Ditz::verbose
+end
+module_function :debug
+
+def self.has_readline?
+  @has_readline
+end
+
+def self.has_readline= val
+  @has_readline = val
+end
+
+begin
+  Ditz::has_readline = false
+  require 'readline'
+  Ditz::has_readline = true
+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 LoadError, "can't find #{fn} in any load path" unless dir
+  File.expand_path File.join(dir, fn)
+end
+
+def load_plugins fn
+  Ditz::debug "loading plugins from #{fn}"
+  return unless File.exist?(fn)
+  plugins = YAML::load_file fn
+  plugins.each do |p|
+    fn = Ditz::find_ditz_file "ditz/plugins/#{p}.rb"
+    Ditz::debug "loading plugin #{p.inspect} from #{fn}"
+    require File.expand_path(fn)
+  end
+  plugins
+end
+
+module_function :home_dir, :find_dir_containing, :find_ditz_file, :load_plugins
+end
+
+# Git-style automatic pagination of all output.
+# Call run_pager from any opperator needing pagination.
+# Yoinked from http://nex-3.com/posts/73-git-style-automatic-paging-in-ruby#comments
+def run_pager config
+  if RUBY_VERSION >= '1.9.0'
+     return if RUBY_PLATFORM =~ /win32/
+  else
+     return if PLATFORM =~ /win32/
+  end
+  return unless STDOUT.tty?
+  return if config.paginate == 'never'
+
+  read, write = IO.pipe
+
+  unless Kernel.fork # Child process
+    STDOUT.reopen(write)
+    STDERR.reopen(write) if STDERR.tty?
+    read.close
+    write.close
+    return
+  end
+
+  # Parent process, become pager
+  STDIN.reopen(read)
+  read.close
+  write.close
+
+  if config.paginate == 'auto'
+    ENV['LESS'] = '' unless ENV['LESS']  # += doesn't work on undefined var
+    ENV['LESS'] += 'FRX'  # Don't page if the input is short enough
+  end
+
+  Kernel.select [STDIN] # Wait until we have input before we start the pager
+  pager = ENV['PAGER'] || 'less'
+  exec pager rescue exec "/bin/sh", "-c", pager
+end
+
+require 'ditz/model-objects'
+require 'ditz/operator'
+require 'ditz/views'
+require 'ditz/hook'
+require 'ditz/file-storage'

data/man/man1/ditz.1

@@ -0,0 +1,38 @@
+.TH "ditz" "1" "0.5" "" ""
+.SH "NAME"
+ditz \- simple, light\-weight distributed issue tracker
+.SH "SYNOPSIS"
+\fBditz\fR [ \fIoptions\fR ] \fIcommand\fR [ \fIarguments\fR ]
+
+To list all available commands, use \fBditz help\fR.  To get help for a specific command, use \fBditz help
+command\fR.
+.SH "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.
+
+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.
+.SH "AUTHOR"
+ditz was written by William Morgan <\fIwmorgan\-ditz@masanjin.net\fR>.
+
+This manpage was written for the Debian package of ditz by Christian Garbs
+<\fIdebian@cgarbs.de\fR>.
+.SH "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.