samg-timetrap 1.1.0 → 1.1.1

data/README.md

@@ -92,6 +92,7 @@ Commands
 --------
 **archives**
   Archives the selected entries (by moving them to a sheet called ``_[SHEET]``)
+  These entries can be seen by running ``t display _[SHEET]``.
   usage: ``t archive [--start DATE] [--end DATE] [SHEET]``
 
 **backend**
@@ -110,7 +111,10 @@ Commands
   specified by passing the ``--format`` flag.  This currently defaults to
   text.  iCal and csv output are also supported.
 
-  usage: ``t display [--ids] [--start DATE] [--end DATE] [--format FMT] [SHEET | all]``
+  Display also allows the use of a ``--round`` or ``-r`` flag which will round
+  all times to 15 minute increments. See global options below.
+
+  usage: ``t display [--ids] [--round] [--start DATE] [--end DATE] [--format FMT] [SHEET | all]``
 
 **edit**
   Inserts a note associated with the an entry in the timesheet, or edits the
@@ -169,3 +173,11 @@ Commands
 
   usage: ``t week [--ids] [--end DATE] [--format FMT] [SHEET | all]``
 
+Global Options
+--------
+
+**rounding**
+  passing a ``--round`` or ``-r`` flag to any command will round entry start
+  and end times to the closest 15 minute increment.  This flag only affects the
+  display commands (e.g. display, list, week, etc.) and is non-destructive.
+  The actual start and end time stored by Timetrap are unaffected.

data/VERSION.yml

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

data/lib/timetrap/cli.rb

@@ -11,7 +11,7 @@ Timetrap - Simple Time Tracking
 Usage: #{File.basename $0} COMMAND [OPTIONS] [ARGS...]
 
 where COMMAND is one of:
-  * archive - move entries to a hidden sheet (by default named '_<SHEET>') so
+  * archive - move entries to a hidden sheet (by default named '_[SHEET]') so
       they're out of the way.
     usage: t archive [--start DATE] [--end DATE] [SHEET]
     -s, --start <date:qs>     Include entries that start on this date or later
@@ -54,6 +54,7 @@ where COMMAND is one of:
 
     OTHER OPTIONS
     -h, --help     Display this help
+    -r, --round    Round output  to 15 minute start and end times.
     EOF
 
     def parse arguments
@@ -74,6 +75,7 @@ where COMMAND is one of:
 
     def invoke_command_if_valid
       command = args.unused.shift
