bugzyrb 0.1.0 → 0.2.0

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+= bugzyrb 0.2.0,  2010-07-08 1
+* added readline support and history for fields being entered
+* optional project, component, version

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/bugzy.cfg

@@ -3,9 +3,9 @@
 # this overrides defaults inside main program
 
 $prompt_assigned_to = false
-$default_assigned_to = ENV['logname']
+$default_assigned_to = ENV['LOGNAME']
 $send_email = true
-$email_to = ENV['logname']
+$email_to = ENV['LOGNAME']
 #$app_dir = 
 
 $default_type = "bug"
@@ -13,6 +13,8 @@ $default_severity = "normal"
 $default_status = "open"
 $default_priority = "P3"
 
+# prompt variables indicate whether you wish to be prompted during add operation
+# if false, then default value will be used
 $prompt_type = true
 $prompt_severity = false
 $prompt_status = false

data/bugzyrb.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bugzyrb}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rahul Kumar"]
-  s.date = %q{2010-07-07}
+  s.date = %q{2010-07-08}
   s.default_executable = %q{bugzyrb}
   s.description = %q{basic, easy-to-use command-line issue-tracker using sqlite for ruby 1.9}
   s.email = %q{sentinel1879@gmail.com}
@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
      ".gitignore",
+     "CHANGELOG.rdoc",
      "LICENSE",
      "README.rdoc",
      "Rakefile",

data/lib/bugzyrb.rb

@@ -101,9 +101,11 @@ class Bugzy
     $default_severity = "normal"
     $default_status = "open"
     $default_priority = "P3"
-    $default_assigned_to = ""
+    $default_assigned_to = "unassigned"
     $default_due = 5 # how many days in advance due date should be
     #$bare = @options[:bare]
+      $use_readline = true
+    $g_row = nil
     # we need to load the cfg file here, if given # , or else in home dir.
     if @options[:config]
       load @options[:config]
@@ -169,11 +171,15 @@ SQL
       message "#{@file} created." if File.exists? @file
       text = <<-TEXT
       If you wish to associate projects and/or components and versions to an issue,
-      please add the same in the database using:
+      please modify bugzyrb.cfg as follows:
+
+      $use_project = true
+      $use_component = true
+      $use_version = true
+      Also, fill in valid_project=[...], default_project="x" and prompt_project=true.
+
+      bugzyrb.cfg must be called using -c bugzyrb.cfg if overriding ~/.bugzyrb.cfg
 
-        project add <NAME> 
-        component add <PROJECTNAME> <COMPONENT>
-        version add <PROJECTNAME> <VERSION>
       TEXT
       message text
 
@@ -201,7 +207,7 @@ SQL
     body['severity']    = @options[:severity] || $default_severity
     body['status']      = @options[:status]   || $default_status
     body['priority']    = @options[:priority] || $default_priority
-    body['assigned_to']    = @options[:assigned_to] 
+    body['assigned_to']    = @options[:assigned_to] || $default_assigned_to
     #comment_count = 0
     #body['description = nil
     #fix = nil
@@ -244,30 +250,30 @@ SQL
     if $prompt_desc
       message "Enter a detailed description (. to exit): "
       desc = get_lines
+      #message "You entered #{desc}"
     end
-    message "You entered #{desc}"
     type = $default_type || "bug"
     severity = $default_severity || "normal"
     status = $default_status || "open"
     priority = $default_priority || "P3"
     if $prompt_type
       type = _choice("Select type:", %w[bug enhancement feature task] )
-      message "You selected #{type}"
+      #message "You selected #{type}"
     end
     if $prompt_severity
       severity = _choice("Select severity:", %w[normal critical moderate] )
-      message "You selected #{severity}"
+      #message "You selected #{severity}"
     end
     if $prompt_status
       status = _choice("Select status:", %w[open started closed stopped canceled] )
-      message "You selected #{status}"
+      #message "You selected #{status}"
     end
+    assigned_to = $default_assigned_to
     if $prompt_assigned_to
       message "Assign to:"
-      assigned_to = $stdin.gets.chomp
-      message "You selected #{assigned_to}"
-    else
-      assigned_to = $default_assigned_to
+      #assigned_to = $stdin.gets.chomp
+      assigned_to = _gets "assigned_to", "assigned_to", $default_assigned_to
+      #message "You selected #{assigned_to}"
     end
     project = component = version = nil
     # project
@@ -293,6 +299,7 @@ SQL
     body["title"]=title
     body["description"]=description
     body["type"]=type
+    body["status"]=status
     body["start_date"]=start_date.to_s
     body["due_date"]=due_date.to_s
     body["priority"]=priority
@@ -308,8 +315,6 @@ SQL
     rowid = db.table_insert_hash("bugs", body)
     puts "Issue #{rowid} created"
     logid = db.sql_logs_insert rowid, "create", "#{rowid} #{type}: #{title}"
-    # send an email of some sort needs improbement FIXME
-    #printable = %w[ title description status severity type assigned_to start_date due_date priority fix ]
     body["id"] = rowid
     mail_issue body
     
@@ -328,22 +333,16 @@ SQL
     Severity      : #{row['severity']} 
     Assigned To   : #{row['assigned_to']} 
 TEXT
+    body << "    Project       : #{row['project']}\n" if $use_project
+    body << "    Component     : #{row['component']}\n" if $use_component
+    body << "    Version       : #{row['version']}\n" if $use_version
     title = "#{row['id']}: #{row['title']} "
-    require 'tempfile'
-    temp = Tempfile.new "bugzy"
-    File.open(temp,"w"){ |f| f.write body }
-
-    #cmd = %Q{ echo "#{body}" | mail -s "#{title}" "#{emailid}" }
-    # cat is not portable please change
-    cmd = %Q{ cat #{temp.path} | mail -s "#{title}" "#{emailid}" }
-
-    $stderr.puts "executing: #{cmd}"
-    unless system(cmd)
-      $stderr.puts "Error executing #{cmd}"
-      $stderr.puts $?
-    end
 
+    cmd = %{ mail -s "#{title}" "#{emailid}" }
+    #puts cmd
+    Cmdapp::pipe_output(cmd, body)
   end
+
   ##
   # view details of a single issue/bug
   # @param [Array] ARGV, first element is issue number
@@ -411,16 +410,21 @@ TEXT
     row = db.sql_select_rowid "bugs", id
     die "No data found for #{id}" unless row
     editable = %w[ status severity type assigned_to start_date due_date priority title description fix ]
+    editable << "project" if $use_project
+    editable << "component" if $use_component
+    editable << "version" if $use_version
     sel = _choice "Select field to edit", editable
     print "You chose: #{sel}"
     old =  row[sel]
     puts " Current value is: #{old}"
+    $g_row = row
     meth = "ask_#{sel}".to_sym
     if respond_to? "ask_#{sel}".to_sym
       str = send(meth, old)
     else
-      print "Enter value: "
-      str = $stdin.gets.chomp
+      #print "Enter value: "
+      #str = $stdin.gets.chomp
+      str = _gets sel, sel, old
     end
     #str = old if str.nil? or str == ""
     if str.nil? or str == old
@@ -431,6 +435,7 @@ TEXT
     message str
     db.sql_update "bugs", id, sel, str
     puts "Updated #{id}"
+    str = str.to_s
     rowid = db.sql_logs_insert id, sel, "[#{id}] updated [#{sel}] with #{str[0..50]}"
     0
   end
@@ -451,6 +456,25 @@ TEXT
     end
     0
   end
+  def copy args
+    id = args.shift
+    db, row = validate_id id, true
+    newrow = row.to_hash
+    ret = newrow.delete("id")
+    newrow.delete("date_created")
+    newrow.delete("date_modified")
+    #row.each_pair { |name, val| puts "(#{name}): #{val} " }
+    ret = ask_title row['title']
+    newrow['title'] = ret.chomp if ret
+    rowid = db.table_insert_hash( "bugs", newrow)
+
+    title = newrow['title']
+    type = newrow['type']
+
+    logid = db.sql_logs_insert rowid, "create", "#{rowid} #{type}: #{title}"
+    newrow["id"] = rowid
+    mail_issue newrow
+  end
   def viewlogs args
     db = get_db
     id = args[0].nil? ? db.max_bug_id : args[0]
@@ -502,7 +526,26 @@ TEXT
     elsif @options[:long]
       fields = "id,status,title,severity,priority,due_date,description"
     end
-    rows = db.run "select #{fields} from bugs "
+    where = nil
+    wherestring = ""
+    if @options[:overdue]
+      #where =  %{ where status != 'closed' and due_date <= "#{Date.today}" }
+      where ||= []
+      where <<  %{ status != 'closed'} 
+      where <<  %{ due_date <= "#{Date.today}" }
+    end
+    if @options[:unassigned]
+      #where =  %{ where status != 'closed' and due_date <= "#{Date.today}" }
+      where ||= []
+      where <<  %{ (assigned_to = 'unassigned' or assigned_to is null) } 
+    end
+    if where
+      wherestring = " where " + where.join(" and ")
+    end
+    puts wherestring
+
+    rows = db.run "select #{fields} from bugs #{wherestring} "
+    die "No rows" unless rows
 
     if incl
       incl_str = incl.join "|"
@@ -572,6 +615,11 @@ TEXT
   def ask_description old=nil
     Cmdapp::edit_text old
   end
+  def ask_title old=nil
+    ret = Cmdapp::edit_text old
+    return ret.chomp if ret
+    ret
+  end
   ##
   # prompts user for a cooment to be attached to a issue/bug
   def comment args #id, comment
@@ -711,32 +759,24 @@ TEXT
   #   future_date(1).to_s[0..10];  #  => creates a string object with only Date part, no time
   #   Date.parse(future_date(1).to_s[0..10]) # => converts to a Date object
 
-  def future_date days=1
-    Time.now() + (24 * 60 * 60 * days)
-    #(Time.now() + (24 * 60 * 60) * days).to_s[0..10]; 
-  end
-
-  ## prompt user for due date, called from edit
-  #def ask_due_date
-    #days = 1
-    #ask("Enter due date?  ", Date) { 
-      #|q| q.default = future_date(days).to_s[0..10]; 
-      #q.validate = lambda { |p| Date.parse(p) >= Date.parse(Time.now.to_s) }; 
-      #q.responses[:not_valid] = "Enter a date greater than today" 
-    #}
+  #def future_date days=1
+    #Time.now() + (24 * 60 * 60 * days)
   #end
+
   # prompt user for due date, called from edit
-  def ask_due_date
-    days = 1
+  # NOTE: this takes a peek at $g_row to get start_date and validate against that
+  def ask_due_date old=nil
+    days = $default_due
     today = Date.today
-    ask("Enter due date?  ", Date) { 
-      |q| q.default = today + days;
-      q.validate = lambda { |p| Date.parse(p) >= today }; 
-      q.responses[:not_valid] = "Enter a date greater than today" 
+    start = Date.parse($g_row['start_date'].to_s) || today
+    ask("Enter due date? (>= #{start}) ", Date) { 
+      |q| q.default = (today + days).to_s;
+      q.validate = lambda { |p| Date.parse(p) >= start }; 
+      q.responses[:not_valid] = "Enter a date >= than #{start}"
     }
   end
 
-  def ask_start_date
+  def ask_start_date old=nil
     ask("Enter start date?  ", Date) { 
       #|q| q.default = Time.now.to_s[0..10]; 
       |q| q.default = Date.today
@@ -844,8 +884,9 @@ TEXT
     end
     case prompt_flag
     when :freeform
-      prompt_text ||= "#{column.capitalize}? "
-      str = ask(prompt_text){ |q| q.default = default if default  }
+      prompt_text ||= "#{column.capitalize}"
+      #str = ask(prompt_text){ |q| q.default = default if default  }
+      str = _gets(column, prompt_text, default)
       return str
     when :choice
       prompt_text ||= "Select #{column}:"
@@ -884,8 +925,25 @@ TEXT
       #puts "Read: #{$_}"                   # writes to STDOUT
     end
     return nil if str == ""
-    return str
+    return str.chomp
+  end
+  def _gets column, prompt, default=nil
+    text = "#{prompt}? "
+    text << "|#{default}|" if default
+    puts text
+    if $use_readline
+      Cmdapp::history_read column, default
+      str = Readline::readline('>', false)
+      Cmdapp::history_save column, str
+      str = default if str.nil? or str == ""
+      return str
+    else
+      str = $stdin.gets.chomp
+      str = default if str.nil? or str == ""
+      return str
+    end
   end
+  # ADD here
 
   def self.main args
     ret = nil
@@ -905,6 +963,11 @@ TEXT
       if plain
         options[:colorize] = (plain == "0") ? false:true
       end
+      config = File.expand_path "~/.bugzyrb.cfg"
+      if File.exists? config
+        options[:config] = config
+        #puts "found  #{config} "
+      end
 
   Subcommands::global_options do |opts|
     opts.banner = "Usage: #{APPNAME} [options] [subcommand [options]]"
@@ -1028,6 +1091,10 @@ TEXT
     opts.banner = "Usage: edit [options] ISSUE_NO"
     opts.description = "Edit a given issue"
   end
+  Subcommands::command :copy do |opts|
+    opts.banner = "Usage: copy [options] ISSUE_NO"
+    opts.description = "Copy a given issue"
+  end
   Subcommands::command :comment do |opts|
     opts.banner = "Usage: comment [options] ISSUE_NO TEXT"
     opts.description = "Add comment a given issue"
@@ -1052,6 +1119,12 @@ TEXT
       options[:bare] = v
       $bare = true
     }
+    opts.on("-o","--overdue", "not closed, due date past") { |v|
+      options[:overdue] = v
+    }
+    opts.on("-u","--unassigned", "not assigned") { |v|
+      options[:unassigned] = v
+    }
   end
   Subcommands::command :viewlogs do |opts|
     opts.banner = "Usage: viewlogs [options] ISSUE_NO"

data/lib/common/cmdapp.rb

@@ -258,6 +258,24 @@ def edit_text text
   return newstr
 end
 
+# pipes given string to command
+# @param [String] command to pipe data to
+# @param [String] data to pipe to command
+# @example
+#     cmd = %{mail -s "my title" rahul}
+#     pipe_output(cmd, "some long text")
+# FIXME: not clear how to return error.
+# NOTE: this is obviously more portable than using system echo or system cat.
+def pipe_output (pipeto, str)
+  #pipeto = '/usr/sbin/sendmail -t'
+  #pipeto = %q{mail -s "my title" rahul}
+  if pipeto != nil  # i was taking pipeto from a hash, so checking
+    proc = IO.popen(pipeto, "w+")
+    proc.puts str
+    proc.close_write
+    #puts proc.gets
+  end
+end
 ##
 # reads up template, and substirutes values from myhash
 # @param [String] template text
@@ -274,6 +292,56 @@ def template_replace template, myhash
   }
   t
 end
+#------------------------------------------------------------
+# these 2 methods deal with with maintaining readline history
+# for various columns. _read reads up any earlier values
+# so user can select from them.
+# _save saves the values for future use.
+#------------------------------------------------------------
+# for a given column, check if there's any previous data
+# in our cache, and put in readlines history so user can 
+# use or edit. Also put default value in history.
+# @param [String] name of column for maintaining cache
+# @param [String] default data for user to recall, or edit
+def history_read column, default=nil
+  values = []
+  oldstr = ""
+  if !defined? $history_hash
+    require 'readline'
+    require 'yaml'
+    filename = File.expand_path "~/.bugzy_history.yml"
+    $history_filename = filename
+    # if file exists with values push them into history
+    if File.exists? filename
+      $history_hash = YAML::load( File.open( filename ) )
+    else
+      $history_hash = Hash.new
+    end
+  end
+  values.push(*$history_hash[column]) if $history_hash.has_key? column
+  # push existing value into history also, so it can be edited
+  values.push(default) if default
+  values.uniq!
+  Readline::HISTORY.clear # else previous values of other fields also come in
+  Readline::HISTORY.push(*values) unless values.empty?
+  #puts Readline::HISTORY.to_a
+end
+## 
+# update our cache with str if not present in cache already
+# @param [String] name of column for maintaining cache
+# @param [String] str : data just entered by user
+#
+def history_save column, str
+  return if str.nil? or str == ""
+  if $history_hash.has_key? column
+    return if $history_hash[column].include? str
+  end
+  ($history_hash[column] ||= []) << str
+  filename = $history_filename
+  File.open( filename, 'w' ) do |f|
+    f << $history_hash.to_yaml
+  end
+end
 
 
 

data/lib/common/db.rb

@@ -118,7 +118,7 @@ module Database
     str << ") values ("
     str << qstr.join(",")
     str << ")"
-    puts str
+    #puts str
     @db.execute(str, *bind_vars)
     rowid = @db.get_first_value( "select last_insert_rowid();")
     return rowid
@@ -150,7 +150,7 @@ module Database
     # @param [Fixnum] id unique key
     # @param [String] fieldname 
     # @param [String] value to update
-    # @example sql_bugs_update 9, :name, "Roger"
+    # @example sql_update "bugs", 9, :name, "Roger"
     def sql_update table, id, field, value
       @db.execute( "update #{table} set #{field} = ?, date_modified = ? where id = ?", value,$now, id)
     end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Rahul Kumar
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-07 00:00:00 +05:30
+date: 2010-07-08 00:00:00 +05:30
 default_executable: bugzyrb
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -112,6 +112,7 @@ extra_rdoc_files:
 files: 
 - .document
 - .gitignore
+- CHANGELOG.rdoc
 - LICENSE
 - README.rdoc
 - Rakefile