fewald-worklog 0 → 0.1.1

data/worklog/version.rb

@@ -0,0 +1,11 @@
+# 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

data/{lib → worklog}/webserver.rb

@@ -6,8 +6,8 @@ require 'rack'
 require 'rack/constants'
 require 'rackup'
 require 'uri'
-require 'storage'
-require 'worklog'
+require_relative 'storage'
+require_relative 'worklog'
 
 class DefaultHeaderMiddleware
   # Rack middleware to add default headers to the response.
@@ -24,12 +24,8 @@ class DefaultHeaderMiddleware
   end
 end
 
-# Class to render the main page of the WorkLog web application.
 class WorkLogResponse
-  def initialize(storage, tags)
-    @storage = storage
-    @tags = tags
-  end
+  # Class to render the main page of the WorkLog web application.
 
   def response(request)
     template = ERB.new(File.read(File.join(File.dirname(__FILE__), 'templates', 'index.html.erb')), trim_mode: '-')
@@ -38,7 +34,7 @@ class WorkLogResponse
     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
+    logs = Storage.days_between(Date.today - days, Date.today, epics_only, tags).reverse
     total_entries = logs.sum { |entry| entry.entries.length }
     _ = total_entries
     _ = presentation
@@ -66,14 +62,9 @@ class WorkLogResponse
 end
 
 class WorkLogApp
-  def initialize(storage)
-    @storage = storage
-    @tags = @storage.tags
-  end
-
-  def call(env)
+  def self.call(env)
     req = Rack::Request.new(env)
-    WorkLogResponse.new(@storage, @tags).response(req)
+    WorkLogResponse.new.response(req)
   end
 end
 
@@ -88,12 +79,8 @@ 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
@@ -102,7 +89,7 @@ class WorkLogServer
       use DefaultHeaderMiddleware
 
       map '/' do
-        run worklog_app
+        run WorkLogApp
       end
       # TODO: Future development
       # map '/favicon.svg' do

data/worklog/worklog.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+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,112 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fewald-worklog
 version: !ruby/object:Gem::Version
-  version: '0'
+  version: 0.1.1
 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'
+date: 2025-03-12 00:00:00.000000000 Z
+dependencies: []
 description: |
   Command line tool for tracking achievments, tasks and interactions.
 
@@ -120,27 +22,25 @@ executables:
 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
+- worklog/cli.rb
+- worklog/daily_log.rb
+- worklog/date_parser.rb
+- worklog/editor.rb
+- worklog/hash.rb
+- worklog/log_entry.rb
+- worklog/logger.rb
+- worklog/person.rb
+- worklog/printer.rb
+- worklog/statistics.rb
+- worklog/storage.rb
+- worklog/string_helper.rb
+- worklog/summary.rb
+- worklog/templates/favicon.svg.erb
+- worklog/templates/index.html.erb
+- worklog/version.rb
+- worklog/webserver.rb
+- worklog/worklog.rb
 homepage: https://github.com/f-ewald/worklog
 licenses:
 - MIT
@@ -165,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Command line tool for tracking achievments, tasks and interactions.
 test_files: []

data/.version

@@ -1 +0,0 @@
-

data/lib/cli.rb

