timetrap 1.15.1 → 1.15.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 14a3e67d1e91f4f7184416c8efd811211911fb40
-  data.tar.gz: 027cbe432274e39ac145ab725bb8a9bf1d719a5a
+SHA256:
+  metadata.gz: 5c87342eeaac646bc3e628a35549cb078a8aa5ad2e469dc14afe4bca7051bfe2
+  data.tar.gz: 9041a05cc7f251e4bcbff0dcf7335bdc613c1ab0a49103bd1068cca432823d22
 SHA512:
-  metadata.gz: 5cb63a6a5f3c7f93f3aba05d2799bb4e311990009945f71369f80344db16219f8c917fd02719ae991d1ac6ce1baea47479aed3547d6709ed2122edb1fd407975
-  data.tar.gz: 1318b4902b8c0d84e57be18830a9b51525b3a76c64fdfe1e46243d29818adeb61e549d7bb848706f02eac1009cc7b0e5c17b039a8483fc305940ceeb9fe52799
+  metadata.gz: 9b5e45261a137be9e44e07f127e60a21849517208df71dfabbe1a14483e4819aceec31892f02b4c2f0bf245674084a895e6398cc1c6e3c55910479e7763b26d7
+  data.tar.gz: c92729865ec97ff09633a2d5a195584eee9b94ae9168cde285b8df83c832a23d75b19741de86fda8f9aeb3fd225f2a7a53f84d225212d27adb5931559c8501f3

data/.github/pull_request_template.md

@@ -0,0 +1,29 @@
+<!--- Provide a general summary of your changes in the Title above -->
+
+## Description
+<!--- Describe your changes in detail -->
+
+## Motivation and Context
+<!--- Why is this change required? What problem does it solve? -->
+<!--- If it fixes an open issue, please link to the issue here. -->
+
+## How Has This Been Tested?
+<!--- Please describe in detail how you tested your changes. -->
+<!--- Include details of your testing environment, and the tests you ran to -->
+<!--- see how your change affects other areas of the code, etc. -->
+
+## Screenshots (if appropriate):
+
+## Types of changes
+<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+
+## Checklist:
+<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
+<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+- [ ] My code follows the code style of this project.
+- [ ] I have updated the documentation accordingly.
+- [ ] I have added tests to cover my changes.
+- [ ] All new and existing tests passed.

data/.github/workflows/rspec.yml

@@ -0,0 +1,16 @@
+name: rspec
+on:
+  - push
+  - pull_request
+
+jobs:
+  test:
+    name: Run Rspec
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.7'
+      - run: bundle install
+      - run: rspec spec

data/.gitignore

@@ -3,3 +3,4 @@ pkg
 *.swp
 Gemfile.lock
 .bundle
+vendor/bundle

data/.rspec

@@ -1,2 +1 @@
---color
---profile
+--require spec_helper

data/.travis.yml

@@ -1,6 +1,9 @@
+before_install:
+  - gem uninstall -v '< 2' -i $(rvm gemdir)@global -ax bundler || true
+  - gem install bundler -v '~> 2'
 language: ruby
 rvm:
-  - 2.1.8
-  - 2.2.4
-  - 2.3.3
   - 2.4.0
+  - 2.5.0
+  - 2.6.0
+  - 2.7.0

data/CONTRIBUTORS

@@ -16,3 +16,4 @@
 * Patrick Davey
 * Kyle Brett
 * Nam D. Nguyen (namdnguyen)
+* Bèr Kessels (berkes)

data/README.md

@@ -13,6 +13,15 @@ To install:
 
 This will place a ``t`` executable in your path.
 
