ptimelog 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4683decb77f362d2861b903e30db9dcb330151f7ee43d6ddb3c332d3af4243b2
-  data.tar.gz: 23c0c132975613fb3f16c064930e6aa72b49e28fbd7cd9b3636aef6863cbb1e4
+  metadata.gz: 53f453d27b45af79d5bef690d87c5ad36984848f3df02a3114cc60fb3e4a4dbf
+  data.tar.gz: 77c4269e3d12bc42db29624bf4b06e2092f1c60459d13aed8a2d3bf28e03ba12
 SHA512:
-  metadata.gz: e24c93aefa5a8ae475013593af737f872bade8f0f02997551bd2fe2cce049e64bd42869fe9648630f1b02191f2f7fc87883b942a9e266492c0fa09227c51b592
-  data.tar.gz: 043b2383d127e1aeccb716f8e14e47a365cdc309862c0d1309916ceb1695b194e1cb9aad1e4bc5f63f3b9a95aa3aae55981606018370b03d077a1f5a3d42159a
+  metadata.gz: 6db9a06490897de96ca955ad900876f8848482a2dfe1796cdf1f0dfdbb35ed0d44f61616e2c00fa56acc1cc427b3e39645b37fc65cf7144f55f414fd762fc15b
+  data.tar.gz: d6e38738b5f4384b03edac240bdcd7622e2812d8d056529d26d10903b6d1e73e3c72e1f3b4bfede1e4a234c5738ec8171d0385d276f3ab7843a8675759361251

data/.rubocop.yml

@@ -1,6 +1,6 @@
 inherit_from: .rubocop_todo.yml
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 120
 
 Metrics/BlockLength:
@@ -13,12 +13,12 @@ Style/TrailingCommaInArrayLiteral:
 Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: consistent_comma
 
-Layout/AlignHash:
+Layout/HashAlignment:
   EnforcedHashRocketStyle: table
   EnforcedColonStyle: table
   EnforcedLastArgumentHashStyle: always_inspect # default
 
-Naming/UncommunicativeMethodParamName:
+Naming/MethodParameterName:
   AllowedNames:
     - fn
     # default allowed names

data/.rubocop_todo.yml

@@ -1,12 +1,12 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-08-06 22:23:40 +0200 using RuboCop version 0.65.0.
+# on 2020-01-22 14:10:50 +0100 using RuboCop version 0.79.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: 3
+# Offense count: 4
 Metrics/AbcSize:
   Max: 16
 

data/README.md

@@ -37,6 +37,7 @@ small tooling to transfer timelog-entries from gtimelog's timelog.txt to the Puz
     - [ ] from *-notation
   - [ ] allow to have a list of "favourite" time-accounts
   - [ ] select best-matching time-account according to tags, possibly limited to the favourites
+  - [x] combine billable and account-lookup into one script
 - [ ] add cli-help
   - [ ] use commander for CLI?
 
