fewald-worklog 0

data/lib/storage.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+require 'rainbow'
+require 'daily_log'
+require 'log_entry'
+require 'worklogger'
+require 'person'
+
+# Handles storage of daily logs and people
+class Storage
+  # LogNotFoundError is raised when a log file is not found
+  class LogNotFoundError < StandardError; end
+
+  FILE_SUFFIX = '.yaml'
+
+  def initialize(config)
+    @config = config
+  end
+
+  def folder_exists?
+    Dir.exist?(@config.storage_path)
+  end
+
+  # Return all logs for all available days
+  # @return [Array<DailyLog>] List of all logs
+  def all_days
+    return [] unless folder_exists?
+
+    logs = []
+    Dir.glob(File.join(@config.storage_path, "*#{FILE_SUFFIX}")).map do |file|
+      next if file.end_with?('people.yaml')
+
+      logs << load_log(file)
+    end
+
+    logs
+  end
+
+  # Return all tags as a set
+  # @return [Set<String>] Set of all tags
+  def tags
+    logs = all_days
+    tags = Set[]
+    logs.each do |log|
+      log.entries.each do |entry|
+        next unless entry.tags
+
+        entry.tags.each do |tag|
+          tags << tag
+        end
+      end
+    end
+    tags
+  end
+
+  # Return days between start_date and end_date
+  # If end_date is nil, return logs from start_date to today
+  #
+  # @param [Date] start_date The start date, inclusive
+  # @param [Date] end_date The end date, inclusive
+  # @param [Boolean] epics_only If true, only return logs with epic entries
+  # @param [Array<String>] tags_filter If provided, only return logs with entries that have at least one of the tags
+  # @return [Array<DailyLog>] List of logs
+  def days_between(start_date, end_date = nil, epics_only = nil, tags_filter = nil)
+    return [] unless folder_exists?
+
+    logs = []
+    end_date = Date.today if end_date.nil?
+
+    return [] if start_date > end_date
+
+    while start_date <= end_date
+      if File.exist?(filepath(start_date))
+        tmp_logs = load_log!(filepath(start_date))
+        tmp_logs.entries.keep_if { |entry| entry.epic? } if epics_only
+
+        if tags_filter
+          # Safeguard against entries without any tags, not just empty array
+          tmp_logs.entries.keep_if { |entry| entry.tags && (entry.tags & tags_filter).size > 0 }
+        end
+
+        logs << tmp_logs if tmp_logs.entries.length > 0
+      end
+
+      start_date += 1
+    end
+    logs
+  end
+
+  # Create file for a new day if it does not exist
+  # @param [Date] date The date, used as the file name.
+  def create_file_skeleton(date)
+    create_folder
+
+    File.write(filepath(date), YAML.dump(DailyLog.new(date:, entries: []))) unless File.exist?(filepath(date))
+  end
+
+  def load_log(file)
+    load_log!(file)
+  rescue LogNotFoundError
+    WorkLogger.error "No work log found for #{file}. Aborting."
+    nil
+  end
+
+  def load_log!(file)
+    WorkLogger.debug "Loading file #{file}"
+    begin
+      log = YAML.load_file(file, permitted_classes: [Date, Time, DailyLog, LogEntry])
+      log.entries.each do |entry|
+        entry.time = Time.parse(entry.time) unless entry.time.respond_to?(:strftime)
+      end
+      log
+    rescue Errno::ENOENT
+      raise LogNotFoundError
+    end
+  end
+
+  def write_log(file, daily_log)
+    create_folder
+
+    WorkLogger.debug "Writing to file #{file}"
+
+    File.open(file, 'w') do |f|
+      f.puts daily_log.to_yaml
+    end
+  end
+
+  def load_single_log_file(file, headline = true)
+    daily_log = load_log!(file)
+    puts "Work log for #{Rainbow(daily_log.date).gold}:" if headline
+    daily_log.entries
+  end
+
+  def load_people
+    load_people!
+  rescue Errno::ENOENT
+    WorkLogger.info 'Unable to load people.'
+    []
+  end
+
+  # Load all people from the people file
+  # @return [Array<Person>] List of people
+  def load_people!
+    people_file = File.join(@config.storage_path, '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 write_people!(people)
+    create_folder
+
+    people_file = File.join(@config.storage_path, 'people.yaml')
+    File.open(people_file, 'w') do |f|
+      f.puts people.to_yaml
+    end
+  end
+
+  # Create folder if not exists already.
+  def create_folder
+    Dir.mkdir(@config.storage_path) unless Dir.exist?(@config.storage_path)
+  end
+
+  # Construct filepath for a given date.
+  # @param [Date] date The date
+  # @return [String] The filepath
+  def filepath(date)
+    File.join(@config.storage_path, "#{date}#{FILE_SUFFIX}")
+  end
+end

data/lib/string_helper.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Helpers for String manipulation
+module StringHelper
+  # Pluralize a word based on a count. If the plural form is irregular, it can be provided.
+  # Otherwise, it will be generated automatically.
+  #
+  # @param count [Integer] the count to base the pluralization on
+  # @param singular [String] the singular form of the word
+  # @param plural [String] the plural form of the word, if it is irregular. Otherwise it will be generated.
+  # @return [String] the pluralized word
+  def pluralize(count, singular, plural = nil)
+    if count == 1
+      singular
+    else
+      return plural if plural
+
+      return "#{singular[0..-2]}ies" if singular.end_with? 'y'
+
+      return "#{singular}es" if singular.end_with? 'ch', 's', 'sh', 'x', 'z'
+
+      return "#{singular[0..-2]}ves" if singular.end_with? 'f', 'fe'
+
+      "#{singular}s"
+    end
+  end
+
+  # Format a string to be left-aligned in a fixed-width field
+  #
+  # @param string [String] the string to format
+  # @return [String] the formatted string
+  def format_left(string)
+    format('%18s', string)
+  end
+end

data/lib/summary.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'erb'
+require 'httparty'
+require 'json'
+
+require 'worklogger'
+
+# AI Summary generation.
+class Summary
+  MODEL = 'llama3.2'
+  SUMMARY_INSTRUCTION = <<~INSTRUCTION
+    <% entries.each do |entry| -%>
+    <%= entry.message %>
+    <% end -%>
+  INSTRUCTION
+
+  SYSTEM_INSTRUCTION = <<~INSTRUCTION
+    You are a professional summarization assistant specialized in crafting performance review summaries. Your role is to take a list of achievements provided by the user and generate a concise, professional summary suitable for use in a formal performance review.
+
+    Guidelines:
+
+    Accuracy: Do not invent or infer any facts not explicitly provided by the user. Use only the information given.
+    Tone: Maintain a formal, professional tone throughout the summary.
+    Structure: Organize the summary in a coherent manner, emphasizing key accomplishments and their impact.
+    Clarity: Use clear and concise language, avoiding jargon unless specified by the user.
+    Your Task:
+
+    Analyze the list of achievements provided by the user.
+    Identify the key themes and accomplishments.
+    Draft a polished summary that highlights the individual’s contributions and results.
+    Constraints:
+
+    Do not fabricate details or add context that has not been explicitly stated.
+    Always prioritize clarity and professionalism in your writing.
+    Example Input:
+
+    "Exceeded sales targets by 15% in Q3."
+    "Implemented a new CRM system, reducing customer response time by 30%."
+    "Mentored two junior team members, both of whom received promotions."
+    Example Output: "[Name] demonstrated outstanding performance during the review period. Key accomplishments include exceeding sales targets by 15% in Q3, implementing a new CRM system that improved customer response times by 30%, and mentoring two junior team members who achieved career advancements. These achievements highlight [Name]'s exceptional contributions to team success and organizational growth."
+  INSTRUCTION
+
+  def initialize(config)
+    @config = config
+  end
+
+  # Build the prompt from provided log entries.
+  def build_prompt(log_entries)
+    ERB.new(SUMMARY_INSTRUCTION, trim_mode: '-').result_with_hash(entries: log_entries)
+  end
+
+  # Generate a summary from provided log entries.
+  # @param log_entries [Array<LogEntry>] The log entries to summarize.
+  # @return [String] The generated summary.
+  def generate_summary(log_entries)
+    prompt = build_prompt(log_entries)
+
+    WorkLogger.debug("Using prompt: #{prompt}")
+
+    begin
+      response = HTTParty.post('http://localhost:11434/api/generate',
+                               body: {
+                                 model: Summary::MODEL,
+                                 prompt:,
+                                 system: Summary::SYSTEM_INSTRUCTION,
+                                 stream: false
+                               }.to_json,
+                               headers: { 'Content-Type' => 'application/json' })
+      response.parsed_response['response']
+    rescue Errno::ECONNREFUSED
+      WorkLogger.error <<~MSG
+        Ollama doesn't seem to be running. Please start the server and try again.
+        puts 'You can download Ollama at https://ollama.com'
+      MSG
+    end
+  end
+end

data/lib/templates/favicon.svg.erb

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg width="128" height="128" viewBox="0 0 128 128" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <rect fill="#fff" stroke="#000" x="0" y="0" width="128" height="128" stroke-width="4" />
+    <rect fill="#fff" stroke="#000" x="32" y="32" width="64" height="64" stroke-width="2" />
+    <text x="10" y="30" fill="green" font-size="32"><%= Date.today %></text>
+</svg>

data/lib/templates/index.html.erb

@@ -0,0 +1,148 @@
+<html>
+    <head>
+        <title>Work log</title>
+        <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-QWTKZyjpPEjISv5WaRU9OFeRpok6YctnYmDr5pNlyT2bRjXh0JMhjY6hW+ALEwIH" crossorigin="anonymous">
+        <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/js/bootstrap.bundle.min.js" integrity="sha384-YvpcrYf0tY3lHB60NNkmXc5s9fDVZLESaAA55NDzOxhy9GkcIdslK1eN7N6jIeHz" crossorigin="anonymous"></script>
+        <link rel="icon" href="favicon.svg">
+        <link rel="mask-icon" href="favicon.svg" color="#000000">
+        <style type="text/css">
+
+            ul {
+                list-style-type: none;
+                padding: 0 1rem;
+            }
+
+            /* Special style for presentation mode */
+            .presentation {
+                .day {
+                    font-size: 2rem;
+                    line-height: 2.6rem;
+
+                    ul {
+                        border-bottom: 2px solid #AAA;
+                        li {
+                            padding-bottom: 1rem;
+                        }
+                    }
+
+                    .entries {
+                        display: none;
+                    }
+                }
+            }
+        </style>
+    </head>
+    <body>
+    <div class="container <%= presentation ? 'presentation' : '' %>">
+        <nav class="navbar navbar-expand-lg bg-body-tertiary">
+            <div class="container-fluid">
+                <a class="navbar-brand" href="/">
+                    <% if tags %>
+                        <%= tags.first.capitalize %> items
+                    <% else %>
+                        Work log
+                    <% end %>
+                </a>
+                <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
+                    <span class="navbar-toggler-icon"></span>
+                </button>
+                <div class="collapse navbar-collapse" id="navbarSupportedContent">
+                    <div class="navbar-nav me-auto"></div>
+                    <div class="d-flex">
+            <% if presentation %>
+                <a href="<%= update_query({'presentation' => nil}) %>" class="btn btn-primary">
+                    Screen
+                </a>
+            <% else %>
+                <a href="<%= update_query({'presentation' => true}) %>" class="btn btn-primary">
+                    Presentation
+                </a>
+            <% end %>
+            </div>
+                </div>
+            </div>
+
+
+        </nav>
+        <hr class="border border-primary border-2 opacity-75">
+            <div class="pb-4">
+            Show
+            <div class="dropdown d-inline">
+                <a class="btn border-secondary dropdown-toggle" href="#" role="button" data-bs-toggle="dropdown" aria-expanded="false">
+                    <% if epics_only %>
+                    only epics
+                    <% else %>
+                    all items
+                    <% end %>
+                </a>
+                <ul class="dropdown-menu">
+                    <li><a class="dropdown-item" href="<%= update_query({'epics_only' => false}) %>">all items</a></li>
+                    <li><a class="dropdown-item" href="<%= update_query({'epics_only' => true}) %>">only epics</a></li>
+                </ul>
+            </div>
+             from the last
+            <div class="dropdown d-inline">
+                <a class="btn border-secondary dropdown-toggle" href="#" role="button" data-bs-toggle="dropdown" aria-expanded="false">
+                    <%= days %> days
+                </a>
+                <ul class="dropdown-menu">
+                    <li><a class="dropdown-item" href="<%= update_query({'days' => 7}) %>">7 days</a></li>
+                    <li><a class="dropdown-item" href="<%= update_query({'days' => 14}) %>">2 weeks</a></li>
+                    <li><a class="dropdown-item" href="<%= update_query({'days' => 21}) %>">3 weeks</a></li>
+                    <li><a class="dropdown-item" href="<%= update_query({'days' => 28}) %>">4 weeks</a></li>
+                    <li><a class="dropdown-item" href="<%= update_query({'days' => 60}) %>">2 months</a></li>
+                    <li><a class="dropdown-item" href="<%= update_query({'days' => 90}) %>">3 months</a></li>
+                    <li><a class="dropdown-item" href="<%= update_query({'days' => 180}) %>">6 months</a></li>
+                    <li><a class="dropdown-item" href="<%= update_query({'days' => 365}) %>">1 year</a></li>
+                </ul>
+            </div>
+            of work with
+            <div class="dropdown d-inline">
+                <a class="btn border-secondary dropdown-toggle" href="#" role="button" data-bs-toggle="dropdown" aria-expanded="false">
+                    <% if tags %>
+                        <%= tags.size > 1 ? 'multiple tags' : "#{tags.first} tags" %>
+                    <% else %>
+                        all tags
+                    <% end %>
+                </a>
+                <ul class="dropdown-menu">
+                    <li><a class="dropdown-item" href="<%= update_query({'tags' => nil}) %>">all tags</a></li>
+                    <% @tags.to_a.each do |tag| %>
+                        <li><a class="dropdown-item" href="<%= update_query({'tags' => [tag]}) %>"><%= tag %> tags</a></li>
+                    <% end %>
+                </ul>
+            </div>
+            .
+            </div>
+
+        <%- logs.each do |log| -%>
+            <section class="day">
+            <strong><%= log.date.strftime('%a, %B %-d, %Y') %></strong>
+
+            <ul>
+            <%- log.entries.each do |entry| -%>
+                <li>
+                    <code><%= entry.time.strftime('%H:%M') %></code>
+                    <% if entry.epic %>
+                        <span class="badge text-bg-warning">EPIC</span>
+                    <% end%>
+                    <%= entry.message %>
+                    <% if entry.tags and entry.tags.size > 0 %>
+                        <% entry.tags.each do |tag| %>
+                            <strong class="badge text-bg-secondary"><%= tag %></strong>
+                        <% end %>
+                    <% end %>
+                </li>
+            <%- end %>
+            </ul>
+            <p class="entries"><%= log.entries.size %> entries</p>
+            </section>
+        <%- end %>
+        <p><%= total_entries %> entries total</p>
+    </div>
+    <hr/>
+    <footer class="container pb-4 text-muted">
+        Generated at <%= Time.now.strftime('%Y-%m-%d %H:%M %Z') %>
+    </footer>
+    </body>
+</html>

data/lib/version.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+# Returns the current version of the gem from `.version`.
+# Versioning follows SemVer.
+# @return [String] The current version of the gem.
+def current_version
+  version_file_path = File.join(Pathname.new(__dir__).parent, '.version')
+  File.read(version_file_path).strip
+end
+
+# Increment version number according to SemVer.
+# @param version [String] The current version.
+# @param part [String] The part of the version to increment.
+# @return [String] The incremented version.
+def increment_version(version, part = 'patch')
+  major, minor, patch = version.split('.').map(&:to_i)
+  case part
+  when 'major'
+    major += 1
+    minor = 0
+    patch = 0
+  when 'minor'
+    minor += 1
+    patch = 0
+  when 'patch'
+    patch += 1
+  end
+  [major, minor, patch].join('.')
+end

data/lib/webserver.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'erb'
+require 'rack'
+require 'rack/constants'
+require 'rackup'
+require 'uri'
+require 'storage'
+require 'worklog'
+
+class DefaultHeaderMiddleware
+  # Rack middleware to add default headers to the response.
+
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    status, headers, body = @app.call(env)
+    headers[Rack::CONTENT_TYPE] ||= 'text/html'
+    headers[Rack::CACHE_CONTROL] ||= 'no-cache'
+    [status, headers, body]
+  end
+end
+
+# Class to render the main page of the WorkLog web application.
+class WorkLogResponse
+  def initialize(storage, tags)
+    @storage = storage
+    @tags = tags
+  end
+
+  def response(request)
+    template = ERB.new(File.read(File.join(File.dirname(__FILE__), 'templates', 'index.html.erb')), trim_mode: '-')
+    @params = request.params
+    days = @params['days'].nil? ? 7 : @params['days'].to_i
+    tags = @params['tags'].nil? ? nil : @params['tags'].split(',')
+    epics_only = @params['epics_only'] == 'true'
+    presentation = @params['presentation'] == 'true'
+    logs = @storage.days_between(Date.today - days, Date.today, epics_only, tags).reverse
+    total_entries = logs.sum { |entry| entry.entries.length }
+    _ = total_entries
+    _ = presentation
+
+    [200, {}, [template.result(binding)]]
+  end
+
+  private
+
+  def update_query(new_params)
+    uri = URI.parse('/')
+    cloned = @params.clone
+    new_params.each do |key, value|
+      cloned[key] = value
+    end
+    uri.query = URI.encode_www_form(cloned)
+    uri
+  end
+
+  def build_uri(params)
+    uri = URI.parse('/')
+    uri.query = URI.encode_www_form(params)
+    uri.to_s
+  end
+end
+
+class WorkLogApp
+  def initialize(storage)
+    @storage = storage
+    @tags = @storage.tags
+  end
+
+  def call(env)
+    req = Rack::Request.new(env)
+    WorkLogResponse.new(@storage, @tags).response(req)
+  end
+end
+
+# class FaviconApp
+#   # Rack application that creates a favicon.
+
+#   def self.call(_env)
+#     content = ERB.new(File.read(File.join(File.dirname(__FILE__), 'templates', 'favicon.svg.erb')))
+#     [200, { Rack::CONTENT_TYPE => 'image/svg+xml' }, [content.result]]
+#   end
+# end
+
+class WorkLogServer
+  # Main Rack server containing all endpoints.
+  def initialize(worklog_app)
+    @worklog_app = worklog_app
+  end
+
+  def start
+    worklog_app = @worklog_app
+    app = Rack::Builder.new do
+      use Rack::Deflater
+      use Rack::CommonLogger
+      use Rack::ShowExceptions
+      use Rack::ShowStatus
+      use DefaultHeaderMiddleware
+
+      map '/' do
+        run worklog_app
+      end
+      # TODO: Future development
+      # map '/favicon.svg' do
+      #   run FaviconApp
+      # end
+    end
+
+    Rackup::Server.start app: app
+  end
+end