timetrap 1.8.11 → 1.8.12

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ce19a1337e4238314c4b8559d860e3b5fe060e35
+  data.tar.gz: e642ab919336be668b2e1a748aceccf954fda443
+SHA512:
+  metadata.gz: dc45d1614cb7fc9c8e341bdb4d642c46f9ae9a2ff8b0323bf8bd7c13153d3830d47eb27e3d50cbfa468e10619893f32c065aee72f23264a0f2e012edf24d24ce
+  data.tar.gz: 6ce14e2dce4dd692c0422b1fc7772b9fbe7b07404fd65f073558d1ef28b961d3e2d96884ba06e3c59fa5b3e3d72170644f801488214ae2f42716f00a63627e40

data/README.md

@@ -16,6 +16,8 @@ This will place a ``t`` executable in your path.
 ### Basic Usage
 
     $ # get help
+    $ timetrap --help
+    $ # or
     $ t --help
 
 Timetrap maintains a list of *timesheets*.
@@ -199,8 +201,10 @@ formatter in a different place you can run `t configure` and edit the
 All timetrap formatters live under the namespace `Timetrap::Formatters` so
 define your class like this:
 
-    class Timetrap::Formatters::Notes
-    end
+```ruby
+class Timetrap::Formatters::Notes
+end
+```
 
 When `t display` is invoked, timetrap initializes a new instance of the
 formatter passing it an Array of entries.  It then calls `#output` which should
@@ -209,15 +213,17 @@ return a string to be printed to the screen.
 This means we need to implement an `#initialize` method and an `#output`
 method for the class.  Something like this:
 
-    class Timetrap::Formatters::Notes
-      def initialize(entries)
-        @entries = entries
-      end
+```ruby
+class Timetrap::Formatters::Notes
+  def initialize(entries)
+    @entries = entries
+  end
 
-      def output
-        @entries.map{|entry| entry[:note]}.join("\n")
-      end
-    end
+  def output
+    @entries.map{|entry| entry[:note]}.join("\n")
+  end
+end
+```
 
 Now when I invoke it:
 
@@ -301,7 +307,8 @@ Commands
 **out**
   Stop the timer for the current timesheet. Must be called after in. Accepts an
   optional --at flag. Accepts an optional TIMESHEET name to check out of a
-  running, non-current sheet.
+  running, non-current sheet. Will check out of all running sheets if the
+  auto_checkout configuration option is enabled.
 
   usage: ``t out [--at TIME] [TIMESHEET]``
 
@@ -370,7 +377,10 @@ See ``t configure`` for details.  Currently supported options are:
 
   **default_command**: The default command to invoke when you call `t`
 
-  **auto_checkout**: Automatically check out of running entries when you check in
+  **auto_checkout**: Automatically check out of running entries when you check
+                     in or out
+
+  **require_note**: Prompt for a note if one isn't provided when checking in
 
 Autocomplete
 ------------

data/bin/timetrap

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+begin
+  require 'timetrap'
+rescue LoadError
+  if File.symlink? __FILE__
+    require File.dirname(File.readlink(__FILE__)) + '/../lib/timetrap'
+  else
+    require File.dirname(__FILE__) + '/../lib/timetrap'
+  end
+end
+Timetrap::CLI.invoke

data/lib/Getopt/Declare.rb

@@ -1294,8 +1294,8 @@ EOS
     end
     prog.sub!(%r#.*/#,'')
     r = ''
-    if defined?($VERSION)
-      r << "\n#{prog}: version #{$VERSION}  (#{filedate})\n\n"
+    if defined?(::Timetrap::VERSION)
+      r << "\n#{prog}: version #{::Timetrap::VERSION}  (#{filedate})\n\n"
     else
       r << "\n#{prog}: version dated #{filedate}\n\n"
     end

data/lib/timetrap.rb

@@ -5,6 +5,7 @@ require 'sequel'
 require 'yaml'
 require 'erb'
 require 'sequel/extensions/inflector'
+require File.join(File.dirname(__FILE__), 'timetrap', 'version')
 require File.join(File.dirname(__FILE__), 'Getopt/Declare')
 require File.join(File.dirname(__FILE__), 'timetrap', 'config')
 require File.join(File.dirname(__FILE__), 'timetrap', 'helpers')

data/lib/timetrap/cli.rb

@@ -38,7 +38,9 @@ COMMAND is one of:
                               `--format` option
       default_command:        The default command to run when calling t.
       auto_checkout:          Automatically check out of running entries when
-                              you check in
+                              you check in or out
+      require_note:           Prompt for a note if one isn't provided when
+                              checking in
 
   * display - Display the current timesheet or a specific. Pass `all' as SHEET
       to display all unarchived sheets or `full' to display archived and
@@ -78,7 +80,7 @@ COMMAND is one of:
   * now - Show all running entries.
     usage: t now
 
-  * out - Stop the timer for the a timesheet.
+  * out - Stop the timer for a timesheet.
     usage: t out [--at TIME] [TIMESHEET]
     -a, --at <time:qs>        Use this time instead of now
 
@@ -253,6 +255,12 @@ COMMAND is one of:
           warn "Checked out of sheet #{checked_out_of.sheet.inspect}."
         end
       end
+
+      if Config['require_note'] && !Timer.running? && unused_args.empty?
+        $stderr.print("Please enter a note for this entry:\n> ")
+        self.unused_args = $stdin.gets
+      end
+
       Timer.start unused_args, args['-a']
       warn "Checked into sheet #{Timer.current_sheet.inspect}."
     end
@@ -270,11 +278,20 @@ COMMAND is one of:
     end
 
     def out
-      sheet = sheet_name_from_string(unused_args)
-      if Timer.stop sheet, args['-a']
-        warn "Checked out of sheet #{sheet.inspect}."
+      if Config['auto_checkout']
+        stopped = Timer.stop_all(args['-a']).each do |checked_out_of|
+          warn "Checked out of sheet #{checked_out_of.sheet.inspect}."
+        end
+        if stopped.empty?
+          warn "No running entries to stop."
+        end
       else
-        warn "No running entry on sheet #{sheet.inspect}."
+        sheet = sheet_name_from_string(unused_args)
+        if Timer.stop sheet, args['-a']
+          warn "Checked out of sheet #{sheet.inspect}."
+        else
+          warn "No running entry on sheet #{sheet.inspect}."
+        end
       end
     end
 

data/lib/timetrap/config.rb

@@ -27,7 +27,9 @@ module Timetrap
         'default_command' => nil,
         # only allow one running entry at a time.
         # automatically check out of any running tasks when checking in.
-        'auto_checkout' => false
+        'auto_checkout' => false,
+        # interactively prompt for a note if one isn't passed when checking in.
+        'require_note' => false
       }
     end
 

