ptimelog 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efde9baef775527079705c4a87dfa656a8df4f186381a88c6ebd51e0cfdfd4c8
-  data.tar.gz: d68a4f17937165e47fe381dedade07ab625ae98c426a30c6cf09d806a2b77466
+  metadata.gz: 3a7ad17dbf09bc8d7694f9261ffcc8216af2f1ec04be03e62ccabadf9732e8b0
+  data.tar.gz: 4ee34a775b9300e50971421adedee472fbfa5f5c0ec226b93e299d17474df411
 SHA512:
-  metadata.gz: 439357c8e138db02f373cdefedbcd3abd79e16aa5997a8140449327352e0efbdb436b293989b0a19086fcbe41a07c09e7743a3e68b9945cd885080e31b06f056
-  data.tar.gz: 2ca4a1333cd8f21fc07deb995f2ab31b62ada7a8b95286f050bb3f481adbddf85471df28be2c80b5a838c0a91d0e770dbf144830f1349298157161284d545a6f
+  metadata.gz: 198b9c6aefbab6f64b617a6b2ad125f9e9921c829e1740ca08faa41c69c797fda1cca1181665adec6b68b51560b3a5bed88ad3b23a8bceba6382dd4b222bb129
+  data.tar.gz: d37ed829daa68c7527caafe929874c6523986609661f9a9155463f0307ac2fb9d14d3237878d6c6659f799ca59c9536e8cae46770f21cdb13916753277beaf2c

data/.rubocop.yml

@@ -1,5 +1,14 @@
 inherit_from: .rubocop_todo.yml
 
+# require:
+#   - rubocop-rake
+#   - rubocop-rspec
+#   - rubocop-packaging
+#   - rubocop-performance
+
+AllCops:
+    NewCops: enable
+
 Layout/LineLength:
   Max: 120
 

data/.ruby-version

@@ -1 +1 @@
-2.6.3
+2.7.0

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.2

data/README.md

@@ -1,6 +1,8 @@
 # pTimeLog
 
-small tooling to transfer timelog-entries from gtimelog's timelog.txt to the PuzzleTime TimeTracking Website.
+small tooling to transfer timelog-entries from gtimelog's timelog.txt to the PuzzleTime Timetracking Website.
+
+[![Build Status](https://travis-ci.org/kronn/ptimelog.svg?branch=master)](https://travis-ci.org/kronn/ptimelog)
 
 ## Approach
 
@@ -24,8 +26,8 @@ small tooling to transfer timelog-entries from gtimelog's timelog.txt to the Puz
     - [ ] send user and pwd with every request
   - [ ] make entries
   - [ ] open day in browser for review
-- [ ] avoid duplicate entries
-  - [ ] start/end time as indicator?
+- [x] avoid duplicate entries
+  - [x] start/end time as indicator?
 - [x] offer rounding times to the next 5, 10 or 15 minutes
 - [x] allow to add entries from the command-line
 - [ ] handle time-account and billable better
@@ -58,10 +60,13 @@ Currently supported actions are
 - show
 - upload
 - edit
+- add
+- version
 
 ### Date-Identifier
 
-To handle a specific date, the format YYYY-MM-DD is expected, e.g. 2017-12-25. Please note that you should not work on that day, unless you bring presents.
+To handle a specific date, the format YYYY-MM-DD is expected, e.g. 2017-12-25.
+Please note that you should not work on that day, unless you bring presents.
 
 For reusability in a shell-history the following keywords are supported:
 
@@ -74,12 +79,44 @@ If nothing is specified, the action is applied to entries of the last day.
 
 ### Edit-Identifier
 
-When the action is "edit", the next argument is treated as script that should be edited.
+When the action is "edit", the next argument is treated as script that should
+be edited.
 
 If nothing is passed, the main timelog.txt is loaded.
 
 Otherwise, a script to determine the time-account is loaded.
 
+### Adding entries
+
+In order to add entries with the ptimelog-cli, the complete entry needs to be
+quoted on the command-line to count as one argument.
+
+    $ ptimelog add 'ticket 1337: Implement requirements -- client coding'
+
+While this requires some knowledge of the file-format, it is no different than
+entering the same string in gTimelog. For now, the entry is added to the
+timelog.txt as it is passed. By default, the date/time added to the entry is
+the one when the command is executed.
+
+You can prefix a positive or negative signed number to slightly skew the entry
+(think: '-5 meeting' or '+5 lunch \*\*') or even set a precise time ('10:30
+meeting').
+
+    $ ptimelog add '-5 meeting: Discuss requirements -- client planning'
+
+### Showing the Version
+
+I got tired of asking rubygems which version I installed, so I took on the
+herculean task of letting ptimelog show its own version.
+
+### Formatting the Output
+
+In order to format the output of the show-action into a table, a hopefully
+convienient field-marker has been chosen. I think it is unlikely, that ∴ is
+being used in a time-entry. Therefore, you can pipe the output into `column`:
+
+    ptimelog show today | column -t -s ∴
+
 ## Helper-Scripts
 
 ptimelog can prefill the account-number and billable-state of an entry.
@@ -102,8 +139,8 @@ scripts, the code is almost identical and "just" needs to be compiled.
 A config-file is read from `$HOME/.config/ptimelog/config`. It is expected
 to be a YAML-file. Currently, it supports the following keys:
 
-	- rounding: [integer or false, default 15]
-	- base_url: [url to your puzzletime-installation, default https://time.puzzle.ch]
+  - rounding: [integer or false, default 15]
+  - base_url: [url to your puzzletime-installation, default https://time.puzzle.ch]
 
 ## Development
 

data/lib/ptimelog/app.rb

@@ -7,7 +7,7 @@ module Ptimelog
       @config = Configuration.instance
       command = (args[0] || 'show')
 
-      constant_name = command.to_s[0].upcase + command[1..-1].downcase
+      constant_name = command.to_s[0].upcase + command[1..].downcase
       command_class = Command.const_get(constant_name.to_sym)
       raise ArgumentError, "Unsupported Command '#{command}'" if command_class.nil?
 

data/lib/ptimelog/command/add.rb

@@ -11,6 +11,7 @@ module Ptimelog
 
         @task = task
         @timelog = Ptimelog::Timelog.instance
+        @new_lines = []
       end
 
       def needs_entries?
@@ -18,12 +19,47 @@ module Ptimelog
       end
 
       def run
-        date_time = Time.now.strftime('%F %R')
+        add_empty_line if @timelog.previous_entry.date == yesterday
+        add_entry(*parse_task(@task))
 
+        save_file
+      end
+
+      private
+
+      def parse_task(line)
+        matches = line.match('(?<time>\d{1,2}:\d{2} )?(?<offset>[+-]\d+ )?(?<task>.*)')
+        formatted_time = if matches[:time]
+                           Time.parse(matches[:time])
+                         else
+                           Time.now
+                         end
+                         .localtime
+                         .then { |time| time + (matches[:offset].to_i * 60) }
+                         .strftime('%F %R')
+
+        [formatted_time, matches[:task]]
+      end
+
+      def add_entry(date_time, task)
+        @new_lines << "#{date_time}: #{task}"
+      end
+
+      def add_empty_line
+        @new_lines << ''
+      end
+
+      def save_file
         @timelog.timelog_txt.open('a') do |log|
-          log << "#{date_time}: #{@task}\n"
+          @new_lines.each do |line|
+            log << "#{line}\n"
+          end
         end
       end
+
+      def yesterday
+        NamedDate.new.named_date('yesterday')
+      end
     end
   end
 end

data/lib/ptimelog/command/show.rb

@@ -18,6 +18,9 @@ module Ptimelog
         @entries.each do |date, list|
           puts date,
                '----------'
+
+          next if list.empty?
+
           list.each do |entry|
             puts entry
           end

data/lib/ptimelog/configuration.rb

@@ -2,6 +2,7 @@
 
 require 'singleton'
 require 'pathname'
+require 'yaml'
 
 module Ptimelog
   # Wrapper around configuration-options and -loading
@@ -9,10 +10,10 @@ module Ptimelog
     include Singleton
 
     CONFIGURATION_DEFAULTS = {
-      base_url: 'https://time.puzzle.ch',
-      rounding: 15,
-      dir:      '~/.config/ptimelog',
-      timelog:  '~/.local/share/gtimelog/timelog.txt',
+      'base_url' => 'https://time.puzzle.ch',
+      'rounding' => 15,
+      'dir'      => '~/.config/ptimelog',
+      'timelog'  => '~/.local/share/gtimelog/timelog.txt',
     }.freeze
 
     def initialize
@@ -21,10 +22,12 @@ module Ptimelog
 
     def reset
       @config = load_config(
-        Pathname.new(CONFIGURATION_DEFAULTS[:dir]).join('config')
+        Pathname.new(CONFIGURATION_DEFAULTS['dir'])
+                .expand_path
+                .join('config')
       )
-      wrap_with_pathname(:dir)
-      wrap_with_pathname(:timelog)
+      wrap_with_pathname('dir')
+      wrap_with_pathname('timelog')
     end
 
     def load_config(fn)
@@ -34,13 +37,13 @@ module Ptimelog
     end
 
     def [](key)
-      @config[key.to_sym]
+      @config[key.to_s]
     end
 
     def []=(key, value)
-      @config[key.to_sym] = value
+      @config[key.to_s] = value
 
-      wrap_with_pathname(key.to_sym) if %w[dir timelog].include?(key.to_s)
+      wrap_with_pathname(key.to_s) if %w[dir timelog].include?(key.to_s)
     end
 
     private

data/lib/ptimelog/day.rb

@@ -9,10 +9,10 @@ module Ptimelog
 
     def entries
       timelog.each_with_object({}) do |(date, lines), entries|
-        next unless date                           # guard against the machine
-        next unless @date == :all || @date == date # limit to one day if passed
+        next unless date # guard against the machine
+        next unless @date.to_s == 'all' || @date == date # limit to one day if passed
 
-        entries[date] = join_similar(entries_of_day(lines)) # lines |> entries_of_day |> join_similar"
+        entries[date] = join_similar(entries_of_day(lines)) # lines |> entries_of_day |> join_similar
       end
     end
 

data/lib/ptimelog/entry.rb

@@ -5,12 +5,11 @@ require 'time'
 module Ptimelog
   # Dataclass to wrap an entry
   class Entry
-    # allow to read everything
-    attr_reader :date, :start_time, :finish_time, :ticket, :description,
-                :tags, :billable, :account
-
     # define only trivial writers, omit special and derived values
-    attr_writer :date,                            :ticket, :description
+    attr_accessor :date, :ticket, :description
+
+    # allow to read everything else
+    attr_reader :start_time, :finish_time, :tags, :billable, :account
 
     BILLABLE     = 1
     NON_BILLABLE = 0
@@ -54,7 +53,7 @@ module Ptimelog
     end
 
     def valid?
-      @start_time && !hidden?
+      @start_time && duration.positive? && !hidden?
     end
 
     def hidden?
@@ -77,10 +76,16 @@ module Ptimelog
     end
 
     def to_s
-      billable = billable? ? '$' : nil
+      billable = billable? ? '($)' : nil
+      tag_list = Array(@tags).compact
+
+      tags = tag_list.join(' ') if tag_list.any?
+      desc = [@ticket, @description].compact.join(': ')
+      acc  = [@account, billable].compact.join(' ') if @account
+
       [
-        @start_time, '-', @finish_time,
-        [@ticket, @description, @tags, @account, billable].compact.join(' ∴ '),
+        @start_time, '-', @finish_time, '∴',
+        [desc, tags, acc].compact.join(' ∴ '),
       ].compact.join(' ')
     end
 
@@ -107,7 +112,7 @@ module Ptimelog
     end
 
     def script_args
-      @script_args ||= @tags.to_a[1..-1].to_a.map(&:inspect).join(' ')
+      @script_args ||= @tags.to_a[1..].to_a.map(&:inspect).join(' ')
     end
 
     def infer_account_and_billable

data/lib/ptimelog/named_date.rb

@@ -9,17 +9,39 @@ module Ptimelog
       named_date(arg) || :all
     end
 
-    def named_date(date)
+    def named_date(date) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/AbcSize
       case date.to_s
-      when 'yesterday'        then Date.today.prev_day.to_s
+      when 'yesterday'        then yesterday
       when 'today'            then Date.today.to_s
-      when 'last', ''         then timelog.to_h.keys.compact.sort[-2] || Date.today.prev_day.to_s
-      when /\d{4}(-\d{2}){2}/ then date
+      when 'last', ''         then last_entry.to_s || yesterday
+      when 'mon', 'monday'    then previous_weekday('monday')
+      when 'tue', 'tuesday'   then previous_weekday('tuesday')
+      when 'wed', 'wednesday' then previous_weekday('wednesday')
+      when 'thu', 'thursday'  then previous_weekday('thursday')
+      when 'fri', 'friday'    then previous_weekday('friday')
+      when 'sat', 'saturday'  then previous_weekday('saturday')
+      when 'sun', 'sunday'    then previous_weekday('sunday')
+      when /\d{4}(-\d{2}){2}/ then date.to_s
       end
     end
 
     private
 
+    def previous_weekday(date)
+      Date.today.prev_day(7)
+          .step(Date.today.prev_day)
+          .find { |d| d.send(:"#{date}?") }
+          .to_s
+    end
+
+    def last_entry
+      timelog.to_h.keys.compact.sort[-2]
+    end
+
+    def yesterday
+      Date.today.prev_day.to_s
+    end
+
     def timelog
       Timelog.load
     end

data/lib/ptimelog/timelog.rb

@@ -15,6 +15,14 @@ module Ptimelog
       def timelog_txt
         Pathname.new(Configuration.instance[:timelog]).expand_path
       end
+
+      def previous_entry
+        lines = timelog_txt.readlines.last(2)
+        last_line = lines.map(&:chomp).delete_if(&:empty?).last
+        last_entry = instance.tokenize(last_line)
+
+        Entry.from_timelog(last_entry)
+      end
     end
 
     def load
@@ -25,6 +33,10 @@ module Ptimelog
       self.class.timelog_txt
     end
 
+    def previous_entry
+      self.class.previous_entry
+    end
+
     def read
       timelog_txt.read
     end

data/lib/ptimelog/version.rb

@@ -16,5 +16,5 @@
 # with an improvement. Keep in mind that this is also covered by rspec so I
 # expect (pun intended) 100% test-coverage for any additional code.
 module Ptimelog
-  VERSION = '0.9.0'
+  VERSION = '0.10.0'
 end

data/ptimelog.gemspec

@@ -22,6 +22,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.7.0'
+
   spec.add_dependency 'naught'
 
   spec.add_development_dependency 'bundler'
@@ -30,5 +32,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0.50'
+  # spec.add_development_dependency 'rubocop-rake'
+  # spec.add_development_dependency 'rubocop-rspec'
+  # spec.add_development_dependency 'rubocop-packaging'
+  # spec.add_development_dependency 'rubocop-performance'
   spec.add_development_dependency 'timecop', '~> 0.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ptimelog
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Matthias Viehweger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-08 00:00:00.000000000 Z
+date: 2021-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: naught
@@ -136,8 +136,8 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".ruby-gemset"
 - ".ruby-version"
+- ".tool-versions"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -176,14 +176,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Move time-entries from gTimelog to PuzzleTime

data/.ruby-gemset

@@ -1 +0,0 @@
-gpuzzletime