samg-timetrap 1.0.3 → 1.1.0

data/README.md

@@ -1,11 +1,14 @@
 Timetrap
 ========
 
-Timetrap is a ruby port of Trevor Caira's Timebook, a small utility which aims
-to be a low-overhead way of tracking what you spend time on.  It contains
-several enhancement over Timebook notably the ability to parse natural language
-time strings.  This makes commands such as ``t in --at "30 minutes ago"``
-possible.  Timetrap maintains its state in a sqlite3 database.
+Timetrap is a utility which provides an easy to use command line interface for
+tracking what you spend your time on.  It is a ruby port of Trevor Caira's
+Timebook, a small python utility.  It contains several enhancement over
+Timebook notably the ability to parse natural language time strings.  This
+makes commands such as ``t in --at "30 minutes ago"`` possible.  Timetrap is
+also able to export entries to several formats (e.g. ical, csv) and is designed
+to be easily extended to support additional export formats.
+Timetrap maintains its state in a sqlite3 database.
 
 To install:
 
@@ -45,7 +48,7 @@ timesheet ``foo`` was desired).
 Usage
 -----
 
-The basic usage is as follows::
+The basic usage is as follows:
 
     $ t switch writing
     $ t in document timetrap --at "10 minutes ago"
@@ -88,7 +91,7 @@ last row, the total time tracked in the timesheet is shown.
 Commands
 --------
 **archives**
-  Archives the selected entries (by moving them to a sheet called _<SHEET>)
+  Archives the selected entries (by moving them to a sheet called ``_[SHEET]``)
   usage: ``t archive [--start DATE] [--end DATE] [SHEET]``
 
 **backend**
@@ -105,7 +108,7 @@ Commands
 
   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.
+  text.  iCal and csv output are also supported.
 
   usage: ``t display [--ids] [--start DATE] [--end DATE] [--format FMT] [SHEET | all]``
 
@@ -117,6 +120,7 @@ Commands
   usage: ``t edit [--id ID] [--start TIME] [--end TIME] [NOTES]``
 
 **format**
+  Deprecated
   Alias for display
 
 **in**

data/VERSION.yml

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

data/lib/timetrap/cli.rb

@@ -24,14 +24,14 @@ where COMMAND is one of:
     -v, --ids                 Print database ids (for use with edit)
     -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
+    -f, --format <format>     The output format.  Currently supports ical, csv, and
                                 text (default).
   * edit - alter an entry's note, start, or end time. Defaults to the active entry
     usage: t edit [--id ID] [--start TIME] [--end TIME] [NOTES]
     -i, --id <id:i>           Alter entry with id <id> instead of the running entry
     -s, --start <time:qs>     Change the start time to <time>
     -e, --end <time:qs>       Change the end time to <time>
-  * format - alias for display
+  * format - deprecated: 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
@@ -77,7 +77,10 @@ where COMMAND is one of:
       case (valid = commands.select{|name| name =~ %r|^#{command}|}).size
       when 0 then say "Invalid command: #{command}"
       when 1 then send valid[0]
-      else; say "Ambigous command: #{command}"; end
+      else
+        say "Ambiguous command: #{command}" if command
+        say(USAGE)
+      end
     end
 
     def archive
@@ -152,17 +155,8 @@ where COMMAND is one of:
       end
       say Timetrap.format(fmt_klass, selected_entries.order(:start).all)
     end
+    alias_method :format, :display
 
-    # TODO: Consolidate display and format
-    def format
-      begin
-        fmt_klass = Timetrap::Formatters.const_get("#{args['-f'].classify}")
-      rescue
-        say "Invalid format specified `#{args['-f']}'"
-        return
-      end
-      say Timetrap.format(fmt_klass, selected_entries.order(:start).all)
-    end
 
     def switch
       sheet = unused_args
@@ -182,6 +176,7 @@ where COMMAND is one of:
           m
         end
       end
+      if sheets.empty? then say "No sheets found"; return end
       width = sheets.sort_by{|h|h[:name].length }.last[:name].length + 4
       say " %-#{width}s%-12s%-12s%s" % ["Timesheet", "Running", "Today", "Total Time"]
       sheets.each do |sheet|

data/lib/timetrap/formatters/csv.rb

@@ -0,0 +1,19 @@
+module Timetrap
+  module Formatters
+    class Csv
+      attr_reader :output
+
+      def initialize entries
+        @output = entries.inject("start,end,note\n") do |out, e|
+          next(out) unless e.end
+          out << %|"#{e.start.strftime(time_format)}","#{e.end.strftime(time_format)}","#{e.note}"\n|
+        end
+      end
+
+      private
+      def time_format
+        "%Y-%m-%d %H:%M:%S"
+      end
+    end
+  end
+end

data/spec/timetrap_spec.rb

@@ -188,12 +188,42 @@ Grand Total                                 10:00:00
       end
 
       describe "format" do
-        describe 'ical' do
-          before do
-            create_entry(:start => '2008-10-03 12:00:00', :end => '2008-10-03 14:00:00')
-            create_entry(:start => '2008-10-05 12:00:00', :end => '2008-10-05 14:00:00')
+        before do
+          create_entry(:start => '2008-10-03 12:00:00', :end => '2008-10-03 14:00:00')
+          create_entry(:start => '2008-10-05 12:00:00', :end => '2008-10-05 14:00:00')
+        end
+        describe 'csv' do
+
+          it "should not export running items" do
+            invoke 'in'
+            invoke 'format --format csv'
+            $stdout.string.should == <<-EOF
+start,end,note
+"2008-10-03 12:00:00","2008-10-03 14:00:00","note"
+"2008-10-05 12:00:00","2008-10-05 14:00:00","note"
+            EOF
           end
 
+          it "should filter events by the passed dates" do
+            invoke 'format --format csv --start 2008-10-03 --end 2008-10-03'
+            $stdout.string.should == <<-EOF
+start,end,note
+"2008-10-03 12:00:00","2008-10-03 14:00:00","note"
+            EOF
+          end
+
+          it "should not filter events by date when none are passed" do
+            invoke 'format --format csv'
+            $stdout.string.should == <<-EOF
+start,end,note
+"2008-10-03 12:00:00","2008-10-03 14:00:00","note"
+"2008-10-05 12:00:00","2008-10-05 14:00:00","note"
+            EOF
+          end
+        end
+
+        describe 'ical' do
+
           it "should not export running items" do
             invoke 'in'
             invoke 'format --format ical'
@@ -294,27 +324,36 @@ END:VCALENDAR
       end
 
       describe "list" do
-        before do
-          Time.stub!(:now).and_return Time.parse("Oct 5 18:00:00 -0700 2008")
-          create_entry( :sheet => 'A Longly Named Sheet 2', :start => '2008-10-03 12:00:00',
-                       :end => '2008-10-03 14:00:00')
-          create_entry( :sheet => 'A Longly Named Sheet 2', :start => '2008-10-03 12:00:00',
-                       :end => '2008-10-03 14:00:00')
-          create_entry( :sheet => 'A Longly Named Sheet 2', :start => '2008-10-05 12:00:00',
-                       :end => '2008-10-05 14:00:00')
-          create_entry( :sheet => 'A Longly Named Sheet 2', :start => '2008-10-05 14:00:00',
-                       :end => nil)
-          create_entry( :sheet => 'Sheet 1', :start => '2008-10-03 16:00:00',
-                       :end => '2008-10-03 18:00:00')
-          Timetrap.current_sheet = 'A Longly Named Sheet 2'
-        end
-        it "should list available timesheets" do
-          invoke 'list'
-          $stdout.string.should == <<-OUTPUT
+        describe "with no sheets defined" do
+          it "should say that there are no sheets" do
+            invoke 'list'
+            $stdout.string.chomp.should == 'No sheets found'
+          end
+        end
+
+        describe "with sheets defined" do
+          before do
+            Time.stub!(:now).and_return Time.parse("Oct 5 18:00:00 -0700 2008")
+            create_entry( :sheet => 'A Longly Named Sheet 2', :start => '2008-10-03 12:00:00',
+                         :end => '2008-10-03 14:00:00')
+            create_entry( :sheet => 'A Longly Named Sheet 2', :start => '2008-10-03 12:00:00',
+                         :end => '2008-10-03 14:00:00')
+            create_entry( :sheet => 'A Longly Named Sheet 2', :start => '2008-10-05 12:00:00',
+                         :end => '2008-10-05 14:00:00')
+            create_entry( :sheet => 'A Longly Named Sheet 2', :start => '2008-10-05 14:00:00',
+                         :end => nil)
+            create_entry( :sheet => 'Sheet 1', :start => '2008-10-03 16:00:00',
+                         :end => '2008-10-03 18:00:00')
+            Timetrap.current_sheet = 'A Longly Named Sheet 2'
+          end
+          it "should list available timesheets" do
+            invoke 'list'
+            $stdout.string.should == <<-OUTPUT
  Timesheet                 Running     Today       Total Time
 *A Longly Named Sheet 2     4:00:00     6:00:00    10:00:00
  Sheet 1                    0:00:00     0:00:00     2:00:00
-          OUTPUT
+            OUTPUT
+          end
         end
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: samg-timetrap
 version: !ruby/object:Gem::Version 
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors: 
 - Sam Goldstein
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-10 00:00:00 -07:00
+date: 2009-07-16 00:00:00 -07:00
 default_executable: t
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -90,6 +90,7 @@ files:
 - bin/t
 - lib/timetrap.rb
 - lib/timetrap/cli.rb
+- lib/timetrap/formatters/csv.rb
 - lib/timetrap/formatters/ical.rb
 - lib/timetrap/formatters/text.rb
 - lib/timetrap/helpers.rb