data/lib/timetrap/version.rb

@@ -1,3 +1,3 @@
 module Timetrap
-  VERSION = '1.8.11'
+  VERSION = '1.8.12'
 end

data/spec/timetrap_spec.rb

@@ -555,6 +555,32 @@ END:VCALENDAR
           $stderr.string.should =~ /\w+/
         end
 
+        describe "with require_note config option set" do
+          before do
+            with_stubbed_config 'require_note' => true
+          end
+
+          it "should prompt for a note if one isn't passed" do
+            $stdin.string = "an interactive note\n"
+            invoke "in"
+            $stderr.string.should include('enter a note')
+            Timetrap::Timer.active_entry.note.should == "an interactive note"
+          end
+
+          it "should not prompt for a note if one is passed" do
+            $stdin.string = "an interactive note\n"
+            invoke "in a normal note"
+            Timetrap::Timer.active_entry.note.should == "a normal note"
+          end
+
+          it "should not stop the running entry or prompt" do
+            invoke "in a normal note"
+            $stdin.string = "an interactive note\n"
+            invoke "in"
+            Timetrap::Timer.active_entry.note.should == "a normal note"
+          end
+        end
+
         describe "with auto_checkout config option set" do
           before do
             with_stubbed_config 'auto_checkout' => true
@@ -604,6 +630,14 @@ END:VCALENDAR
               invoke "in -a '#{now}' second task"
               entry.reload.end.to_s.should == now.to_s
             end
+
+            it "should check out of the running entry without having to start a new entry" do
+              entry = Timetrap::Timer.active_entry('sheet1')
+              entry.should be_a(Timetrap::Entry)
+              entry.end.should be_nil
+              invoke "out"
+              entry.reload.end.should_not be_nil
+            end
           end
         end
       end
@@ -1279,4 +1313,13 @@ END:VCALENDAR
     end
 
   end
+  describe 'bins' do
+    # https://github.com/samg/timetrap/pull/80
+    it 'should include a t bin and an equivalent timetrap bin' do
+      timetrap = File.open(File.expand_path(File.join(File.dirname(__FILE__), '..', 'bin', 'timetrap')))
+      t = File.open(File.expand_path(File.join(File.dirname(__FILE__), '..', 'bin', 't')))
+      t.read.should == timetrap.read
+      t.stat.mode.should == timetrap.stat.mode
+    end
+  end
 end

metadata

@@ -1,169 +1,151 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: timetrap
-version: !ruby/object:Gem::Version 
-  hash: 33
-  prerelease: 
-  segments: 
-  - 1
-  - 8
-  - 11
-  version: 1.8.11
+version: !ruby/object:Gem::Version
+  version: 1.8.12
 platform: ruby
-authors: 
+authors:
 - Sam Goldstein
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-12-07 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bundler
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 1
-        - 3
-        version: "1.3"
+      - !ruby/object:Gem::Version
+        version: '1.3'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 25
-        segments: 
-        - 2
-        - 13
-        version: "2.13"
+      - !ruby/object:Gem::Version
+        version: '2.13'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: fakefs
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: icalendar
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: icalendar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 1
-        - 3
-        - 0
+      - !ruby/object:Gem::Version
         version: 1.3.0
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: json
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: sequel
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 63
-        segments: 
-        - 4
-        - 0
-        - 0
+      - !ruby/object:Gem::Version
         version: 4.0.0
   type: :runtime
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: sqlite3
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 29
-        segments: 
-        - 1
-        - 3
-        - 3
+      - !ruby/object:Gem::Version
         version: 1.3.3
   type: :runtime
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: chronic
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 51
-        segments: 
-        - 0
-        - 10
-        - 2
+      - !ruby/object:Gem::Version
         version: 0.10.2
   type: :runtime
-  version_requirements: *id009
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.2
 description: Command line time tracker
-email: 
+email:
 - sgrock@gmail.org
-executables: 
+executables:
 - dev_t
 - t
+- timetrap
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
 - .travis.yml
@@ -172,9 +154,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- VERSION.yml
 - bin/dev_t
 - bin/t
+- bin/timetrap
 - completions/bash/timetrap-autocomplete.bash
 - completions/zsh/_t
 - lib/Getopt/Declare.rb
@@ -196,37 +178,28 @@ files:
 - spec/timetrap_spec.rb
 - timetrap.gemspec
 homepage: https://github.com/samg/timetrap
-licenses: 
+licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 2.0.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Command line time tracker
-test_files: 
+test_files:
 - spec/timetrap_spec.rb

data/VERSION.yml

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