gwtf 0.4.4 → 0.4.5

data/lib/gwtf/commands/edit_command.rb

@@ -13,6 +13,7 @@ command [:edit, :vi, :e] do |c|
       begin
         tmp = Tempfile.new("gwtf")
         tmp.puts "Subject: %s" % [ item.subject ]
+        tmp.puts "Due Date: %s" % [ item.due_date ]
         tmp.puts "Description:"
         tmp.puts item.description if item.description
         tmp.rewind
@@ -23,13 +24,28 @@ command [:edit, :vi, :e] do |c|
         tmp.unlink
       end
 
-      if edited_item.split("\n").first =~ /^Subject:\s*(.+)/
+      edited_item = edited_item.split("\n")
+
+      if edited_item.first =~ /^Subject:\s*(.+)/
         item.subject = $1
       else
         raise "Subject is required"
       end
 
-      description = edited_item.split("\n")[2..-1]
+      if edited_item[1] =~ /^Due Date:\s*(.+)/
+        if ["", " "].include?($1)
+          item.due_date = nil
+        else
+          item.due_date = $1
+        end
+      else
+        item.due_date = nil       # if the user just delete the line from the
+        edited_item.insert(1, "") # treat it as removing the due date but insert
+                                  # some blank data in the array to not break the
+                                  # description finding logic
+      end
+
+      description = edited_item[4..-1]
 
       unless [description].flatten.compact.empty?
         item.description = description.join("\n")

data/lib/gwtf/commands/list_command.rb

@@ -23,10 +23,20 @@ command [:list, :ls, :l] do |c|
         items = Gwtf::Items.new(File.join(global_options[:data], project), project)
         stats = items.stats
 
-        puts "%#{longest_name + 3}s: open: %3d: closed %3d: total: %3d" % [ project, stats["open"], stats["closed"], stats["total"] ] unless stats["open"] == 0
+        unless stats["open"] == 0
+          msg = "%#{longest_name + 3}s: open: %-3d closed %-3d overdue: %-3d total: %-3d" % [ project, stats["open"], stats["closed"], stats["overdue"], stats["total"] ]
+
+          if stats["overdue"] > 0
+            puts Gwtf.red(msg)
+          elsif stats["due_soon"] > 0
+            puts Gwtf.yellow(msg)
+          else
+            puts Gwtf.green(msg)
+          end
+        end
       end
-
       puts
+
     elsif options[:overview]
       Gwtf.projects(global_options[:data]).each do |project|
         items = Gwtf::Items.new(File.join(global_options[:data], project), project)

data/lib/gwtf/commands/new_command.rb

@@ -1,6 +1,10 @@
 desc 'Create an item'
 arg_name 'Short item description'
 command [:new, :add, :n, :a, :c] do |c|
+  c.desc 'Due date for the item (yyyy/mm/dd)'
+  c.default_value false
+  c.flag [:due]
+
   c.desc 'Invoke EDITOR to provide a long form description'
   c.default_value false
   c.switch [:edit, :e]
@@ -43,6 +47,7 @@ command [:new, :add, :n, :a, :c] do |c|
     item = @items.new_item
     item.subject = subject
     item.description = description if description
+    item.due_date = options[:due] if options[:due]
     item.save
 
     if options[:remind]

data/lib/gwtf/item.rb

@@ -1,10 +1,19 @@
 module Gwtf
   class Item
+    include ObjHash
+
     attr_accessor :file
     attr_reader :project
 
+    property :description, :default => nil, :validation => String
+    property :subject, :default => nil, :validation => String
+    property :status, :default => "open", :validation => ["open", "closed"]
+    property :item_id, :default => nil, :validation => Integer
+    property :work_log, :default => [], :validation => Array
+    property :due_date, :default => nil, :validation => /^20\d\d[- \/.](0[1-9]|1[012])[- \/.](0[1-9]|[12][0-9]|3[01])$/
+    property :closed_at, :default => nil
+
     def initialize(file=nil, project=nil)
-      @item = default_item
       @file = file
       @project = project
 
@@ -12,19 +21,33 @@ module Gwtf
     end
 
     def open?
-      @item["status"] == "open"
+      status == "open"
     end
 
     def closed?
       !open?
     end
 
+    def overdue?
+      if has_due_date? && open?
+        return !!(days_till_due < 0)
+      else
+        return false
+      end
+    end
+
+    def days_till_due
+      return 1000 unless has_due_date?
+
+      return (Date.parse(due_date) - Date.today).to_i
+    end
+
     def load_item
       raise "A file to read from has not been specified" unless @file
 
       read_item = JSON.parse(File.read(@file))
 
-      @item.merge!(read_item)
+      merge!(read_item)
     end
 
     def backup_dir
@@ -32,7 +55,7 @@ module Gwtf
     end
 
     def save(backup=true)
-      raise "No item_id set, cannot save item" unless @item["item_id"]
+      raise "No item_id set, cannot save item" unless item_id
 
       if backup && File.exist?(@file)
         backup_name = File.basename(@file) + "-" + Time.now.to_f.to_s
@@ -47,17 +70,6 @@ module Gwtf
       @file
     end
 
-    def default_item
-      {"description" => nil,
-       "subject" => nil,
-       "created_at" => Time.now,
-       "edited_at" => nil,
-       "closed_at" => nil,
-       "status" => "open",
-       "item_id" => nil,
-       "work_log" => []}
-    end
-
     def time_worked
       work_log.inject(0) do |result, log|
         begin
@@ -74,12 +86,14 @@ module Gwtf
       flag << "closed" if closed?
       flag << "open" if open?
       flag << "descr" if description?
+      flag << "overdue" if overdue?
       flag << work_log.size.to_s unless work_log.empty?
       flag
     end
 
     def compact_flags
       flags = []
+      flags << "O" if overdue?
       flags << "D" if has_description?
       flags << "C" if closed?
       flags << "L" unless work_log.empty?
@@ -87,14 +101,30 @@ module Gwtf
       flags
     end
 
+    def colorize_by_due_date(string)
+      if overdue?
+        return Gwtf.red(string)
+      elsif days_till_due <= 1 && open?
+        return Gwtf.yellow(string)
+      else
+        return string
+      end
+    end
+
     def summary
       summary = StringIO.new
 
       summary.puts "    Subject: %s" % [ subject ]
       summary.puts "     Status: %s" % [ status ]
+
+      if has_due_date? && open?
+        due = "%s (%d days)" % [ due_date, days_till_due ]
+        summary.puts "   Due Date: %s" % [ colorize_by_due_date(due) ]
+      end
+
       summary.puts "Time Worked: %s" % [ Gwtf.seconds_to_human(time_worked) ]
-      summary.puts "    Created: %s" % [ Time.parse(created_at).strftime("%F %R") ]
-      summary.puts "     Closed: %s" % [ Time.parse(closed_at).strftime("%F %R") ] if closed?
+      summary.puts "    Created: %s" % [ Time.parse(created_at.to_s).strftime("%F %R") ]
+      summary.puts "     Closed: %s" % [ Time.parse(closed_at.to_s).strftime("%F %R") ] if closed?
       summary.puts "         ID: %s" % [ item_id ]
 
       if has_description?
@@ -124,17 +154,13 @@ module Gwtf
     end
 
     def to_s
-      "%5s %-4s%-12s%8s" % [ item_id, compact_flags.join, Time.parse(created_at.to_s).strftime("%F"), subject ]
-    end
-
-    def to_hash
-      @item
+      colorize_by_due_date("%5s %-4s%-10s %s" % [ item_id, compact_flags.join, has_due_date? ? due_date : "", subject ])
     end
 
     def record_work(text, elapsed=0)
       update_property(:edited_at, Time.now)
 
-      @item["work_log"] << {"text" => text, "time" => Time.now, "elapsed" => elapsed}
+      work_log << {"text" => text, "time" => Time.now, "elapsed" => elapsed}
     end
 
     def open
@@ -147,35 +173,6 @@ module Gwtf
       update_property(:status, "closed")
     end
 
-    def to_json
-      JSON.pretty_generate(@item)
-    end
-
-    def to_yaml
-      @item.to_yaml
-    end
-
-    def update_property(property, value)
-      property = property.to_s
-
-      raise "No such property: #{property}" unless @item.include?(property)
-
-      @item["edited_at"] = Time.now
-      @item[property] = value
-    end
-
-    def [](property)
-      property = property.to_s
-
-      raise "No such property: #{property}" unless @item.include?(property)
-
-      @item[property]
-    end
-
-    def []=(property, value)
-      update_property(property, value)
-    end
-
     def schedule_reminer(timespec, recipient, done=false, ifopen=false)
       command_args = ["--send"]
       command_args << "--recipient=%s" % [ recipient ]
@@ -194,54 +191,5 @@ module Gwtf
         save
       end
     end
-
-    # simple read from the class:
-    #
-    #   >> i.description
-    #   => "Sample Item"
-    #
-    # method like writes:
-    #
-    #   >> i.description "This is a test"
-    #   => "This is a test"
-    #
-    # assignment
-    #
-    #   >> i.description = "This is a test"
-    #   => "This is a test"
-    #
-    # boolean
-    #
-    #   >> i.description?
-    #   => false
-    #   >> i.description "foo"
-    #   => foo
-    #   >> i.has_description?
-    #   => true
-    #   >> i.has_description
-    #   => true
-    def method_missing(method, *args)
-      method = method.to_s
-
-      if @item.include?(method)
-        if args.empty?
-          return @item[method]
-        else
-          return update_property(method, args.first)
-        end
-
-      elsif method =~ /^has_(.+?)\?*$/
-        return !@item[$1].nil?
-
-      elsif method =~ /^(.+)\?$/
-        return !@item[$1].nil?
-
-      elsif method =~ /^(.+)=$/
-        property = $1
-        return update_property(property, args.first) if @item.include?(property)
-      end
-
-      raise NameError, "undefined local variable or method `#{method}'"
-    end
   end
 end

data/lib/gwtf/items.rb

@@ -79,10 +79,14 @@ module Gwtf
 
     # Returns an array of total, open and closed items for the current project
     def stats
-      count = {"open" => 0, "closed" => 0}
+      count = {"open" => 0, "closed" => 0, "overdue" => 0, "due_soon" => 0, "due_today" => 0}
 
       each_item do |item|
         count[ item.status ] += 1
+
+        count["overdue"] += 1 if item.overdue?
+        count["due_soon"] += 1 if item.days_till_due == 1
+        count["due_today"] += 1 if item.days_till_due == 0
       end
 
       count["total"] = count["open"] + count["closed"]
@@ -110,7 +114,6 @@ module Gwtf
       list.puts "Project %s items: %d / %d" % [ @project, count["open"], count["total"] ]
       list.puts
       list.puts items.string
-      list.puts
 
       list.string
     end

data/lib/gwtf/version.rb

@@ -1,3 +1,3 @@
 module Gwtf
-  VERSION = '0.4.4'
+  VERSION = '0.4.5'
 end

data/lib/gwtf.rb

@@ -1,4 +1,5 @@
 module Gwtf
+  require 'objhash'
   require 'gwtf/items'
   require 'gwtf/item'
   require 'gwtf/version'
@@ -56,6 +57,30 @@ module Gwtf
     end
   end
 
+  def self.green(msg)
+    if STDOUT.tty?
+      "%s" % [ msg ]
+    else
+      msg
+    end
+  end
+
+  def self.yellow(msg)
+    if STDOUT.tty?
+      "%s" % [ msg ]
+    else
+      msg
+    end
+  end
+
+  def self.red(msg)
+    if STDOUT.tty?
+      "%s" % [ msg ]
+    else
+      msg
+    end
+  end
+
   # borrowed from ohai, thanks Adam.
   def self.seconds_to_human(seconds)
     days = seconds.to_i / 86400

data/lib/objhash.rb

@@ -0,0 +1,221 @@
+module ObjHash
+  include Enumerable
+
+  module ClassMethods
+    # Create a new known property of the ObjHash
+    # it's imagined these might have validators, defaults
+    # required etc associated with them in args
+    def property(name, args={:default => nil, :validation => nil})
+      name = name.to_s
+
+      raise "Already have a property #{name}" if objhash_config.include?(name)
+
+      objhash_config[name] = {:default => nil, :validation => nil}.merge(args)
+    end
+
+    def objhash_config
+      @objhash_values ||= {
+                           "created_at" => {:default => lambda { Time.now }},
+                           "edited_at" => {:default => lambda { Time.now }}
+                          }
+    end
+
+    def objhash_default_value(property)
+      property = property.to_s
+
+      raise "Unknown property #{property}" unless objhash_config.include?(property)
+
+      if objhash_config[property][:default].is_a?(Proc)
+        objhash_config[property][:default].call
+      else
+        objhash_config[property][:default]
+      end
+    end
+  end
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  def default_property_value(property)
+    self.class.objhash_default_value(property)
+  end
+
+  def objhash_config
+    self.class.objhash_config
+  end
+
+  def objhash_values
+    return @objhash_values if @objhash_values
+
+    @objhash_values = {}
+
+    objhash_config.each_pair do |property, args|
+      update_property(property, default_property_value(property))
+    end
+
+    @objhash_values
+  end
+
+  def include?(property)
+    objhash_config.include?(property.to_s)
+  end
+
+  def update_property(property, value)
+    property = property.to_s
+
+    raise "Unknown property #{property}" unless include?(property)
+
+    validate_property(property, value)
+
+    objhash_values[property] = value
+    objhash_values["edited_at"] = Time.now
+  end
+
+  def validate_property(property, value)
+    raise "Unknown property #{property}" unless include?(property)
+
+    validation = objhash_config[property.to_s][:validation]
+
+    return true if validation.nil?
+
+    # if the value is the default we dont validate it allowing nil
+    # defaults but validation only on assignment of non default value
+    return true if value == objhash_config[property.to_s][:default]
+
+    raise "#{property} should be #{validation}" if value.nil? && !validation.nil?
+
+    if validation.is_a?(Symbol)
+      case validation
+        when :boolean
+          raise "#{property} should be a boolean" unless [TrueClass, FalseClass].include?(value.class)
+        when :ipv6
+          begin
+            require 'ipaddr'
+            ip = IPAddr.new(value)
+            raise "#{property} should be a valid IPv6 address" unless ip.ipv6?
+          rescue
+            raise "#{property} should be a valid IPv6 address"
+          end
+
+        when :ipv4
+          begin
+            require 'ipaddr'
+            ip = IPAddr.new(value)
+            raise "#{property} should be a valid IPv4 address" unless ip.ipv4?
+          rescue
+            raise "#{property} should be a valid IPv4 address"
+          end
+        else
+          raise "Don't know how to validate #{property} using #{validation}"
+      end
+
+    elsif validation.is_a?(Array)
+      raise "%s should be one of %s" % [property, validation.join(", ")] unless validation.include?(value)
+
+    elsif validation.is_a?(Regexp)
+      raise "#{property} should match #{validation}" unless value.match(validation)
+
+    elsif validation.is_a?(Proc)
+      raise "#{property} does not validate against lambda" unless validation.call(value)
+
+    else
+      raise "#{property} is a #{value.class} should be a #{validation}" unless value.is_a?(validation)
+    end
+
+    return true
+  end
+
+  def to_hash
+    objhash_values
+  end
+
+  def to_s
+    objhash_values.inspect
+  end
+
+  def to_json
+    objhash_values.to_json
+  end
+
+  def to_yaml
+    objhash_values.to_yaml
+  end
+
+  def each
+    objhash_values.keys.sort.each do |property|
+      yield [property, objhash_values[property]]
+    end
+  end
+
+  def [](property)
+    raise "No such property: #{property}" unless include?(property)
+
+    objhash_values[property.to_s]
+  end
+
+  def []=(property, value)
+    update_property(property, value)
+  end
+
+  def merge(hsh)
+    objhash_values.merge(hsh)
+  end
+
+  def merge!(hsh)
+    raise TypeError, "Can't convert #{hsh.class} into Hash" unless hsh.respond_to?(:to_hash)
+
+    objhash_values.keys.each do |k|
+      next if ["edited_at", "created_at"].include?(k)
+      update_property(k, hsh[k]) if hsh.include?(k)
+    end
+
+    self
+  end
+
+  # simple read from the class:
+  #
+  #   >> i.description
+  #   => "Sample Item"
+  #
+  # method like writes:
+  #
+  #   >> i.description "This is a test"
+  #   => "This is a test"
+  #
+  # assignment
+  #
+  #   >> i.description = "This is a test"
+  #   => "This is a test"
+  #
+  # boolean
+  #
+  #   >> i.description?
+  #   => false
+  #   >> i.description "foo"
+  #   => foo
+  #   >> i.has_description?
+  #   => true
+  #   >> i.has_description
+  #   => true
+  def method_missing(method, *args)
+    method = method.to_s
+
+    if include?(method)
+      if args.empty?
+        return objhash_values[method]
+      else
+        return update_property(method, args.first)
+      end
+
+    elsif method =~ /^(has_)*(.+?)\?$/
+      return !!objhash_values[$2]
+
+    elsif method =~ /^(.+)=$/
+      property = $1
+      return update_property(property, args.first) if include?(property)
+    end
+
+    raise NameError, "undefined local variable or method `#{method}'"
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gwtf
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: false
   segments: 
   - 0
   - 4
-  - 4
-  version: 0.4.4
+  - 5
+  version: 0.4.5
 platform: ruby
 authors: 
 - R.I.Pienaar
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-04 00:00:00 +01:00
+date: 2012-04-07 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -102,6 +102,7 @@ extra_rdoc_files: []
 
 files: 
 - bin/gwtf
+- lib/objhash.rb
 - lib/gwtf/commands/show_command.rb
 - lib/gwtf/commands/open_command.rb
 - lib/gwtf/commands/shell_command.rb