+      set_global_options
       case (valid = commands.select{|name| name =~ %r|^#{command}|}).size
       when 0 then say "Invalid command: #{command}"
       when 1 then send valid[0]
@@ -83,12 +85,18 @@ where COMMAND is one of:
       end
     end
 
+    # currently just sets whether output should be rounded to 15 min intervals
+    def set_global_options
+      Timetrap::Entry.round = true if args['-r']
+    end
+
     def archive
       ee = selected_entries
       out = "Archive #{ee.count} entries? "
       print out
       if $stdin.gets =~ /\Aye?s?\Z/i
         ee.all.each do |e|
+          next unless e.end
           e.update :sheet => "_#{e.sheet}"
         end
       else
@@ -167,12 +175,12 @@ where COMMAND is one of:
     def list
       sheets = Entry.sheets.map do |sheet|
         sheet_atts = {:total => 0, :running => 0, :today => 0}
-        DB[:entries].filter(:sheet => sheet).inject(sheet_atts) do |m, e|
-          e_end = e[:end] || Time.now
+        Timetrap::Entry.filter(:sheet => sheet).inject(sheet_atts) do |m, e|
+          e_end = e.end_or_now
           m[:name] ||= sheet
-          m[:total] += (e_end.to_i - e[:start].to_i)
-          m[:running] += (e_end.to_i - e[:start].to_i) unless e[:end]
-          m[:today] += (e_end.to_i - e[:start].to_i) if same_day?(Time.now, e[:start])
+          m[:total] += (e_end.to_i - e.start.to_i)
+          m[:running] += (e_end.to_i - e.start.to_i) unless e.end
+          m[:today] += (e_end.to_i - e.start.to_i) if same_day?(Time.now, e.start)
           m
         end
       end
@@ -191,7 +199,7 @@ where COMMAND is one of:
 
     def now
       if Timetrap.running?
-        out = "#{Timetrap.current_sheet}: #{format_duration(Timetrap.active_entry.start, Time.now)}".gsub(/  /, ' ')
+        out = "#{Timetrap.current_sheet}: #{format_duration(Timetrap.active_entry.start, Timetrap.active_entry.end_or_now)}".gsub(/  /, ' ')
         out << " (#{Timetrap.active_entry.note})" if Timetrap.active_entry.note =~ /.+/
         say out
       else

data/lib/timetrap/formatters/text.rb

@@ -19,7 +19,7 @@ module Timetrap
           from_current_day = []
           sheets[sheet].each_with_index do |e, i|
             from_current_day << e
-            e_end = e.end || Time.now
+            e_end = e.end_or_now
             self.output <<  "%-4s%16s%11s -%9s%10s    %s\n" % [
               (Timetrap::CLI.args['-v'] ? e.id : ''),
               format_date_if_new(e.start, last_start),

data/lib/timetrap/helpers.rb

@@ -44,7 +44,7 @@ module Timetrap
     end
 
     def format_total entries
-      secs = entries.inject(0){|m, e|e_end = e.end || Time.now; m += e_end.to_i - e.start.to_i if e_end && e.start;m}
+      secs = entries.inject(0){|m, e|e_end = e.end_or_now; m += e_end.to_i - e.start.to_i if e_end && e.start;m}
       "%2s:%02d:%02d" % [secs/3600, (secs%3600)/60, secs%60]
     end
 

data/lib/timetrap/models.rb

@@ -2,6 +2,17 @@ module Timetrap
   class Entry < Sequel::Model
     plugin :schema
 
+    class << self
+    # a class level instance variable that controls whether or not all entries
+    # should respond to #start and #end with times rounded to 15 minute
+    # increments.
+      attr_accessor :round
+    end
+
+    def round?
+      !!self.class.round
+    end
+
     def start= time
       self[:start]= Chronic.parse(time) || time
     end
@@ -10,6 +21,37 @@ module Timetrap
       self[:end]= Chronic.parse(time) || time
     end
 
+    def start
+      round? ? rounded_start : self[:start]
+    end
+
+    def end
+      round? ? rounded_end : self[:end]
+    end
+
+    def end_or_now
+      self.end || (round? ? round(Time.now) : Time.now)
+    end
+
+    def rounded_start
+      round(self[:start])
+    end
+
+    def rounded_end
+      round(self[:end])
+    end
+
+    def round time
+      return nil unless time
+      Time.at(
+        if (r = time.to_i % 900) < 450
+          time.to_i - r
+        else
+          time.to_i + (900 - r)
+        end
+      )
+    end
+
     def self.sheets
       map{|e|e.sheet}.uniq.sort
     end

data/spec/timetrap_spec.rb

@@ -39,6 +39,13 @@ describe Timetrap do
             e.sheet.should == '_default'
           end
         end
+
+        it "should leave the running entry alone" do
+          invoke "in"
+          $stdin.string = "yes\n"
+          invoke 'archive'
+          Timetrap::Entry.order(:id).last.sheet.should == 'default'
+        end
       end
 
       describe 'edit' do
@@ -547,6 +554,43 @@ describe Timetrap::Entry do
         @entry.sheet= 'name'
         @entry.sheet.should == 'name'
       end
+
+      def with_global_round_set_to val
+        old_val = Timetrap::Entry.round
+        begin
+          Timetrap::Entry.round = val
+          block_return_value = yield
+        ensure
+          Timetrap::Entry.round = old_val
+        end
+      end
+
+      it "should use round start if the global round attribute is set" do
+        with_global_round_set_to true do
+          @time = Chronic.parse("12:55am")
+          @entry.start = @time
+          @entry.start.should == Chronic.parse("1am")
+        end
+      end
+
+      it "should use round start if the global round attribute is set" do
+        with_global_round_set_to true do
+          @time = Chronic.parse("12:50am")
+          @entry.start = @time
+          @entry.start.should == Chronic.parse("12:45am")
+        end
+      end
+
+      it "should have a rounded start" do
+        @time = Chronic.parse("12:50am")
+        @entry.start = @time
+        @entry.rounded_start.should == Chronic.parse("12:45am")
+      end
+
+      it "should not round nil times" do
+        @entry.start = nil
+        @entry.rounded_start.should be_nil
+      end
     end
 
     describe "parsing natural language times" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: samg-timetrap
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors: 
 - Sam Goldstein
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-16 00:00:00 -07:00
+date: 2009-07-28 00:00:00 -07:00
 default_executable: t
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -98,6 +98,7 @@ files:
 - spec/timetrap_spec.rb
 has_rdoc: true
 homepage: http://github.com/samg/timetrap/tree/master
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --inline-source
@@ -119,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 2
 summary: Command line time tracker