timetrap 1.10.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f0cfbd1ca2273c6fbcaa8a48af329f8bb02e29b
-  data.tar.gz: 55d18f5690cfcfbf6f5379f244e323d5f2da4d80
+  metadata.gz: 271617ba22c6a444786172a06c319c130e520e3e
+  data.tar.gz: 58a80a95272541cf095d4727e580a1feda1b49f4
 SHA512:
-  metadata.gz: 099d87442198a0dd457bf1ea35c6a2a7dd390b0b6c3935f63edfd6d5bb76d0adb605e82c46a454f1b5ff8e3bc36933c230267838050d2d311fac9a28ea776bfa
-  data.tar.gz: 4e18a20f8a8cdff882cf3a2b72f4e31f5adb8af5b5f2aed738f649e2a5190c0028cbff9a40649bedd6cfa15587524633fc7763d7e292a71fbdc85575a0226654
+  metadata.gz: 75ac29be79462ac44122fedbe8255b48091d749cd08eed5ef672327c7d1a8e949f40ffdb584d3a203e2a3a42ea4ff0ef2ba81ca13c25477555e5d0d96556d409
+  data.tar.gz: d85f15fd101a3a3a321b2d6283c744ac1f7fdc919ee292a8366ad71543841fb70253c2274b8bbd691fae9ef6ac260386e51adf23c1b22fd344b6e287ed989dfb

data/.travis.yml

@@ -2,3 +2,4 @@ language: ruby
 rvm:
   - 2.1.8
   - 2.2.4
+  - 2.3.1

data/CONTRIBUTORS

@@ -13,3 +13,4 @@
 * Miles Matthias
 * Devon Blandin (@dblandin)
 * Marc Addeo
+* Patrick Davey

data/README.md

@@ -301,7 +301,7 @@ Commands
   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]``
+  usage: ``t archive [--start DATE] [--end DATE] [--grep REGEX] [SHEET]``
 
 **backend**
   Run an interactive database session on the timetrap database. Requires the
@@ -331,7 +331,7 @@ Commands
   Display also allows the use of a ``--round`` or ``-r`` flag which will round
   all times in the output. See global options below.
 
-  usage: ``t display [--ids] [--round] [--start DATE] [--end DATE] [--format FMT] [SHEET | all | full]``
+  usage: ``t display [--ids] [--round] [--start DATE] [--end DATE] [--format FMT] [--grep REGEX] [SHEET | all | full]``
 
 **edit**
   Inserts a note associated with the an entry in the timesheet, or edits the
@@ -454,6 +454,11 @@ See ``t configure`` for details.  Currently supported options are:
   **auto_sheet_search_paths**: an array of directories to search for user
                               defined auto_sheet classes
 
+  **note_editor**: The command to start editing notes. Defaults to false which
+               means no external editor is used. Please see the section below
+               on Notes Editing for tips on using non-terminal based editors.
+               Example: note_editor: "vim"
+
 
 ### Autocomplete
 
