gpuzzletime 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad32482efc9bdb226539c6ff78448407dc53abd9290d245d9d90303c97b8a8d4
-  data.tar.gz: f10bf0669eb02e48aa06ea0f668af33b79a641f88c1dc0fbbc578dfa9694f357
+  metadata.gz: da04f6e2158de538ed579e152023e1577f4743eaf869148398cad63cc4602e7e
+  data.tar.gz: 1cbf496d462a395a0466e7fe0d94ef54ef3bd59c64caccfa7c3a77e5ca013fe7
 SHA512:
-  metadata.gz: 94eb248ad45b98d633af96960952edbe7067d0fed37623769b0ca1d7fb1830f39b4173b9ac84608c26bb7c5a9256ca323a731a1a2c202e1c5be4b1c366fa6c71
-  data.tar.gz: cf5212b3a8846f48e4a09f02deef0337ec5ce01861797982c53670e67610549af3427ec89705704b06ac44add75ceeb19a0982f9522948cb11f7c84fb05bb039
+  metadata.gz: e35352a95c6bc0bda0ce852f7b95c9681ca508d094239b754d5081fdb625c0d8e0eafd50983206b70ef2fbd7656164f3965d4d730612eec786c6dd1fe580ae4d
+  data.tar.gz: 8ca1ea92a1036ce3f9a791d2d565728dcc7ecd2afe510cb04f60579e57d0ce3eaf78d7e5c7fb9f3208ec58cbac01c8117e5b3361befc8b4c2b8599869d14d860

data/.rubocop.yml

@@ -1,6 +1,12 @@
+inherit_from: .rubocop_todo.yml
+
 Metrics/LineLength:
   Max: 120
 
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
 Style/TrailingCommaInArrayLiteral:
   EnforcedStyleForMultiline: consistent_comma
 
@@ -11,7 +17,3 @@ Layout/AlignHash:
   EnforcedHashRocketStyle: table
   EnforcedColonStyle: table
   EnforcedLastArgumentHashStyle: always_inspect # default
-
-Metrics/BlockLength:
-  Exclude:
-    - spec/**/*

data/.rubocop_todo.yml

@@ -0,0 +1,25 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-06-11 08:46:25 +0200 using RuboCop version 0.65.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 28
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 153
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+# Offense count: 3
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 27

data/README.md

@@ -25,7 +25,7 @@ small tooling to transfer timelog-entries from gtimelog's timelog.txt to the Puz
   - [ ] open day in browser for review
 - [ ] avoid duplicate entries
   - [ ] start/end time as indicator?
