ursm-ditz 0.4 → 0.5

data/contrib/completion/ditz.bash

@@ -6,16 +6,32 @@
 
 _ditz() 
 {
-    cur=${COMP_WORDS[COMP_CWORD]}
+    local 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 ) )
+	# no command yet, show all commands
+	COMPREPLY=( $( compgen -W "$(ditz --commands)" -- $cur ) )
+
+    else
+	unset COMP_WORDS[COMP_CWORD]  # remove last
+	unset COMP_WORDS[0]           # remove first
+	
+	# add options if applicable...
+	local options
+	if [ "${cur:0:1}" = '-' ]; then
+	    # ...but only if at least a dash is given
+	    case "${COMP_WORDS[1]}" in
+		add|add_reference|add_release|assign|close|comment|release|set_component|start|stop|unassign)
+		    options="--comment --no-comment"
+		    ;;
+		edit)
+		    options="--comment --no-comment --silent"
+		    ;;
+	    esac
+	fi
+	
+	# let ditz parse the commandline and print available completions, then append the options form above
+	COMPREPLY=( $( compgen -W "$(ditz "${COMP_WORDS[@]}" '<options>' 2>/dev/null) $options" -- $cur ) )
     fi 
 }
 

data/lib/ditz.rb

@@ -1,9 +1,13 @@
+require 'pathname'
+
 module Ditz
 
-VERSION = "0.4"
+VERSION = "0.5"
+attr_accessor :verbose
+module_function :verbose, :verbose=
 
 def debug s
-  puts "# #{s}" if $opts[:verbose]
+  puts "# #{s}" if $verbose || Ditz::verbose
 end
 module_function :debug
 
@@ -46,11 +50,52 @@ def find_ditz_file fn
   File.expand_path File.join(dir, fn)
 end
 
-module_function :home_dir, :find_dir_containing, :find_ditz_file
+def load_plugins fn
+  Ditz::debug "loading plugins from #{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
 
-require 'model-objects'
-require 'operator'
-require 'views'
-require 'hook'
+# Git-style automatic pagination of all output.
+# Call run_pa	ger from any opperator needing pagination.
+# Yoinked from http://nex-3.com/posts/73-git-style-automatic-paging-in-ruby#comments
+def run_pager
+  return if PLATFORM =~ /win32/
+  return unless STDOUT.tty?
+
+  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
+
+  ENV['LESS'] ||= 'FSRX'  # Don't page if the input is short enough, unless
+                          # the user already have a LESS variable.
+
+  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/lib/ditz/file-storage.rb

@@ -0,0 +1,54 @@
+module Ditz
+
+## stores ditz database on disk
+class FileStorage
+  PROJECT_FN = "project.yaml"
+  ISSUE_FN_GLOB = "issue-*.yaml"
+
+  def ISSUE_TO_FN i; "issue-#{i.id}.yaml" end
+
+  def initialize base_dir
+    @base_dir = base_dir
+    @project_fn = File.join @base_dir, PROJECT_FN
+  end
+
+  def load
+    Ditz::debug "loading project from #{@project_fn}"
+    project = Project.from @project_fn
+
+    fn = File.join @base_dir, ISSUE_FN_GLOB
+    Ditz::debug "loading issues from #{fn}"
+    project.issues = Dir[fn].map { |fn| Issue.from fn }
+    Ditz::debug "found #{project.issues.size} issues"
+
+    project.issues.each { |i| i.project = project }
+    project
+  end
+
+  def save project
+    dirty = false
+    dirty = project.each_modelobject { |o| break true if o.changed? }
+    if dirty
+      Ditz::debug "project is dirty, saving #{@project_fn}"
+      project.save! @project_fn
+    end
+
+    changed_issues = project.issues.select { |i| i.changed? }
+    changed_issues.each do |i|
+      fn = filename_for_issue i
+      Ditz::debug "issue #{i.name} is dirty, saving #{fn}"
+      i.save! fn
+    end
+
+    project.deleted_issues.each do |i|
+      fn = filename_for_issue i
+      Ditz::debug "issue #{i.name} has been deleted, deleting #{fn}"
+      FileUtils.rm fn
+    end
+  end
+
+  def filename_for_issue i; File.join @base_dir, ISSUE_TO_FN(i) end
+  def filename_for_project; @project_fn end
+end
+
+end

data/lib/{hook.rb → ditz/hook.rb}

@@ -57,7 +57,7 @@ EOS
         files = dirs.map { |d| Dir[File.join(d, "*.rb")] }.flatten
         files.each do |fn|
           Ditz::debug "loading hook file #{fn}"
-          load fn
+          require File.expand_path(fn)
         end
       end
 

data/lib/{html.rb → ditz/html.rb}

