timetrap 1.8.13 → 1.8.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d18f6060d9238cea925da011e99bc4c41afb503
-  data.tar.gz: f683279029600c23ae088dcd3160dfd9ae1a5e12
+  metadata.gz: e382d25aad4d86af2c0adbafca7ac08214e12bc9
+  data.tar.gz: 4ef80db091acde2505f029a7028bdfc76747e7b2
 SHA512:
-  metadata.gz: a234bafa3c03b01b3b81942ef5e3e7c6216b835dcc51a62811d47da81a595d301ac376f7e6b0cb4cf1a4a77deb52447162e8be9f03bda4eb1741c5f346df1b1f
-  data.tar.gz: 550652a4832b0050803c8187b62f9eb42880e7fdffe97d0eefa87a63fb964b3dfeb1fd2f97bdd9cd5f71f7ccb31f076c5ff6ec90d4531f0069f7e0cbe836116c
+  metadata.gz: 7cfdf04d7086a4a8ba73bb1c6b51348e01d141a2461301b9bb85f8293df6800998f7b9c8fc3b8251ee936780cc5d31155efafc0301f55f2430d00e04b9571f49
+  data.tar.gz: 0a5220b5e22404849e583e7dd3d63a359b03cd6011e90e29bf67cf45ac982f7c5d45d38db87e60305361461c4055ad62ffd91be26f47bbbe2cf905ab0ea1dd4e

data/CONTRIBUTORS

@@ -9,3 +9,5 @@
 * Steven Ghyselbrecht
 * Matthew M. Keeler
 * Toby Foster
+* Michael Moen
+* Miles Matthias

data/README.md

@@ -237,6 +237,53 @@ Timetrap Formatters Repository
 A community focused repository of custom formatters is available at
 https://github.com/samg/timetrap_formatters.
 
