fewald-worklog 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e12db32224c9de9918c8ec94a01f033d09f4e157d53958cdc733b4555f24895e
-  data.tar.gz: c825cdb202b22b27f14b5bba6617a0c5511f5b75721e543deb6ae6c38bdb7f6f
+  metadata.gz: 04c383f8fdef10be4e54ff89c59e3a89ee96c23c18688cf8d85ab972125d782d
+  data.tar.gz: 105a71a7563257e67573c3331baeac23a1cec8d5b5c0b50a846fae90373ec05e
 SHA512:
-  metadata.gz: d29144ca0648fb5ad056bb7317a096bcaf7eb63dd6aa2022c6581309493c9d009811d698f2d445b57d981cbca6fe636ec0fa605489de4a49fc46f4275b710141
-  data.tar.gz: dcbf6fc6e56340e453f745bd8eb1235c93416deee11e6109d37f240906f2e66542a06a6ffa1de5a561a07f918182d42e50e1b5d761b0c0e42636ee520613cc19
+  metadata.gz: 7b506d69b1abf9f0f540003d4a6c6012120d3269747840ad85ac8e055920eff99dfff63be2f899de13842033fdc3cf2ac757afb97e7294cf3749fcd32b3afb7e
+  data.tar.gz: 4b6171aeb03cbcc92ccda7f9eda6a7cbf32f78ef7739e80ee9aa685af8248f2a1527437506dc49392bbb17371cad5040528a47f410d45fc6e6cf126b2aa5da37

data/bin/wl

@@ -6,6 +6,8 @@
 if ENV['WL_PATH']
   # Import the worklog CLI from the path specified in the WL_PATH environment variable
   # This is used during development to avoid having to rely on the order of the $PATH.
+  puts "Loading worklog from #{ENV['WL_PATH']}. This should only be used during development."
+  puts 'To use the installed worklog, unset the WL_PATH environment variable.'
   require_relative File.join(ENV['WL_PATH'], 'worklog', 'cli')
 else
   require_relative '../worklog/cli'

data/worklog/cli.rb

@@ -1,4 +1,3 @@
-#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 # Add the current directory to the load path
@@ -9,12 +8,12 @@ require 'thor'
 require 'date'
 require 'logger'
 
+require_relative 'worklog'
 require 'date_parser'
 require 'printer'
 require 'statistics'
 require 'storage'
 require 'webserver'
-require 'worklog'
 require_relative 'summary'
 require_relative 'editor'
 require_relative 'string_helper'
@@ -56,7 +55,7 @@ class WorklogCLI < Thor
     time = Time.strptime(options[:time], '%H:%M:%S')
     Storage.create_file_skeleton(date)
 
-    daily_log = Storage.load_log(Storage.filepath(date))
+    daily_log = Storage.load_log!(Storage.filepath(date))
     daily_log.entries << LogEntry.new(time:, tags: options[:tags], ticket: options[:ticket], url: options[:url],
                                       epic: options[:epic], message:)
 
@@ -64,7 +63,8 @@ class WorklogCLI < Thor
     daily_log.entries.sort_by!(&:time)
 
     Storage.write_log(Storage.filepath(options[:date]), daily_log)
-    WorkLogger.info Rainbow("Added to the work log for #{options[:date]}").green
+
+    WorkLogger.info Rainbow("Added entry on #{options[:date]}: #{message}").green
   end
 
   desc 'edit', 'Edit a specified day in the work log'
@@ -100,7 +100,7 @@ class WorklogCLI < Thor
       exit 1
     end
 
-    daily_log = Storage.load_log(Storage.filepath(options[:date]))
+    daily_log = Storage.load_log!(Storage.filepath(options[:date]))
     if daily_log.entries.empty?
       WorkLogger.error Rainbow("No entries found for #{options[:date]}. Aborting.").red
       exit 1
@@ -260,8 +260,3 @@ class WorklogCLI < Thor
     end
   end
 end
