samg-timetrap 0.1.2 → 1.0.0

data/README.md

@@ -101,19 +101,18 @@ Commands
 
 **display**
   Display a given timesheet. If no timesheet is specified, show the current
-  timesheet. If ``all`` is passed as timesheet display all timesheets. Accepts
+  timesheet. If ``all`` is passed as SHEET display all timesheets. 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 [--ids] [--start DATE] [--end DATE] [TIMESHEET]``
+  Display is designed to support a variety of export formats that can be
+  specified by passing the ``--format`` flag.  This currently defaults to
+  text.  iCal output is also supported.
 
-**format**
-  Export the current sheet as a comma-separated value format spreadsheet.  If
-  the final entry is active, it is ignored.
-
-  Currently must pass 'ical' as FORMATTER
+  usage: ``t display [--ids] [--start DATE] [--end DATE] [--format FMT] [SHEET | all]``
 
-  usage: ``t format [--start DATE] [--end DATE] FORMATTER``
+**format**
+  Alias for display
 
 **in**
   Start the timer for the current timesheet. Must be called before out.  Notes

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 2
-:major: 0
-:minor: 1
+:patch: 0
+:major: 1
+:minor: 0

data/lib/timetrap/cli.rb

@@ -19,16 +19,14 @@ where COMMAND is one of:
   * backend - open an sqlite shell to the database
     usage: t backend
   * display - display the current timesheet or a specific. Pass `all' as
-      timesheet to display all sheets.
-    usage: t display [--ids] [--start DATE] [--end DATE] [TIMESHEET | all ]
+      SHEET to display all sheets.
+    usage: t display [--ids] [--start DATE] [--end DATE] [--format FMT] [SHEET | all]
     -v, --ids                 Print database ids (for use with alter)
     -s, --start <date:qs>     Include entries that start on this date or later
     -e, --end <date:qs>       Include entries that start on this date or earlier
-  * format - export a sheet to csv format
-    usage: t format [--start DATE] [--end DATE] FORMATTER
-    FORMATTER                 Currently only supports 'ical'
-    -s, --start <date:qs>     Include entries that start on this date or later
-    -e, --end <date:qs>       Include entries that start on this date or earlier
+    -f, --format <format>     The output format.  Currently supports ical and
+                                text (default).
+  * format - alias for display
   * in - start the timer for the current timesheet
     usage: t in [--at TIME] [NOTES]
     -a, --at <time:qs>        Use this time instead of now
@@ -43,7 +41,7 @@ where COMMAND is one of:
     usage: t out [--at TIME]
     -a, --at <time:qs>        Use this time instead of now
   * running - show all running timesheets
-    NOT IMPLEMENTED
+    usage: t running
   * switch - switch to a new timesheet
     usage: t switch TIMESHEET
 
@@ -122,72 +120,46 @@ where COMMAND is one of:
     end
 
     def display
-      sheets = if (sheet = sheet_name_from_string(unused_args)) == 'all'
-        Timetrap::Entry.sheets
-      elsif sheet =~ /.+/
-        [sheet]
-      else
-        [Timetrap.current_sheet]
-      end
-      entries = []
-      sheets.each do |sheet|
-        say "Timesheet: #{sheet}"
-        id_heading = args['-v'] ? 'Id' : '  '
-        say "#{id_heading}  Day                Start      End        Duration   Notes"
-        last_start = nil
-        from_current_day = []
-        ee = Timetrap::Entry.filter(:sheet => sheet).order(:start)
-        ee = ee.filter(:start >= Date.parse(args['-s'])) if args['-s']
-        ee = ee.filter(:start <= Date.parse(args['-e']) + 1) if args['-e']
-        entries += ee.all
-        ee.each_with_index do |e, i|
-
-
-          from_current_day << e
-          e_end = e.end || Time.now
-          say "%-4s%16s%11s -%9s%10s    %s" % [
-            (args['-v'] ? e.id : ''),
-            format_date_if_new(e.start, last_start),
-            format_time(e.start),
-            format_time(e.end),
-            format_duration(e.start, e_end),
-            e.note
-          ]
-
-          nxt = ee.map[i+1]
-          if nxt == nil or !same_day?(e.start, nxt.start)
-            say "%52s" % format_total(from_current_day)
-            from_current_day = []
-          else
-          end
-          last_start = e.start
+      begin
+        fmt_klass = if args['-f']
+          Timetrap::Formatters.const_get("#{args['-f'].classify}")
+        else
+          Timetrap::Formatters::Text
         end
-        say <<-OUT
-    ---------------------------------------------------------
-        OUT
-        say "    Total%43s" % format_total(ee)
-        say "\n" unless sheet == sheets.last
+      rescue
+        say "Invalid format specified `#{args['-f']}'"
+        return
       end
-      if sheets.size > 1
-        say <<-OUT
--------------------------------------------------------------
-        OUT
-        say "Grand Total%41s" % format_total(entries)
+      ee = if (sheet = sheet_name_from_string(unused_args)) == 'all'
+        Timetrap::Entry
+      elsif sheet =~ /.+/
+        Timetrap::Entry.filter(:sheet => sheet)
+      else
+        Timetrap::Entry.filter(:sheet => Timetrap.current_sheet)
       end