@@ -494,6 +499,17 @@ Then add this to source the completions:
 fpath=(/path/to/timetrap-1.x.y/gem/completions/zsh $fpath)
 ```
 
+#### Notes editing
+If you use the note_editor setting, then it is possible to use
+an editor for writing your notes. If you use a non terminal based
+editor (like atom, sublime etc.) then you will need to make timetrap
+wait until the editor has finished. If you're using the "core.editor"
+flag in git, then it'll be the same flags you'll use.
+
+As of when this command was added, for atom you would use `atom --wait`
+and for sublime `subl -w`. If you use a console based editor (vim, emacs,
+nano) then it should just work.
+
 Special Thanks
 --------------
 

data/lib/timetrap.rb

@@ -1,6 +1,7 @@
 require "rubygems"
 
 require 'chronic'
+require 'tempfile'
 require 'sequel'
 require 'yaml'
 require 'erb'

data/lib/timetrap/cli.rb

@@ -42,6 +42,9 @@ COMMAND is one of:
                               you check in or out
       require_note:           Prompt for a note if one isn't provided when
                               checking in
+      note_editor:            Command to launch notes editor or false if no editor use.
+                              If you use a non terminal based editor (e.g. sublime, atom)
+                              please read the notes in the README.
 
   * display - Display the current timesheet or a specific. Pass `all' as SHEET
       to display all unarchived sheets or `full' to display archived and
@@ -74,7 +77,7 @@ COMMAND is one of:
 
   * kill - Delete a timesheet or an entry.
     usage: t kill [--id ID] [TIMESHEET]
-    -i, --id <id:i>           Alter entry with id <id> instead of the running entry
+    -i, --id <id:i>           Delete entry with id <id> instead of timesheet
 
   * list - Show the available timesheets.
     usage: t list
@@ -239,15 +242,24 @@ COMMAND is one of:
         entry.update :sheet => args['-m']
       end
 
-      # update notes
-      if unused_args =~ /.+/
-        note = unused_args
+      if Config['note_editor']
         if args['-z']
-          note = [entry.note, note].join(Config['append_notes_delimiter'])
+          note = [entry.note, get_note_from_external_editor].join(Config['append_notes_delimiter'])
+          entry.update :note => note
+        elsif args.size == 0 # no arguments supplied
+          entry.update :note => get_note_from_external_editor(entry.note)
+        end
+      else
+        if unused_args =~ /.+/
+          note = unused_args
+          if args['-z']
+            note = [entry.note, note].join(Config['append_notes_delimiter'])
+          end
+          entry.update :note => note
         end
-        entry.update :note => note
       end
 
+
       puts format_entries(entry)
     end
 
@@ -262,12 +274,17 @@ COMMAND is one of:
         end
       end
 
+      note = unused_args
       if Config['require_note'] && !Timer.running? && unused_args.empty?
-        $stderr.print("Please enter a note for this entry:\n> ")
-        self.unused_args = $stdin.gets
+        if Config['note_editor']
+          note = get_note_from_external_editor
+        else
+          $stderr.print("Please enter a note for this entry:\n> ")
+          note = $stdin.gets.strip
+        end
       end
 
-      Timer.start unused_args, args['-a']
+      Timer.start note, args['-a']
       warn "Checked into sheet #{Timer.current_sheet.inspect}."
     end
 
@@ -453,6 +470,21 @@ COMMAND is one of:
       $stdin.gets =~ /\Aye?s?\Z/i
     end
 
+    def get_note_from_external_editor(contents = "")
+      file = Tempfile.new('get_note')
+      unless contents.empty?
+        file.open
+        file.write(contents)
+        file.close
+      end
+
+      system("#{Config['note_editor']} #{file.path}")
+      file.open.read
+    ensure
+     file.close
+     file.unlink
+    end
+
     extend Helpers::AutoLoad
     def format_entries(entries)
       load_formatter(args['-f'] || Config['default_formatter']).new(Array(entries)).output

data/lib/timetrap/config.rb

@@ -35,7 +35,9 @@ module Timetrap
         # automatically check out of any running tasks when checking in.
         'auto_checkout' => false,
         # interactively prompt for a note if one isn't passed when checking in.
-        'require_note' => false
+        'require_note' => false,
+        # command to launch external editor (false if no external editor used)
+        'note_editor' => false
       }
     end
 

data/lib/timetrap/formatters/text.rb

@@ -1,22 +1,19 @@
 module Timetrap
   module Formatters
     class Text
+      LONGEST_NOTE_LENGTH = 50
       attr_accessor :output
       include Timetrap::Helpers
 
       def initialize entries
+        @entries = entries
         self.output = ''
         sheets = entries.inject({}) do |h, e|
           h[e.sheet] ||= []
           h[e.sheet] << e
           h
         end
-        longest_note = entries.inject('Notes'.length) {|l, e| [e.note.to_s.rstrip.length, l].max}
-        max_id_length = if Timetrap::CLI.args['-v']
-          entries.inject(3) {|l, e| [e.id.to_s.length, l].max}
-        else
-          3
-        end
+
         (sheet_names = sheets.keys.sort).each do |sheet|
 
           self.output <<  "Timesheet: #{sheet}\n"
@@ -25,7 +22,6 @@ module Timetrap
           last_start = nil
           from_current_day = []
 
-
           sheets[sheet].each_with_index do |e, i|
             from_current_day << e
             self.output <<  "%-#{max_id_length + 1}s%16s%11s -%9s%10s    %s\n" % [
@@ -34,7 +30,7 @@ module Timetrap
               format_time(e.start),
               format_time(e.end),
               format_duration(e.duration),
-              e.note
+              format_note(e.note)
             ]
 
             nxt = sheets[sheet].to_a[i+1]
@@ -53,7 +49,53 @@ module Timetrap
           self.output <<  "%s\n" % ('-'*(4+52+longest_note))
           self.output <<  "Grand Total%41s\n" % format_total(sheets.values.flatten)
         end
+
+
+      end
+
+
+      private
+
+      attr_reader :entries
+
+      def longest_note
+        @longest_note ||= begin
+          entries.inject('Notes'.length) {|l, e| [e.note.to_s.rstrip.length, LONGEST_NOTE_LENGTH].min}
+        end
       end
+
+      def max_id_length
+        @max_id_length ||= begin
+          if Timetrap::CLI.args['-v']
+            entries.inject(3) {|l, e| [e.id.to_s.length, l].max}
+          else
+            3
+          end
+        end
+      end
+
+      def format_note(note)
+        return "" unless note
+
+        lines = []
+        line_number = 0
+        note.lines.each do |line|
+          while index = line.index(/\s/, LONGEST_NOTE_LENGTH) do
+            shorter_line = line.slice!(0..(index - 1))
+            lines << padded_line(shorter_line.strip, line_number)
+            line_number += 1
+          end
+          lines << padded_line(line.strip, line_number)
+          line_number += 1
+        end
+        lines.join("\n")
+      end
+
+      def padded_line(content, line_number)
+        return content if line_number == 0
+        "#{" " * (56 + max_id_length - 3) }#{content}"
+      end
+
     end
   end
 end

data/lib/timetrap/version.rb

@@ -1,3 +1,3 @@
 module Timetrap
-  VERSION = '1.10.0'
+  VERSION = '1.11.0'
 end

data/spec/timetrap_spec.rb

@@ -3,6 +3,18 @@ require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'timetra
 require 'rspec'
 require 'fakefs/safe'
 
+RSpec.configure do |config|
+  # as we are stubbing stderr and stdout, if you want to capture
+  # any of your output in tests, simply add :write_stdout_stderr => true
+  # as metadata to the end of your test
+  config.after(:each, write_stdout_stderr: true) do
+    $stderr.rewind
+    $stdout.rewind
+    File.write("stderr.txt", $stderr.read)
+    File.write("stdout.txt", $stdout.read)
+  end
+end
+
 def local_time(str)
   Timetrap::Timer.process_time(str)
 end
@@ -14,7 +26,7 @@ end
 module Timetrap::StubConfig
   def with_stubbed_config options = {}
     defaults = Timetrap::Config.defaults.dup
-    Timetrap::Config.stub(:[]).and_return do |k|
+    Timetrap::Config.stub(:[]) do |k|
       defaults.merge(options)[k]
     end
     yield if block_given?
@@ -129,9 +141,9 @@ describe Timetrap do
             FileUtils.mkdir_p(ENV['HOME'])
             config_file = ENV['HOME'] + '/.timetrap.yml'
             FileUtils.rm(config_file) if File.exist? config_file
-            File.exist?(config_file).should be_false
+            File.exist?(config_file).should be_falsey
             invoke "configure"
-            File.exist?(config_file).should be_true
+            File.exist?(config_file).should be_truthy
           end
         end
 
@@ -232,12 +244,63 @@ describe Timetrap do
           not_running.refresh.sheet.should == 'default'
           Timetrap::Timer.current_sheet.should == 'another second sheet'
         end
+
+        context "with external editor" do
+          let(:note_editor_command) { 'vim' }
+
+          before do
+            with_stubbed_config 'note_editor' => note_editor_command, 'append_notes_delimiter' => '//'
+          end
+
+          it "should open an editor for editing the note" do |example|
+            Timetrap::CLI.stub(:system) do |editor_command|
+              path = editor_command.match(/#{note_editor_command} (?<path>.*)/)
+              File.write(path[:path], "edited note")
+            end
+            Timetrap::Timer.active_entry.note.should == 'running entry'
+            invoke "edit"
+            Timetrap::Timer.active_entry.note.should == 'edited note'
+          end
+
+          it "should pass existing note to editor" do |example|
+            capture = nil
+            Timetrap::CLI.stub(:system) do |editor_command|
+              path = editor_command.match(/#{note_editor_command} (?<path>.*)/)
+
+              capture = File.read(path[:path])
+            end
+            invoke "edit"
+            expect(capture).to eq("running entry")
+          end
+
+          context "appending" do
+            it "should open an editor for editing the note with -z" do |example|
+              Timetrap::CLI.stub(:system) do |editor_command|
+                path = editor_command.match(/#{note_editor_command} (?<path>.*)/)
+                File.write(path[:path], "appended in editor")
+              end
+              Timetrap::Timer.active_entry.note.should == 'running entry'
+              invoke "edit -z"
+              Timetrap::Timer.active_entry.note.should == 'running entry//appended in editor'
+            end
+
+            it "should open a editor for editing the note with --append" do |example|
+              Timetrap::CLI.stub(:system) do |editor_command|
+                path = editor_command.match(/#{note_editor_command} (?<path>.*)/)
+                File.write(path[:path], "appended in editor")
+              end
+              Timetrap::Timer.active_entry.note.should == 'running entry'
+              invoke "edit --append"
+              Timetrap::Timer.active_entry.note.should == 'running entry//appended in editor'
+            end
+          end
+        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
+            it 'should use sheet defined in dotfile' do
               Dir.chdir('spec/dotfile') do
                 with_stubbed_config('auto_sheet' => 'dotfiles')
                 Timetrap::Timer.current_sheet.should == 'dotfile-sheet'
@@ -357,6 +420,12 @@ The "format" command is deprecated in favor of "display". Sorry for the inconven
             Timetrap::Entry.create( :sheet => 'SpecSheet',
               :note => 'entry 4', :start => '2008-10-05 18:00:00'
             )
+            Timetrap::Entry.create( :sheet => 'LongNoteSheet',
+              :note => "long notesheet " * 20, :start => '2008-10-05 16:00:00', :end => '2008-10-05 18:00:00'
+            )
+            Timetrap::Entry.create( :sheet => 'SheetWithLineBreakNote',
+              :note => "first line\nand a second line ", :start => '2008-10-05 16:00:00', :end => '2008-10-05 18:00:00'
+            )
 
             now = local_time('2008-10-05 20:00:00')
             Time.stub(:now).and_return now
@@ -410,26 +479,42 @@ Id    Day                Start      End        Duration   Notes
       Total                                    8:00:00
             OUTPUT
 
-            @desired_output_for_all = <<-OUTPUT
-Timesheet: SpecSheet
+            @desired_output_for_long_note_sheet = <<-OUTPUT
+Timesheet: LongNoteSheet
     Day                Start      End        Duration   Notes
-    Fri Oct 03, 2008   12:00:00 - 14:00:00   2:00:00    entry 1
-                       16:00:00 - 18:00:00   2:00:00    entry 2
-                                             4:00:00
-    Sun Oct 05, 2008   16:00:00 - 18:00:00   2:00:00    entry 3
-                       18:00:00 -            2:00:00    entry 4
-                                             4:00:00
-    ---------------------------------------------------------------------
-    Total                                    8:00:00
+    Sun Oct 05, 2008   16:00:00 - 18:00:00   2:00:00    long notesheet long notesheet long notesheet long notesheet
+                                                        long notesheet long notesheet long notesheet long
+                                                        notesheet long notesheet long notesheet long notesheet
+                                                        long notesheet long notesheet long notesheet long
+                                                        notesheet long notesheet long notesheet long notesheet
+                                                        long notesheet long notesheet
+                                             2:00:00
+    ------------------------------------------------------------------------------------------------------
+    Total                                    2:00:00
+            OUTPUT
+
+            @desired_output_for_long_note_sheet_with_ids = <<-OUTPUT
+Timesheet: LongNoteSheet
+Id    Day                Start      End        Duration   Notes
+60000 Sun Oct 05, 2008   16:00:00 - 18:00:00   2:00:00    long notesheet long notesheet long notesheet long notesheet
+                                                          long notesheet long notesheet long notesheet long
+                                                          notesheet long notesheet long notesheet long notesheet
+                                                          long notesheet long notesheet long notesheet long
+                                                          notesheet long notesheet long notesheet long notesheet
+                                                          long notesheet long notesheet
+                                               2:00:00
+      ------------------------------------------------------------------------------------------------------
+      Total                                    2:00:00
+            OUTPUT
 
-Timesheet: another
+            @desired_output_for_note_with_linebreak = <<-OUTPUT
+Timesheet: SheetWithLineBreakNote
     Day                Start      End        Duration   Notes
-    Sun Oct 05, 2008   18:00:00 -            2:00:00    a long entry note
+    Sun Oct 05, 2008   16:00:00 - 18:00:00   2:00:00    first line
+                                                        and a second line
                                              2:00:00
-    ---------------------------------------------------------------------
+    --------------------------------------------------------------------------------
     Total                                    2:00:00
--------------------------------------------------------------------------
-Grand Total                                 10:00:00
             OUTPUT
           end
 
@@ -484,10 +569,23 @@ Grand Total                                 10:00:00
           end
 
 
-          it "should display all timesheets" do
-            Timetrap::Timer.current_sheet = 'another'
-            invoke 'display all'
-            $stdout.string.should == @desired_output_for_all
+          it "should display long notes nicely" do
+            Timetrap::Timer.current_sheet = 'LongNoteSheet'
+            invoke 'display'
+            $stdout.string.should == @desired_output_for_long_note_sheet
+          end
+
+          it "should display long notes with linebreaks nicely" do
+            Timetrap::Timer.current_sheet = 'SheetWithLineBreakNote'
+            invoke 'display'
+            $stdout.string.should == @desired_output_for_note_with_linebreak
+          end
+
+          it "should display long notes with ids nicely" do
+            Timetrap::DB["UPDATE entries SET id = 60000 WHERE id = 6"].all
+            Timetrap::Timer.current_sheet = 'LongNoteSheet'
+            invoke 'display --ids'
+            $stdout.string.should == @desired_output_for_long_note_sheet_with_ids
           end
 
           it "should not display archived for all timesheets" do
@@ -617,17 +715,17 @@ start,end,note,sheet
             invoke 'in'
             invoke 'display --format ical'
 
-            $stdout.string.scan(/BEGIN:VEVENT/).should have(2).item
+            expect($stdout.string.scan(/BEGIN:VEVENT/).size).to eq(2)
           end
 
           it "should filter events by the passed dates" do
             invoke 'display --format ical --start 2008-10-03 --end 2008-10-03'
-            $stdout.string.scan(/BEGIN:VEVENT/).should have(1).item
+            expect($stdout.string.scan(/BEGIN:VEVENT/).size).to eq(1)
           end
 
           it "should not filter events by date when none are passed" do
             invoke 'display --format ical'
-            $stdout.string.scan(/BEGIN:VEVENT/).should have(2).item
+            expect($stdout.string.scan(/BEGIN:VEVENT/).size).to eq(2)
           end
 
           it "should export a sheet to an ical format" do
@@ -701,28 +799,56 @@ END:VCALENDAR
         end
 
         describe "with require_note config option set" do
-          before do
-            with_stubbed_config 'require_note' => true
-          end
+          context "without a note_editor" do
+            before do
+              with_stubbed_config 'require_note' => true, 'note_editor' => false
+            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 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"
+            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
 
-          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"
+          context "with a note editor" do
+            let(:note_editor_command) { 'vim' }
+            before do
+              with_stubbed_config 'require_note' => true, 'note_editor' => note_editor_command
+            end
+
+            it "should open an editor for writing the note" do |example|
+              Timetrap::CLI.stub(:system) do |editor_command|
+                path = editor_command.match(/#{note_editor_command} (?<path>.*)/)
+                File.write(path[:path], "written in editor")
+              end
+              invoke "in"
+              $stderr.string.should_not include('enter a note')
+              Timetrap::Timer.active_entry.note.should == "written in editor"
+            end
+
+            it "should preserve linebreaks from editor" do |example|
+              Timetrap::CLI.stub(:system) do |editor_command|
+                path = editor_command.match(/#{note_editor_command} (?<path>.*)/)
+                File.write(path[:path], "line1\nline2")
+              end
+              invoke "in"
+              Timetrap::Timer.active_entry.note.should == "line1\nline2"
+            end
           end
         end
 
@@ -868,10 +994,10 @@ END:VCALENDAR
       describe "kill" do
         it "should give me a chance not to fuck up" do
           entry = create_entry
-          lambda do
+          expect do
             $stdin.string = ""
             invoke "kill #{entry.sheet}"
-          end.should_not change(Timetrap::Entry, :count).by(-1)
+          end.not_to change(Timetrap::Entry, :count)
         end
 
         it "should delete a timesheet" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timetrap
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.11.0
 platform: ruby
 authors:
 - Sam Goldstein
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-08 00:00:00.000000000 Z
+date: 2016-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler