ohac-ditz 0.5.1

data/lib/ditz/lowline.rb

@@ -0,0 +1,244 @@
+require 'tempfile'
+require "ditz/util"
+
+class Numeric
+  def to_pretty_s
+    %w(zero one two three four five six seven eight nine ten)[self] || to_s
+  end
+end
+
+class String
+  def dcfirst; self[0..0].downcase + self[1..-1] end
+  def blank?; self =~ /\A\s*\z/ end
+  def underline; self + "\n" + ("-" * self.length) end
+  def pluralize n, b=true
+    s = (n == 1 ? self : (self == 'bugfix' ? 'bugfixes' : self + "s")) # oh yeah
+    b ? n.to_pretty_s + " " + s : s
+  end
+  def shortened_email; self =~ /<?(\S+?)@.+/ ? $1 : self end
+  def multistrip; strip.gsub(/\n\n+/, "\n\n") end
+end
+
+class Array
+  def listify prefix=""
+    return "" if empty?
+    "\n" +
+      map_with_index { |x, i| x.to_s.gsub(/^/, "#{prefix}#{i + 1}. ") }.
+        join("\n")
+  end
+end
+
+class Time
+  def pretty; strftime "%c" end
+  def pretty_date; strftime "%Y-%m-%d" end
+  def ago
+    diff = (Time.now - self).to_i.abs
+    if diff < 60
+      "second".pluralize diff
+    elsif diff < 60*60*3
+      "minute".pluralize(diff / 60)
+    elsif diff < 60*60*24*3
+      "hour".pluralize(diff / (60*60))
+    elsif diff < 60*60*24*7*2
+      "day".pluralize(diff / (60*60*24))
+    elsif diff < 60*60*24*7*8
+      "week".pluralize(diff / (60*60*24*7))
+    elsif diff < 60*60*24*7*52
+      "month".pluralize(diff / (60*60*24*7*4))
+    else
+      "year".pluralize(diff / (60*60*24*7*52))
+    end
+  end
+end
+
+module Lowline
+  ## UI configuration
+  @use_editor_if_possible = true
+  attr_accessor :use_editor_if_possible
+
+  class Error < StandardError; end
+
+  def editor
+    @editor ||=
+      if ENV["EDITOR"] && !ENV["EDITOR"].empty?
+        ENV["EDITOR"]
+      else
+        %w(/usr/bin/sensible-editor /usr/bin/vi).find { |e| File.exist?(e) }
+      end
+  end
+
+  def run_editor
+    raise Error, "no editor" unless editor
+
+    f = Tempfile.new "ditz"
+    yield f
+    f.close
+
+    cmd = "#{editor} #{f.path.inspect}"
+
+    mtime = File.mtime f.path
+    system cmd or raise Error, "cannot execute command: #{cmd.inspect}"
+
+    File.mtime(f.path) == mtime ? nil : f.path
+  end
+
+  def ask q, opts={}
+    default_s = case opts[:default]
+      when nil; nil
+      when ""; " (enter for none)"
+      else; " (enter for #{opts[:default].to_s})"
+    end
+
+    tail = case q
+      when /[:?]$/; " "
+      when /[:?]\s+$/; ""
+      else; ": "
+    end
+
+    while true
+      prompt = [q, default_s, tail].compact.join
+      if Ditz::has_readline?
+        ans = Readline::readline(prompt)
+      else
+        print prompt
+        ans = STDIN.gets.strip
+      end
+      if opts[:default]
+        ans = opts[:default] if ans.blank?
+      else
+        next if ans.blank? && !opts[:empty_ok]
+      end
+      break ans unless (opts[:restrict] && ans !~ opts[:restrict])
+    end
+  end
+
+  def ask_via_editor q, opts={}
+    default = opts[:default]
+    comments = opts[:comments]
+    fn = run_editor do |f|
+      if default
+        f.puts default
+      end
+      f.puts
+      f.puts q.gsub(/^/, "## ")
+      f.puts "##"
+      f.puts "## Enter your text above. Lines starting with a '#' will be ignored."
+      if comments
+        f.puts "##"
+        f.puts comments.gsub(/^/, "## ")
+      end
+    end
+    return unless fn
+    IO.read(fn).gsub(/^#.*$/, "").multistrip
+  end
+
+  def ask_multiline q
+    puts "#{q} (ctrl-d, ., or /stop to stop, /edit to edit, /reset to reset):"
+    ans = ""
+    while true
+      if Ditz::has_readline?
+        line = Readline::readline('> ')
+      else
+        (line = STDIN.gets) && line.strip!
+      end
+      if line
+        if Ditz::has_readline?
+          Readline::HISTORY.push(line)
+        end
+        case line
+        when /^\.$/, "/stop"
+          break
+        when "/reset"
+          return ask_multiline(q)
+        when "/edit"
+          return ask_via_editor(q, :default => ans)
+        else
+          ans << line + "\n"
+        end
+      else
+        puts
+        break
+      end
+    end
+    ans.multistrip
+  end
+
+  def ask_multiline_or_editor q, opts={}
+    if Lowline.use_editor_if_possible && editor
+      ask_via_editor q, :comments => opts[:comments]
+    else
+      ask_multiline q
+    end
+  end
+
+  def ask_yon q
+    while true
+      print "#{q} (y/n): "
+      a = STDIN.gets.strip
+      break a if a =~ /^[yn]$/i
+    end =~ /y/i
+  end
+
+  def ask_for_many plural_name, name=nil
+    name ||= plural_name.gsub(/s$/, "")
+    stuff = []
+
+    while true
+      puts
+      puts "Current #{plural_name}:"
+      if stuff.empty?
+        puts "None!"
+      else
+        stuff.each_with_index { |c, i| puts "  #{i + 1}) #{c}" }
+      end
+      puts
+      ans = ask "(A)dd #{name}, (r)emove #{name}, or (d)one"
+      case ans
+      when "a", "A"
+        ans = ask "#{name.capitalize} name", ""
+        stuff << ans unless ans =~ /^\s*$/
+      when "r", "R"
+        ans = ask "Remove which #{name}? (1--#{stuff.size})"
+        stuff.delete_at(ans.to_i - 1) if ans
+      when "d", "D"
+        break
+      end
+    end
+    stuff
+  end
+
+  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
+        yield c
+      when Symbol
+        c.send to_string
+      when Proc
+        to_string.call c
+      else
+        raise ArgumentError, "unknown to_string argument type; expecting Proc or Symbol"
+      end
+      puts "  #{i + 1}) #{pretty}"
+    end
+
+    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
+
+    ss = js.map { |j| stuff[j - 1] }
+    (many)? ss : ss.first
+  end
+end
+

data/lib/ditz/model-objects.rb

@@ -0,0 +1,379 @@
+require 'ditz/model'
+
+module Ditz
+
+class Component < ModelObject
+  field :name
+  def name_prefix; name.gsub(/\s+/, "-").downcase end
+end
+
+class Release < ModelObject
+  class Error < StandardError; end
+
+  field :name
+  field :status, :default => :unreleased, :ask => false
+  field :release_time, :ask => false
+  changes_are_logged
+
+  def released?; self.status == :released end
+  def unreleased?; !released? end
+
+  def issues_from project; project.issues.select { |i| i.release == name } end
+
+  def release! project, who, comment
+    raise Error, "already released" if released?
+
+    issues = issues_from project
+    bad = issues.find { |i| i.open? }
+    raise Error, "open issue #{bad.name} must be reassigned" if bad
+
+    self.release_time = Time.now
+    self.status = :released
+    log "released", who, comment
+  end
+end
+
+class Project < ModelObject
+  class Error < StandardError; end
+
+  field :name, :prompt => "Project name", :default_generator => lambda { File.basename(Dir.pwd) }
+  field :version, :default => Ditz::VERSION, :ask => false
+  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_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
+
+  alias :__old_drop_release :drop_release
+  def drop_release release
+    raise Error, "only can drop releases without issues" unless issues_for_release(release).empty?
+    __old_drop_release release
+  end
+
+  def added_issues; @added_issues ||= [] end
+  def deleted_issues; @deleted_issues ||= [] end
+
+  def get_components
+    puts <<EOS
+Issues can be tracked across the project as a whole, or the project can be
+split into components, and issues tracked separately for each component.
+EOS
+    use_components = ask_yon "Track issues separately for different components?"
+    comp_names = use_components ? ask_for_many("components") : []
+
+    ([name] + comp_names).uniq.map { |n| Component.create_interactively :with => { :name => n } }
+  end
+
+  def issues_for ident
+    by_name = issues.find { |i| i.name == ident }
+    by_name ? [by_name] : issues.select { |i| i.id =~ /^#{Regexp::escape ident}/ }
+  end
+
+  def component_for component_name
+    components.find { |i| i.name == component_name }
+  end
+
+  def release_for release_name
+    releases.find { |i| i.name == release_name }
+  end
+
+  def unreleased_releases; releases.select { |r| r.unreleased? } end
+
+  def issues_for_release release
+    release == :unassigned ? unassigned_issues : issues.select { |i| i.release == release.name }
+  end
+
+  def issues_for_component component
+    issues.select { |i| i.component == component.name }
+  end
+
+  def unassigned_issues
+    issues.select { |i| i.release.nil? }
+  end
+
+  def group_issues these_issues=issues
+    these_issues.group_by { |i| i.type }.sort_by { |(t,g)| Issue::TYPE_ORDER[t] }
+  end
+
+  def assign_issue_names!
+    prefixes = components.map { |c| [c.name, c.name.gsub(/^\s+/, "-").downcase] }.to_h
+    ids = components.map { |c| [c.name, 0] }.to_h
+    issues.sort_by { |i| i.creation_time }.each do |i|
+      i.name = components.length > 1 ? "#{prefixes[i.component]}-#{ids[i.component] += 1}" : "##{ids[i.component] += 1}"
+    end
+  end
+
+  def validate! whence, context
+    config, project = context
+    if(dup = components.map { |c| c.name }.first_duplicate)
+      raise Error, "more than one component named #{dup.inspect}: #{components.inspect}"
+    elsif(dup = releases.map { |r| r.name }.first_duplicate)
+      raise Error, "more than one release named #{dup.inspect}"
+    end
+  end
+end
+
+class Issue < ModelObject
+  class Error < StandardError; end
+
+  field :title
+  field :desc, :prompt => "Description", :multiline => true
+  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
+  field :creation_time, :ask => false, :generator => Proc.new { Time.now }
+  field :references, :ask => false, :multi => true
+  field :id, :ask => false, :generator => :make_id
+  changes_are_logged
+
+  ## we only have to check beyond what ModelObject.create already checks
+  def validate! whence, context
+    config, project = context
+    if whence == :create
+      raise ModelError, "title is empty" unless title =~ /\S/
+      raise ModelError, "invalid type #{type.inspect}" unless TYPES.member?(type)
+      raise ModelError, "invalid status #{status.inspect}" unless STATUSES.member?(status)
+      raise ModelError, "#{type}s can't be added to already-released releases" if release && [:feature, :task].include?(type) && project.release_for(release).released?
+    end
+  end
+
+  attr_accessor :name, :pathname, :project
+
+  ## these are the fields we interpolate issue names on
+  #INTERPOLATED_FIELDS = [:title, :desc, :log_events]
+  INTERPOLATED_FIELDS = []
+
+  STATUS_SORT_ORDER = { :unstarted => 2, :paused => 1, :in_progress => 0, :closed => 3 }
+  STATUS_WIDGET = { :unstarted => "_", :in_progress => ">", :paused => "=", :closed => "x" }
+  DISPOSITIONS = [ :fixed, :wontfix, :reorg ]
+  TYPES = [ :bugfix, :feature, :task ]
+  TYPE_ORDER = { :bugfix => 0, :feature => 1, :task => 2 }
+  TYPE_LETTER = { 'b' => :bugfix, 'f' => :feature, 't' => :task }
+  STATUSES = STATUS_WIDGET.keys
+
+  STATUS_STRINGS = { :in_progress => "in progress", :wontfix => "won't fix" }
+  DISPOSITION_STRINGS = { :wontfix => "won't fix", :reorg => "reorganized" }
+
+  def serialized_form_of field, value
+    return super unless INTERPOLATED_FIELDS.member? field
+
+    if field == :log_events
+      value.map do |time, who, what, comment|
+        comment = @project.issues.inject(comment || '') do |s, i|
+          s.gsub(/\b#{i.name}\b/, "{issue #{i.id}}")
+        end
+        [time, who, what, comment]
+      end
+    else
+      @project.issues.inject(value || '') do |s, i|
+        s.gsub(/\b#{i.name}\b/, "{issue #{i.id}}")
+      end
+    end
+  end
+
+  def deserialized_form_of field, value
+    return super unless INTERPOLATED_FIELDS.member? field
+
+    if field == :log_events
+      value.map do |time, who, what, comment|
+        comment = @project.issues.inject(comment) do |s, i|
+          s.gsub(/\{issue #{i.id}\}/, i.name)
+        end.gsub(/\{issue \w+\}/, "[unknown issue]")
+        [time, who, what, comment]
+      end
+    else
+      @project.issues.inject(value) do |s, i|
+        s.gsub(/\{issue #{i.id}\}/, i.name)
+      end.gsub(/\{issue \w+\}/, "[unknown issue]")
+    end
+  end
+
+  ## make a unique id
+  def make_id config, project
+    if RUBY_VERSION >= '1.9.0'
+      Digest::SHA1.hexdigest [Time.now, rand, creation_time, reporter, title, desc].join("\n")
+    else
+      SHA1.hexdigest [Time.now, rand, creation_time, reporter, title, desc].join("\n")
+    end
+  end
+
+  def sort_order; [STATUS_SORT_ORDER[status], creation_time] end
+  def status_widget; STATUS_WIDGET[status] end
+
+  def status_string; STATUS_STRINGS[status] || status.to_s end
+  def disposition_string; DISPOSITION_STRINGS[disposition] || disposition.to_s end
+
+  def closed?; status == :closed end
+  def open?; !closed? end
+  def in_progress?; status == :in_progress end
+  def unstarted?; !in_progress? end
+  def bug?; type == :bugfix end
+  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
+    raise Error, "unstarted" unless self.status == :in_progress
+    change_status :paused, who, comment
+  end
+
+  def close disp, who, comment
+    raise Error, "unknown disposition #{disp}" unless DISPOSITIONS.member? disp
+    log "closed with disposition #{disp}", who, comment
+    self.status = :closed
+    self.disposition = disp
+  end
+
+  def change_status to, who, comment
+    raise Error, "unknown status #{to}" unless STATUSES.member? to
+    raise Error, "already marked as #{to}" if status == to
+    log "changed status from #{status} to #{to}", who, comment
+    self.status = to
+  end
+  private :change_status
+
+  def change hash, who, comment, silent
+    what = []
+    if title != hash[:title]
+      what << "title"
+      self.title = hash[:title]
+    end
+
+    if desc != hash[:description]
+      what << "description"
+      self.desc = hash[:description]
+    end
+
+    if reporter != hash[:reporter]
+      what << "reporter"
+      self.reporter = hash[:reporter]
+    end
+
+    unless what.empty? || silent
+      log "edited " + what.join(", "), who, comment
+      true
+    end
+
+    !what.empty?
+  end
+
+  def assign_to_release release, who, comment
+    log "assigned to release #{release.name} from #{self.release || 'unassigned'}", who, comment
+    self.release = release.name
+  end
+
+  def assign_to_component component, who, comment
+    log "assigned to component #{component.name} from #{self.component}", who, comment
+    self.component = component.name
+  end
+
+  def unassign who, comment
+    raise Error, "not assigned to a release" unless release
+    log "unassigned from release #{release}", who, comment
+    self.release = nil
+  end
+
+  def get_type config, project
+    type = ask "Is this a (b)ugfix, a (f)eature, or a (t)ask?", :restrict => /^[bft]$/
+    TYPE_LETTER[type]
+  end
+
+  def get_component config, project
+    if project.components.size == 1
+      project.components.first
+    else
+      ask_for_selection project.components, "component", :name
+    end.name
+  end
+
+  def get_release config, project
+    releases = project.releases.select { |r| r.unreleased? }
+    if !releases.empty? && ask_yon("Assign to a release now?")
+      if releases.size == 1
+        r = releases.first
+        puts "Assigning to release #{r.name}."
+        r
+      else
+        ask_for_selection releases, "release", :name
+      end.name
+    end
+  end
+
+  def get_reporter config, project
+    reporter = ask "Creator", :default => config.user
+  end
+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, :prompt => "Directory to store issues state in", :default => ".ditz"
+  field :use_editor_if_possible, :interactive_generator => :get_use_editor
+  field :paginate, :interactive_generator => :get_paginate
+
+  def user; "#{name} <#{email}>" end
+
+  def validate! whence, context
+    self.use_editor_if_possible = true if self.use_editor_if_possible.nil?
+  end
+
+  def get_paginate
+    page = ask "Paginate output (always/never/auto)?", :restrict => /^(always|never|auto)$/i
+    page.downcase
+  end
+
+  def get_use_editor
+    yon = ask "Use your text editor for multi-line input when possible (y/n)?", :restrict => /^(y|yes|n|no)$/i
+    yon =~ /y/ ? true : false
+  end
+
+  def get_default_name
+    require 'etc'
+
+    name = if ENV["USER"]
+      pwent = Etc.getpwnam ENV["USER"]
+      pwent ? pwent.gecos.split(/,/).first : nil
+    end
+    name || "Ditz User"
+  end
+
+  def get_default_email
+    require 'socket'
+    email = (ENV["USER"] || "") + "@" +
+      begin
+        Socket.gethostbyname(Socket.gethostname).first
+      rescue SocketError
+        Socket.gethostname
+      end
+  end
+end
+
+end