fewald-worklog 0.3.4 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5469080196a9c73579db866047532ac791b48d2dd1ea470a1996b3175132d669
-  data.tar.gz: 6a6540617d20a0ad75b1489774b8507e0558a14389652a6b1add2ca63ba3f909
+  metadata.gz: e2554331b36043db6a3386effbe1c243c99c97bbceae33b4faa4fcbdf8242101
+  data.tar.gz: 8497987c745fad61def23bb27eb02a2c1785cd988bdcc21598cf13d8a0fa01b5
 SHA512:
-  metadata.gz: 97c033d0d3b61fc15972104f43c6b25ac1e1e8bfbff29031b591849f8e1bd2c5eccfb91c8ada2cf7a15a71f9dcc9abbaf37669a075c4013c47cf364908bb155b
-  data.tar.gz: 307dea9173abc3207316aadd0ee6e5fe557966ca72ea857ff4ea69e30866d8c3c3a2dcb8eb74650ada3c482c4e33a85e7555a115837594fc9921253d1b45adb6
+  metadata.gz: d40bccfd27b7da9e638259a5eec07d3cb5f7c898fc9692eee088dfe93a5abeb39023a617434f784ff9a4a6047ba4a9acd2c5db672c82d4006180c4b1663636cc
+  data.tar.gz: 8cb2393190a637bdff6cb4147d8296f71fae468103dee080778c17035d1438c23db5b3e8cee8a79533029f8acb784690da1deb5f24a6d548406457ab6f2b9f6e

data/.version

@@ -1 +1 @@
-0.3.4
+0.3.6

data/lib/cli.rb

@@ -77,6 +77,12 @@ class WorklogCLI < Thor
     worklog.github(options)
   end
 
+  desc 'init', 'Initialize the work log storage and configuration in the home directory'
+  def init
+    worklog = Worklog::Worklog.new
+    worklog.init(options)
+  end
+
   desc 'remove', 'Remove last entry from the log'
   option :date, type: :string, default: Time.now.strftime('%Y-%m-%d')
   def remove
@@ -110,6 +116,7 @@ class WorklogCLI < Thor
   end
 
   desc 'people', 'Show all people mentioned in the work log'
+  option :inactive, type: :boolean, default: false, desc: 'Include inactive people in the list'
   def people(person = nil)
     worklog = Worklog::Worklog.new
     worklog.people(person, options)

data/lib/configuration.rb

@@ -72,6 +72,27 @@ module Worklog
       end
     end
 
+    CONFIGURATION_TEMPLATE = ERB.new <<~YAML
+      # Worklog Configuration File
+      # This file contains configuration settings for Worklog.
+      # You can modify the values below to customize your setup.
+      # For more information, refer to the documentation.
+      storage_path: <%= Dir.home %>/.worklog
+      log_level: info
+      timezone: 'America/Los_Angeles'
+      webserver_port: 3000
+
+      project:
+        # Number of last projects to show in the project list
+        show_last: 3
+
+      github:
+        # Your GitHub API key for accessing the GitHub API
+        api_key: ""
+        # Your GitHub username for finding assigned issues and PRs
+        username: ""
+    YAML
+
     # Initialize configuration with optional block for setting attributes.
     # If no block is given, default values are used.
     # @example
@@ -98,7 +119,7 @@ module Worklog
     # If the file does not exist, it will use default values.
     # @return [Configuration] the loaded configuration
     def self.load
-      file_path = File.join(Dir.home, '.worklog.yaml')
+      file_path = config_file_path
       config = Configuration.new
       if File.exist?(file_path)
         file_cfg = YAML.load_file(file_path)
@@ -126,5 +147,11 @@ module Worklog
     def default_storage_path?
       @storage_path == File.join(Dir.home, '.worklog')
     end
+
+    # Get the default configuration file path.
+    # @return [String] the default configuration file path
+    def self.config_file_path
+      File.join(Dir.home, '.worklog.yaml')
+    end
   end
 end

data/lib/person.rb

@@ -13,8 +13,10 @@ module Worklog
   #  @return [String, nil] The team the person belongs to, can be nil
   # !attribute [r] notes
   #  @return [Array<String>] An array of notes about the person
+  #  !attribute [r] inactive
+  #  @return [Boolean] Whether the person is inactive (for example left the company)
   class Person
-    attr_reader :handle, :github_username, :name, :email, :team, :notes
+    attr_reader :handle, :github_username, :name, :email, :team, :notes, :inactive
 
     def initialize(handle:, name:, **params)
       # params to symbol keys
@@ -26,6 +28,20 @@ module Worklog
       @email = params[:email]
       @team = params[:team]
       @notes = params[:notes] || []
+      @inactive = params[:inactive] || false
+    end
+
+    # Returns true if the person is active (not inactive).
+    # If not specified, persons are active by default.
+    # @return [Boolean] true if active, false otherwise
+    def active?
+      !@inactive
+    end
+
+    # Returns true if the person is marked as inactive.
+    # @return [Boolean] true if inactive, false otherwise
+    def inactive?
+      @inactive
     end
 
     # Creates a new Person instance from a hash of attributes.

data/lib/project_storage.rb

@@ -41,6 +41,9 @@ module Worklog
       @configuration = configuration
     end
 
+    # Returns all loaded projects.
+    # If the projects are not already loaded, it loads them from disk.
+    # @return [Hash<String, Project>] A hash of project objects keyed by their unique project keys.
     def projects
       @projects ||= load_projects
     end

data/lib/storage.rb

@@ -17,6 +17,21 @@ module Worklog
     # Regular expression to match daily log file names
     LOG_PATTERN = /\d{4}-\d{2}-\d{2}#{FILE_SUFFIX}\z/
 