@@ -1,149 +0,0 @@
-# frozen_string_literal: true
-
-# Add the current directory to the load path
-# curr_dir = File.expand_path(__dir__)
-# $LOAD_PATH << curr_dir unless $LOAD_PATH.include?(curr_dir)
-
-require 'thor'
-require 'date'
-require 'worklogger'
-
-require 'worklog'
-require 'date_parser'
-require 'configuration'
-require 'editor'
-require 'printer'
-require 'statistics'
-require 'storage'
-require 'string_helper'
-require 'summary'
-require 'version'
-require 'webserver'
-
-# CLI for the work log application
-class WorklogCLI < Thor
-  attr_accessor :config, :storage
-
-  include StringHelper
-  class_option :verbose, type: :boolean, aliases: '-v', desc: 'Enable verbose output'
-
-  package_name 'Worklog'
-
-  # Initialize the CLI with the given arguments, options, and configuration
-  def initialize(args = [], options = {}, config = {})
-    @config = load_configuration
-    @storage = Storage.new(@config)
-    super
-  end
-
-  def self.exit_on_failure?
-    true
-  end
-
-  desc 'add MESSAGE', 'Add a new entry to the work log, defaults to the current date.'
-  long_desc <<~LONGDESC
-    Add a new entry with the current date and time to the work log.
-    The message is required and must be enclosed in quotes if it contains more than one word.
-
-    People can be referenced either by using the tilde "~" or the at symbol "@", followed by
-    an alphanumeric string.
-  LONGDESC
-  option :date, type: :string, default: DateTime.now.strftime('%Y-%m-%d'), desc: 'Set the date of the entry'
-  option :time, type: :string, default: DateTime.now.strftime('%H:%M:%S'), desc: 'Set the time of the entry'
-  option :tags, type: :array, default: [], desc: 'Add tags to the entry'
-  option :ticket, type: :string, desc: 'Ticket number associated with the entry. Can be any alphanumeric string.'
-  option :url, type: :string, desc: 'URL to associate with the entry'
-  option :epic, type: :boolean, default: false, desc: 'Mark the entry as an epic'
-  def add(message)
-    worklog = Worklog.new
-    worklog.add(message, options)
-  end
-
-  desc 'edit', 'Edit a day in the work log. By default, the current date is used.'
-  option :date, type: :string, default: DateTime.now.strftime('%Y-%m-%d')
-  def edit
-    worklog = Worklog.new
-    worklog.edit(options)
-  end
-
-  desc 'remove', 'Remove last entry from the log'
-  option :date, type: :string, default: DateTime.now.strftime('%Y-%m-%d')
-  def remove
-    worklog = Worklog.new
-    worklog.remove(options)
-  end
-
-  desc 'show', 'Show the work log for a specific date or a range of dates. Defaults to todays date.'
-  long_desc <<~LONGDESC
-    Show the work log for a specific date or a range of dates. As a default, all items from the current day will be shown.
-  LONGDESC
-  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
-  option :epics_only, type: :boolean, default: false, desc: 'Show only entries that are marked as epic'
-  option :tags, type: :array, default: [], desc: 'Filter entries by tags. Tags are treated as an OR condition.'
-  def show
-    worklog = Worklog.new
-    worklog.show(options)
-  end
-
-  desc 'people', 'Show all people mentioned in the work log'
-  def people(person = nil)
-    worklog = Worklog.new
-    worklog.people(person, options)
-  end
-
-  desc 'tags', 'Show all tags used in the work log'
-  def tags
-    worklog = Worklog.new
-    worklog.tags(options)
-  end
-
-  desc 'server', 'Start the work log server'
-  def server
-    app = WorkLogApp.new(@storage)
-    WorkLogServer.new(app).start
-  end
-
-  desc 'stats', 'Show statistics for the work log'
-  def stats
-    worklog = Worklog.new
-    worklog.stats(options)
-  end
-
-  desc 'summary', 'Generate a summary of the work log entries'
-  option :date, type: :string, default: DateTime.now.strftime('%Y-%m-%d')
-  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 summary
-    worklog = Worklog.new
-    worklog.summary(options)
-  end
-
-  desc 'version', 'Show the version of the Worklog'
-  def version
-    puts "Worklog #{current_version} running on Ruby #{RUBY_VERSION}"
-  end
-
-  # Define shortcuts and aliases
-  map 'a' => :add
-  map 'statistics' => :stats
-  map 'serve' => :server
-end

data/lib/configuration.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-require 'yaml'
-
-# Configuration class for the application.
-class Configuration
-  attr_accessor :storage_path, :log_level, :webserver_port
-
-  def initialize(&block)
-    block.call(self) if block_given?
-
-    # Set default values if not set
-    @storage_path ||= File.join(Dir.home, '.worklog')
-    @log_level ||= :info
-    @webserver_port ||= 3000
-  end
-end
-
-# Load configuration from a YAML file.
-# The file should be located at ~/.worklog.yaml.
-def load_configuration
-  file_path = File.join(Dir.home, '.worklog.yaml')
-  if File.exist?(file_path)
-    file_cfg = YAML.load_file(file_path)
-    Configuration.new do |cfg|
-      cfg.storage_path = file_cfg['storage_path'] if file_cfg['storage_path']
-      cfg.log_level = file_cfg['log_level'].to_sym if file_cfg['log_level']
-      cfg.webserver_port = file_cfg['webserver_port'] if file_cfg['webserver_port']
-    end
-  else
-    puts "Configuration file does not exist in #{file_path}"
-  end
-end

data/lib/storage.rb

@@ -1,172 +0,0 @@
-# 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/version.rb

@@ -1,31 +0,0 @@
-# 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