+      ee = ee.filter(:start >= Date.parse(args['-s'])) if args['-s']
+      ee = ee.filter(:start <= Date.parse(args['-e']) + 1) if args['-e']
+      say Timetrap.format(fmt_klass, ee.order(:start).all)
     end
 
     # TODO: Consolidate display and format
     def format
       begin
-        fmt_klass = Timetrap::Formatters.const_get("#{unused_args.classify}")
+        fmt_klass = Timetrap::Formatters.const_get("#{args['-f'].classify}")
       rescue
-        say "Invalid format specified `#{unused_args}'"
+        say "Invalid format specified `#{args['-f']}'"
         return
       end
-      ee = Timetrap::Entry.filter(:sheet => Timetrap.current_sheet)
+      ee = if (sheet = sheet_name_from_string(unused_args)) == 'all'
+        Timetrap::Entry
+      elsif sheet =~ /.+/
+        Timetrap::Entry.filter(:sheet => sheet)
+      else
+        Timetrap::Entry.filter(:sheet => Timetrap.current_sheet)
+      end
       ee = ee.filter(:start >= Date.parse(args['-s'])) if args['-s']
       ee = ee.filter(:start <= Date.parse(args['-e']) + 1) if args['-e']
-      say Timetrap.format(fmt_klass,ee.all)
+      say Timetrap.format(fmt_klass, ee.all)
     end
 
     def switch
@@ -231,7 +203,8 @@ where COMMAND is one of:
     end
 
     def running
-      say "Sorry not implemented yet :-("
+      say "Running Timesheets:"
+      say Timetrap::Entry.filter(:end => nil).map{|e| "  #{e.sheet}: #{e.note}"}.uniq.sort
     end
 
     private

data/lib/timetrap/formatters/text.rb

@@ -1 +1,55 @@
+module Timetrap
+  module Formatters
+    class Text
+      attr_accessor :output
+      include Timetrap::Helpers
 
+      def initialize entries
+        self.output = ''
+        sheets = entries.inject({}) do |h, e|
+          h[e.sheet] ||= []
+          h[e.sheet] << e
+          h
+        end
+        (sheet_names = sheets.keys.sort).each do |sheet|
+          self.output <<  "Timesheet: #{sheet}\n"
+          id_heading = Timetrap::CLI.args['-v'] ? 'Id' : '  '
+          self.output <<  "#{id_heading}  Day                Start      End        Duration   Notes\n"
+          last_start = nil
+          from_current_day = []
+          sheets[sheet].each_with_index do |e, i|
+            from_current_day << e
+            e_end = e.end || Time.now
+            self.output <<  "%-4s%16s%11s -%9s%10s    %s\n" % [
+              (Timetrap::CLI.args['-v'] ? e.id : ''),
+              format_date_if_new(e.start, last_start),
+              format_time(e.start),
+              format_time(e.end),
+              format_duration(e.start, e_end),
+              e.note
+            ]
+
+            nxt = sheets[sheet].map[i+1]
+            if nxt == nil or !same_day?(e.start, nxt.start)
+              self.output <<  "%52s\n" % format_total(from_current_day)
+              from_current_day = []
+            else
+            end
+            last_start = e.start
+          end
+          self.output <<  <<-OUT
+    ---------------------------------------------------------
+          OUT
+          self.output <<  "    Total%43s\n" % format_total(sheets[sheet])
+          self.output <<  "\n" unless sheet == sheet_names.last
+        end
+        if sheets.size > 1
+          self.output <<  <<-OUT
+-------------------------------------------------------------
+          OUT
+          self.output <<  "Grand Total%41s\n" % format_total(sheets.values.flatten)
+        end
+      end
+    end
+  end
+end

data/spec/timetrap_spec.rb

@@ -171,17 +171,17 @@ Grand Total                                 10:00:00
           end
 
           it "should filter events by the passed dates" do
-            invoke 'format ical --start 2008-10-03 --end 2008-10-03'
+            invoke 'format --format ical --start 2008-10-03 --end 2008-10-03'
             $stdout.string.scan(/BEGIN:VEVENT/).should have(1).item
           end
 
           it "should not filter events by date when none are passed" do
-            invoke 'format ical'
+            invoke 'format --format ical'
             $stdout.string.scan(/BEGIN:VEVENT/).should have(2).item
           end
 
           it "should export a sheet to an ical format" do
-            invoke 'format ical --start 2008-10-03 --end 2008-10-03'
+            invoke 'format --format ical --start 2008-10-03 --end 2008-10-03'
             desired = <<-EOF
 BEGIN:VCALENDAR
 VERSION:2.0
@@ -347,12 +347,16 @@ current sheet: 0:01:00 (a timesheet that is running)
       end
 
       describe "running" do
-        before do
+        it "should show all running timesheets" do
           create_entry :sheet => 'one', :end => nil
           create_entry :sheet => 'two', :end => nil
+          create_entry :sheet => 'three'
+          invoke 'running'
+          $stdout.string.should == "Running Timesheets:\n  one: note\n  two: note\n"
         end
-        it "should show all running timesheets" do
-          pending
+        it "should show no runnig timesheets" do
+          invoke 'running'
+          $stdout.string.should == "Running Timesheets:\n"
         end
       end
 
@@ -444,6 +448,7 @@ current sheet: 0:01:00 (a timesheet that is running)
       Timetrap.current_sheet.should == 'sheet2'
     end
   end
+
 end
 
 describe Timetrap::Entry do

metadata

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