+## AutoSheets
+
+Timetrap has a feature called auto sheets that allows you to automatically
+select which timesheet to check into.
+
+Timetrap ships with a couple auto sheets.  The default auto sheet is called
+`dotfiles` and will read the sheetname to check into from a `.timetrap-sheet`
+file in the current directory.
+
+[Here are all the included auto sheets](lib/timetrap/auto_sheets)
+
+You can specify which auto sheet logic you want to use in `~/.timetrap.yml` by
+changing the `auto_sheet` value.
+
+#### Custom AutoSheets
+
+It's also easy to write your own auto sheet logic that matches your personal
+workflow.  You're encouraged to submit these back to timetrap for inclusion in
+a future version.
+
+To create a custom auto sheet module you create a ruby class and implement one
+method on it `#sheet`.
+
+All timetrap auto sheets live under the namespace `Timetrap::AutoSheets`
+
+To ensure that timetrap can find your auto sheet put it in
+`~/.timetrap/auto_sheets/`.  The filename should be the same as the
+string you will set in the configuration (for example
+`~/.timetrap/auto_sheets/dotfiles.rb`.  If you want to put your auto sheet in a
+different place you can run `t configure` and edit the
+`auto sheet_search_paths` option.
+
+As an example here's the dotfiles auto sheet
+
+```ruby
+module Timetrap
+  module AutoSheets
+    class Dotfiles
+      def sheet
+        dotfile = File.join(Dir.pwd, '.timetrap-sheet')
+        File.read(dotfile).chomp if File.exist?(dotfile)
+      end
+    end
+  end
+end
+```
+
 Commands
 --------
 **archive**
@@ -326,6 +373,17 @@ Commands
 
   usage: ``t sheet [TIMESHEET]``
 
+**today**
+  Shortcut for display with start date as the current day
+
+  usage: ``t today [--ids] [--format FMT] [SHEET | all]``
+
+**yesterday**
+  Shortcut for display with start and end dates as the day before the current
+  day
+
+  usage: ``t yesterday [--ids] [--format FMT] [SHEET | all]``
+
 **week**
   Shortcut for display with start date set to monday of this week
 
@@ -382,6 +440,8 @@ See ``t configure`` for details.  Currently supported options are:
 
   **require_note**: Prompt for a note if one isn't provided when checking in
 
+  **auto_sheet**: Which auto sheet module to use.
+
 Autocomplete
 ------------
 
@@ -409,10 +469,16 @@ source /path/to/timetrap-1.x.y/gem/completions/bash/timetrap-autocomplete.bash
 
 ### zsh
 
-You need to add timetrap's zsh completions directory to your `$fpath`,
-so add the following to your `.zshrc`:
+If it isn't already, add the following to your `.zshrc`:
 
-```zsh
+```bash
+autoload -U compinit
+compinit
+```
+
+Then add this to source the completions:
+
+```bash
 fpath=(/path/to/timetrap-1.x.y/gem/completions/zsh $fpath)
 ```
 

data/lib/timetrap.rb

@@ -12,6 +12,7 @@ require File.join(File.dirname(__FILE__), 'timetrap', 'helpers')
 require File.join(File.dirname(__FILE__), 'timetrap', 'cli')
 require File.join(File.dirname(__FILE__), 'timetrap', 'timer')
 require File.join(File.dirname(__FILE__), 'timetrap', 'formatters')
+require File.join(File.dirname(__FILE__), 'timetrap', 'auto_sheets')
 module Timetrap
   DB_NAME = defined?(TEST_MODE) ? nil : Timetrap::Config['database_file']
   # connect to database.  This will create one if it doesn't exist

data/lib/timetrap/auto_sheets.rb

@@ -0,0 +1,5 @@
+# Namespace for auto_sheet classes
+module Timetrap
+  module AutoSheets
+  end
+end

data/lib/timetrap/auto_sheets/dotfiles.rb

@@ -0,0 +1,10 @@
+module Timetrap
+  module AutoSheets
+    class Dotfiles
+      def sheet
+        dotfile = File.join(Dir.pwd, '.timetrap-sheet')
+        File.read(dotfile).chomp if File.exist?(dotfile)
+      end
+    end
+  end
+end

data/lib/timetrap/auto_sheets/yaml_cwd.rb

@@ -0,0 +1,36 @@
+module Timetrap
+  module AutoSheets
+    ### auto_sheet_paths
+    #
+    # Specify which sheet to automatically use in which directories in with the
+    # following format in timetrap.yml:
+    #
+    # auto_sheet_paths:
+    #   Sheet name: /path/to/directory
+    #   More specific sheet: /path/to/directory/that/is/nested
+    #   Other sheet:
+    #     - /path/to/first/directory
+    #     - /path/to/second/directory
+    #
+    # **Note** Timetrap will always use the sheet specified in the config file
+    # if you are in that directory (or in its tree). To use a different sheet,
+    # you must be in a different directory.
+    #
+    class YamlCwd
+      def sheet
+        auto_sheet = nil
+        cwd = "#{Dir.getwd}/"
+        most_specific = 0
+        Array(Timetrap::Config['auto_sheet_paths']).each do |sheet, dirs|
+          Array(dirs).each do |dir|
+            if cwd.start_with?(dir) && dir.length > most_specific
+              most_specific = dir.length
+              auto_sheet = sheet
+            end
+          end
+        end
+        auto_sheet
+      end
+    end
+  end
+end

data/lib/timetrap/cli.rb

@@ -97,6 +97,9 @@ COMMAND is one of:
   * today - Shortcut for display with start date as the current day
     usage: t today [--ids] [--format FMT] [SHEET | all]
 
+  * yesterday - Shortcut for display with start and end dates as the day before the current day
+    usage: t yesterday [--ids] [--format FMT] [SHEET | all]
+
   * week - Shortcut for display with start date set to monday of this week.
     usage: t week [--ids] [--end DATE] [--format FMT] [SHEET | all]
 
@@ -395,6 +398,13 @@ COMMAND is one of:
         display
     end
 
+    def yesterday
+      yesterday = (Date.today - 1).to_s
+      args['-s'] = yesterday
+      args['-e'] = yesterday
+      display
+    end
+
     def week
       args['-s'] = Date.today.wday == 1 ? Date.today.to_s : Date.parse(Chronic.parse(%q(last monday)).to_s).to_s
       display
@@ -430,6 +440,7 @@ COMMAND is one of:
       $stdin.gets =~ /\Aye?s?\Z/i
     end
 
+    extend Helpers::AutoLoad
     def format_entries(entries)
       load_formatter(args['-f'] || Config['default_formatter']).new(Array(entries)).output
     end

data/lib/timetrap/config.rb

@@ -23,6 +23,12 @@ module Timetrap
         ],
         # formatter to use when display is invoked without a --format option
         'default_formatter' => 'text',
+        # the auto_sheet to use
+        'auto_sheet' => 'dotfiles',
+        # an array of directories to search for user defined auto_sheet classes
+        'auto_sheet_search_paths' => [
+          "#{ENV['HOME']}/.timetrap/auto_sheets"
+        ],
         # the default command to when you run `t`.  default to printing usage.
         'default_command' => nil,
         # only allow one running entry at a time.

data/lib/timetrap/helpers.rb

@@ -1,30 +1,40 @@
 module Timetrap
   module Helpers
+    module AutoLoad
+      def load_formatter(formatter)
+        auto_load(formatter, 'formatter')
+      end
+
+      def load_auto_sheet(auto_sheet)
+        auto_load(auto_sheet, 'auto_sheet')
+      end
 
-    def load_formatter(formatter)
-      err_msg = "Can't load #{formatter.inspect} formatter."
-      begin
-        paths = (
-          Array(Config['formatter_search_paths']) +
-          [ File.join( File.dirname(__FILE__), 'formatters') ]
-        )
-       if paths.detect do |path|
-           begin
-             fp = File.join(path, formatter)
-             require File.join(path, formatter)
-             true
-           rescue LoadError
-             nil
-           end
-         end
-       else
-         raise LoadError, "Couldn't find #{formatter}.rb in #{paths.inspect}"
-       end
-       Timetrap::Formatters.const_get(formatter.camelize)
-      rescue LoadError, NameError => e
-        err = e.class.new("#{err_msg} (#{e.message})")
-        err.set_backtrace(e.backtrace)
-        raise err
+      def auto_load(name, type)
+        err_msg = "Can't load #{name.inspect} #{type}."
+        begin
+          paths = (
+            Array(Config["#{type}_search_paths"]) +
+            [ File.join( File.dirname(__FILE__), type.pluralize) ]
+          )
+        if paths.detect do |path|
+            begin
+              fp = File.join(path, name)
+              require File.join(path, name)
+              true
+            rescue LoadError
+              nil
+            end
+          end
+        else
+          raise LoadError, "Couldn't find #{name}.rb in #{paths.inspect}"
+        end
+        namespace = Timetrap.const_get(type.pluralize.camelize)
+        namespace.const_get(name.camelize)
+        rescue LoadError, NameError => e
+          err = e.class.new("#{err_msg} (#{e.message})")
+          err.set_backtrace(e.backtrace)
+          raise err
+        end
       end
     end
 

data/lib/timetrap/timer.rb

@@ -1,5 +1,7 @@
 module Timetrap
   module Timer
+    extend Helpers::AutoLoad
+
     class AlreadyRunning < StandardError
       def message
         "Timetrap is already running"
@@ -63,7 +65,16 @@ module Timetrap
       unless Meta.find(:key => 'current_sheet')
         Meta.create(:key => 'current_sheet', :value => 'default')
       end
-      Meta.find(:key => 'current_sheet').value
+
+      if the_auto_sheet = auto_sheet
+        unless @auto_sheet_warned
+          warn "Sheet #{the_auto_sheet.inspect} selected by Timetrap::AutoSheets::#{::Timetrap::Config['auto_sheet'].capitalize}"
+          @auto_sheet_warned = true
+        end
+        the_auto_sheet
+      else
+        Meta.find(:key => 'current_sheet').value
+      end
     end
 
     def last_sheet
@@ -122,5 +133,10 @@ module Timetrap
       Entry.create(:sheet => Timer.current_sheet, :note => note, :start => time).save
     end
 
+    def auto_sheet
+      if Timetrap::Config['auto_sheet']
+        load_auto_sheet(Config['auto_sheet']).new.sheet
+      end
+    end
   end
 end

data/lib/timetrap/version.rb

@@ -1,3 +1,3 @@
 module Timetrap
-  VERSION = '1.8.13'
+  VERSION = '1.8.14'
 end

data/spec/dotfile/.timetrap-sheet

@@ -0,0 +1 @@
+dotfile-sheet

data/spec/timetrap_spec.rb

@@ -219,6 +219,66 @@ describe Timetrap do
         end
       end
 
+      describe 'auto_sheet' do
+        describe "using dotfiles auto_sheet" do
+          describe 'with a .timetrap-sheet in cwd' do
+            it 'should use sheet defined in dorfile' do
+              Dir.chdir('spec/dotfile') do
+                with_stubbed_config('auto_sheet' => 'dotfiles')
+                Timetrap::Timer.current_sheet.should == 'dotfile-sheet'
+              end
+            end
+          end
+        end
+
+        describe "using YamlCwd autosheet" do
+          describe 'with cwd in auto_sheet_paths' do
+            it 'should use sheet defined in config' do
+              with_stubbed_config(
+                'auto_sheet_paths' => {
+                'a sheet' => ['/not/cwd/', Dir.getwd]
+              }, 'auto_sheet' => 'yaml_cwd')
+              Timetrap::Timer.current_sheet.should == 'a sheet'
+            end
+          end
+
+          describe 'with ancestor of cwd in auto_sheet_paths' do
+            it 'should use sheet defined in config' do
+              with_stubbed_config(
+                'auto_sheet_paths' => {'a sheet' => '/'},
+                'auto_sheet' => 'yaml_cwd'
+              )
+              Timetrap::Timer.current_sheet.should == 'a sheet'
+            end
+          end
+
+          describe 'with cwd not in auto_sheet_paths' do
+            it 'should not use sheet defined in config' do
+              with_stubbed_config(
+                'auto_sheet_paths' => {
+                  'a sheet' => '/not/the/current/working/directory/'
+              },'auto_sheet' => 'yaml_cwd')
+              Timetrap::Timer.current_sheet.should == 'default'
+            end
+          end
+
+          describe 'with cwd and ancestor in auto_sheet_paths' do
+            it 'should use the most specific config' do
+              with_stubbed_config(
+                'auto_sheet_paths' => {
+                  'general sheet' => '/', 'more specific sheet' => Dir.getwd
+              }, 'auto_sheet' => 'yaml_cwd')
+              Timetrap::Timer.current_sheet.should == 'more specific sheet'
+              with_stubbed_config(
+                'auto_sheet_paths' => {
+                  'more specific sheet' => Dir.getwd, 'general sheet' => '/'
+                }, 'auto_sheet' => 'yaml_cwd')
+              Timetrap::Timer.current_sheet.should == 'more specific sheet'
+            end
+          end
+        end
+      end
+
       describe "backend" do
         it "should open an sqlite console to the db" do
           Timetrap::CLI.should_receive(:exec).with("sqlite3 #{Timetrap::DB_NAME}")
@@ -406,7 +466,7 @@ Grand Total                                 10:00:00
             )
             invoke 'd SpecSheet'
             # check it doesn't error and produces valid looking output
-            $stdout.string.should include('Timesheet: SpecSheet') 
+            $stdout.string.should include('Timesheet: SpecSheet')
           end
         end
 
@@ -682,6 +742,20 @@ END:VCALENDAR
         end
       end
 
+      describe "yesterday" do
+        it "should only show entries for yesterday" do
+          yesterday = Time.now - (24 * 60 * 60)
+          create_entry(
+            :start => yesterday,
+            :end => yesterday
+          )
+          create_entry
+          invoke 'yesterday'
+          $stdout.string.should include yesterday.strftime('%a %b %d, %Y')
+          $stdout.string.should_not include Time.now.strftime('%a %b %d, %Y')
+        end
+      end
+
       describe "week" do
         it "should only show entries from this week" do
           create_entry(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timetrap
 version: !ruby/object:Gem::Version
-  version: 1.8.13
+  version: 1.8.14
 platform: ruby
 authors:
 - Sam Goldstein
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-12 00:00:00.000000000 Z
+date: 2014-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -162,6 +162,9 @@ files:
 - lib/Getopt/Declare.rb
 - lib/Getopt/DelimScanner.rb
 - lib/timetrap.rb
+- lib/timetrap/auto_sheets.rb
+- lib/timetrap/auto_sheets/dotfiles.rb
+- lib/timetrap/auto_sheets/yaml_cwd.rb
 - lib/timetrap/cli.rb
 - lib/timetrap/config.rb
 - lib/timetrap/formatters.rb
@@ -175,6 +178,7 @@ files:
 - lib/timetrap/models.rb
 - lib/timetrap/timer.rb
 - lib/timetrap/version.rb
+- spec/dotfile/.timetrap-sheet
 - spec/timetrap_spec.rb
 - timetrap.gemspec
 homepage: https://github.com/samg/timetrap
@@ -202,4 +206,5 @@ signing_key:
 specification_version: 4
 summary: Command line time tracker
 test_files:
+- spec/dotfile/.timetrap-sheet
 - spec/timetrap_spec.rb