+***UPDATE***: The current gem release seems to be having issues installing and the gem ownership on RubyGems.org is currently in the process of being transferred.  Meanwhile, here is how to build the latest master from source:
+
+    $ git clone https://github.com/samg/timetrap
+    $ cd timetrap
+    $ gem build timetrap
+    $ gem install timetrap_X.X.X.gem
+
+If you have errors while parsing the documentation, use `--no-document` option when installing the gem, or other option is to `gem install rdoc` before installing the `timetrap`. This is a known issue from [rdoc](https://github.com/ruby/rdoc/commit/5f9603f35d8e520c761015810c005e4a5beb97c3)
+
 ### Basic Usage
 
     $ # get help
@@ -64,7 +73,7 @@ If you make a mistake use the `edit` command.
 You check out with the `out` command.
 
     $ t out
-    Checked out of sheet "coding"
+    Checked out of entry "document timetrap" in sheet "coding"
 
 Running `edit` when you're checked out will edit the last entry you checked out
 of.
@@ -113,7 +122,7 @@ Command line flags also have short versions.
     $ # equivalent to the command above
     $ t i -a "5 minutes ago"
 
-You can consult the Chronic gem (http://chronic.rubyforge.org/) for a full
+You can consult the Chronic gem (https://github.com/mojombo/chronic) for a full
 list of parsable time formats, but all of these should work.
 
     $ t out --at "in 30 minutes"
@@ -308,7 +317,7 @@ Commands
 --------
 
 **archive**
-  Archives the selected entries (by moving them to a sheet called ``_[SHEET]``)
+  Archive 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] [--grep REGEX] [SHEET]``
@@ -320,8 +329,8 @@ Commands
   usage: ``t backend``
 
 **configure**
-  Creates a config file at  ``~/.timetrap.yml`` or ``ENV['TIMETRAP_CONFIG_FILE']`` if
-  one doesn't exist.  If one does exist it will update it with new
+  Create a config file at  ``~/.timetrap.yml`` or ``ENV['TIMETRAP_CONFIG_FILE']`` if
+  one doesn't exist.  If one does exist, update it with new
   configuration options preserving any user overrides. Prints path to config
   file.  This file may contain ERB.
 
@@ -344,7 +353,7 @@ Commands
   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
+  Insert a note associated with the an entry in the timesheet, or edit the
   start or end times.  Defaults to the current entry, or previously running
   entry. An ``--id`` flag can be passed with the entry's id (see display.)
 
@@ -512,6 +521,7 @@ 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
@@ -522,6 +532,29 @@ 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.
 
+Development
+-----------
+
+Get `bundler` in case you don't have it:
+
+    gem install bundler
+
+Set a local path for the project's dependencies:
+
+    bundle config set --local path 'vendor/bundle'
+
+Install timetrap's dependencies:
+
+    bundle install
+
+Now you can run your local timetrap installation:
+
+    bundle exec t
+
+Or run the test suite:
+
+    bundle exec rspec
+
 Special Thanks
 --------------
 

data/completions/bash/timetrap-autocomplete.bash

@@ -3,8 +3,9 @@ _timetrap ()
 {
   cur="${COMP_WORDS[COMP_CWORD]}"
   cmd="${COMP_WORDS[1]}"
+
   if [[ ( $cmd = s* || $cmd = d* ) && "$COMP_CWORD" = 2 ]]; then
-    COMPREPLY=($(compgen -W "$(echo "select distinct sheet from entries where sheet not like '\_%';" | sqlite3 ~/.timetrap.db)" $cur))
+    COMPREPLY=($(compgen -W "$(echo "select distinct sheet from entries where sheet not like '\_%';" | t b)" $cur))
     return
   elif [[ "$COMP_CWORD" = 1 ]]; then
     CMDS="archive backend configure display edit in kill list now out resume sheet week month"

data/lib/timetrap/cli.rb

@@ -71,6 +71,7 @@ COMMAND is one of:
     -z, --append              Append to the current note instead of replacing it
                                 the delimiter between appended notes is
                                 configurable (see configure)
+    -c, --clear               Allow an empty note, can be used to clear existing notes
     -m, --move <sheet>        Move to another sheet
 
   * in - Start the timer for the current timesheet.
@@ -247,14 +248,18 @@ COMMAND is one of:
       end
 
       if Config['note_editor']
-        if args['-z']
+        if args['-c']
+          entry.update :note => ''
+        elsif args['-z']
           note = [entry.note, get_note_from_external_editor].join(Config['append_notes_delimiter'])
           entry.update :note => note
         elsif editing_a_note?
           entry.update :note => get_note_from_external_editor(entry.note)
         end
       else
-        if unused_args =~ /.+/
+        if args['-c']
+          entry.update :note => ''
+        elsif unused_args =~ /.+/
           note = unused_args
           if args['-z']
             note = [entry.note, note].join(Config['append_notes_delimiter'])
@@ -324,7 +329,9 @@ COMMAND is one of:
     def out
       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}."
+          note = Timer.last_checkout.note
+          entry = note_blank?(note) ? Timer.last_checkout.id : note.inspect
+          warn "Checked out of entry #{entry} in sheet #{checked_out_of.sheet.inspect}."
         end
         if stopped.empty?
           warn "No running entries to stop."
@@ -332,7 +339,9 @@ COMMAND is one of:
       else
         sheet = sheet_name_from_string(unused_args)
         if Timer.stop sheet, args['-a']
-          warn "Checked out of sheet #{sheet.inspect}."
+          note = Timer.last_checkout.note
+          entry = note_blank?(note) ? Timer.last_checkout.id : note.inspect
+          warn "Checked out of entry #{entry} in sheet #{sheet.inspect}."
         else
           warn "No running entry on sheet #{sheet.inspect}."
         end
@@ -388,7 +397,13 @@ COMMAND is one of:
       end
 
       Timer.current_sheet = sheet
-      warn "Switching to sheet #{sheet.inspect}"
+      if Timer.last_sheet == sheet
+        warn "Already on sheet #{sheet.inspect}"
+      elsif Entry.sheets.include?(sheet)
+        warn "Switching to sheet #{sheet.inspect}"
+      else
+        warn "Switching to sheet #{sheet.inspect} (new sheet)"
+      end
     end
 
     def list
@@ -473,6 +488,10 @@ COMMAND is one of:
 
     private
 
+    def note_blank?(note)
+      note.inspect.to_s.gsub('"', '').strip.size.zero?
+    end
+
     def unused_args
       args.unused.join(' ')
     end

data/lib/timetrap/formatters/csv.rb

@@ -6,7 +6,7 @@ module Timetrap
       def initialize entries
         @output = entries.inject("start,end,note,sheet\n") do |out, e|
           next(out) unless e.end
-          out << %|"#{e.start.strftime(time_format)}","#{e.end.strftime(time_format)}","#{e.note}","#{e.sheet}"\n|
+          out << %|"#{e.start.strftime(time_format)}","#{e.end.strftime(time_format)}","#{escape(e.note)}","#{e.sheet}"\n|
         end
       end
 
@@ -14,6 +14,10 @@ module Timetrap
       def time_format
         "%Y-%m-%d %H:%M:%S"
       end
+
+      def escape(note)
+        note.gsub %q{"}, %q{""}
+      end
     end
   end
 end

data/lib/timetrap/formatters/ical.rb

@@ -4,7 +4,7 @@ rescue LoadError
   raise <<-ERR
 The icalendar gem must be installed for ical output.
 To install it:
-$ [sudo] gem install icalendar -v"~>1.1.5"
+$ [sudo] gem install icalendar
   ERR
 end
 
@@ -22,21 +22,13 @@ module Timetrap
       end
 
       def initialize entries
-        entries.each do |e|
-          next unless e.end
-          calendar.event do
-
-            # hack around an issue in ical gem in ruby 1.9
-            unless respond_to? :<=>
-              def <=> other
-                dtstart > other.dtstart ? 1 : 0
-              end
-            end
-
-            dtstart DateTime.parse(e.start.to_s)
-            dtend DateTime.parse(e.end.to_s)
-            summary e.note
-            description e.note
+        entries.each do |entry|
+          next unless entry.end
+          calendar.event do |e|
+            e.dtstart = DateTime.parse(entry.start.to_s)
+            e.dtend = DateTime.parse(entry.end.to_s)
+            e.summary = entry.note
+            e.description = entry.note
           end
         end
         calendar.publish

data/lib/timetrap/formatters/json.rb

@@ -16,7 +16,12 @@ module Timetrap
       def initialize entries
         @output = entries.map do |e|
           next unless e.end
-          e.values
+
+          e.values.inject({}) do |h, (k,v)|
+            h[k] = v
+            h[k] = e.public_send(k) if %i[end start].include?(k)
+            h
+          end
         end.compact.to_json
       end
     end

data/lib/timetrap/helpers.rb

@@ -40,16 +40,16 @@ module Timetrap
 
     def selected_entries
       ee = if (sheet = sheet_name_from_string(unused_args)) == 'all'
-        Timetrap::Entry.filter('sheet not like ? escape "!"', '!_%')
+        Timetrap::Entry.where(Sequel.lit('sheet not like ? escape "!"', '!_%'))
       elsif (sheet = sheet_name_from_string(unused_args)) == 'full'
-       Timetrap::Entry.filter()
+        Timetrap::Entry.where()
       elsif sheet =~ /.+/
-        Timetrap::Entry.filter('sheet = ?', sheet)
+        Timetrap::Entry.where(sheet: sheet)
       else
-        Timetrap::Entry.filter('sheet = ?', Timer.current_sheet)
+        Timetrap::Entry.where(sheet: Timer.current_sheet)
       end
-      ee = ee.filter('start >= ?', Date.parse(Timer.process_time(args['-s']).to_s)) if args['-s']
-      ee = ee.filter('start <= ?', Date.parse(Timer.process_time(args['-e']).to_s) + 1) if args['-e']
+      ee = ee.filter(Sequel.lit('start >= ?', Date.parse(Timer.process_time(args['-s']).to_s))) if args['-s']
+      ee = ee.filter(Sequel.lit('start <= ?', Date.parse(Timer.process_time(args['-e']).to_s) + 1)) if args['-e']
       ee = ee.order(:start)
       if args['-g']
         re = Regexp::new(args['-g'])

data/lib/timetrap/models.rb

@@ -1,7 +1,5 @@
 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
@@ -68,27 +66,10 @@ module Timetrap
     end
 
     private
-    # do a quick pseudo migration.  This should only get executed on the first run
-    set_schema do
-      primary_key :id
-      column :note, String
-      column :start, DateTime
-      column :end, DateTime
-      column :sheet, String
-    end
-    create_table unless table_exists?
+
   end
 
   class Meta < Sequel::Model(:meta)
-    plugin :schema
-
-    set_schema do
-      primary_key :id
-      column :key, String
-      column :value, String
-    end
-    create_table unless table_exists?
-
     def value
       self[:value].to_s
     end

data/lib/timetrap/schema.rb

@@ -0,0 +1,47 @@
+# Defines the table schemas. Acts as migration.
+#
+# Npte the executing below the classes. These create the tables
+module Timetrap
+  class Schema
+    def self.create_table!
+      DB.drop_table(self::TABLE)
+      create_table
+    end
+
+    def self.create_table
+      self.new.create_table
+    end
+
+    def self.try_create_table
+      create_table unless DB.table_exists?(self::TABLE)
+    end
+  end
+
+  class EntrySchema < Schema
+    TABLE = :entries
+    def create_table
+      DB.create_table(TABLE) do
+        primary_key :id
+        column :note, String
+        column :start, DateTime
+        column :end, DateTime
+        column :sheet, String
+      end
+    end
+  end
+
+  class MetaSchema < Schema
+    TABLE = :meta
+    def create_table
+      DB.create_table(TABLE) do
+        primary_key :id
+        column :key, String
+        column :value, String
+      end
+    end
+  end
+
+  ## Executes the schema, acting as a small migration
+  EntrySchema.try_create_table
+  MetaSchema.try_create_table
+end

data/lib/timetrap/version.rb

@@ -1,3 +1,3 @@
 module Timetrap
-  VERSION = '1.15.1'
+  VERSION = '1.15.4'
 end

data/lib/timetrap.rb

@@ -18,8 +18,12 @@ module Timetrap
   DB_NAME = defined?(TEST_MODE) ? nil : Timetrap::Config['database_file']
   # connect to database.  This will create one if it doesn't exist
   DB = Sequel.sqlite DB_NAME
-  CLI.args = Getopt::Declare.new(<<-EOF)
+  # only declare cli options when run as standalone
+  if %w[dev_t t timetrap].include?(File.basename($PROGRAM_NAME)) || defined?(TEST_MODE)
+    CLI.args = Getopt::Declare.new(<<-EOF)
     #{CLI::USAGE}
-  EOF
+    EOF
+  end
 end
+require File.expand_path(File.join(File.dirname(__FILE__), 'timetrap', 'schema'))
 require File.expand_path(File.join(File.dirname(__FILE__), 'timetrap', 'models'))

data/spec/spec_helper.rb

@@ -0,0 +1,40 @@
+# Constants
+TEST_MODE = true
+
+# Vendors
+require 'fakefs/safe'
+
+# Load support files from the spec/support directory
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].sort.each { |f| require f }
+
+# timetrap
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'timetrap'))
+
+# Config
+RSpec.configure do |config|
+  # Use color in STDOUT
+  config.color = true
+  # Use color not only in STDOUT but also in pagers and files
+  config.tty = true
+
+  # Display 10 slowest tests after a test run
+  config.profile_examples = false
+
+  # Use the specified formatter
+  # :documentation, :progress, :html, :json, CustomFormatterClass
+  config.formatter = :progress
+
+  # Specify order for spec to be run in
+  # TODO: make sure all specs pass when set to :rand
+  # config.order = :rand
+
+  # 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

data/spec/support/local_time.rb

@@ -0,0 +1,7 @@
+def local_time(str)
+  Timetrap::Timer.process_time(str)
+end
+
+def local_time_cli(str)
+  local_time(str).strftime('%Y-%m-%d %H:%M:%S')
+end

data/spec/support/with_rounding_on.rb

@@ -0,0 +1,9 @@
+def with_rounding_on
+  old_round = Timetrap::Entry.round
+  begin
+    Timetrap::Entry.round = true
+    block_return_value = yield
+  ensure
+    Timetrap::Entry.round = old_round
+  end
+end

data/spec/support/with_stubbed_config.rb

@@ -0,0 +1,7 @@
+def with_stubbed_config(options = {})
+  defaults = Timetrap::Config.defaults.dup
+  allow(Timetrap::Config).to receive(:[]) do |k|
+    defaults.merge(options)[k]
+  end
+  yield if block_given?
+end