gwtf 0.6.1 → 0.7.0

data/lib/gwtf.rb

@@ -4,6 +4,7 @@ module Gwtf
   require 'gwtf/item'
   require 'gwtf/version'
   require 'gwtf/notifier/base'
+  require 'gwtf/notifier/email'
   require 'json'
   require 'yaml'
   require 'fileutils'
@@ -12,6 +13,12 @@ module Gwtf
   require 'time'
   require 'readline'
 
+  @@color = true
+
+  def self.color=(value)
+    @@color = value
+  end
+
   def self.each_command
     commands_dir = File.join(File.dirname(__FILE__), "gwtf", "commands")
     Dir.entries(commands_dir).grep(/_command.rb$/).sort.each do |command|
@@ -28,12 +35,22 @@ module Gwtf
     end.compact.sort
   end
 
-  def self.notifier_for_address(address)
+  def self.protocol_for_address(address)
     uri = URI.parse(address)
 
     case uri.scheme
       when nil, "email"
-        require 'gwtf/notifier/email'
+        return "email"
+      else
+        return uri.scheme
+    end
+  end
+
+  def self.notifier_for_address(address)
+    protocol = protocol_for_address(address)
+
+    case protocol_for_address(address)
+      when "email"
         return Notifier::Email
       when "boxcar"
         gem 'boxcar_api', '>= 1.2.0'
@@ -42,7 +59,7 @@ module Gwtf
 
         return Notifier::Boxcar
       else
-        raise "Do not know how to handle addresses of type #{uri.scheme} for #{address}"
+        raise "Do not know how to handle addresses of type #{protocol} for #{address}"
     end
   end
 
@@ -58,7 +75,7 @@ module Gwtf
   end
 
   def self.green(msg)
-    if STDOUT.tty?
+    if STDOUT.tty? && @@color
       "%s" % [ msg ]
     else
       msg
@@ -66,7 +83,7 @@ module Gwtf
   end
 
   def self.yellow(msg)
-    if STDOUT.tty?
+    if STDOUT.tty? && @@color
       "%s" % [ msg ]
     else
       msg
@@ -74,7 +91,7 @@ module Gwtf
   end
 
   def self.red(msg)
-    if STDOUT.tty?
+    if STDOUT.tty? && @@color
       "%s" % [ msg ]
     else
       msg

data/lib/gwtf/commands/list_command.rb

@@ -55,18 +55,7 @@ command [:list, :ls, :l] do |c|
       end
 
     elsif options[:overview]
-      Gwtf.projects(global_options[:data]).each do |project|
-        next if project == "reminders"
-
-        items = Gwtf::Items.new(File.join(global_options[:data], project), project)
-
-        if items.item_ids.size > 0
-          if text = items.list_text(options[:all], true)
-            puts text
-            puts
-          end
-        end
-      end
+      puts Gwtf::Items.overview_text(global_options[:data], options[:all])
 
     else
       puts

data/lib/gwtf/commands/new_command.rb

@@ -48,7 +48,6 @@ command [:new, :add, :n, :a, :c] do |c|
     item.subject = subject
     item.description = description if description
     item.due_date = options[:due] if options[:due]
-    item.save
 
     if options[:remind]
       STDOUT.sync
@@ -58,6 +57,8 @@ command [:new, :add, :n, :a, :c] do |c|
       item.schedule_reminer(options[:remind], options[:recipient], options[:done], options[:ifopen])
     end
 
+    item.save
+
     puts item.to_s
   end
 end

data/lib/gwtf/commands/notify_command.rb

@@ -0,0 +1,63 @@
+desc 'Tool to send various kinds of notification'
+
+command [:notify] do |c|
+  c.desc 'Email address to send to'
+  c.default_value Etc.getlogin
+  c.flag [:recipient, :r]
+
+  c.desc 'Send a reminder about an item'
+  c.default_value false
+  c.flag [:remind]
+
+  c.desc 'Send a overview list of all projects with items'
+  c.default_value false
+  c.switch [:overview]
+
+  c.desc 'Send a list of any due or overdue items'
+  c.default_value false
+  c.switch [:due]
+
+  c.desc 'When notifying about a specific item, close it after notify'
+  c.default_value false
+  c.switch [:done]
+
+  c.desc 'Only notify about an open item'
+  c.default_value false
+  c.switch [:ifopen]
+
+  c.action do |global_options,options,args|
+    if options[:remind]
+      raise "Need an item ID to remind" unless options[:remind] =~ /^(.+)$/
+
+      item = @items.load_item(options[:remind])
+
+      unless options[:ifopen] && item.closed?
+        item.send_reminder(options[:recipient], options[:done])
+      end
+
+    elsif options[:overview]
+      overview_text = Gwtf::Items.overview_text(global_options[:data])
+
+      unless overview_text == ""
+        options[:recipient].split(",").each do |r|
+          next unless Gwtf.protocol_for_address(r) == "email"
+
+          Gwtf::Notifier::Email.send_email(overview_text, "Summary of Tasks", r)
+        end
+      end
+
+    elsif options[:due]
+      Gwtf.color = false
+
+      due_text = Gwtf::Items.due_text(global_options[:data])
+
+      unless due_text == ""
+        options[:recipient].split(",").each do |r|
+          next unless Gwtf.protocol_for_address(r) == "email"
+
+          Gwtf::Notifier::Email.send_email(due_text, "Due and Overdue Tasks", r)
+        end
+      end
+    end
+  end
+end

data/lib/gwtf/commands/remind_command.rb