+    # The template for the people YAML file.
+    # This template is used to create a new people file if it does not exist.
+    PERSON_TEMPLATE = <<~YAML
+      ---
+      # Each person is defined by the following attributes:
+      # - handle: <unique_handle>
+      #   github_username: <github_username>
+      #   name: <full_name>
+      #   team: <team_name>
+      #   email: <email_address>
+      #   role: <role_in_team>
+      #   inactive: <true_or_false>
+      #   --- Define your people below this line ---
+    YAML
+
     def initialize(config)
       @config = config
     end
@@ -157,14 +172,13 @@ module Worklog
     # 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)
+      return [] unless File.exist?(people_filepath)
 
-      yamltext = File.read(people_file)
+      yamltext = File.read(people_filepath)
       if yamltext != yamltext.gsub(/^- !.*$/, '-')
         WorkLogger.debug 'The people.yaml file contains deprecated syntax. Migrating now.'
         yamltext.gsub!(/^- !.*$/, '-')
-        File.write(people_file, yamltext)
+        File.write(people_filepath, yamltext)
       end
       YAML.load(yamltext, permitted_classes: []).map { |person_hash| Person.from_hash(person_hash) }
     end
@@ -172,25 +186,59 @@ module Worklog
     # Write people to the people file
     # @param [Array<Person>] people List of people
     def write_people!(people)
-      people_file = File.join(@config.storage_path, 'people.yaml')
-      File.open(people_file, 'w') do |f|
+      File.open(people_filepath, 'w') do |f|
         f.puts people.to_yaml
       end
     end
 
     # Create folder if not exists already.
+    # @return [void]
     def create_default_folder
+      WorkLogger.debug 'Creating storage folder if it does not exist.'
+
       # Do nothing if the storage path is not the default path
-      return unless @config.default_storage_path?
+      unless @config.default_storage_path?
+        WorkLogger.debug 'Custom storage path detected, skipping creation of default storage folder.'
+        return
+      end
 
       Dir.mkdir(@config.storage_path) unless Dir.exist?(@config.storage_path)
     end
 
+    # This method assumes that the storage folder already exists.
+    # It creates default files like people.yaml if they do not exist.
+    def create_default_files
+      WorkLogger.info 'Creating default files in storage folder if they do not exist.'
+      # projects_file = File.join(@config.storage_path, 'projects.yaml')
+      # unless File.exist?(projects_file)
+      #   File.write(projects_file, [].to_yaml)
+      # end
+
+      if File.exist?(people_filepath)
+        WorkLogger.info 'people.yaml already exists, skipping creation.'
+      else
+        WorkLogger.info 'Creating default people.yaml file.'
+        File.write(people_filepath, PERSON_TEMPLATE)
+      end
+
+      # Write the default config file if it does not exist
+      return if File.exist?(Configuration.config_file_path)
+
+      File.write(Configuration.config_file_path,
+                 Configuration::CONFIGURATION_TEMPLATE.result)
+    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
+
+    # Return the full absolute filepath for the people.yaml file
+    # @return [String] The filepath
+    def people_filepath
+      File.join(@config.storage_path, 'people.yaml')
+    end
   end
 end

data/lib/worklog.rb

@@ -24,7 +24,7 @@ require 'takeout'
 module Worklog
   # Main class providing all worklog functionality.
   # This class is the main entry point for the application.
-  # It handles command line arguments, configuration, and logging.
+  # It handles configuration, data storage, and logging.
   # @!attribute [r] config
   #   @return [Configuration] The configuration object containing settings for the application.
   # @!attribute [r] storage
@@ -40,7 +40,9 @@ module Worklog
   #                date: '2023-10-01',
   #                time: '10:00:00',
   #                tags: ['feature', 'x'],
-  #                ticket: 'TICKET-123')
+  #                ticket: 'TICKET-123',
+  #                epic: true,
+  #                project: 'my_project')
   class Worklog
     include StringHelper
 
@@ -50,11 +52,13 @@ module Worklog
       # Load or use provided configuration
       @config = config || Configuration.load
 
-      # Initialize storage
-      @storage = Storage.new(@config)
-
+      # Set log level based on configuration
       WorkLogger.level = @config.log_level == :debug ? Logger::Severity::DEBUG : Logger::Severity::INFO
 
+      # Initialize (project) storage
+      @storage = Storage.new(@config)
+      @project_storage = ProjectStorage.new(@config)
+
       bootstrap
     end
 
@@ -64,6 +68,9 @@ module Worklog
 
       # Load all people as they're used in multiple/most of the methods.
       @people = @storage.load_people_hash
+
+      # Load all projects from disk
+      @projects = @project_storage.load_projects
     end
 
     # Add new entry to the work log.
@@ -157,7 +164,7 @@ module Worklog
     end
 
     # Show all known people and details about a specific person.
-    def people(person = nil, _options = {})
+    def people(person = nil, options = {})
       all_logs = @storage.all_days
 
       if person
@@ -180,6 +187,8 @@ module Worklog
 
         mentions.each do |handle, v|
           if @people.key?(handle)
+            next unless @people[handle].active? || options[:inactive]
+
             person = @people[handle]
             print "#{Rainbow(person.name).gold} (#{handle})"
             print " (#{person.team})" if person.team
@@ -195,6 +204,8 @@ module Worklog
       printer = Printer.new(@config, all_people)
       puts "All interactions with #{Rainbow(person.name).gold}"
 
+      puts "GitHub: #{Rainbow(person.github_username).blue}" if person.github_username
+
       if person.notes
         puts 'Notes:'
         person.notes.each do |note|

metadata

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