fewald-worklog 0.3.7 → 0.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 403f517a4187813057f08fa0152df86fdbcc29271a6881650c9de260b1026283
-  data.tar.gz: 8a6fc79840438dc25323ffa4b7a172919be95982783259658dfbdccf90286449
+  metadata.gz: a5a920425a1afeebc25dfcc71d12b6df1019cee84acb600121371d42e041004f
+  data.tar.gz: 1f2de59cecee3fd2ed0d553488738bb908aefa1f907c2125aa8c28b3c0a4a641
 SHA512:
-  metadata.gz: 1a4e9fd85a1b1c80a8432763706a06b5496fc8160dac7a1bd07f487ded8cd250040d0cd8442e72c78de570ec29bfac6fdb7eab6168817e0af3bb9f4c4b682ade
-  data.tar.gz: 7a36f2c3dbe92fc4543a359d4736a80078b2a5f80a544df354d60df684c14036ed44782d342a7ac25d51ea300688cf0098ca25eef9b8729fb5892081168cb567
+  metadata.gz: 1c4d4203b735ebe240623eddfed044793bc6a1a9dc45ade6e28c171f8f9b458a0624228d864b743ffe7396eb1cf432563331027ed68e521e74445ccb27af5107
+  data.tar.gz: 648c610f794c778610de43a4698cbb6cbf04cfd8ac3abf09c3d219d3bb9552e0502bf7cb4b823036b1b95c1526114c7ae7b774f6acacd3f208b8683129d214d0

data/.version

@@ -1 +1 @@
-0.3.7
+0.3.9

data/lib/github/client.rb

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

data/lib/people_storage.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require_relative 'worklogger'
+require_relative 'person'
+module Worklog
+  # Handles storage of people
+  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>
+      #   github_username: <github_username>
+      #   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,18 +161,14 @@ module Worklog
       #   File.write(projects_file, [].to_yaml)
       # end
 
-      if File.exist?(people_filepath)
-        WorkLogger.info 'people.yaml already exists, skipping creation.'
+      # 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."
       else
-        WorkLogger.info 'Creating default people.yaml file.'
-        File.write(people_filepath, PERSON_TEMPLATE)
+        WorkLogger.info "Creating default configuration file at #{Configuration.config_file_path}."
+        File.write(Configuration.config_file_path,
+                   Configuration::CONFIGURATION_TEMPLATE.result)
       end
-
-      # Write the default config file if it does not exist
-      return if File.exist?(Configuration.config_file_path)
-
-      File.write(Configuration.config_file_path,
-                 Configuration::CONFIGURATION_TEMPLATE.result)
     end
 
     # Construct filepath for a given date.
@@ -234,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
@@ -134,6 +136,44 @@ module Worklog
       WorkLogger.info Rainbow("Updated work log for #{options[:date]}").green
     end
 
+    # Fetch latest events from GitHub for a specified user and add them to the work log.
+    #
+    # @param options [Hash] the options hash containing GitHub username and other parameters.
+    def github(_options = {})
+      github = Github::Client.new(@config)
+      github_events = github.fetch_events
+
+      WorkLogger.info Rainbow("Fetched #{github_events.size} events from GitHub.").green
+
+      events_by_date = github_events.group_by { |event| event.to_log_entry.time.to_date }
+
+      events_by_date.each do |date, events|
+        WorkLogger.info Rainbow("Found #{events.size} events for #{date}").green
+        puts "Processing #{events.size} events for '#{date}'"
+        @storage.create_file_skeleton(date)
+        daily_log = @storage.load_log!(@storage.filepath(date))
+        entries_before = daily_log.entries.size
+        events.each do |event|
+          log_entry = event.to_log_entry
+          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}"
+        end
+        entries_after = daily_log.entries.size
+        WorkLogger.info Rainbow("Added #{entries_after - entries_before} new entries for #{date}").green
+
+        # Write log back to storage
+        @storage.write_log(@storage.filepath(date), daily_log)
+      end
+    end
+
+    # Initialize the work log storage with default files and folders.
+    # 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.
     #
     # @param options [Hash] the options hash containing date range or single date.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fewald-worklog
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.3.9
 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