fewald-worklog 0.3.8 → 0.3.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7eebce5b88e954faa6242724ed451878b495285aa11757e40361ad430d45e5d5
-  data.tar.gz: 683dd70aff93d5a0731bf56472d7ed55c5a62dfb71aba141b6534da100c90c6d
+  metadata.gz: c918d6adace19f7c6fcf87f5a52a82c3fd3c60ddfc85e4042299e67dc204a17a
+  data.tar.gz: d901d4d78036bb7754f58406f47a9d003690dec8a087cffcaf77bc55e0d4de26
 SHA512:
-  metadata.gz: 9fda2165e1a06fe4df84eaa3c7d7396bcdf8f0fa14468bbadf89632c35cce0ba425e9b80fab2844fa07c8a65f18330d29593d142c5b8695e1976bb6b343f3e0f
-  data.tar.gz: 217d4319ee3dd036000c4b14c9fc9a413e3920391d4b538a786db2239107bf46e56832fe23161416940fe0f98a086676b5cb25d2edb23e4978b9b33b3f8807c9
+  metadata.gz: f7400ed28bd389bbe70c51a61abfd63ae3fe3cbc7575273b8383e85aeef6b11137b8f645b57e65fc8f5bd6bb3fe5814387b9c3b2b9e11f755dd1bae933854d2f
+  data.tar.gz: a016e500815e38dfbb4308fe07ce599fc46f71eaf96c7fc3af668198f00b3985f09f7d02144faadca83c326cfd8b91ce201aa56b2077bae7545c012000cb7670

data/.version

@@ -1 +1 @@
-0.3.8
+0.3.10

data/lib/github/client.rb

@@ -16,7 +16,6 @@ module Worklog
       EVENT_FILTER = Set.new(%w[
                                PullRequestEvent
                                PullRequestReviewEvent
-
                              ]).freeze
 
       def initialize(configuration)

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

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require 'person'
+require 'worklogger'
+require 'yaml'
+
+module Worklog
+  # Finding, reading, and writing of people
+  # @see Person
+  # @see Storage
+  class PeopleStorage
+    PEOPLE_FILE = 'people.yaml'
+
+    # The template for the people YAML file.
+    # This template is used to create a new people file if it does not exist.
+    PERSON_TEMPLATE = <<~YAML
+      ---
+      # 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>
+      #   title: <title_or_role>
+      #   inactive: <true_or_false>
+      #   --- Define your people below this line ---
+    YAML
+
+    def initialize(config)
+      @config = config
+    end
+
+    # Return the full absolute filepath for the people.yaml file
+    # @return [String] The filepath
+    def people_filepath
+      File.join(@config.storage_path, PEOPLE_FILE)
+    end
+
+    # Load all people from the people file and return them as a hash with handle as key
+    # @return [Hash<String, Person>] Hash of people with handle as key
+    def load_people_hash
+      load_people.to_h { |person| [person.handle, person] }
+    end
+
+    # Load all people from the people YAML file
+    # Return empty array if file does not exist
+    # @return [Array<Person>] List of all people
+    def load_people
+      load_people!
+    rescue Errno::ENOENT
+      # If the file does not exist, create it with the template
+      File.write(people_filepath, PERSON_TEMPLATE)
+      []
+    end
+
+    # Load all people from the people YAML file
+    # @return [Array<Person>] List of all people
+    # @raise [Errno::ENOENT] if the people file does not exist
+    def load_people!
+      # TODO: Remove this migration code in future versions
+      # This was introduced in v0.2.26 (Oct 2 2025) to fix deprecated YAML syntax
+      yamltext = File.read(people_filepath)
+      if yamltext != yamltext.gsub(/^- !.*$/, '-')
+        WorkLogger.debug 'The people.yaml file contains deprecated syntax. Migrating now.'
+        yamltext.gsub!(/^- !.*$/, '-')
+        File.write(people_filepath, yamltext)
+      end
+      # End TODO
+
+      data = YAML.load(yamltext, permitted_classes: [])
+      return [] unless data.is_a?(Array)
+
+      data.map { |person_hash| Person.from_hash(person_hash) }
+    end
+
+    # Write people to the people file
+    # @param [Array<Person>] people List of people
+    def write_people!(people)
+      raise ArgumentError, 'people must be an array of Person objects' if people.nil? || !people.is_a?(Array)
+
+      File.open(people_filepath, 'w') do |f|
+        f.puts people.to_yaml
+      end
+      @people = people
+    end
+
+    # Create the default people file if it does not exist
+    # @return [void]
+    def create_default_file
+      if File.exist?(people_filepath)
+        WorkLogger.info 'people.yaml already exists, skipping creation.'
+      else
+        WorkLogger.info 'Creating default people.yaml file.'
+        File.write(people_filepath, PERSON_TEMPLATE)
+      end
+    end
+
+    # Find a person by their handle
+    # @param [String] handle The handle of the person
+    # @return [Person, nil] The person if found, nil otherwise
+    def find_by_handle(handle)
+      @people ||= load_people
+      @people.find { |person| person.handle == handle }
+    end
+
+    # Find a person by their GitHub username
+    # @param [String] github_username The GitHub username of the person
+    # @return [Person, nil] The person if found, nil otherwise
+    def find_by_github_username(github_username)
+      @people ||= load_people
+      @people.find { |person| person.github_username == github_username }
+    end
+  end
+end

data/lib/storage.rb

@@ -17,21 +17,6 @@ module Worklog
     # Regular expression to match daily log file names
     LOG_PATTERN = /\d{4}-\d{2}-\d{2}#{FILE_SUFFIX}\z/
 
-    # The template for the people YAML file.
-    # This template is used to create a new people file if it does not exist.
-    PERSON_TEMPLATE = <<~YAML
-      ---
-      # Each person is defined by the following attributes:
-      # - handle: <unique_handle>
-      #   github_username: <github_username>
-      #   name: <full_name>
-      #   team: <team_name>
-      #   email: <email_address>
-      #   role: <role_in_team>
-      #   inactive: <true_or_false>
-      #   --- Define your people below this line ---
-    YAML
-
     def initialize(config)
       @config = config
     end
@@ -153,44 +138,6 @@ module Worklog
       daily_log.entries
     end
 
-    # Load all people from the people file, or return an empty array if the file does not exist
-    #
-    # @return [Array<Person>] List of people
-    def load_people
-      load_people!
-    rescue Errno::ENOENT
-      WorkLogger.info 'Unable to load people.'
-      []
-    end
-
-    # Load all people from the people file and return them as a hash with handle as key
-    # @return [Hash<String, Person>] Hash of people with handle as key
-    def load_people_hash
-      load_people.to_h { |person| [person.handle, person] }
-    end
-
-    # Load all people from the people file
-    # @return [Array<Person>] List of people
-    def load_people!
-      return [] unless File.exist?(people_filepath)
-
-      yamltext = File.read(people_filepath)
-      if yamltext != yamltext.gsub(/^- !.*$/, '-')
-        WorkLogger.debug 'The people.yaml file contains deprecated syntax. Migrating now.'
-        yamltext.gsub!(/^- !.*$/, '-')
-        File.write(people_filepath, yamltext)
-      end
-      YAML.load(yamltext, permitted_classes: []).map { |person_hash| Person.from_hash(person_hash) }
-    end
-
-    # Write people to the people file
-    # @param [Array<Person>] people List of people
-    def write_people!(people)
-      File.open(people_filepath, 'w') do |f|
-        f.puts people.to_yaml
-      end
-    end
-
     # Create folder if not exists already.
     # @return [void]
     def create_default_folder
@@ -214,13 +161,6 @@ module Worklog
       #   File.write(projects_file, [].to_yaml)
       # end
 
-      if File.exist?(people_filepath)
-        WorkLogger.info 'people.yaml already exists, skipping creation.'
-      else
-        WorkLogger.info 'Creating default people.yaml file.'
-        File.write(people_filepath, PERSON_TEMPLATE)
-      end
-
       # Write the default config file if it does not exist
       if File.exist?(Configuration.config_file_path)
         WorkLogger.info "Configuration file (#{Configuration.config_file_path}) already exists, skipping creation."
@@ -237,11 +177,5 @@ module Worklog
     def filepath(date)
       File.join(@config.storage_path, "#{date}#{FILE_SUFFIX}")
     end
-
-    # Return the full absolute filepath for the people.yaml file
-    # @return [String] The filepath
-    def people_filepath
-      File.join(@config.storage_path, 'people.yaml')
-    end
   end
 end

data/lib/worklog.rb

@@ -14,6 +14,7 @@ require 'hasher'
 require 'log_entry'
 require 'worklogger'
 require 'string_helper'
+require 'people_storage'
 require 'printer'
 require 'project_storage'
 require 'statistics'
@@ -57,6 +58,7 @@ module Worklog
 
       # Initialize (project) storage
       @storage = Storage.new(@config)
+      @people_storage = PeopleStorage.new(@config)
       @project_storage = ProjectStorage.new(@config)
 
       bootstrap
@@ -67,7 +69,7 @@ module Worklog
       @storage.create_default_folder
 
       # Load all people as they're used in multiple/most of the methods.
-      @people = @storage.load_people_hash
+      @people = @people_storage.load_people_hash
 
       # Load all projects from disk
       @projects = @project_storage.load_projects
@@ -152,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}"
@@ -169,6 +171,7 @@ module Worklog
     # This method will not overwrite existing files and is thus safe to run multiple times.
     def init(_options = {})
       @storage.create_default_files
+      @people_storage.create_default_file
     end
 
     # Show the work log for a specific date range or a single date.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fewald-worklog
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.3.10
 platform: ruby
 authors:
 - Friedrich Ewald
@@ -149,6 +149,7 @@ files:
 - lib/hash.rb
 - lib/hasher.rb
 - lib/log_entry.rb
+- lib/people_storage.rb
 - lib/person.rb
 - lib/printer.rb
 - lib/project.rb