fewald-worklog 0

data/lib/worklog.rb

@@ -0,0 +1,216 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'optparse'
+require 'rainbow'
+require 'yaml'
+
+require 'hash'
+require 'daily_log'
+require 'date_parser'
+require 'log_entry'
+require 'storage'
+require 'worklogger'
+require 'string_helper'
+require 'printer'
+require 'statistics'
+
+# Main class providing all worklog functionality.
+# This class is the main entry point for the application.
+# It handles command line arguments, configuration, and logging.
+class Worklog
+  include StringHelper
+  attr_reader :config
+
+  def initialize(config = nil)
+    @config = config || Configuration.new
+    @storage = Storage.new(@config)
+
+    WorkLogger.level = @config.log_level == :debug ? Logger::Severity::DEBUG : Logger::Severity::INFO
+  end
+
+  def add(message, options = {})
+    # Remove leading and trailing whitespaces
+    # Raise an error if the message is empty
+    message = message.strip
+    raise ArgumentError, 'Message cannot be empty' if message.empty?
+
+    date = Date.strptime(options[:date], '%Y-%m-%d')
+    time = Time.strptime(options[:time], '%H:%M:%S')
+    @storage.create_file_skeleton(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:)
+
+    # Sort by time in case an entry was added later out of order.
+    daily_log.entries.sort_by!(&:time)
+
+    @storage.write_log(@storage.filepath(options[:date]), daily_log)
+
+    WorkLogger.info Rainbow("Added entry on #{options[:date]}: #{message}").green
+  end
+
+  def edit(options = {})
+    date = Date.strptime(options[:date], '%Y-%m-%d')
+
+    # Load existing log
+    log = @storage.load_log(@storage.filepath(date))
+    unless log
+      WorkLogger.error "No work log found for #{options[:date]}. Aborting."
+      exit 1
+    end
+
+    txt = Editor::EDITOR_PREAMBLE.result_with_hash(content: YAML.dump(log))
+    return_val = Editor.open_editor(txt)
+
+    @storage.write_log(@storage.filepath(date),
+                       YAML.load(return_val, permitted_classes: [Date, Time, DailyLog, LogEntry]))
+    WorkLogger.info Rainbow("Updated work log for #{options[:date]}").green
+  end
+
+  def show(options = {})
+    people = @storage.load_people!
+    printer = Printer.new(people)
+
+    start_date, end_date = start_end_date(options)
+
+    entries = @storage.days_between(start_date, end_date)
+    if entries.empty?
+      printer.no_entries(start_date, end_date)
+    else
+      entries.each do |entry|
+        printer.print_day(entry, entries.size > 1, options[:epics_only])
+      end
+    end
+  end
+
+  def people(person = nil, _options = {})
+    all_people = @storage.load_people!
+    people_map = all_people.to_h { |p| [p.handle, p] }
+    all_logs = @storage.all_days
+
+    if person
+      unless people_map.key?(person)
+        WorkLogger.error Rainbow("No person found with handle #{person}.").red
+        return
+      end
+      person_detail(all_logs, all_people, people_map[person.strip])
+    else
+      puts 'People mentioned in the work log:'
+
+      mentions = {}
+
+      all_logs.map(&:people).each do |people|
+        mentions.merge!(people) { |_key, oldval, newval| oldval + newval }
+      end
+
+      # Sort the mentions by handle
+      mentions = mentions.to_a.sort_by { |handle, _| handle }
+
+      mentions.each do |handle, v|
+        if people_map.key?(handle)
+          print "#{Rainbow(people_map[handle].name).gold} (#{handle})"
+        else
+          print handle
+        end
+        puts ": #{v} #{pluralize(v, 'occurrence')}"
+      end
+    end
+  end
+
+  def person_detail(all_logs, all_people, person)
+    printer = Printer.new(all_people)
+    puts "All interactions with #{Rainbow(person.name).gold}"
+
+    if person.notes
+      puts 'Notes:'
+      person.notes.each do |note|
+        puts "* #{note}"
+      end
+    end
+
+    puts 'Interactions:'
+    all_logs.each do |daily_log|
+      daily_log.entries.each do |entry|
+        printer.print_entry(daily_log, entry, true) if entry.people.include?(person.handle)
+      end
+    end
+  end
+
+  def tags(_options = {})
+    all_logs = @storage.all_days
+
+    puts Rainbow('Tags used in the work log:').gold
+
+    # Count all tags used in the work log
+    tags = all_logs.map(&:entries).flatten.map(&:tags).flatten.compact.tally
+
+    # Determine length of longest tag for formatting
+    # Add one additonal space for formatting
+    max_len = tags.empty? ? 0 : tags.keys.map(&:length).max + 1
+
+    tags.sort.each { |k, v| puts "#{Rainbow(k.ljust(max_len)).gold}: #{v} #{pluralize(v, 'occurrence')}" }
+  end
+
+  def stats(_options = {})
+    stats = Statistics.new(@config).calculate
+    puts "#{format_left('Total days')}: #{stats.total_days}"
+    puts "#{format_left('Total entries')}: #{stats.total_entries}"
+    puts "#{format_left('Total epics')}: #{stats.total_epics}"
+    puts "#{format_left('Entries per day')}: #{format('%.2f', stats.avg_entries)}"
+    puts "#{format_left('First entry')}: #{stats.first_entry}"
+    puts "#{format_left('Last entry')}: #{stats.last_entry}"
+  end
+
+  def summary(options = {})
+    start_date, end_date = start_end_date(options)
+    entries = @storage.days_between(start_date, end_date).map(&:entries).flatten
+
+    # Do nothing if no entries are found.
+    if entries.empty?
+      Printer.new.no_entries(start_date, end_date)
+      return
+    end
+    puts Summary.new(@config).generate_summary(entries)
+  end
+
+  def remove(options = {})
+    date = Date.strptime(options[:date], '%Y-%m-%d')
+    unless File.exist?(@storage.filepath(date))
+      WorkLogger.error Rainbow("No work log found for #{options[:date]}. Aborting.").red
+      exit 1
+    end
+
+    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
+    end
+
+    removed_entry = daily_log.entries.pop
+    @storage.write_log(@storage.filepath(date), daily_log)
+    WorkLogger.info Rainbow("Removed entry: #{removed_entry.message}").green
+  end
+
+  # Parse the start and end date based on the options provided
+  #
+  # @param options [Hash] the options hash
+  # @return [Array] the start and end date as an array
+  def start_end_date(options)
+    if options[:days]
+      # Safeguard against negative days
+      raise ArgumentError, 'Number of days cannot be negative' if options[:days].negative?
+
+      start_date = Date.today - options[:days]
+      end_date = Date.today
+    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
+      start_date = Date.strptime(options[:date], '%Y-%m-%d')
+      end_date = start_date
+    end
+    [start_date, end_date]
+  end
+end

data/lib/worklogger.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'singleton'
+
+# Singleton class for logging work log messages
+class WorkLogger
+  include Singleton
+
+  def self.instance
+    @instance ||= Logger.new($stdout)
+  end
+
+  def self.level=(level)
+    instance.level = level
+  end
+
+  def self.level
+    instance.level
+  end
+
+  def self.info(message) = instance.info(message)
+  def self.warn(message) = instance.warn(message)
+  def self.error(message) = instance.error(message)
+  def self.debug(message) = instance.debug(message)
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: fewald-worklog
+version: !ruby/object:Gem::Version
+  version: '0'
+platform: ruby
+authors:
+- Friedrich Ewald
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.6'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rackup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: |
+  Command line tool for tracking achievments, tasks and interactions.
+
+  You can add work items, view them and run a webserver to share them with other people,
+  for example via screen sharing.
+
+  This tool is designed to run in a terminal completely local without sharing any data with
+  any other service. No telemetry, no tracking, no data sharing of any kind.
+executables:
+- wl
+extensions: []
+extra_rdoc_files: []
+files:
+- ".version"
+- bin/wl
+- lib/cli.rb
+- lib/configuration.rb
+- lib/daily_log.rb
+- lib/date_parser.rb
+- lib/editor.rb
+- lib/hash.rb
+- lib/log_entry.rb
+- lib/person.rb
+- lib/printer.rb
+- lib/statistics.rb
+- lib/storage.rb
+- lib/string_helper.rb
+- lib/summary.rb
+- lib/templates/favicon.svg.erb
+- lib/templates/index.html.erb
+- lib/version.rb
+- lib/webserver.rb
+- lib/worklog.rb
+- lib/worklogger.rb
+homepage: https://github.com/f-ewald/worklog
+licenses:
+- MIT
+metadata:
+  documentation_uri: https://f-ewald.github.io/worklog
+  rubygems_mfa_required: 'true'
+post_install_message: 'Thanks for installing worklog! Now you can use it by running
+  wl from your terminal.''
+
+  '
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Command line tool for tracking achievments, tasks and interactions.
+test_files: []