@@ -48,16 +48,54 @@ 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>"
+
+  def issue_status_img_for i, opts={}
+    fn, title = if i.closed?
+      case i.disposition
+      when :fixed; ["green-check.png", "fixed"]
+      when :wontfix; ["red-check.png", "won't fix"]
+      when :reorg; ["blue-check.png", "reorganized"]
+      end
+    elsif i.in_progress?
+      ["green-bar.png", "in progress"]
+    elsif i.paused?
+      ["yellow-bar.png", "paused"]
+    end
+
+    return "" unless fn
+
+    args = {:src => fn, :alt => title, :title => title}
+    args[:class] = opts[:class] if opts[:class]
+
+    "<img " + args.map { |k, v| "#{k}=#{v.inspect}" }.join(" ") + "/>"
   end
 
-  def link_issue_names project, s
+  def issue_link_for i, opts={}
+    link = if opts[:inline]
+      "<span class=\"inline-issue-link\">" + link_to(i, "issue <span class=\"id\">#{i.id[0,8]}</span>: #{i.title}") + "</span>"
+    else
+      link_to i, i.title
+    end
+    link = link + " " + issue_status_img_for(i, :class => "inline-status-image") if opts[:status_image]
+    link
+  end
+
+  def link_issue_names project, s, opts={}
     project.issues.inject(s) do |s, i|