-
-# Start the CLI if the file is executed
-# This prevents the CLI from starting when the file is required in another file,
-# which is useful for testing.
-WorklogCLI.start if __FILE__ == $PROGRAM_NAME

data/worklog/person.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: true
 
 # Represents a person at work.
 class Person

data/worklog/statistics.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 require 'date'
-require 'storage'
+require_relative 'storage'
 
 STATS = Data.define(:total_days, :total_entries, :total_epics, :avg_entries, :first_entry, :last_entry)
 
 # Module for calculating statistics for the work log.
 module Statistics
   # Calculate statistics for the work log for all days.
-  # @return [STATS]
+  # @return [STATS] The statistics for the work log
   def self.calculate
     all_entries = Storage.all_days
     return STATS.new(0, 0, 0, 0, Date.today, Date.today) if all_entries.empty?

data/worklog/storage.rb

@@ -3,6 +3,7 @@
 require 'rainbow'
 require_relative 'daily_log'
 require_relative 'logger'
+require_relative 'person'
 
 module Storage
   # LogNotFoundError is raised when a log file is not found
@@ -16,11 +17,14 @@ module Storage
   end
 
   # Return all days with logs
+  # @return [Array<DailyLog>] List of logs
   def self.all_days
     return [] unless folder_exists?
 
     logs = []
     Dir.glob(File.join(DATA_DIR, "*#{FILE_SUFFIX}")).map do |file|
+      next if file.end_with?('people.yaml')
+
       logs << load_log(file)
     end
 
@@ -44,7 +48,7 @@ module Storage
 
     while start_date <= end_date
       if File.exist?(filepath(start_date))
-        tmp_logs = load_log(filepath(start_date))
+        tmp_logs = load_log!(filepath(start_date))
         tmp_logs.entries.keep_if { |entry| entry.epic? } if epics_only
 
         if tags_filter
@@ -61,6 +65,7 @@ module Storage
   end
 
   # Create file for a new day if it does not exist
+  # @param [Date] date The date, used as the file name.
   def self.create_file_skeleton(date)
     create_folder
 
@@ -98,11 +103,31 @@ module Storage
   end
 
   def self.load_single_log_file(file, headline = true)
-    daily_log = load_log(file)
+    daily_log = load_log!(file)
     puts "Work log for #{Rainbow(daily_log.date).gold}:" if headline
     daily_log.entries
   end
 
+  # Load all people from the people file
+  # @return [Array<Person>] List of people
+  def self.load_people!
+    people_file = File.join(DATA_DIR, 'people.yaml')
+    return [] unless File.exist?(people_file)
+
+    YAML.load_file(people_file, permitted_classes: [Person])
+  end
+
+  # Write people to the people file
+  # @param [Array<Person>] people List of people
+  def self.write_people!(people)
+    create_folder
+
+    people_file = File.join(DATA_DIR, 'people.yaml')
+    File.open(people_file, 'w') do |f|
+      f.puts people.to_yaml
+    end
+  end
+
   private
 
   # Create folder if not exists already.
@@ -110,8 +135,10 @@ module Storage
     Dir.mkdir(DATA_DIR) unless Dir.exist?(DATA_DIR)
   end
 
+  # Construct filepath for a given date.
+  # @param [Date] date The date
+  # @return [String] The filepath
   def filepath(date)
-    # Construct filepath for a given date.
     File.join(DATA_DIR, "#{date}#{FILE_SUFFIX}")
   end
 

data/worklog/string_helper.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: true
 
 # Helpers for String manipulation
 module StringHelper

data/worklog/worklog.rb

@@ -1,14 +1,14 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require 'optparse'
+require 'rainbow'
+require 'yaml'
+
 require_relative 'hash'
 require_relative 'daily_log'
 require_relative 'log_entry'
 require_relative 'storage'
 
-require 'optparse'
-require 'rainbow'
-require 'yaml'
-
 module Worklog
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: fewald-worklog
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Friedrich Ewald
 bindir: bin
 cert_chain: []
-date: 2025-03-13 00:00:00.000000000 Z
+date: 2025-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty