timetrap 1.3.0 → 1.4.0

data/README.md

@@ -1,13 +1,18 @@
 Timetrap
 ========
 
-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 is a simple command line time tracker written in ruby. It provides an
+easy to use command line interface for tracking what you spend your time on.
+
+It began as 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 times (e.g. "30 minutes ago"), additional commands such as
+`archive` and `configure`, and support for rounding.
+
+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, by
+creating a new formatter class (in ruby.)
+
 Timetrap maintains its state in a sqlite3 database.
 
 Timetrap is available as a gem on gemcutter (http://gemcutter.org/gems/timetrap)
@@ -35,7 +40,7 @@ time sheet may only have one period running at once.
 Interactions with timetrap are performed through the ``t`` command on the
 command line. ``t`` is followed by one of timetrap's subcommands.  Often used
 subcommands include ``in``, ``out``, ``switch``, ``now``, ``list`` and
-``display``. Commands may be abbreviated as long as they are unambiguous: thus
+``display``. *Commands may be abbreviated as long as they are unambiguous.* thus
 ``t switch foo`` and ``t s foo`` are identical.  With the default command set,
 no two commands share the first same letter, thus it is only necessary to type
 the first letter of a command.  Likewise, commands which display timesheets
@@ -105,7 +110,8 @@ Commands
 **configure**
   Creates a config file at  ``~/.timetrap.yml`` or ``ENV['TIMETRAP_CONFIG_FILE']`` if
   one doesn't exist.  Prints path to config file.  Currently allows configuration
-  of path to database file.
+  of path to database file, and the number of seconds used when the `--round`
+  flag is set (defaults to 15 minutes.)
 
   usage: ``t configure``
 
@@ -120,7 +126,7 @@ Commands
   text.  iCal and csv output are also supported.
 
   Display also allows the use of a ``--round`` or ``-r`` flag which will round
-  all times to 15 minute increments. See global options below.
+  all times in the output. See global options below.
 
   usage: ``t display [--ids] [--round] [--start DATE] [--end DATE] [--format FMT] [SHEET | all]``
 
@@ -190,6 +196,8 @@ Global Options
   display commands (e.g. display, list, week, etc.) and is non-destructive.
   The actual start and end time stored by Timetrap are unaffected.
 
+  See `configure` command to change rounding increment from 15 minutes.
+
 Configuration
 --------
 

data/VERSION.yml

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

data/lib/timetrap/cli.rb

@@ -54,8 +54,9 @@ where COMMAND is one of:
     usage: t week [--ids] [--end DATE] [--format FMT] [SHEET | all]
 
     OTHER OPTIONS
-    -h, --help     Display this help
-    -r, --round    Round output  to 15 minute start and end times.
+    -h, --help              Display this help
+    -r, --round             Round output to 15 minute start and end times.
+    -y, --yes               Noninteractive, assume yes as answer to all prompts
 
     Submit bugs and feature requests to http://github.com/samg/timetrap/issues
     EOF
@@ -95,9 +96,7 @@ where COMMAND is one of:
 
     def archive
       ee = selected_entries
-      out = "Archive #{ee.count} entries? "
-      print out
-      if $stdin.gets =~ /\Aye?s?\Z/i
+      if ask_user "Archive #{ee.count} entries? "
         ee.all.each do |e|
           next unless e.end
           e.update :sheet => "_#{e.sheet}"
@@ -136,8 +135,7 @@ where COMMAND is one of:
       if e = Entry[args['-i']]
         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
+        if ask_user out
           e.destroy
           say "it's dead"
         else
@@ -145,8 +143,7 @@ where COMMAND is one of:
         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
+        if ask_user "are you sure you want to delete #{victims} entries on sheet #{sheet.inspect}? "
           Timetrap.kill_sheet sheet
           say "killed #{victims} entries"
         else
@@ -231,5 +228,11 @@ where COMMAND is one of:
       args.unused.join(' ')
     end
 
+    def ask_user question
+      return true if args['-y']
+      print question
+      $stdin.gets =~ /\Aye?s?\Z/i
+    end
+
   end
 end

data/spec/timetrap_spec.rb

@@ -357,6 +357,14 @@ END:VCALENDAR
             invoke "kill --id #{entry.id}"
           end.should change(Timetrap::Entry, :count).by(-1)
         end
+
+        it "should not prompt the user if the --yes flag is passed" do
+          create_entry
+          entry = create_entry
+          lambda do
+            invoke "kill --id #{entry.id} --yes"
+          end.should change(Timetrap::Entry, :count).by(-1)
+        end
       end
 
       describe "list" do

data/timetrap.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{timetrap}
-  s.version = "1.3.0"
+  s.version = "1.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sam Goldstein"]
-  s.date = %q{2010-03-14}
+  s.date = %q{2010-06-17}
   s.default_executable = %q{t}
   s.description = %q{Command line time tracker}
   s.email = %q{sgrock@gmail.com}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: timetrap
 version: !ruby/object:Gem::Version 
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors: 
 - Sam Goldstein
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-14 00:00:00 -08:00
+date: 2010-06-17 00:00:00 -07:00
 default_executable: t
 dependencies: 
 - !ruby/object:Gem::Dependency