-      s.gsub(/\b#{i.name}\b/, fancy_issue_link_for(i))
+      s.gsub(/\b#{i.name}\b/, issue_link_for(i, {:inline => true, :status_image => true}.merge(opts)))
     end
   end
 
+  def progress_meter p, size=50
+    done = (p * size).to_i
+    undone = [size - done, 0].max
+    "<span class='progress-meter'><span class='progress-meter-done'>" +
+      ("&nbsp;" * done) +
+      "</span><span class='progress-meter-undone'>" +
+      ("&nbsp;" * undone) +
+      "</span></span>"
+  end
+
   ## render a nested ERB
   alias :render :render_template
 

data/lib/{lowline.rb → ditz/lowline.rb}

@@ -1,5 +1,5 @@
 require 'tempfile'
-require "util"
+require "ditz/util"
 
 class Numeric
   def to_pretty_s
@@ -57,7 +57,9 @@ module Lowline
     yield f
     f.close
 
-    editor = ENV["EDITOR"] || "/usr/bin/vi"
+    editor = ENV["EDITOR"]
+    editor ||= "/usr/bin/sensible-editor" if File.exist?("/usr/bin/sensible-editor")
+    editor ||= "/usr/bin/vi"
     cmd = "#{editor} #{f.path.inspect}"
 
     mtime = File.mtime f.path
@@ -98,11 +100,10 @@ module Lowline
 
   def ask_via_editor q, default=nil
     fn = run_editor do |f|
+      f.puts(default || "")
       f.puts q.gsub(/^/, "## ")
       f.puts "##"
-      f.puts "## Enter your text below. Lines starting with a '#' will be ignored."
-      f.puts
-      f.puts default if default
+      f.puts "## Enter your text above. Lines starting with a '#' will be ignored."
     end
     return unless fn
     IO.read(fn).gsub(/^#.*$/, "").multistrip
@@ -139,6 +140,15 @@ module Lowline
     ans.multistrip
   end
 
+  def can_run_editor?
+    !ENV["EDITOR"].nil? || File.exist?("/usr/bin/sensible-editor") || File.exist?("/usr/bin/vi")
+  end
+
+  def ask_multiline_smartly q
+    can_run_editor? ? ask_via_editor(q) : ask_multiline(q)
+  end
+
+
   def ask_yon q
     while true
       print "#{q} (y/n): "
@@ -175,8 +185,15 @@ module Lowline
     stuff
   end
 
-  def ask_for_selection stuff, name, to_string=:to_s
-    puts "Choose a #{name}:"
+  def ask_for_selection stuff, name, to_string=:to_s, many=false
+    if many
+      return [] if stuff.empty?
+      name = name.pluralize(2, false)
+      puts "Choose one or more #{name} (comma separated list):"
+    else
+      return nil if stuff.empty?
+      puts "Choose a #{name}:"
+    end
     stuff.each_with_index do |c, i|
       pretty = case to_string
       when block_given? && to_string # heh
@@ -191,12 +208,15 @@ module Lowline
       puts "  #{i + 1}) #{pretty}"
     end
 
-    j = while true
-      i = ask "#{name.capitalize} (1--#{stuff.size})"
-      break i.to_i if i && (1 .. stuff.size).member?(i.to_i)
+    js = while true
+      is = ask "#{name.capitalize} (1--#{stuff.size})"
+      next unless is
+      is = is.strip.split(/\s*,\s*/).map { |i| i.to_i }
+      break is if is.all? { |i| (1 .. stuff.size).member?(i) }
     end
 
-    stuff[j - 1]
+    ss = js.map { |j| stuff[j - 1] }
+    (many)? ss : ss.first
   end
 end
 

data/lib/{model-objects.rb → ditz/model-objects.rb}

@@ -1,4 +1,4 @@
-require 'model'
+require 'ditz/model'
 
 module Ditz
 
@@ -36,17 +36,37 @@ end
 class Project < ModelObject
   class Error < StandardError; end
 
-  attr_accessor :pathname
-
-  field :name, :default_generator => lambda { File.basename(Dir.pwd) }
+  field :name, :prompt => "Project name", :default_generator => lambda { File.basename(Dir.pwd) }
   field :version, :default => Ditz::VERSION, :ask => false
-  field :components, :multi => true, :generator => :get_components
+  field :components, :multi => true, :interactive_generator => :get_components
   field :releases, :multi => true, :ask => false
 
+  attr_accessor :pathname
+
   ## issues are not model fields proper, so we build up their interface here.
-  attr_accessor :issues
-  def add_issue issue; added_issues << issue; issues << issue end
-  def drop_issue issue; deleted_issues << issue if issues.delete issue end
+  attr_reader :issues
+  def issues= issues
+    @issues = issues
+    @issues.each { |i| i.project = self }
+    assign_issue_names!
+    issues
+  end
+
+  def add_issue issue
+    added_issues << issue
+    issues << issue
+    issue.project = self
+    assign_issue_names!
+    issue
+  end
+
+  def drop_issue issue
+    if issues.delete issue
+      deleted_issues << issue
+      assign_issue_names!
+    end
+  end
+
   def added_issues; @added_issues ||= [] end
   def deleted_issues; @deleted_issues ||= [] end
 
@@ -63,7 +83,7 @@ EOS
 
   def issues_for ident
     by_name = issues.find { |i| i.name == ident }
-    by_name ? [by_name] : issues.select { |i| i.id =~ /^#{ident}/ }
+    by_name ? [by_name] : issues.select { |i| i.id =~ /^#{Regexp::escape ident}/ }
   end
 
   def component_for component_name
@@ -107,6 +127,12 @@ EOS
       raise Error, "more than one release named #{dup.inspect}"
     end
   end
+
+  def self.from *a
+    p = super(*a)
+    p.validate!
+    p
+  end
 end
 
 class Issue < ModelObject
@@ -114,9 +140,9 @@ class Issue < ModelObject
 
   field :title
   field :desc, :prompt => "Description", :multiline => true
-  field :type, :generator => :get_type
-  field :component, :generator => :get_component
-  field :release, :generator => :get_release
+  field :type, :interactive_generator => :get_type
+  field :component, :interactive_generator => :get_component
+  field :release, :interactive_generator => :get_release, :nil_ok => true
   field :reporter, :prompt => "Issue creator", :default_generator => lambda { |config, proj| config.user }
   field :status, :ask => false, :default => :unstarted
   field :disposition, :ask => false
@@ -194,6 +220,7 @@ class Issue < ModelObject
   def feature?; type == :feature end
   def unassigned?; release.nil? end
   def assigned?; !unassigned? end
+  def paused?; status == :paused end
 
   def start_work who, comment; change_status :in_progress, who, comment end
   def stop_work who, comment
@@ -216,27 +243,29 @@ class Issue < ModelObject
   end
   private :change_status
 
-  def change hash, who, comment
+  def change hash, who, comment, silent
     what = []
     if title != hash[:title]
-      what << "changed title"
+      what << "title"
       self.title = hash[:title]
     end
 
     if desc != hash[:description]
-      what << "changed description"
+      what << "description"
       self.desc = hash[:description]
     end
 
     if reporter != hash[:reporter]
-      what << "changed reporter"
+      what << "reporter"
       self.reporter = hash[:reporter]
     end
 
-    unless what.empty?
-      log what.join(", "), who, comment
+    unless what.empty? || silent
+      log "edited " + what.join(", "), who, comment
       true
     end
+
+    !what.empty?
   end
 
   def assign_to_release release, who, comment
@@ -289,15 +318,18 @@ end
 class Config < ModelObject
   field :name, :prompt => "Your name", :default_generator => :get_default_name
   field :email, :prompt => "Your email address", :default_generator => :get_default_email
-  field :issue_dir, :ask => false, :default => "bugs"
+  field :issue_dir, :prompt => "Directory to store issues state in", :default => ".ditz"
 
   def user; "#{name} <#{email}>" end
 
   def get_default_name
     require 'etc'
 
-    name = Etc.getpwnam(ENV["USER"])
-    name = name ? name.gecos.split(/,/).first : ""
+    name = if ENV["USER"]
+      pwent = Etc.getpwnam ENV["USER"]
+      pwent ? pwent.gecos.split(/,/).first : nil
+    end
+    name || "Ditz User"
   end
 
   def get_default_email