@@ -33,12 +33,12 @@ command [:remind, :rem] do |c|
   c.action do |global_options,options,args|
     raise "Please supply an item ID to remind about" if args.empty?
 
-    STDOUT.sync
+    STDOUT.sync = true
 
     unless options[:send]
       if args.first =~ /^\d+$/ # got an item id, schedule a reminder
         unless options[:at]
-          raise "Please specify a valid at(1) time specification with --at after the item id" unless args.size > 2
+          raise "Please specify a valid at(1) time specification with --at after the item id" unless args.size >= 2
           options[:at] = args[1..-1].join(" ")
         end
 
@@ -67,12 +67,11 @@ command [:remind, :rem] do |c|
         puts reminder.to_s
       end
     else
+      # This is deprecated use 'gwtf email --remind 10' instead
       item = @items.load_item(args.first)
 
       unless options[:ifopen] && item.closed?
-        options[:recipient].split(",").each do |recipient|
-          item.send_reminder(recipient.strip, options[:done], Gwtf.notifier_for_address(recipient.strip))
-        end
+        item.send_reminder(options[:recipient], options[:done])
       end
     end
   end

data/lib/gwtf/item.rb

@@ -186,20 +186,24 @@ module Gwtf
     end
 
     def schedule_reminer(timespec, recipient, done=false, ifopen=false)
-      command_args = ["--send"]
+      command_args = ["--remind"]
       command_args << "--recipient=%s" % [ recipient ]
       command_args << "--done" if done
       command_args << "--ifopen" if ifopen
 
-      command = "echo gwtf --project='%s' remind %s %s | at %s 2>&1" % [ @project, command_args.join(" "), item_id, timespec]
+      command = "echo gwtf --project='%s' email %s %s | at %s 2>&1" % [ @project, command_args.join(" "), item_id, timespec]
       out = %x[#{command}]
 
+      raise "Failed to add at(1) job: %s" % [ out ] unless $? == 0
+
       puts out
       out
     end
 
-    def send_reminder(recipient, mark_as_done, klass)
-      klass.new(self, recipient).notify
+    def send_reminder(recipient, mark_as_done)
+      recipient.split(",").each do |r|
+        Gwtf.notifier_for_address(r.strip).new(self, r.strip).notify
+      end
 
       if mark_as_done
         record_work("Closing item as part of scheduled reminder")

data/lib/gwtf/items.rb

@@ -20,6 +20,43 @@ module Gwtf
       end
     end
 
+    # overview text of open (or all) items in all projects
+    def self.overview_text(datadir, all=false)
+      overview = StringIO.new
+
+      Gwtf.projects(datadir).each do |project|
+        next if project == "reminders"
+
+        items = Gwtf::Items.new(File.join(datadir, project), project)
+
+        if items.item_ids.size > 0
+          if text = items.list_text(all, true)
+            overview.puts text
+            overview.puts
+          end
+        end
+      end
+
+      overview.string
+    end
+
+    # overview text of all due items in all projects
+    def self.due_text(datadir)
+      overview = StringIO.new
+
+      Gwtf.projects(datadir).each do |project|
+        next if project == "reminders"
+
+        items = Gwtf::Items.new(File.join(datadir, project), project)
+
+        items.each_item do |item|
+          overview.puts "%s: %s" % [ project, item.to_s ] if item.due?
+        end
+      end
+
+      overview.string
+    end
+
     def initialize(data_dir, project)
       raise "Data directory #{data_dir} does not exist" unless File.directory?(data_dir)
 

data/lib/gwtf/notifier/email.rb

@@ -1,23 +1,27 @@
 module Gwtf
   module Notifier
     class Email<Base
-      def notify
-        begin
-          tmp = Tempfile.new("gwtf")
-          tmp.write(item.summary)
-          tmp.rewind
+      def self.send_email(body, subject, recipient)
+        tmp = Tempfile.new("gwtf")
+        tmp.write(body)
+        tmp.rewind
+
+        subject.gsub!("'", "\'")
+        recipient.gsub!("'", "\'")
 
-          if item.project == "default"
-            subject = "Reminder for item %s" % [ item.item_id ]
-          else
-            subject = "Reminder for item %s in %s project" % [ item.item_id, item.project ]
-          end
+        system("cat #{tmp.path} | mail -s '#{subject}' '#{recipient}'")
+      ensure
+        tmp.close!
+      end
 
-          system("cat #{tmp.path} | mail -s '#{subject}' '#{recipient}'")
-        ensure
-          tmp.close
-          tmp.unlink
+      def notify
+        if item.project == "default"
+          subject = "Reminder for item %s" % [ item.item_id ]
+        else
+          subject = "Reminder for item %s in %s project" % [ item.item_id, item.project ]
         end
+
+        Email.send_email(item.summary, subject, recipient)
       end
     end
   end

data/lib/gwtf/version.rb

@@ -1,3 +1,3 @@
 module Gwtf
-  VERSION = '0.6.1'
+  VERSION = '0.7.0'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gwtf
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 3
   prerelease: false
   segments: 
   - 0
-  - 6
-  - 1
-  version: 0.6.1
+  - 7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - R.I.Pienaar
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-10 00:00:00 +01:00
+date: 2012-04-11 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -106,6 +106,7 @@ files:
 - lib/gwtf/commands/show_command.rb
 - lib/gwtf/commands/open_command.rb
 - lib/gwtf/commands/shell_command.rb
+- lib/gwtf/commands/notify_command.rb
 - lib/gwtf/commands/done_command.rb
 - lib/gwtf/commands/log_command.rb
 - lib/gwtf/commands/edit_command.rb