fewald-worklog 0.2.4 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bf5afbd99a91e77e5a3d16101653fecdeafdd808c5ca7c4ea23aa60be01ad54
-  data.tar.gz: 24c33cda5e47f1878c814bcb22ab06d9295e9e4d2e3f59b39ccdcf8801d3e8d9
+  metadata.gz: 6006eac22572b9dfaa7907f122d1f9e1b59ed633abdb58f8e7cff1fd1ae05216
+  data.tar.gz: a88c31463ccf65fa26af9ad68b48b0d195ab4c0ee99724eb3cecf5ef694d5ef2
 SHA512:
-  metadata.gz: '09d41c3cc186e650aebbca3d91840cfbec6c6207a67929c3b1b379b470008d00acacf8ff38ae20d9d648589354e2e2538220852ee86ad564a69b76e7b86607fa'
-  data.tar.gz: d8da05a9c100cc1b59243a303910faa2a675f0c15ade7ac253fb846b5e3435895245d454c0cf0957a096a94c6dcddeca0f2a8114f7f0c12d759189413dcef690
+  metadata.gz: e9a68724ee65d0075d247c29ae0c4fd03790f4943f7ca11e6063c10300da4ca69872c64e3b968a8976824a9627fb781680277b02d76e408f5861b5a9cd90bbc6
+  data.tar.gz: 938cd3f3b08fcb78f992e996a2ad3118e8cbbaf680149943f4d6e18da5ddcaf45a8e8806ba3562552946d9a930ca858edb9f4c3b3fff061ccee1dc533ab67d85

data/.version

@@ -1 +1 @@
-0.2.4
+0.2.6

data/lib/cli.rb

@@ -16,7 +16,6 @@ require 'printer'
 require 'statistics'
 require 'storage'
 require 'string_helper'
-require 'summary'
 require 'version'
 require 'webserver'
 
@@ -104,9 +103,22 @@ class WorklogCLI < Thor
   end
 
   desc 'tags', 'Show all tags used in the work log'
-  def tags
+  option :date, type: :string, default: DateTime.now.strftime('%Y-%m-%d'),
+                desc: <<~DESC
+                  Show the work log for a specific date. If this option is provided, --from and --to and --days should not be used.
+                DESC
+  option :from, type: :string, desc: <<~EOF
+    Inclusive start date of the range. Takes precedence over --date, if defined.
+  EOF
+  option :to, type: :string, desc: <<~EOF
+    Inclusive end date of the range. Takes precedence over --date, if defined.
+  EOF
+  option :days, type: :numeric, desc: <<~EOF
+    Number of days to show starting from --date. Takes precedence over --from and --to if defined.
+  EOF
+  def tags(tag = nil)
     worklog = Worklog.new
-    worklog.tags(options)
+    worklog.tags(tag, options)
   end
 
   desc 'server', 'Start the work log server'

data/lib/daily_log.rb

@@ -15,17 +15,19 @@ class DailyLog
     @entries = params[:entries]
   end
 
+  # Returns true if there are people mentioned in any entry of the current day.
+  #
+  # @return [Boolean] true if there are people mentioned, false otherwise.
   def people?
-    # Returns true if there are people mentioned in any entry of the current day.
     people.size.positive?
   end
 
+  # Returns a hash of people mentioned in the log for the current day
+  # with the number of times they are mentioned.
+  # People are defined as words starting with @ or ~.
+  #
+  # @return [Hash<String, Integer>]
   def people
-    # Returns a hash of people mentioned in the log for the current day
-    # with the number of times they are mentioned.
-    # People are defined as words starting with @ or ~.
-    #
-    # @return [Hash<String, Integer>]
     entries.map(&:people).flatten.tally
   end
 
@@ -41,6 +43,10 @@ class DailyLog
     entries.flat_map(&:tags).uniq.sort
   end
 
+  # Equals method to compare two DailyLog objects.
+  #
+  # @param other [DailyLog] the other DailyLog object to compare with
+  # @return [Boolean] true if both DailyLog objects have the same date and entries, false otherwise
   def ==(other)
     date == other.date && entries == other.entries
   end

data/lib/log_entry.rb

@@ -31,7 +31,7 @@ class LogEntry
   end
 
   # Returns the message string with formatting without the time.
-  # @param people Hash[String, Person] A hash of people with their handles as keys.
+  # @param known_people Hash[String, Person] A hash of people with their handles as keys.
   def message_string(known_people = nil)
     # replace all mentions of people with their names.
     msg = @message.dup

data/lib/worklog.rb

@@ -14,6 +14,7 @@ require 'worklogger'
 require 'string_helper'
 require 'printer'
 require 'statistics'
+require 'summary'
 
 # Main class providing all worklog functionality.
 # This class is the main entry point for the application.
@@ -138,9 +139,25 @@ class Worklog
     end
   end
 
-  def tags(_options = {})
-    all_logs = @storage.all_days
+  # Show all tags used in the work log or details for a specific tag
+  #
+  # @param tag [String, nil] the tag to show details for, or nil to show all tags
+  # @param options [Hash] the options hash containing date range
+  # @return [void]
+  #
+  # @example
+  #   worklog.tags('example_tag', from: '2023-10-01', to: '2023-10-31')
+  #   worklog.tags(nil) # Show all tags for all time
+  def tags(tag = nil, options = {})
+    if tag.nil? || tag.empty?
+      tag_overview
+    else
+      tag_detail(tag, options)
+    end
+  end
 
+  def tag_overview
+    all_logs = @storage.all_days
     puts Rainbow('Tags used in the work log:').gold
 
     # Count all tags used in the work log
@@ -153,6 +170,29 @@ class Worklog
     tags.sort.each { |k, v| puts "#{Rainbow(k.ljust(max_len)).gold}: #{v} #{pluralize(v, 'occurrence')}" }
   end
 
+  # Show detailed information about a specific tag
+  #
+  # @param tag [String] the tag to show details for
+  # @param options [Hash] the options hash containing date range
+  # @return [void]
+  #
+  # @example
+  #   worklog.tag_detail('example_tag', from: '2023-10-01', to: '2023-10-31')
+  def tag_detail(tag, options)
+    printer = Printer.new(@storage.load_people!)
+    start_date, end_date = start_end_date(options)
+
+    @storage.days_between(start_date, end_date).each do |daily_log|
+      next unless daily_log.tags.include?(tag)
+
+      daily_log.entries.each do |entry|
+        next unless entry.tags.include?(tag)
+
+        printer.print_entry(daily_log, entry, true)
+      end
+    end
+  end
+
   def stats(_options = {})
     stats = Statistics.new(@config).calculate
     puts "#{format_left('Total days')}: #{stats.total_days}"
@@ -207,9 +247,11 @@ class Worklog
     elsif options[:from]
       start_date = DateParser.parse_date_string!(options[:from], true)
       end_date = DateParser.parse_date_string!(options[:to], false) if options[:to]
-    else
+    elsif options[:date]
       start_date = Date.strptime(options[:date], '%Y-%m-%d')
       end_date = start_date
+    else
+      raise ArgumentError, 'No date range specified. Use --days, --from, --to or --date options.'
     end
     [start_date, end_date]
   end

metadata

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