-- [ ] offer rounding times to the next 5, 10 or 15 minutes
+- [x] offer rounding times to the next 5, 10 or 15 minutes
 - [ ] allow to add entries from the command-line
 - [ ] handle time-account and billable better
   - [ ] import time-accounts from ptime (https://time.puzzle.ch/work_items/search.json?q=search%20terms)
@@ -83,19 +83,27 @@ Otherwise, a script to determine the time-account is loaded.
 gpuzzletime can prefill the account-number and billable-state of an entry.
 
 The tags are used to determine a script that helps infer the time-account.
-These scripts should be located in ~/.config/gpuzzletime/parsers/ and be named
+These scripts should be located in `~/.config/gpuzzletime/parsers/` and be named
 like the first tag used. The script gets the ticket, the description and all
 remaining tags passed as arguments. The output of the script should only be the
 ID of the time-account.
 
 In order to infer the billable-state of an entry, a script
-~/.config/gpuzzletime/billable is called. It only gets the previously infered
+`~/.config/gpuzzletime/billable` is called. It only gets the previously infered
 account-id as argument and is expected to output "true" or "false".
 
 Since these script are called a lot, it is better to write them in a compiled
 language. If you only like ruby, take a look at crystal. For such simple
 scripts, the code is almost identical and "just" needs to be compiled.
 
+## Configuration
+
+A config-file is read from `$HOME/.config/gpuzzletime/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]
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run

data/Rakefile

@@ -2,7 +2,9 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
-task default: :spec
+task default: %i[rubocop spec]

data/lib/gpuzzletime.rb

@@ -5,5 +5,6 @@ $LOAD_PATH.unshift File.dirname(__FILE__)
 # Autoloading and such
 module Gpuzzletime
   autoload :App, 'gpuzzletime/app'
+  autoload :Timelog, 'gpuzzletime/timelog'
   autoload :VERSION, 'gpuzzletime/version'
 end

data/lib/gpuzzletime/app.rb

@@ -7,9 +7,14 @@ require 'pathname'
 module Gpuzzletime
   # Wrapper for everything
   class App
-    def initialize(args)
-      @base_url = 'https://time.puzzle.ch'
+    CONFIGURATION_DEFAULTS = {
+      base_url: 'https://time.puzzle.ch',
+      rounding: 15,
+      dir:      Pathname.new('~/.config/gpuzzletime').expand_path,
+    }.freeze
 
+    def initialize(args)
+      @config  = load_config(CONFIGURATION_DEFAULTS[:dir].join('config'))
       @command = (args[0] || :show).to_sym
 
       case @command
@@ -48,22 +53,32 @@ module Gpuzzletime
 
     private
 
+    def load_config(config_fn)
+      user_config = config_fn.exist? ? YAML.load_file(config_fn) : {}
+
+      CONFIGURATION_DEFAULTS.merge(user_config)
+    end
+
     def entries
       @entries ||= {}
     end
 
+    def timelog
+      Timelog.load
+    end
+
     def fill_entries(purpose)
-      parse(read).each do |date, lines|
+      timelog.each do |date, lines|
         # this is mixing preparation, assembly and output, but gets the job done
         next unless date                           # guard against the machine
         next unless @date == :all || @date == date # limit to one day if passed
 
         entries[date] = []
 
-        start = nil             # at the start of the day, we have no previous end
+        start = nil # at the start of the day, we have no previous end
 
         lines.each do |entry|
-          finish = entry[:time] # we use that twice
+          finish = round_time(entry[:time], @config[:rounding]) # we use that twice
           hidden = entry[:description].match(/\*\*$/) # hide lunch and breaks
 
           if start && !hidden
@@ -88,12 +103,25 @@ module Gpuzzletime
       end
     end
 
+    def round_time(time, interval)
+      return time unless interval
+
+      hour, minute = time.split(':')
+      minute = (minute.to_i / interval.to_f).round * interval.to_i
+
+      if minute == 60
+        [hour.succ, 0]
+      else
+        [hour, minute]
+      end.map { |part| part.to_s.rjust(2, '0') }.join(':')
+    end
+
     def open_browser(start, entry)
-      xdg_open "'#{@base_url}/ordertimes/new?#{url_options(start, entry)}'", silent: true
+      xdg_open "'#{@config[:base_url]}/ordertimes/new?#{url_options(start, entry)}'", silent: true
     end
 
     def xdg_open(args, silent: false)
-      opener   = 'xdg-open'
+      opener   = 'xdg-open' # could be configurable, but is already a proxy
       silencer = '> /dev/null 2> /dev/null'
 
       if system("which #{opener} #{silencer}")
@@ -104,6 +132,9 @@ module Gpuzzletime
 
           This binary is needed to launch a webbrowser and open the page
           to enter the worktime-entry into puzzletime.
+
+          If this needs to be configurable, please open an issue at
+          https://github.com/kronn/gpuzzletime/issues/new
         ERRORMESSAGE
       end
     end
@@ -111,7 +142,7 @@ module Gpuzzletime
     def launch_editor
       editor = `which $EDITOR`.chomp
 
-      file = @file.nil? ? timelog_txt : parser_file(@file)
+      file = @file.nil? ? Timelog.timelog_txt : parser_file(@file)
 
       exec "#{editor} #{file}"
     end
@@ -123,7 +154,7 @@ module Gpuzzletime
         'ordertime[ticket]':          entry[:ticket],
         'ordertime[description]':     entry[:description],
         'ordertime[from_start_time]': start,
-        'ordertime[to_end_time]':     entry[:time],
+        'ordertime[to_end_time]':     round_time(entry[:time], @config[:rounding]),
         'ordertime[account_id]':      account,
         'ordertime[billable]':        infer_billable(account),
       }
@@ -135,40 +166,14 @@ module Gpuzzletime
       case date
       when 'yesterday'        then Date.today.prev_day.to_s
       when 'today'            then Date.today.to_s
-      when 'last'             then parse(read).to_h.keys.compact.sort[-2] || Date.today.prev_day.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
       end
     end
 
-    def timelog_txt
-      Pathname.new('~/.local/share/gtimelog/timelog.txt').expand_path
-    end
-
-    def read
-      timelog_txt.read
-    end
-
-    def parse(data)
-      data.split("\n")
-          .map { |line| tokenize(line) }
-          .group_by { |match| match && match[:date] }
-          .to_a
-    end
-
-    def tokenize(line)
-      re_date = /(?<date>\d{4}-\d{2}-\d{2})/
-      re_time = /(?<time>\d{2}:\d{2})/
-      re_tick = /(?:(?<ticket>.*?): )/
-      re_desc = /(?<description>.*?)/
-      re_tags = /(?: -- (?<tags>.*)?)/
-
-      regexp = /^#{re_date} #{re_time}: #{re_tick}?#{re_desc}#{re_tags}?$/
-      line.match(regexp)
-    end
-
     def parser_file(parser_name)
-      Pathname.new("~/.config/gpuzzletime/parsers/#{parser_name}") # FIXME: security-hole, prevent relative paths!
-              .expand_path
+      @config[:dir].join("parsers/#{parser_name}") # FIXME: security-hole, prevent relative paths!
+                   .expand_path
     end
 
     def infer_account(entry)
@@ -186,7 +191,7 @@ module Gpuzzletime
     end
 
     def infer_billable(account)
-      script = Pathname.new('~/.config/gpuzzletime/billable').expand_path
+      script = @config[:dir].join('billable')
 
       return 1 unless script.exist?
 

data/lib/gpuzzletime/timelog.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module Gpuzzletime
+  # Load and tokenize the data from gtimelog
+  class Timelog
+    class << self
+      def load
+        new.load
+      end
+
+      def timelog_txt
+        Pathname.new('~/.local/share/gtimelog/timelog.txt').expand_path
+      end
+    end
+
+    def load
+      parse(read)
+    end
+
+    def timelog_txt
+      self.class.timelog_txt
+    end
+
+    def read
+      timelog_txt.read
+    end
+
+    def parse(data)
+      data.split("\n")
+          .map { |line| tokenize(line) }
+          .group_by { |match| match && match[:date] }
+          .to_a
+    end
+
+    def tokenize(line)
+      re_date = /(?<date>\d{4}-\d{2}-\d{2})/
+      re_time = /(?<time>\d{2}:\d{2})/
+      re_tick = /(?:(?<ticket>.*?): )/
+      re_desc = /(?<description>.*?)/
+      re_tags = /(?: -- (?<tags>.*)?)/
+
+      regexp = /^#{re_date} #{re_time}: #{re_tick}?#{re_desc}#{re_tags}?$/
+      line.match(regexp)
+    end
+  end
+end

data/lib/gpuzzletime/version.rb

@@ -2,5 +2,5 @@
 
 # Version
 module Gpuzzletime
-  VERSION = '0.3.2'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gpuzzletime
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Matthias Viehweger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-26 00:00:00.000000000 Z
+date: 2019-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -120,6 +120,7 @@ files:
 - ".overcommit.yml"
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
@@ -133,6 +134,7 @@ files:
 - gpuzzletime.gemspec
 - lib/gpuzzletime.rb
 - lib/gpuzzletime/app.rb
+- lib/gpuzzletime/timelog.rb
 - lib/gpuzzletime/version.rb
 homepage: https://github.com/kronn/gpuzzletime
 licenses: