gwtf 0.2.0 → 0.3.0

data/bin/gwtf

@@ -48,7 +48,7 @@ pre do |global,command,options,args|
     Gwtf::Items.setup(project_dir)
   end
 
-  @items = Gwtf::Items.new(project_dir)
+  @items = Gwtf::Items.new(project_dir, global[:project])
 
   true
 end

data/lib/gwtf.rb

@@ -14,6 +14,15 @@ module Gwtf
     end
   end
 
+  def self.projects(root_dir)
+    Dir.entries(root_dir).map do |entry|
+      next if entry =~ /^\./
+        next unless File.directory?(File.join(root_dir, entry))
+
+      entry
+    end.compact.sort
+  end
+
   # borrowed from ohai, thanks Adam.
   def self.seconds_to_human(seconds)
     days = seconds.to_i / 86400

data/lib/gwtf/commands/list_command.rb

@@ -4,21 +4,42 @@ command [:list, :ls, :l] do |c|
   c.default_value false
   c.switch [:all, :a]
 
+  c.desc 'Show a short summary for all projects'
+  c.default_value false
+  c.switch [:summary, :s]
+
+  c.desc 'Show a overview for all projects'
+  c.default_value false
+  c.switch [:overview, :o]
+
   c.action do |global_options,options,args|
-    count = {"open" => 0, "closed" => 0}
+    if options[:summary]
+      projects = Gwtf.projects(global_options[:data])
+      longest_name = projects.map{|p| p.length}.max
 
-    @items.each_item do |item|
-      count[ item[:status] ] += 1
+      projects.each_with_index do |project, idx|
+        puts "Items in all projects:\n\n" if idx == 0
 
-      flags = []
-      flags << "D" if item.has_description?
-      flags << "C" if item.closed? && options[:all]
+        items = Gwtf::Items.new(File.join(global_options[:data], project), project)
+        stats = items.stats
 
-      puts "%5s %-4s%-12s%8s" % [ item.item_id, flags.join, Time.parse(item.created_at).strftime("%F"), item.subject ] if (options[:all] || item.open?)
-    end
+        puts "%#{longest_name + 3}s: open: %3d: closed %3d: total: %3d" % [ project, stats["open"], stats["closed"], stats["total"] ] unless stats["total"] == 0
+
+      end
 
-    puts
-    puts "Project %s items: %d / %d" % [ global_options[:project], count["open"], count["open"] + count["closed"] ]
+      puts
+    elsif options[:overview]
+      Gwtf.projects(global_options[:data]).each do |project|
+        items = Gwtf::Items.new(File.join(global_options[:data], project), project)
+
+        puts items.list_text(options[:all]) if items.item_ids.size > 0
+        puts
+      end
+    else
+      puts
+      puts @items.list_text(options[:all])
+      puts
+    end
   end
 end
 

data/lib/gwtf/commands/new_command.rb

@@ -5,7 +5,26 @@ command [:new, :add, :n, :a, :c] do |c|
   c.default_value false
   c.switch [:edit, :e]
 
+  c.desc 'Schedule a reminder about this task'
+  c.default_value false
+  c.flag [:remind]
+
+  c.desc 'Mark item done after sending reminder'
+  c.default_value false
+  c.switch [:done]
+
+  c.desc 'Only alert if the item is still marked open'
+  c.default_value false
+  c.switch [:ifopen]
+
+  c.desc 'Email address to send to'
+  c.default_value Etc.getlogin
+  c.flag [:recipient, :r]
+
   c.action do |global_options,options,args|
+    subject = args.join(" ")
+    raise "Please supply a short desciption for the item on the command line" if subject == ""
+
     if options[:edit]
       raise "EDITOR is not set" unless ENV.include?("EDITOR")
 
@@ -22,10 +41,18 @@ command [:new, :add, :n, :a, :c] do |c|
     end
 
     item = @items.new_item
-    item.subject = args.join(" ")
+    item.subject = subject
     item.description = description if description
     item.save
 
+    if options[:remind]
+      STDOUT.sync
+
+      print "Creating reminder at job for item #{item.item_id}: "
+
+      item.schedule_reminer(options[:remind], options[:recipient], options[:done], options[:ifopen])
+    end
+
     puts item
   end
 end

data/lib/gwtf/commands/remind_command.rb

@@ -19,39 +19,52 @@ command [:remind, :rem] do |c|
   c.default_value false
   c.switch [:send]
 
+  c.desc 'Mark item done after sending reminder'
+  c.default_value false
+  c.switch [:done]
+
+  c.desc 'Only alert if the item is still marked open'
+  c.default_value false
+  c.switch [:ifopen]
+
   c.action do |global_options,options,args|
     raise "Please supply an item ID to remind about" if args.empty?
 
     unless options[:send]
       raise "Please specify a valid at() time specification" unless args.size > 2
 
-      at = args[1..-1].join(" ")
-
       STDOUT.sync
 
       print "Creating reminder at job for item #{args.first}: "
-      system "echo gwtf --project='%s' remind --recipient='%s' --send %s|at %s" % [ global_options[:project], options[:recipient], args.first, at]
+
+      @items.load_item(args.first).schedule_reminer(args[1..-1].join(" "), options[:recipient], options[:done], options[:ifopen])
     else
       item = @items.load_item(args.first)
 
-      begin
-        tmp = Tempfile.new("gwtf")
-        tmp.write(item.summary)
-        tmp.rewind
+      unless options[:ifopen] && item.closed?
+        begin
+          tmp = Tempfile.new("gwtf")
+          tmp.write(item.summary)
+          tmp.rewind
 