@@ -84,16 +85,15 @@ Otherwise, a script to determine the time-account is loaded.
 ptimelog 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/ptimelog/parsers/` and be named
+These scripts should be located in `~/.config/ptimelog/inferers/` 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.
+remaining tags passed as arguments.
 
-In order to infer the billable-state of an entry, a script
-`~/.config/ptimelog/billable` is called. It only gets the previously infered
-account-id as argument and is expected to output "true" or "false".
+The output of the script should be the ID of the time-account and the
+billable-state as "true" or "false". Both items need to be separated by
+whitespace, so you can output those two on the same line or on different lines.
 
-Since these script are called a lot, it is better to write them in a compiled
+Since these scripts 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.
 

data/lib/ptimelog/command/edit.rb

@@ -13,7 +13,7 @@ module Ptimelog
       end
 
       def run
-        launch_editor(@file)
+        launch_editor(find_file(@file))
       end
 
       private
@@ -21,10 +21,50 @@ module Ptimelog
       def launch_editor(file)
         editor = `which $EDITOR`.chomp
 
-        file = file.nil? ? Timelog.timelog_txt : @scripts.parser(@file)
-
         exec "#{editor} #{file}"
       end
+
+      def find_file(requested_file)
+        %i[
+          timelog
+          existing_inferer
+          existing_parser
+          billable
+          empty_inferer
+        ].each do |file_lookup|
+          valid, filename = send(file_lookup, requested_file)
+
+          return filename if valid
+        end
+      end
+
+      def timelog(file)
+        [file.nil?, Timelog.timelog_txt]
+      end
+
+      def existing_inferer(file)
+        fn = @scripts.inferer(file)
+
+        [fn.exist?, fn]
+      end
+
+      def existing_parser(file)
+        fn = @scripts.parser(file)
+
+        [fn.exist?, fn]
+      end
+
+      def billable(file)
+        [file == 'billable', @scripts.billable]
+      end
+
+      def empty_inferer(file)
+        [true, @scripts.inferer(file)]
+      end
+
+      def empty_parser(file)
+        [true, @scripts.parser(file)]
+      end
     end
   end
 end

data/lib/ptimelog/command/show.rb

@@ -30,6 +30,7 @@ module Ptimelog
                 entry.description,
                 entry.tags,
                 entry.account,
+                (entry.billable? ? '$' : nil),
               ].compact.join(' ∴ '),
             ].compact.join(' ')
           end

data/lib/ptimelog/deprecation_warning.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Ptimelog
+  # Allow to add some (hopefully) helpful deprecation warning
+  module DeprecationWarning
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    # Keep track of wether the deprecation have been shown already or not
+    module ClassMethods
+      def deprecation_warning_rendered?
+        @deprecation_warning_rendered == true
+      end
+
+      def reset_deprecation_warning!
+        @deprecation_warning_rendered = false
+      end
+
+      def deprecation_warning_rendered!
+        @deprecation_warning_rendered = true
+      end
+    end
+
+    def deprecate(*args)
+      warn deprecate_header(*args)
+
+      return if self.class.deprecation_warning_rendered?
+
+      warn deprecate_message(*args)
+      self.class.deprecation_warning_rendered!
+    end
+
+    def deprecate_header(_)
+      raise <<~MESSAGE
+        deprecate_header(args) not implemented
+
+        Please define a header/short-info for the deprecation, rendered every
+        time the deprecation is hit.
+      MESSAGE
+    end
+
+    def deprecate_message(_)
+      raise <<~MESSAGE
+        deprecate_message(args) not implemented
+
+        Please define a message () for the deprecation, rendered only the first
+        time the deprecation is hit.
+      MESSAGE
+    end
+  end
+end

data/lib/ptimelog/entry.rb

@@ -10,6 +10,9 @@ module Ptimelog
     # define only trivial writers, omit special and derived values
     attr_writer :date,                            :ticket, :description
 
+    BILLABLE     = 1
+    NON_BILLABLE = 0
+
     def initialize(config = Configuration.instance)
       @config = config
       @script = Script.new(@config[:dir])
@@ -53,23 +56,29 @@ module Ptimelog
     end
 
     def hidden?
-      @description =~ /\*\*$/ # hide lunch and breaks
+      @description.to_s.end_with?('**') # hide lunch and breaks
+    end
+
+    def billable?
+      @billable == BILLABLE
     end
 
+    # this method will be reduced in 0.7, when support for parsers is removed
     def infer_ptime_settings
-      @account  = infer_account
-      @billable = infer_billable
+      return if hidden?
+
+      if @script.inferer(script_name).exist?
+        @account, @billable = infer_account_and_billable
+      else
+        @account  = infer_account
+        @billable = infer_billable
+      end
     end
 
     def to_s
       [
         @start_time, '-', @finish_time,
-        [
-          @ticket,
-          @description,
-          @tags,
-          @account,
-        ].compact.join(' : '),
+        [@ticket, @description, @tags, @account].compact.join(' : '),
       ].compact.join(' ')
     end
 
@@ -92,24 +101,43 @@ module Ptimelog
       end.map { |part| part.to_s.rjust(2, '0') }.join(':')
     end
 
-    def infer_account
-      return unless @tags
+    def script_name
+      @script_name ||= @tags.to_a.first.to_s
+    end
 
-      parser_name = @tags.first
-      parser = @script.parser(parser_name)
+    def script_args
+      @script_args ||= @tags.to_a[1..-1].to_a.map(&:inspect).join(' ')
+    end
 
+    # this method will be removed in 0.7, when support for parsers is removed
+    def infer_account
+      parser = @script.parser(script_name)
       return unless parser.exist?
 
-      cmd = %(#{parser} "#{@ticket}" "#{@description}" #{@tags[1..-1].map(&:inspect).join(' ')})
+      @script.deprecate(parser)
+
+      cmd = %(#{parser} "#{@ticket}" "#{@description}" #{script_args})
       `#{cmd}`.chomp # maybe only execute if parser is in correct dir?
     end
 
+    # this method will be removed in 0.7, when support for billable is removed
     def infer_billable
       script = @script.billable
+      return BILLABLE unless script.exist?
+
+      @script.deprecate(script)
+
+      `#{script} #{@account}`.chomp == 'true' ? BILLABLE : NON_BILLABLE
+    end
+
+    def infer_account_and_billable
+      script = @script.inferer(script_name)
+
+      cmd = %(#{script} "#{@ticket}" "#{@description}" #{script_args})
 
-      return 1 unless script.exist?
+      account, billable = `#{cmd}`.chomp.split
 
-      `#{script} #{@account}`.chomp == 'true' ? 1 : 0
+      [account, (billable == 'true' ? BILLABLE : NON_BILLABLE)]
     end
   end
 end

data/lib/ptimelog/null_pathname.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'naught'
+require 'pathname'
+
+NullPathname = Naught.build do |config|
+  config.impersonate Pathname
+  config.predicates_return false
+end

data/lib/ptimelog/script.rb

@@ -16,5 +16,27 @@ module Ptimelog
     def billable
       @config_dir.join('billable').expand_path
     end
+
+    def inferer(name)
+      return NullPathname.new if name.to_s.empty?
+      raise if name =~ %r{[\\/]} # prevent relavtive paths, stupidly, FIXME: really check FS
+
+      @config_dir.join('inferers').join(name).expand_path
+    end
+
+    include DeprecationWarning
+
+    def deprecate_message(_)
+      <<~MESSAGE
+        Please move the parser- and billable-scripts to an inferer-script.
+        Support for the previous scripts in parsers/* and billable will
+        be dropped in 0.7.
+
+      MESSAGE
+    end
+
+    def deprecate_header(script_fn)
+      "DEPRECATION NOTICE: #{script_fn} is deprecated"
+    end
   end
 end

data/lib/ptimelog/version.rb

@@ -1,6 +1,20 @@
 # frozen_string_literal: true
 
-# Version
+# the version, following semver
+#
+# Someone wanted to have documentation, so here goes...
+#
+# Please note that the version-string is not frozen. Although it of course is,
+# because all strings in this file are frozen. That's what the magic comment
+# at the top of the file does. :gasp:
+#
+# What else? Yeah, the VERSION-constant is part of the module Ptimelog because
+# that is what is described here.
+#
+# So, I truly hope you are happy now, that I documented this file properly. For
+# any remaining questions, please open an issue or even better a pull-request
+# 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.5.3'
+  VERSION = '0.6.0'
 end

data/lib/ptimelog.rb

@@ -6,8 +6,10 @@ $LOAD_PATH.unshift File.dirname(__FILE__)
 module Ptimelog
   autoload :App, 'ptimelog/app'
   autoload :Configuration, 'ptimelog/configuration'
+  autoload :DeprecationWarning, 'ptimelog/deprecation_warning'
   autoload :Entry, 'ptimelog/entry'
   autoload :NamedDate, 'ptimelog/named_date'
+  autoload :NullPathname, 'ptimelog/null_pathname'
   autoload :Script, 'ptimelog/script'
   autoload :Timelog, 'ptimelog/timelog'
   autoload :VERSION, 'ptimelog/version'

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.add_dependency 'naught'
+
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'overcommit', '~> 0.45'
   spec.add_development_dependency 'pry', '~> 0.12'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ptimelog
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Matthias Viehweger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-15 00:00:00.000000000 Z
+date: 2020-01-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: naught
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -138,8 +152,10 @@ files:
 - lib/ptimelog/command/show.rb
 - lib/ptimelog/command/upload.rb
 - lib/ptimelog/configuration.rb
+- lib/ptimelog/deprecation_warning.rb
 - lib/ptimelog/entry.rb
 - lib/ptimelog/named_date.rb
+- lib/ptimelog/null_pathname.rb
 - lib/ptimelog/script.rb
 - lib/ptimelog/timelog.rb
 - lib/ptimelog/version.rb