fewald-worklog 0.3.9 → 0.3.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5a920425a1afeebc25dfcc71d12b6df1019cee84acb600121371d42e041004f
-  data.tar.gz: 1f2de59cecee3fd2ed0d553488738bb908aefa1f907c2125aa8c28b3c0a4a641
+  metadata.gz: 194ae6d7e50c4b3010d53a84e0d9e25d949e374eb5fb75cf3cd51d301c087619
+  data.tar.gz: c4fe113cf9bed0c8c16f2bbb514d296c933a3fd99a590186bd705ad6d43dfcb6
 SHA512:
-  metadata.gz: 1c4d4203b735ebe240623eddfed044793bc6a1a9dc45ade6e28c171f8f9b458a0624228d864b743ffe7396eb1cf432563331027ed68e521e74445ccb27af5107
-  data.tar.gz: 648c610f794c778610de43a4698cbb6cbf04cfd8ac3abf09c3d219d3bb9552e0502bf7cb4b823036b1b95c1526114c7ae7b774f6acacd3f208b8683129d214d0
+  metadata.gz: 02627ae920d177212b611f46f6ddb888ad3b74c2c8619d1576af299aaa712503c1dd4474bebfec12fb4fe514694becd418a1b379794b1b9b3e456eaa49033a43
+  data.tar.gz: 609860215096e6d34b361b38e215da8ad64900113d8a6d60162dfe63dbd9ece113bc9274668055bd14825fcb45f33db32a83857e16403baf2cfef11c7f6e16b8

data/.version

@@ -1 +1 @@
-0.3.9
+0.3.11

data/lib/github/client.rb

@@ -163,8 +163,10 @@ module Worklog
       # @raise [GithubAPIError] if the API token is missing
       def verify_token!
         WorkLogger.debug 'Verifying GitHub API token presence'
-        @configuration.github.api_key || raise(GithubAPIError,
-                                               'GitHub API key is not configured. Please set it in the configuration.')
+        return unless @configuration.github.api_key.nil? || @configuration.github.api_key.empty?
+
+        raise(GithubAPIError,
+              'GitHub API key is not configured. Please set it in the configuration.')
       end
     end
   end

data/lib/github/pull_request_event.rb

@@ -50,7 +50,7 @@ module Worklog
 
       # Convert the PullRequestEvent to a LogEntry
       # @return [LogEntry]
-      def to_log_entry
+      def to_log_entry(*)
         message = if merged?
                     'Merged PR '
                   elsif closed?

data/lib/github/pull_request_review_event.rb

@@ -40,10 +40,12 @@ module Worklog
 
       # Convert the PullRequestReviewEvent to a LogEntry
       # @return [LogEntry]
-      def to_log_entry
+      def to_log_entry(people_storage = nil)
+        handle = resolve_username(people_storage) || creator
+
         message = String.new 'Reviewed '
         message << 'and approved ' if approved?
-        message << "PR ##{number} #{creator}: #{title}"
+        message << "PR ##{number} #{handle}: #{title}"
         LogEntry.new(
           key: Hasher.sha256("#{repository}-#{number}-#{state}"),
           source: 'github',
@@ -58,6 +60,20 @@ module Worklog
       def to_s
         "#<PullRequestReviewEvent repository=#{repository} number=#{number} state=#{state} creator=#{creator} created_at=#{created_at}>" # rubocop:disable Layout/LineLength
       end
+
+      private
+
+      # Resolve the GitHub username to a person handle using the provided PeopleStorage
+      # @param [PeopleStorage, nil] people_storage The PeopleStorage instance to use for resolution
+      # @return [String, nil] The person handle if found, otherwise nil
+      # @example
+      #  resolve_username(people_storage) #=> "~johndoe"
+      def resolve_username(people_storage)
+        return if people_storage.nil?
+
+        person = people_storage.find_by_github_username(creator)
+        person ? "~#{person.handle}" : nil
+      end
     end
   end
 end

data/lib/github/push_event.rb

@@ -6,7 +6,7 @@ module Worklog
   module Github
     # Event representing a push event
     class PushEvent
-      def to_log_entry
+      def to_log_entry(*)
         WorkLogger.debug('Converting PushEvent to LogEntry')
         LogEntry.new(
           key: 'github-push-event',

data/lib/people_storage.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
+require 'person'
+require 'worklogger'
 require 'yaml'
-require_relative 'worklogger'
-require_relative 'person'
+
 module Worklog
-  # Handles storage of people
+  # Finding, reading, and writing of people
+  # @see Person
+  # @see Storage
   class PeopleStorage
     PEOPLE_FILE = 'people.yaml'
 
@@ -14,7 +17,11 @@ module Worklog
       ---
       # Each person is defined by the following attributes:
       # - handle: <unique_handle>
+      #     Unique handle used to reference this person (e.g., ~jdoe)
       #   github_username: <github_username>
+      #     GitHub username of the person, used to link GitHub events to this person.
+      #     This can be omitted if the person does not have a GitHub account and can
+      #     be different from the handle.
       #   name: <full_name>
       #   team: <team_name>
       #   email: <email_address>

data/lib/worklog.rb

@@ -154,7 +154,7 @@ module Worklog
         daily_log = @storage.load_log!(@storage.filepath(date))
         entries_before = daily_log.entries.size
         events.each do |event|
-          log_entry = event.to_log_entry
+          log_entry = event.to_log_entry(@people_storage)
           WorkLogger.debug('Entry already exists, skipping') if daily_log.key?(log_entry.key)
           daily_log << log_entry unless daily_log.key?(log_entry.key)
           WorkLogger.debug "Added entry: #{log_entry.message_string}"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fewald-worklog
 version: !ruby/object:Gem::Version
-  version: 0.3.9
+  version: 0.3.11
 platform: ruby
 authors:
 - Friedrich Ewald