fewald-worklog 0.3.18 → 0.3.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 691934914763f18fbf4695873e5bd5c529a31fc5b2d67c68ec19b9d30647dded
-  data.tar.gz: ef97e71d9881018b85071d16339980196a250f34ef449ae295ec330176606fab
+  metadata.gz: 33d69c646f75c4ff235bf6f6d314ae91de000c2043b8369e0427db9d0b80e08f
+  data.tar.gz: b1d9e80dcc075878a260f6baee8992e8959bcf29786f28575e4e8b918cb704b3
 SHA512:
-  metadata.gz: 005733caa2baaed390cebb2f8c8d55ccfefa0e8fe225a2a1776b98c733075453b9ba09193d6dbbe6e5020db10af965d818360401a79292d04cc9ac936337c485
-  data.tar.gz: 10eb61fab0d9d51a50bb8bb61ca793af7986f0cc7490c7b34799310422b1bce4aac3c1dc6306a3b53888a300630b962ee66b3a9c1d5bbcf4e2b3e70f318cca97
+  metadata.gz: 514b631b513aff4bff09165cf247711bc9739fc210aa0024e4a2e860a2405c0831d9ad650148af0fc5d315339ee87615151411f3b6ca8ad4af80f37b32c2c049
+  data.tar.gz: 91debf86e2527915247ec3d7e12f2a0335945b2b3ffe7cf7c772bcf5e86b2f9759cf2a93331235652e8af1ea067af2f1d30b85765a01fa62606ce5c958573305

data/.version

@@ -1 +1 @@
-0.3.18
+0.3.19

data/lib/log_entry.rb

@@ -4,6 +4,7 @@ require 'yaml'
 require 'rainbow'
 require 'daily_log'
 require 'hash'
+require 'log_entry_formatters'
 
 module Worklog
   # A single log entry in a DailyLog.
@@ -61,41 +62,19 @@ module Worklog
 
     # Returns the message string with formatting without the time.
     # @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
-      people.each do |person|
-        next unless known_people && known_people[person]
-
-        msg.gsub!(/[~@]#{person}/) do |match|
-          s = String.new
-          s << ' ' if match[0] == ' '
-          s << "#{Rainbow(known_people[person].name).underline} (~#{person})" if known_people && known_people[person]
-          s
-        end
-      end
-
-      s = String.new
-
-      # Prefix with [EPIC] if epic
-      s << epic_prefix if epic?
-
-      # Print the message
-      s << if source == 'github'
-             Rainbow(msg).fg(:green)
-           else
-             msg
-           end
-
-      s << format_metadata
-      s
+    # @param formatter [BaseFormatter] the formatter to use for formatting the message. If nil, a default
+    # ConsoleFormatter is used.
+    # @return [String] the formatted message string
+    def message_string(known_people = nil, formatter = nil)
+      formatter ||= LogEntryFormatters::ConsoleFormatter.new(known_people)
+      formatter.format(self)
     end
 
+    # Return people that are mentioned in the entry. People are defined as character sequences
+    # starting with @ or ~. Whitespaces are used to separate people. Punctuation is ignored.
+    # Empty set if no people are mentioned.
+    # @return [Set<String>]
     def people
-      # Return people that are mentioned in the entry. People are defined as character sequences
-      # starting with @ or ~. Whitespaces are used to separate people. Punctuation is ignored.
-      # Empty set if no people are mentioned.
-      # @return [Set<String>]
       @message.scan(PERSON_REGEX).flatten.uniq.sort.to_set
     end
 
@@ -116,6 +95,7 @@ module Worklog
     end
 
     # Convert the log entry to YAML format.
+    # @return [String] the YAML representation of the log entry.
     def to_yaml
       to_hash.to_yaml
     end

data/lib/log_entry_formatters.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require 'rainbow'
+
+module Worklog
+  module LogEntryFormatters
+    # The base formatter provides common functionality and prints the message including
+    # the metadata (ticket, tags, url, project) in a formatted way. It also replaces
+    # people handles with their names if known.
+    class BaseFormatter
+      # Constructor
+      # @param known_people [Hash<String, Person>] A hash of people with their handles as keys.
+      def initialize(known_people = nil)
+        @known_people = known_people
+      end
+
+      # Format the log entry message with metadata.
+      # @param log_entry [LogEntry] the log entry to format.
+      # @return [String] the formatted message.
+      def format(log_entry)
+        # replace all mentions of people with their names.
+        msg = log_entry.message.dup
+        s = String.new
+        s << epic_prefix if log_entry.epic
+        s << replace_people_handles(log_entry, msg)
+        # Add a space between the message and the metadata if there is any metadata to add.
+        s << ' ' unless metadata(log_entry).empty?
+        s << metadata(log_entry)
+        s
+      end
+
+      protected
+
+      # Prefix for epic entries.
+      # @return [String]
+      def epic_prefix
+        '⭐️ '
+      end
+
+      # Format metadata for display and add some emojis for prettier visualization.
+      # @return [String] Formatted metadata
+      def metadata(log_entry)
+        metadata_parts = []
+        metadata_parts << "🎫#{Rainbow(log_entry.ticket).fg(:blue)}" if log_entry.ticket
+        metadata_parts << "🏷️#{log_entry.tags.join(', ')}" if log_entry.tags&.any?
+        metadata_parts << "🔗#{log_entry.url}" if log_entry.url && log_entry.url != ''
+        metadata_parts << "📘#{log_entry.project}" if log_entry.project && log_entry.project != ''
+
+        metadata_parts.empty? ? '' : metadata_parts.join(' ')
+      end
+
+      # Replace people handles in the message with their names.
+      # @param known_people Hash[String, Person] A hash of people with their handles as keys.
+      # @param msg [String] the message to replace handles in.
+      # @return [String] the message with replaced handles.
+      def replace_people_handles(log_entry, msg)
+        log_entry.people.each do |person|
+          next unless @known_people && @known_people[person]
+
+          msg.gsub!(/[~@]#{person}/) do |match|
+            s = String.new
+            s << ' ' if match[0] == ' '
+            if @known_people && @known_people[person]
+              s << "#{Rainbow(@known_people[person].name).underline} (~#{person})"
+            end
+            s
+          end
+        end
+        msg
+      end
+    end
+
+    # Formatter for console output. It adds colors and formatting to the message.
+    # It also adds emojis for tickets, tags, urls, and projects.
+    # This formatter should be used instead of the BaseFormatter when outputting to the console.
+    class ConsoleFormatter < BaseFormatter; end
+
+    # Simple formatter that doesn't add any colors or metadata to the output.
+    # This formatter should be used when the output is meant to be consumed by other tools or
+    # when the formatting is not desired.
+    class SimpleFormatter < BaseFormatter
+      # Format the log entry message without any metadata.
+      # @param log_entry [LogEntry] the log entry to format.
+      # @return [String] the formatted message.
+      def format(log_entry)
+        replace_people_handles(log_entry, log_entry.message.dup)
+      end
+    end
+  end
+end

metadata

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