samg-timetrap 0.0.4 → 0.0.5

data/README.md

@@ -50,24 +50,32 @@ The basic usage is as follows::
     $ t out
 
 The first command, ``t switch writing``, switches to the timesheet "writing"
-(or creates it if it does not exist). ``t in document timetrap --at "10 minutes
+(or creates it if it does not exist). ``t in document timetrap ``--at`` "10 minutes
 ago"`` creates a new period in the current timesheet, and annotates it with the
-description "document timetrap". The optional --at flag can be passed to start
-the entry at a time other than the present.  Any Chronic or database parsable
-strings are accepted.  Note that this command would be in error if the
-``writing`` timesheet was already active.  Finally, ``t out`` records the
-current time as the end time for the most recent period in the ``writing``
-timesheet.
+description "document timetrap". The optional ``--at`` flag can be passed to start
+the entry at a time other than the present.  The ``--at`` flag is able to parse
+natural language times (via Chronic: http://chronic.rubyforge.org/) and will
+understand 'friday 13:00', 'mon 2:35', '4pm', etc. (also true of the ``alter``
+command's ``--start`` and ``--end`` flags.)  Note that this command would be in
+error if the ``writing`` timesheet was already active.  Finally, ``t out``
+records the current time as the end time for the most recent period in the
+``writing`` timesheet.
 
 To display the current timesheet, invoke the ``t display`` command::
 
     $ t display
-    Timesheet writing:
-    Day            Start      End        Duration   Notes
-    Mar 14, 2009   19:53:30 - 20:06:15   0:12:45    document timetrap
-                   20:07:02 -            0:00:01    write home about timetrap
-                                         0:12:46
-    Total                                0:12:46
+    Timesheet: timetrap
+        Day                Start      End        Duration   Notes
+        Mon Apr 13, 2009   15:46:51 - 17:03:50   1:16:59    improved display functionality
+                           17:25:59 - 17:26:02   0:00:03
+                           18:38:07 - 18:38:52   0:00:45    working on list
+                           22:37:38 - 23:38:43   1:01:05    work on kill
+                                                 2:18:52
+        Tue Apr 14, 2009   00:41:16 - 01:40:19   0:59:03    gem packaging
+                           10:20:00 - 10:48:10   0:28:10    enhance alter
+                                                 1:27:13
+        ---------------------------------------------------------
+        Total                                    3:46:05
 
 Each period in the timesheet is listed on a row. If the timesheet is active,
 the final period in the timesheet will have no end time. After each day, the
@@ -79,9 +87,11 @@ Commands
 --------
 
 **alter**
-  Inserts a note associated with the currently active period in the timesheet.
+  Inserts a note associated with the an entry in the timesheet, or alters the
+  start or end times.  Defaults to the current time although an ``--id`` flag can
+  be passed with the entry's id (see display.)
 
-  usage: ``t alter NOTES...``
+  usage: ``t alter [--id ID] [--start TIME] [--end TIME] [NOTES]``
 
 **backend**
   Run an interactive database session on the timetrap database. Requires the
@@ -91,9 +101,11 @@ Commands
 
 **display**
   Display a given timesheet. If no timesheet is specified, show the current
-  timesheet.
+  timesheet. Accepts an optional ``--ids`` flag which will include the entries'
+  ids in the output.  This is useful when editing an non running entry with
+  ``alter``.
 
-  usage: ``t display [TIMESHEET]``
+  usage: ``t display [--ids] [TIMESHEET]``
 
 **format**
   Export the current sheet as a comma-separated value format spreadsheet.  If
@@ -107,15 +119,15 @@ Commands
 **in**
   Start the timer for the current timesheet. Must be called before out.  Notes
   may be specified for this period. This is exactly equivalent to
-  ``t in; t alter NOTES``
+  ``t in; t alter NOTES``. Accepts an optional --at flag.
 
-  usage: ``t in [--at TIME] [NOTES...]``
+  usage: ``t in [--at TIME] [NOTES]``
 
 **kill**
-  Delete a timesheet. If no timesheet is specified, delete the current
-  timesheet and switch to the default timesheet.
+  Delete a timesheet or an entry.  Entry's are referenced using an ``--id``
+  flag (see display).  Sheets are referenced by name.
 
-  usage: ``t kill [TIMESHEET]``
+  usage: ``t kill [--id ID] [TIMESHEET]``
 
 **list**
   List the available timesheets.
@@ -126,15 +138,13 @@ Commands
   Print the current sheet, whether it's active, and if so, how long it has been
   active and what notes are associated with the current period.
 
-  If a specific timesheet is given, display the same information for that
-  timesheet instead.
-
   usage: ``t now``
 
 **out**
-  Stop the timer for the current timesheet. Must be called after in.
+  Stop the timer for the current timesheet. Must be called after in. Accepts an
+  optional --at flag.
 
-  usage: ``t in [--at TIME]``
+  usage: ``t out [--at TIME]``
 
 **running**
   Print all active sheets and any messages associated with them.

data/lib/timetrap.rb

@@ -64,18 +64,28 @@ module Timetrap
     end
 
     def kill
-      sheet = unused_args
-      unless (sheets = Entry.map{|e| e.sheet }.uniq).include?(sheet)
-        say "ain't no sheet #{sheet.inspect}", 'sheets:', *sheets
-        return
-      end
-      victims = Entry.filter(:sheet => sheet).count
-      print "are you sure you want to delete #{victims} entries on sheet #{sheet.inspect}? "
-      if $stdin.gets =~ /\Aye?s?\Z/i
-        Timetrap.kill sheet
-        say "killed #{victims} entries"
+      if e = Entry[args['--id']]
+        out = "are you sure you want to delete entry #{e.id}? "
+        out << "(#{e.note}) " if e.note.to_s =~ /.+/
+        print out
+        if $stdin.gets =~ /\Aye?s?\Z/i
+          e.destroy
+          say "it's dead"
+        else
+          say "will not kill"
+        end
+      elsif (sheets = Entry.map{|e| e.sheet }.uniq).include?(sheet = unused_args)
+        victims = Entry.filter(:sheet => sheet).count
+        print "are you sure you want to delete #{victims} entries on sheet #{sheet.inspect}? "
+        if $stdin.gets =~ /\Aye?s?\Z/i
+          Timetrap.kill_sheet sheet
+          say "killed #{victims} entries"
+        else
+          say "will not kill"
+        end
       else
-        say "will not kill"
+        victim = args['--id'] ? args['--id'].to_s.inspect : sheet.inspect
+        say "can't find #{victim} to kill", 'sheets:', *sheets
       end
     end
 
@@ -84,7 +94,7 @@ module Timetrap
       sheet = (sheet =~ /.+/ ? sheet : Timetrap.current_sheet)
       say "Timesheet: #{sheet}"
       id_heading = args['--ids'] ? 'Id' : '  '
-      say "       #{id_heading}  Day                Start      End        Duration   Notes"
+      say "#{id_heading}  Day                Start      End        Duration   Notes"
       last_start = nil
       from_current_day = []
       (ee = Timetrap.entries(sheet)).each_with_index do |e, i|
@@ -92,7 +102,7 @@ module Timetrap
 
         from_current_day << e
         e_end = e.end || Time.now
-        say "%9s%18s%11s -%9s%10s    %s" % [
+        say "%-4s%16s%11s -%9s%10s    %s" % [
           (args['--ids'] ? e.id : ''),
           format_date_if_new(e.start, last_start),
           format_time(e.start),
@@ -103,16 +113,16 @@ module Timetrap
 
         nxt = Timetrap.entries(sheet).map[i+1]
         if nxt == nil or !same_day?(e.start, nxt.start)
-          say "%59s" % format_total(from_current_day)
+          say "%52s" % format_total(from_current_day)
           from_current_day = []
         else
         end
         last_start = e.start
       end
       say <<-OUT
-           ---------------------------------------------------------
+    ---------------------------------------------------------
       OUT
-      say "           Total%43s" % format_total(ee)
+      say "    Total%43s" % format_total(ee)
     end
 
     def format
@@ -261,7 +271,7 @@ module Timetrap
     self.current_sheet = sheet
   end
 
-  def kill sheet
+  def kill_sheet sheet
     Entry.filter(:sheet => sheet).destroy
   end
 

data/spec/timetrap_spec.rb

@@ -86,28 +86,28 @@ describe Timetrap do
           Time.stub!(:now).and_return Time.at(1223254800 + (60*60*2))
           @desired_output = <<-OUTPUT
 Timesheet: SpecSheet
-           Day                Start      End        Duration   Notes
-           Fri Oct 03, 2008   12:00:00 - 14:00:00   2:00:00    entry 1
-                              16:00:00 - 18:00:00   2:00:00    entry 2
-                                                    4:00:00
-           Sun Oct 05, 2008   16:00:00 - 18:00:00   2:00:00    entry 3
-                              18:00:00 -            2:00:00    entry 4
-                                                    4:00:00
-           ---------------------------------------------------------
-           Total                                    8:00:00
+    Day                Start      End        Duration   Notes
+    Fri Oct 03, 2008   12:00:00 - 14:00:00   2:00:00    entry 1
+                       16:00:00 - 18:00:00   2:00:00    entry 2
+                                             4:00:00
+    Sun Oct 05, 2008   16:00:00 - 18:00:00   2:00:00    entry 3
+                       18:00:00 -            2:00:00    entry 4
+                                             4:00:00
+    ---------------------------------------------------------
+    Total                                    8:00:00
           OUTPUT
 
           @desired_output_with_ids = <<-OUTPUT
 Timesheet: SpecSheet
-       Id  Day                Start      End        Duration   Notes
-        3  Fri Oct 03, 2008   12:00:00 - 14:00:00   2:00:00    entry 1
-        2                     16:00:00 - 18:00:00   2:00:00    entry 2
-                                                    4:00:00
-        4  Sun Oct 05, 2008   16:00:00 - 18:00:00   2:00:00    entry 3
-        5                     18:00:00 -            2:00:00    entry 4
-                                                    4:00:00
-           ---------------------------------------------------------
-           Total                                    8:00:00
+Id  Day                Start      End        Duration   Notes
+3   Fri Oct 03, 2008   12:00:00 - 14:00:00   2:00:00    entry 1
+2                      16:00:00 - 18:00:00   2:00:00    entry 2
+                                             4:00:00
+4   Sun Oct 05, 2008   16:00:00 - 18:00:00   2:00:00    entry 3
+5                      18:00:00 -            2:00:00    entry 4
+                                             4:00:00
+    ---------------------------------------------------------
+    Total                                    8:00:00
           OUTPUT
         end
 
@@ -183,10 +183,20 @@ Timesheet: SpecSheet
         end
 
         it "should delete a timesheet" do
+          create_entry
           entry = create_entry
           lambda do
             $stdin.string = "yes\n"
             invoke "kill #{entry.sheet}"
+          end.should change(Timetrap::Entry, :count).by(-2)
+        end
+
+        it "should delete an entry" do
+          create_entry
+          entry = create_entry
+          lambda do
+            $stdin.string = "yes\n"
+            invoke "kill --id #{entry.id}"
           end.should change(Timetrap::Entry, :count).by(-1)
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: samg-timetrap
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Sam Goldstein