-        if global_options[:project] == "default"
-          subject = "Reminder for item %s" % [ args.first ]
-        else
-          subject = "Reminder for item %s in %s project" % [ args.first, global_options[:project] ]
-        end
+          if global_options[:project] == "default"
+            subject = "Reminder for item %s" % [ args.first ]
+          else
+            subject = "Reminder for item %s in %s project" % [ args.first, global_options[:project] ]
+          end
+
+          system("cat #{tmp.path} | mail -s '#{subject}' '#{options[:recipient]}'")
 
-        system("cat #{tmp.path}|mail -s '#{subject}' '#{options[:recipient]}'")
-      ensure
-        tmp.close
-        tmp.unlink
+          if options[:done]
+            item.record_work("Closing item as part of scheduled reminder")
+            item.close
+            item.save
+          end
+        ensure
+          tmp.close
+          tmp.unlink
+        end
       end
     end
   end
 end
-
-

data/lib/gwtf/commands/shell_command.rb

@@ -20,10 +20,14 @@ command :shell do |c|
 
     STDOUT.sync = true
 
-    print "Optional description for work log: "
+    print "Optional description for work log (start with done! to close): "
 
     begin
       description = STDIN.gets.chomp
+      if description =~ /^(done|close)!\s*(.+)/
+        description = $1
+        item.close
+      end
     rescue Exception
       puts
       description = ""

data/lib/gwtf/item.rb

@@ -1,10 +1,12 @@
 module Gwtf
   class Item
     attr_accessor :file
+    attr_reader :project
 
-    def initialize(file=nil)
+    def initialize(file=nil, project=nil)
       @item = default_item
       @file = file
+      @project = project
 
       load_item if file
     end
@@ -76,6 +78,15 @@ module Gwtf
       flag
     end
 
+    def compact_flags
+      flags = []
+      flags << "D" if has_description?
+      flags << "C" if closed?
+      flags << "L" unless work_log.empty?
+
+      flags
+    end
+
     def summary
       summary = StringIO.new
 
@@ -113,9 +124,7 @@ module Gwtf
     end
 
     def to_s
-      flag = " (#{flags.join(',')})" unless flags.empty?
-
-      "%s%s: %s" % [item_id, flag, subject]
+      "%5s %-4s%-12s%8s" % [ item_id, compact_flags.join, Time.parse(created_at.to_s).strftime("%F"), subject ]
     end
 
     def to_hash
@@ -167,6 +176,15 @@ module Gwtf
       update_property(property, value)
     end
 
+    def schedule_reminer(timespec, recipient, done=false, ifopen=false)
+      command_args = ["--send"]
+      command_args << "--recipient=%s" % [ recipient ]
+      command_args << "--done" if done
+      command_args << "--ifopen" if ifopen
+
+      system "echo gwtf --project='%s' remind %s %s | at %s" % [ @project, command_args.join(" "), item_id, timespec]
+    end
+
     # simple read from the class:
     #
     #   >> i.description

data/lib/gwtf/items.rb

@@ -20,15 +20,18 @@ module Gwtf
       end
     end
 
-    def initialize(data_dir)
+    def initialize(data_dir, project)
       raise "Data directory #{data_dir} does not exist" unless File.directory?(data_dir)
 
+      @project = project
       @data_dir = data_dir
       @config = read_config
     end
 
+    # Creates a new blank item with the next available ID, saves it and saves
+    # the global config with the next id that should be assigned
     def new_item
-      item = Item.new
+      item = Item.new(nil, @project)
       item.item_id = @config["next_item"]
       item.file = File.join(@data_dir, "#{item.item_id}.gwtf")
 
@@ -38,16 +41,19 @@ module Gwtf
       item
     end
 
+    # Loads an item from disk
     def load_item(item)
       raise "Item #{item} does not exist" unless File.exist?(file_for_item(item))
 
-      Item.new(file_for_item(item))
+      Item.new(file_for_item(item), @project)
     end
 
+    # Reads the overall gwtf config file
     def read_config
       JSON.parse(File.read(Items.config_file(@data_dir)))
     end
 
+    # Saves the overall gwtf config
     def save_config
       raise "Config has not been loaded" unless @config
 
@@ -56,16 +62,52 @@ module Gwtf
       end
     end
 
+    # Array of integer IDs that belong to this project in ascending order
     def item_ids
       Dir.entries(@data_dir).grep(/\.gwtf$/).map{|i| File.basename(i, ".gwtf")}.map{|i| Integer(i)}.sort
     end
 
+    # Returns the path where the JSON data for a item might be found in the current project
     def file_for_item(item)
       File.join(@data_dir, "#{item}.gwtf")
     end
 
+    # Iterates over all items in a project
     def each_item
       item_ids.each {|item| yield load_item(item) }
     end
+
+    # Returns an array of total, open and closed items for the current project
+    def stats
+      count = {"open" => 0, "closed" => 0}
+
+      each_item do |item|
+        count[ item.status ] += 1
+      end
+
+      count["total"] = count["open"] + count["closed"]
+
+      count
+    end
+
+    # Returns a blob of text that represents a list of items in a project
+    def list_text(all=false)
+      list = StringIO.new
+      items = StringIO.new
+
+      count = {"open" => 0, "closed" => 0}
+
+      each_item do |item|
+        count[ item[:status] ] += 1
+
+        items.puts item if (all || item.open?)
+      end
+
+      list.puts "Project %s items: %d / %d" % [ @project, count["open"], count["open"] + count["closed"] ]
+      list.puts
+      list.puts items.string
+
+      list.string
+    end
   end
 end

data/lib/gwtf/version.rb

@@ -1,3 +1,3 @@
 module Gwtf
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gwtf
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - R.I.Pienaar
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-12 00:00:00 +00:00
+date: 2012-03-13 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency