timet 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d469231d2981219dd87a4f3e7a456f1e5d047656186343798cc6a5edd4990fdc
-  data.tar.gz: 17c5ff8e151fc7ac540aa85f84ba3e93b6678d50d544e3a8489411235dfdd391
+  metadata.gz: bec76070c29c2eab4a2a5792084a9980c1cd29c0ab3ac80dbae2c6310e74d78a
+  data.tar.gz: 551fe37b00ac0ca015e28fcdd37810216c0ff00ea4b800c97bd0fb539af1df7b
 SHA512:
-  metadata.gz: 4915bac3ff784ebc128e4dc4ba97c9427cc673c04ee7cb14b72f01bc7366d4b8ce741eb060f4caa6d33126ebee6cece04a2ccb3d37aaa8483c8ce36a0f2be540
-  data.tar.gz: cb97abad6c3be282f2ce0d46df2f500da6fbb4ccecdd89574b81110f1da1475a3d7ccf677634b4691a7332880b2ab9cc5e5e32ad9e25291f6210a0958ae48253
+  metadata.gz: 290e56a65e8c9e163d1558efe87fb93c8d74522c9aa1410f77a21ea6fe81d4a8270ec03947deb959699940c1c40ff91b4749f9512f1de4e005ac822cb564934a
+  data.tar.gz: 0e27f41ad71bca972355c70c235d900ae0c4ec571c47f9fd7324b979b3036b02f4cd6dd5aaa0464d4dd5ac12f2989ae38aed5e15613c496eb182dacb92f3bf11

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 ## [Unreleased]
 
+## [1.4.0] - 2024-10-29
+
+**Improvements:**
+
+- Introduced constants for fixed tag size and block character in the `TagDistribution` module.
+- Refactored `process_and_print_tags` to use constants directly and ensure tags are truncated to fit within the defined size.
+- Simplified `calculate_value_and_bar_length` method to directly calculate percentage value and bar length using `MAX_BAR_LENGTH`.
+- Renamed `summary` to `report` in `application.rb` for clarity.
+- Integrated `Formatter` functionality into `Table` and `TimeBlockChart` modules.
+- Added new methods in `Table` for formatting specific parts of the table row.
+- Enhanced `TimeBlockChart` with new methods for formatting and printing date information.
+- Integrated `Table` and `TimeBlockChart` into `TimeReport` for a more modular structure.
+- Removed redundant methods from `TimeReportHelper` and ensured all necessary methods are included in the appropriate modules.
+- Added a `blue` method to the `String` class to apply blue color to text and applied it to the total time display in `TimeReport`.
+- Refactored database initialization and column addition logic to improve reusability and maintainability.
+- Refactored Pomodoro session handling and table formatting to improve readability and functionality.
+- Refactored `summary` method to use `time_scope` instead of `filter` for clarity.
+- Refactored insertion logic to improve clarity and prevent redundant checks.
+- Refactored tag distribution formatting into a separate `TagDistribution` module for better code organization.
+
+**Bug fixes:**
+
+- Fixed a typo in the table header title.
+
 ## [1.3.2] - 2024-10-25
 
 **Improvements:**

data/lib/timet/application.rb

@@ -69,10 +69,12 @@ module Timet
       notes = options[:notes] || notes
       pomodoro = (options[:pomodoro] || pomodoro).to_i
 
-      if VALID_STATUSES_FOR_INSERTION.include?(@db.last_item_status)
-        @db.insert_item(start_time, tag, notes)
-        play_sound_and_notify(pomodoro * 60, tag) if pomodoro.positive?
+      unless VALID_STATUSES_FOR_INSERTION.include?(@db.last_item_status)
+        return puts 'A task is currently being tracked.'
       end
+
+      @db.insert_item(start_time, tag, notes, pomodoro)
+      play_sound_and_notify(pomodoro * 60, tag) if pomodoro.positive?
       summary
     end
 
@@ -128,15 +130,15 @@ module Timet
       end
     end
 
-    desc 'summary (su) [filter] [tag] --csv=csv_filename',
-         '[filter] => [today (t), yesterday (y), week (w), month (m), [start_date]..[end_date]]  [tag]'
+    desc 'summary (su) [time_scope] [tag] --csv=csv_filename',
+         '[time_scope] => [today (t), yesterday (y), week (w), month (m), [start_date]..[end_date]]  [tag]'
     option :csv, type: :string, desc: 'Export to CSV file'
-    # Generates a summary of tracking items based on the provided filter and tag, and optionally exports the summary
+    # Generates a summary of tracking items based on the provided time_scope and tag, and optionally exports the summary
     # to a CSV file.
     #
-    # @param filter [String, nil] The filter to apply when generating the summary. Possible values include 'today',
-    # 'yesterday', 'week', 'month', or a date range in the format '[start_date]..[end_date]'.
-    # @param tag [String, nil] The tag to filter the tracking items by.
+    # @param time_scope [String, nil] The time_scope to apply when generating the summary. Possible values include
+    # 'today', 'yesterday', 'week', 'month', or a date range in the format '[start_date]..[end_date]'.
+    # @param tag [String, nil] The tag to time_scope the tracking items by.
     #
     # @return [void] This method does not return a value; it performs side effects such as displaying the summary and
     # exporting to CSV if specified.
@@ -150,19 +152,19 @@ module Timet
     # @example Generate a summary for a date range and export to CSV
     #   summary('2023-01-01..2023-01-31', nil, csv: 'summary.csv')
     #
-    # @note The method initializes a `TimeReport` object with the database, filter, tag, and optional CSV filename.
+    # @note The method initializes a `TimeReport` object with the database, time_scope, tag, and optional CSV filename.
     # @note The method calls `display` on the `TimeReport` object to show the summary.
     # @note If a CSV filename is provided and there are items to export, the method calls `export_sheet` to export the
     # summary to a CSV file.
     # @note If no items are found to export, it prints a message indicating that no items were found.
-    def summary(filter = nil, tag = nil)
+    def summary(time_scope = nil, tag = nil)
       csv_filename = options[:csv]&.split('.')&.first
-      summary = TimeReport.new(@db, filter, tag, csv_filename)
+      report = TimeReport.new(@db, time_scope, tag, csv_filename)
 
-      summary.display
-      items = summary.items
+      report.display
+      items = report.items
       if csv_filename && items.any?
-        summary.export_sheet
+        report.export_sheet
       elsif items.empty?
         puts 'No items found to export'
       end
@@ -281,25 +283,5 @@ module Timet
     def version
       puts Timet::VERSION
     end
-
-    private
-
-    # Deletes a tracking item from the database by its ID and prints a confirmation message.
-    #
-    # @param id [Integer] The ID of the tracking item to be deleted.
-    # @param message [String] The message to be printed after the item is deleted.
-    #
-    # @return [void] This method does not return a value; it performs side effects such as deleting the tracking item
-    # and printing a message.
-    #
-    # @example Delete a tracking item with ID 1 and print a confirmation message
-    #   delete_item_and_print_message(1, 'Deleted item 1')
-    #
-    # @note The method deletes the tracking item from the database using `@db.delete_item(id)`.
-    # @note After deleting the item, the method prints the provided message using `puts message`.
-    def delete_item_and_print_message(id, message)
-      @db.delete_item(id)
-      puts message
-    end
   end
 end

data/lib/timet/application_helper.rb

@@ -109,10 +109,10 @@ module Timet
     # @param tag [String] A tag or label for the session, used in the notification message.
     # @return [void]
     def run_linux_session(time, tag)
-      notification_command = "notify-send --icon=clock 'Pomodoro session complete! (tag: #{tag}) Time for a break.'"
+      notification_command = "notify-send --icon=clock '#{show_message(tag)}'"
       command = "sleep #{time} && tput bel && tt stop 0 && #{notification_command} &"
       pid = spawn(command)
-      Process.wait(pid)
+      Process.detach(pid)
     end
 
     # Runs a Pomodoro session on a macOS system.
@@ -120,11 +120,42 @@ module Timet
     # @param time [Integer] The duration of the Pomodoro session in seconds.
     # @param _tag [String] A tag or label for the session, not used in the notification message on macOS.
     # @return [void]
-    def run_mac_session(time, _tag)
-      notification_command = "osascript -e 'display notification \"Pomodoro session complete! Time for a break.\"'"
+    def run_mac_session(time, tag)
+      notification_command = "osascript -e 'display notification \"#{show_message(tag)}\"'"
       command = "sleep #{time} && afplay /System/Library/Sounds/Basso.aiff && tt stop 0 && #{notification_command} &"
       pid = spawn(command)
-      Process.wait(pid)
+      Process.detach(pid)
+    end
+
+    # Generates a message indicating that a Pomodoro session is complete and it's time for a break.
+    #
+    # @param tag [String] The tag associated with the completed Pomodoro session.
+    # @return [String] A message indicating the completion of the Pomodoro session and suggesting a break.
+    #
+    # @example
+    #   show_message("work")
+    #   # => "Pomodoro session complete (work). Time for a break."
+    #
+    def show_message(tag)
+      "Pomodoro session complete (#{tag}). Time for a break."
+    end
+
+    # Deletes a tracking item from the database by its ID and prints a confirmation message.
+    #
+    # @param id [Integer] The ID of the tracking item to be deleted.
+    # @param message [String] The message to be printed after the item is deleted.
+    #
+    # @return [void] This method does not return a value; it performs side effects such as deleting the tracking item
+    # and printing a message.
+    #
+    # @example Delete a tracking item with ID 1 and print a confirmation message
+    #   delete_item_and_print_message(1, 'Deleted item 1')
+    #
+    # @note The method deletes the tracking item from the database using `@db.delete_item(id)`.
+    # @note After deleting the item, the method prints the provided message using `puts message`.
+    def delete_item_and_print_message(id, message)
+      @db.delete_item(id)
+      puts message
     end
   end
 end

data/lib/timet/color_codes.rb

@@ -5,7 +5,7 @@ module Timet
   class ColorCodes
     RESET = "\u001b[0m"
     UNDERLINE = "\e[4m"
-    BLINK = "\e[5m["
+    BLINK = "\e[5m"
 
     def self.reset
       RESET
@@ -27,6 +27,10 @@ end
 
 # Extend String class globally
 class String
+  def white
+    "#{Timet::ColorCodes.color(246)}#{self}#{Timet::ColorCodes.reset}"
+  end
+
   def gray
     "#{Timet::ColorCodes.color(242)}#{self}#{Timet::ColorCodes.reset}"
   end
@@ -35,6 +39,10 @@ class String
     "#{Timet::ColorCodes.color(1)}#{self}#{Timet::ColorCodes.reset}"
   end
 
+  def blue
+    "#{Timet::ColorCodes.color(12)}#{self}#{Timet::ColorCodes.reset}"
+  end
+
   def underline
     "#{Timet::ColorCodes.underline}#{self}#{Timet::ColorCodes.reset}"
   end

data/lib/timet/database.rb

@@ -28,7 +28,9 @@ module Timet
     def initialize(database_path = DEFAULT_DATABASE_PATH)
       @db = SQLite3::Database.new(database_path)
       create_table
-      add_notes
+
+      add_column('items', 'notes', 'TEXT')
+      add_column('items', 'pomodoro', 'INTEGER')
     end
 
     # Creates the items table if it doesn't already exist.
@@ -51,23 +53,27 @@ module Timet
       SQL
     end
 
-    # Adds a new column named "notes" to the "items" table if it doesn't exist.
+    # Adds a new column to the specified table if it does not already exist.
     #
-    # @return [void] This method does not return a value; it performs side effects such as executing SQL to add
-    # the column.
+    # @param table_name [String] The name of the table to which the column will be added.
+    # @param new_column_name [String] The name of the new column to be added.
+    # @param date_type [String] The data type of the new column (e.g., 'INTEGER', 'TEXT', 'BOOLEAN').
+    # @return [void] This method does not return a value; it performs side effects such as adding the column and
+    # printing a message.
     #
-    # @example Add the notes column to the items table
-    #   add_notes
+    # @example Add a new 'completed' column to the 'tasks' table
+    #   add_column('tasks', 'completed', 'INTEGER')
     #
-    # @note The method checks if the 'notes' column already exists and adds it if it does not.
-    def add_notes
-      table_name = 'items'
-      new_column_name = 'notes'
+    # @note The method first checks if the column already exists in the table using `pragma_table_info`.
+    # @note If the column exists, the method returns without making any changes.
+    # @note If the column does not exist, the method executes an SQL `ALTER TABLE` statement to add the column.
+    # @note The method prints a message indicating that the column has been added.
+    def add_column(table_name, new_column_name, date_type)
       result = execute_sql("SELECT count(*) FROM pragma_table_info('items') where name='#{new_column_name}'")
       column_exists = result[0][0].positive?
       return if column_exists
 
-      execute_sql("ALTER TABLE #{table_name} ADD COLUMN #{new_column_name} TEXT")
+      execute_sql("ALTER TABLE #{table_name} ADD COLUMN #{new_column_name} #{date_type}")
       puts "Column '#{new_column_name}' added to table '#{table_name}'."
     end
 
@@ -84,8 +90,8 @@ module Timet
     #   insert_item(1633072800, 'work', 'Completed task X')
     #
     # @note The method executes SQL to insert a new row into the 'items' table.
-    def insert_item(start, tag, notes)
-      execute_sql('INSERT INTO items (start, tag, notes) VALUES (?, ?, ?)', [start, tag, notes])
+    def insert_item(start, tag, notes, pomodoro = nil)
+      execute_sql('INSERT INTO items (start, tag, notes, pomodoro) VALUES (?, ?, ?, ?)', [start, tag, notes, pomodoro])
     end
 
     # Updates an existing item in the items table.

data/lib/timet/table.rb

@@ -0,0 +1,300 @@
+# frozen_string_literal: true
+
+module Timet
+  # This module is responsible for formatting the output of the `timet` application.
+  # It provides methods for formatting the table header, separators, and rows.
+  module Table
+    # Generates and displays a table summarizing time entries, including headers, time blocks, and total durations.
+    #
+    # @example
+    #   table
+    #
+    # @return [Array<(String, Hash)>] An array containing the time block string and a hash of durations by tag.
+    #
+    # @note
+    #   - The method relies on the `header`, `process_time_entries`, `separator`, and `total` methods.
+    #   - The `header` method is responsible for printing the table header.
+    #   - The `process_time_entries` method processes the time entries and returns the time block and duration by tag.
+    #   - The `separator` method returns a string representing the separator line.
+    #   - The `total` method prints the total duration.
+    #
+    # @see #header
+    # @see #process_time_entries
+    # @see #separator
+    # @see #total
+    def table
+      header
+      time_block, duration_by_tag = process_time_entries
+      puts separator
+      total
+      [time_block, duration_by_tag]
+    end
+
+    # Formats the header of the time tracking report table.
+    #
+    # @return [void] This method does not return a value; it performs side effects such as printing
+    # the formatted header.
+    #
+    # @example Format and print the table header
+    #   header
+    #
+    # @note The method constructs a string representing the table header and prints it.
+    def header
+      title = "Tracked time report [#{@filter.blink.red}]:"
+      header = <<~TABLE
+        #{title}
+        #{separator}
+        \033[32m| Id    | Date       | Tag    | Start    | End      | Duration | Notes              |\033[0m
+        #{separator}
+      TABLE
+      puts header
+    end
+
+    # Formats the separator line for the time tracking report table.
+    #
+    # @return [String] The formatted separator line.
+    #
+    # @example Get the formatted table separator
+    #   separator # => '+-------+------------+--------+----------+----------+----------+------------+'
+    #
+    # @note The method returns a string representing the separator line for the table.
+    def separator
+      '+-------+------------+--------+----------+----------+----------+--------------------+'
+    end
+
+    # Processes each time entry in the `items` array and updates the time block and duration by tag.
+    #
+    # @return [Array<(Hash, Hash)>] An array containing the updated time block and duration by tag.
+    #
+    # @example
+    #   items = [
+    #     [start_time1, end_time1, tag1],
+    #     [start_time2, end_time2, tag2]
+    #   ]
+    #   process_time_entries
+    #   #=> [{ '2024-10-21' => { 8 => [duration1, tag1], 9 => [duration2, tag2] } },
+    #   { tag1 => total_duration1, tag2 => total_duration2 }]
+    #
+    # @note
+    #   - The method relies on the `items` instance variable, which should be an array of arrays.
+    #   - Each sub-array in `items` is expected to contain a start time, end time, and a tag.
+    #   - The `display_time_entry` method is used to display each time entry.
+    #   - The `process_time_block_item` method processes each time entry and updates the time block and duration by tag.
+    #
+    # @see #items
+    # @see #display_time_entry
+    # @see #process_time_block_item
+    def process_time_entries
+      duration_by_tag = Hash.new(0)
+      time_block = Hash.new { |hash, key| hash[key] = {} }
+
+      items.each_with_index do |item, idx|
+        display_time_entry(item, TimeHelper.extract_date(items, idx))
+        time_block, duration_by_tag = process_time_block_item(item, time_block, duration_by_tag)
+      end
+      [time_block, duration_by_tag]
+    end
+
+    # Processes a time block item and updates the time block hash.
+    #
+    # @param item [Array] The time entry to process, containing the start time, end time, and tag.
+    # @param time_block [Hash] A hash containing time block data, where keys are dates and values are hashes of time
+    # slots and their corresponding values.
+    # @param duration_by_tag [Hash] A hash containing the total duration by tag.
+    #
+    # @return [Array<(Hash, Hash)>] An array containing the updated time block hash and the updated duration
+    # by tag hash.
+    #
+    # @example
+    #   item = [nil, Time.new(2024, 10, 21, 8, 0, 0), Time.new(2024, 10, 21, 9, 0, 0), 'work']
+    #   time_block = {}
+    #   duration_by_tag = {}
+    #   process_time_block_item(item, time_block, duration_by_tag)
+    #   #=> [{ '2024-10-21' => { 8 => [3600, 'work'] } }, { 'work' => 3600 }]
+    #
+    # @note
+    #   - The method relies on the `TimeHelper` module for time-related calculations.
+    #   - The `add_hashes` method is used to merge the new time block data into the existing time block hash.
+    #   - The `calculate_duration` method calculates the duration between the start and end times.
+    #
+    # @see TimeHelper#count_seconds_per_hour_block
+    # @see TimeHelper#timestamp_to_date
+    # @see TimeHelper#calculate_duration
+    # @see #add_hashes
+    def process_time_block_item(item, time_block, duration_by_tag)
+      _, start_time, end_time, tag = item
+
+      block_hour = TimeHelper.count_seconds_per_hour_block(start_time, end_time, tag)
+      date_line = TimeHelper.timestamp_to_date(start_time)
+      time_block[date_line] = add_hashes(time_block[date_line], block_hour)
+      duration_by_tag[tag] += TimeHelper.calculate_duration(start_time, end_time)
+      [time_block, duration_by_tag]
+    end
+
+    # Displays a single time entry in the report.
+    #
+    # @param item [Array] The item to display.
+    # @param date [String, nil] The date to display. If nil, the date is not displayed.
+    #
+    # @return [void] This method does not return a value; it performs side effects such as printing the row.
+    #
+    # @example Display a time entry
+    #   display_time_entry(item, '2021-10-01')
+    #
+    # @note The method formats and prints the row for the time entry.
+    def display_time_entry(item, date = nil)
+      return puts 'Missing time entry data.' unless item
+
+      id, start_time_value, end_time_value, tag_name, notes = item
+      duration = TimeHelper.calculate_duration(start_time_value, end_time_value)
+      start_time = TimeHelper.format_time(start_time_value)
+      end_time = TimeHelper.format_time(end_time_value)
+      start_date = date || (' ' * 10)
+      puts format_table_row(id, tag_name[0..5], start_date, start_time, end_time, duration, notes)
+    end
+
+    # Formats a table row with the given row data.
+    #
+    # @param row [Array] The row data to format, containing the following elements:
+    #   - id [Integer] The ID of the time entry.
+    #   - tag [String] The tag associated with the time entry.
+    #   - start_date [String] The start date of the time entry.
+    #   - start_time [String] The start time of the time entry.
+    #   - end_time [String] The end time of the time entry.
+    #   - duration [Integer] The duration of the time entry in seconds.
+    #   - notes [String] Any notes associated with the time entry.
+    #
+    # @return [String] The formatted table row.
+    #
+    # @example
+    #   row = [1, 'work', '2024-10-21', '08:00:00', '09:00:00', 3600, 'Completed task A']
+    #   format_table_row(*row)
+    #   #=> "|      1| 2024-10-21 | work   | 08:00:00 | 09:00:00 |   1:00:00 | Completed task A  |"
+    #
+    # @note
+    #   - The method relies on the `@db` instance variable, which should be an object with `find_item`
+    #   and `seconds_to_hms` methods.
+    #   - The `format_end_time`, `format_mark`, and `format_notes` methods are used to format specific parts of the row.
+    #
+    # @see #format_end_time
+    # @see #format_mark
+    # @see #format_notes
+    def format_table_row(*row)
+      id, tag, start_date, start_time, end_time, duration, notes = row
+      end_time = format_end_time(end_time, id, duration)
+      mark = format_mark(id)
+
+      "| #{id.to_s.rjust(6)}| #{start_date} | #{tag.ljust(6)} | #{start_time.split[1]} | " \
+        "#{end_time.rjust(8)} | #{@db.seconds_to_hms(duration).rjust(8)} | #{format_notes(notes)}  #{mark}"
+    end
+
+    # Formats the end time of the time entry.
+    #
+    # @param end_time [String] The end time of the time entry.
+    # @param id [Integer] The ID of the time entry.
+    # @param duration [Integer] The duration of the time entry in seconds.
+    #
+    # @return [String] The formatted end time.
+    #
+    # @example
+    #   format_end_time('09:00:00', 1, 3600)
+    #   #=> "09:00:00"
+    #
+    # @note
+    #   - The method relies on the `@db` instance variable, which should be an object with a `find_item` method.
+    #   - If the `pomodoro` value is positive and the end time is not set, a blinking `timet` is added.
+    #
+    # @see #format_table_row
+    def format_end_time(end_time, id, duration)
+      end_time = end_time ? end_time.split[1] : '-'
+      pomodoro = @db.find_item(id)[5] || 0
+
+      if pomodoro.positive? && end_time == '-'
+        delta = (@db.find_item(id)[5] - (duration / 60.0)).round(1)
+        timet = "\e]8;;Session ends\a#{delta} min\e]8;;\a".green
+        end_time = " #{timet}".blink
+      end
+
+      end_time
+    end
+
+    # Formats the mark for the time entry.
+    #
+    # @param id [Integer] The ID of the time entry.
+    #
+    # @return [String] The formatted mark.
+    #
+    # @example
+    #   format_mark(1)
+    #   #=> "|"
+    #
+    # @note
+    #   - The method relies on the `@db` instance variable, which should be an object with a `find_item` method.
+    #   - If the `pomodoro` value is positive, a special mark is added.
+    #
+    # @see #format_table_row
+    def format_mark(id)
+      pomodoro = @db.find_item(id)[5] || 0
+      mark = '|'
+      mark = "#{'├'.white} #{'P'.blue.blink}" if pomodoro.positive?
+      mark
+    end
+
+    # Formats the notes column of the time tracking report table.
+    #
+    # @param notes [String, nil] The notes to be formatted.
+    # @return [String] The formatted notes.
+    #
+    # @example Format notes
+    #   format_notes('This is a long note that needs to be truncated')
+    #
+    # @note The method truncates the notes to a maximum of 20 characters and pads them to a fixed width.
+    def format_notes(notes)
+      spaces = 17
+      return ' ' * spaces unless notes
+
+      max_length = spaces - 3
+      notes = "#{notes.slice(0, max_length)}..." if notes.length > max_length
+      notes.ljust(spaces)
+    end
+
+    # Displays the total duration of the tracked time entries.
+    #
+    # @return [void] This method does not return a value; it performs side effects such as printing the total duration.
+    #
+    # @example Display the total duration
+    #   total
+    #
+    # @note The method calculates and prints the total duration of the tracked time entries.
+    def total
+      total = @items.map do |item|
+        TimeHelper.calculate_duration(item[1], item[2])
+      end.sum
+      puts "|#{' ' * 43}#{'Total:'.blue}  | #{@db.seconds_to_hms(total).rjust(8).blue} |#{' ' * 20}|"
+      puts separator
+      display_pomodoro_label
+    end
+
+    # Displays a blinking "Pomodoro" label if the sum of the compacted values in the 6th column of @items is positive.
+    #
+    # @example
+    #   display_pomodoro_label
+    #
+    # @return [void] This method returns nothing.
+    #
+    # @note
+    #   - The method relies on the `@items` instance variable, which should be an array of arrays.
+    #   - The 6th column of each sub-array in `@items` is expected to contain numeric values.
+    #   - The method uses the `blue.blink` color formatting, which assumes the presence of a `String` extension or
+    #   gem that supports color formatting.
+    #
+    # @see #@items
+    # @see String#blue
+    # @see String#blink
+    def display_pomodoro_label
+      return unless @items.map { |x| x[5] }.compact.sum.positive?
+
+      puts "#{'P'.blue.blink}omodoro"
+    end
+  end
+end

data/lib/timet/tag_distribution.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Timet
+  # The TagDistribution module provides functionality to format and display the distribution of tags based on their
+  # durations. This is particularly useful for visualizing how time is distributed across different tags in a project
+  # or task management system.
+  module TagDistribution
+    MAX_BAR_LENGTH = 70
+    BLOCK_CHAR = '▅'
+    TAG_SIZE = 12
+
+    # Formats and displays the tag distribution.
+    #
+    # @param duration_by_tag [Hash<String, Integer>] A hash where keys are tags and values are durations in seconds.
+    # @return [void] This method outputs the formatted tag distribution to the console.
+    #
+    # @example
+    #   duration_by_tag = { "timet" => 3600, "nextjs" => 1800 }
+    #   Formatter.format_tag_distribution(duration_by_tag)
+    #   # Output:
+    #   #  timet:   66.67%  ====================
+    #   #  nextjs:   33.33%  ==========
+    def tag_distribution(duration_by_tag, colors)
+      total = duration_by_tag.values.sum
+      return unless total.positive?
+
+      sorted_duration_by_tag = duration_by_tag.sort_by { |_, duration| -duration }
+      process_and_print_tags(sorted_duration_by_tag, total, colors)
+    end
+
+    # Processes and prints the tag distribution information.
+    #
+    # @param sorted_duration_by_tag [Array<Array(String, Numeric)>] An array of arrays where each inner array contains a
+    # tag and its corresponding duration, sorted by duration in descending order.
+    # @param total [Numeric] The total duration of all tags combined.
+    # @return [void] This method outputs the tag distribution information to the standard output.
+    def process_and_print_tags(sorted_duration_by_tag, total, colors)
+      sorted_duration_by_tag.each do |tag, duration|
+        value, bar_length = calculate_value_and_bar_length(duration, total)
+        horizontal_bar = (BLOCK_CHAR * bar_length).to_s.color(colors[tag] + 1)
+        tag = tag[0..TAG_SIZE - 1] if tag.size >= TAG_SIZE
+        puts "#{tag.rjust(TAG_SIZE)}: #{value.to_s.rjust(5)}%  #{horizontal_bar}"
+      end
+    end
+
+    # Calculates the percentage value and bar length for a given duration and total duration.
+    #
+    # @param duration [Numeric] The duration for the current tag.
+    # @param total [Numeric] The total duration.
+    # @return [Array<(Float, Integer)>] An array containing the calculated value and bar length.
+    #
+    # @example
+    #   calculate_value_and_bar_length(50, 100, 2) #=> [50.0, 25]
+    def calculate_value_and_bar_length(duration, total)
+      value = duration.to_f / total
+      percentage_value = (duration.to_f / total * 100).round(2)
+      bar_length = (value * MAX_BAR_LENGTH).round
+      [percentage_value, bar_length]
+    end
+  end
+end

data/lib/timet/{formatter.rb → time_block_chart.rb}

@@ -3,7 +3,7 @@
 module Timet
   # This module is responsible for formatting the output of the `timet` application.
   # It provides methods for formatting the table header, separators, and rows.
-  module Formatter
+  module TimeBlockChart
     CHAR_MAPPING = {
       0..120 => '_',
       121..450 => '▁',
@@ -16,123 +16,7 @@ module Timet
       3151..3600 => '█'
     }.freeze
 
-    # Formats the header of the time tracking report table.
-    #
-    # @return [void] This method does not return a value; it performs side effects such as printing
-    # the formatted header.
-    #
-    # @example Format and print the table header
-    #   format_table_header
-    #
-    # @note The method constructs a string representing the table header and prints it.
-    def format_table_header
-      title = "Tracked time report #{@filter.blink.red}]:"
-      header = <<~TABLE
-        #{title}
-        #{format_table_separator}
-        \033[32m| Id    | Date       | Tag    | Start    | End      | Duration | Notes              |\033[0m
-        #{format_table_separator}
-      TABLE
-      puts header
-    end
-
-    # Formats the separator line for the time tracking report table.
-    #
-    # @return [String] The formatted separator line.
-    #
-    # @example Get the formatted table separator
-    #   format_table_separator # => '+-------+------------+--------+----------+----------+----------+------------+'
-    #
-    # @note The method returns a string representing the separator line for the table.
-    def format_table_separator
-      '+-------+------------+--------+----------+----------+----------+--------------------+'
-    end
-
-    # Formats a row of the time tracking report table.
-    #
-    # @param row [Array] The row data to be formatted.
-    # @return [String] The formatted row.
-    #
-    # @example Format a table row
-    #   format_table_row(1, 'work', '2023-10-01', '12:00:00', '14:00:00', 7200, 'Completed task X')
-    #
-    # @note The method formats each element of the row and constructs a string representing the formatted row.
-    def format_table_row(*row)
-      id, tag, start_date, start_time, end_time, duration, notes = row
-      "| #{id.to_s.rjust(5)} | #{start_date} | #{tag.ljust(6)} | #{start_time.split[1]} | " \
-        "#{end_time.split[1].rjust(8)} | #{@db.seconds_to_hms(duration).rjust(8)} | #{format_notes(notes)}  |"
-    end
-
-    # Formats the notes column of the time tracking report table.
-    #
-    # @param notes [String, nil] The notes to be formatted.
-    # @return [String] The formatted notes.
-    #
-    # @example Format notes
-    #   format_notes('This is a long note that needs to be truncated')
-    #
-    # @note The method truncates the notes to a maximum of 20 characters and pads them to a fixed width.
-    def format_notes(notes)
-      spaces = 17
-      return ' ' * spaces unless notes
-
-      max_length = spaces - 3
-      notes = "#{notes.slice(0, max_length)}..." if notes.length > max_length
-      notes.ljust(spaces)
-    end
-
-    # @!method format_tag_distribution(duration_by_tag)
-    #   Formats and displays the tag distribution.
-    #
-    #   @example
-    #     duration_by_tag = { "timet" => 3600, "nextjs" => 1800 }
-    #     Formatter.format_tag_distribution(duration_by_tag)
-    #     # Output:
-    #     #    timet:   66.67%  ====================
-    #     #   nextjs:   33.33%  ==========
-    #
-    #   @param duration_by_tag [Hash<String, Integer>] A hash where keys are tags and values are durations in seconds.
-    #   @return [void] This method outputs the formatted tag distribution to the console.
-    def format_tag_distribution(duration_by_tag, colors)
-      total = duration_by_tag.values.sum
-      return unless total.positive?
-
-      factor = duration_by_tag.size < 3 ? 2 : 1
-      sorted_duration_by_tag = duration_by_tag.sort_by { |_, duration| -duration }
-      process_and_print_tags(sorted_duration_by_tag, factor, total, colors)
-    end
-
-    # Processes and prints the tag distribution information.
-    #
-    # @param sorted_duration_by_tag [Array<Array(String, Numeric)>] An array of arrays where each inner array contains a
-    # tag and its corresponding duration, sorted by duration in descending order.
-    # @param factor [Numeric] The factor used to adjust the bar length.
-    # @param total [Numeric] The total duration of all tags combined.
-    # @return [void] This method outputs the tag distribution information to the standard output.
-    def process_and_print_tags(*args)
-      sorted_duration_by_tag, factor, total, colors = args
-      block = '▅'
-      sorted_duration_by_tag.each do |tag, duration|
-        value, bar_length = calculate_value_and_bar_length(duration, total, factor)
-        horizontal_bar = (block * bar_length).to_s.color(colors[tag] + 1)
-        puts "#{tag.rjust(8)}: #{value.to_s.rjust(7)}%  #{horizontal_bar}"
-      end
-    end
-
-    # Calculates the value and bar length for a given duration, total duration, and factor.
-    #
-    # @param duration [Numeric] The duration for the current tag.
-    # @param total [Numeric] The total duration.
-    # @param factor [Numeric] A factor to adjust the formatting.
-    # @return [Array<(Float, Integer)>] An array containing the calculated value and bar length.
-    #
-    # @example
-    #   calculate_value_and_bar_length(50, 100, 2) #=> [50.0, 25]
-    def calculate_value_and_bar_length(duration, total, factor)
-      value = (duration.to_f / total * 100).round(2)
-      bar_length = (value / factor).round
-      [value, bar_length]
-    end
+    SEPARATOR_CHAR = '░'
 
     # Prints a time block chart based on the provided time block and colors.
     #
@@ -186,23 +70,12 @@ module Timet
       puts '┌╴W ╴╴╴╴╴╴⏰╴╴╴╴╴╴┼'.gray + "#{'╴' * (24 - start_hour) * 4}╴╴╴┼".gray
     end
 
-    # Prints the block characters for each hour in the time block chart.
-    #
-    # This method iterates over each hour from 0 to 23, retrieves the corresponding
-    # block character using the `get_block_char` method, and prints it aligned for
-    # readability. It also adds a double newline at the end for separation.
-    #
-    # @param time_block [Hash] A hash where the keys are formatted hour strings
-    #                          (e.g., "00", "01") and the values are the corresponding
-    #                          values to determine the block character.
-    # @example
-    #   time_block = { "00" => 100, "01" => 200, ..., "23" => 300 }
-    #   print_blocks(time_block)
-    #   # Output:
-    #   # ▁ ▂ ▃ ▄ ▅ ▆ ▇ █ ▁ ▂ ▃ ▄ ▅ ▆ ▇ █ ▁ ▂ ▃ ▄ ▅ ▆ ▇ █
-    #   #
-    #   # (followed by two newlines)
+    # Prints the time blocks for each date in the given time block data structure.
     #
+    # @param time_block [Hash] A hash where keys are date strings and values are time block data.
+    # @param colors [Hash] A hash containing color codes for formatting.
+    # @param start_hour [Integer] The starting hour for the time blocks.
+    # @return [void]
     def print_blocks(time_block, colors, start_hour)
       return unless time_block
 
@@ -210,32 +83,83 @@ module Timet
       time_block.each_key do |date_string|
         date = Date.parse(date_string)
         day = date.strftime('%a')[0..1]
-        weekend = date_string
-        if %w[Sa Su].include?(day)
-          day = day.red
-          weekend = weekend.red
-        end
 
-        weeks << date.cweek
-        n = weeks.size - 1
-        week = if (weeks[n] == weeks[n - 1]) && n.positive?
-                 '  '
-               else
-                 weeks[n].to_s.underline
-               end
-        puts "┆                 ┆#{' ' * (24 - start_hour) * 4}   ┼░░░░".gray if week != '  ' && n.positive?
-        print '┆'.gray + "#{week} #{weekend} #{day} " + '┆- '.gray
+        format_and_print_date_info(date_string, day, weeks, start_hour)
+
         time_block_initial = time_block[date_string]
         print_time_blocks(start_hour, time_block_initial, colors)
 
-        total_seconds = time_block_initial.values.map { |item| item[0] }.sum
-        hours_per_day = (total_seconds / 3600.0).round(1)
-        print "-┆#{hours_per_day}h".gray
-        puts
+        calculate_and_print_hours(time_block_initial)
       end
       print_footer(start_hour)
     end
 
+    # Calculates the total hours from the given time block data and prints it.
+    #
+    # @param time_block_initial [Hash] A hash containing time block data for a specific date.
+    # @return [void]
+    def calculate_and_print_hours(time_block_initial)
+      total_seconds = time_block_initial.values.map { |item| item[0] }.sum
+      hours_per_day = (total_seconds / 3600.0).round(1)
+      print "-┆#{hours_per_day}h".gray
+      puts
+    end
+
+    # Formats and prints the date information including the week and day.
+    #
+    # @param date_string [String] The date string in a parsable format.
+    # @param day [String] The abbreviated day of the week (e.g., "Mo" for Monday).
+    # @param weeks [Array<Integer>] An array storing the week numbers.
+    # @param start_hour [Integer] The starting hour for the time blocks.
+    # @return [void]
+    def format_and_print_date_info(date_string, day, weeks, start_hour)
+      weekend = date_string
+      day = day.red if %w[Sa Su].include?(day)
+      weekend = weekend.red if %w[Sa Su].include?(day)
+
+      week = format_and_print_week(date_string, weeks, start_hour)
+
+      print '┆'.gray + "#{week} #{weekend} #{day} " + '┆- '.gray
+    end
+
+    # Formats and prints the week information including the separator if necessary.
+    #
+    # @param date_string [String] The date string in a parsable format.
+    # @param weeks [Array<Integer>] An array storing the week numbers.
+    # @param start_hour [Integer] The starting hour for the time blocks.
+    # @return [String] The formatted week string.
+    def format_and_print_week(date_string, weeks, start_hour)
+      week, current_index = determine_week(date_string, weeks)
+      print_separator(start_hour, week, current_index)
+      week
+    end
+
+    # Determines the week string based on the date and the previous week.
+    #
+    # @param date_string [String] The date string in a parsable format.
+    # @param weeks [Array<Integer>] An array storing the week numbers.
+    # @return [Array<String, Integer>] An array containing the formatted week string and the current index.
+    def determine_week(date_string, weeks)
+      weeks << Date.parse(date_string).cweek
+      current_index = weeks.size - 1
+      current_week = weeks[current_index]
+      week = current_week == weeks[current_index - 1] && current_index.positive? ? '  ' : current_week.to_s.underline
+      [week, current_index]
+    end
+
+    # Prints the separator line if the week string is not empty and the current index is positive.
+    #
+    # @param start_hour [Integer] The starting hour for the time blocks.
+    # @param week [String] The formatted week string.
+    # @param current_index [Integer] The current index in the weeks array.
+    # @return [void]
+    def print_separator(start_hour, week, current_index)
+      return unless week != '  ' && current_index.positive?
+
+      sep = SEPARATOR_CHAR
+      puts "┆#{sep * 17}┼#{sep * (24 - start_hour) * 4}#{sep * 3}┼#{sep * 4}".gray
+    end
+
     # Prints the footer of the report.
     #
     # @param start_hour [Integer] The start time used to calculate the footer length.

data/lib/timet/time_report.rb

@@ -2,17 +2,20 @@
 
 require 'date'
 require 'csv'
-require_relative 'status_helper'
-require_relative 'formatter'
 require_relative 'time_report_helper'
+require_relative 'table'
+require_relative 'time_block_chart'
+require_relative 'tag_distribution'
 
 module Timet
   # The TimeReport class is responsible for displaying a report of tracked time
   # entries. It allows filtering the report by time periods and displays
   # a formatted table with the relevant information.
   class TimeReport
-    include Formatter
     include TimeReportHelper
+    include Table
+    include TimeBlockChart
+    include TagDistribution
 
     # Provides access to the database instance.
     attr_reader :db
@@ -54,15 +57,12 @@ module Timet
     def display
       return puts 'No tracked time found for the specified filter.' if items.empty?
 
-      format_table_header
-      time_block, duration_by_tag = process_time_entries
-      puts format_table_separator
-      total
+      time_block, duration_by_tag = table
 
       colors = duration_by_tag.map { |x| x[0] }.sort.each_with_index.to_h
       print_time_block_chart(time_block, colors)
 
-      format_tag_distribution(duration_by_tag, colors)
+      tag_distribution(duration_by_tag, colors)
     end
 
     # Displays a single row of the report.
@@ -76,9 +76,9 @@ module Timet
     #
     # @note The method formats and prints the table header, row, and total duration.
     def show_row(item)
-      format_table_header
+      header
       display_time_entry(item)
-      puts format_table_separator
+      puts separator
       total
     end
 
@@ -116,42 +116,18 @@ module Timet
       end
     end
 
-    # Displays a single time entry in the report.
-    #
-    # @param item [Array] The item to display.
-    # @param date [String, nil] The date to display. If nil, the date is not displayed.
-    #
-    # @return [void] This method does not return a value; it performs side effects such as printing the row.
-    #
-    # @example Display a time entry
-    #   display_time_entry(item, '2021-10-01')
-    #
-    # @note The method formats and prints the row for the time entry.
-    def display_time_entry(item, date = nil)
-      return puts 'Missing time entry data.' unless item
-
-      id, start_time_value, end_time_value, tag_name, notes = item
-      duration = TimeHelper.calculate_duration(start_time_value, end_time_value)
-      start_time = TimeHelper.format_time(start_time_value)
-      end_time = TimeHelper.format_time(end_time_value) || '- -'
-      start_date = date || (' ' * 10)
-      puts format_table_row(id, tag_name[0..5], start_date, start_time, end_time, duration, notes)
-    end
-
-    # Displays the total duration of the tracked time entries.
-    #
-    # @return [void] This method does not return a value; it performs side effects such as printing the total duration.
+    # Writes the CSV rows for the time report.
     #
-    # @example Display the total duration
-    #   total
+    # @param csv [CSV] The CSV object to which the rows will be written.
+    # @return [void]
     #
-    # @note The method calculates and prints the total duration of the tracked time entries.
-    def total
-      total = @items.map do |item|
-        TimeHelper.calculate_duration(item[1], item[2])
-      end.sum
-      puts "|#{' ' * 43}\033[94mTotal:  | #{@db.seconds_to_hms(total).rjust(8)} |\033[0m                    |"
-      puts format_table_separator
+    # @example
+    #   csv = CSV.new(file)
+    #   write_csv_rows(csv)
+    def write_csv_rows(csv)
+      items.each do |item|
+        csv << format_item(item)
+      end
     end
 
     # Filters the items based on the specified filter and tag.

data/lib/timet/time_report_helper.rb

@@ -6,58 +6,6 @@ module Timet
   # and validating date formats.
   # This module is designed to be included in classes that require time report processing functionalities.
   module TimeReportHelper
-    # Processes each time entry in the items array and updates the time block and duration by tag.
-    #
-    # @return [Array<(Hash, Hash)>] An array containing the updated time block and duration by tag.
-    #
-    # @example
-    #   items = [
-    #     [start_time1, end_time1, tag1],
-    #     [start_time2, end_time2, tag2]
-    #   ]
-    #   process_time_entries
-    #   #=> [{ '2024-10-21' => { 8 => [duration1, tag1], 9 => [duration2, tag2] } }, { tag1 => total_duration1,
-    #   tag2 => total_duration2 }]
-    def process_time_entries
-      duration_by_tag = Hash.new(0)
-      time_block = Hash.new { |hash, key| hash[key] = {} }
-
-      items.each_with_index do |item, idx|
-        display_time_entry(item, TimeHelper.extract_date(items, idx))
-        start_time = item[1]
-        end_time = item[2]
-        tag = item[3]
-        time_block = process_time_block_item(start_time, end_time, tag, time_block)
-
-        duration_by_tag[tag] += TimeHelper.calculate_duration(start_time, end_time)
-      end
-      [time_block, duration_by_tag]
-    end
-
-    # Processes a time block item and updates the time block hash.
-    #
-    # @param start_time [Time] The start time of the time block.
-    # @param end_time [Time] The end time of the time block.
-    # @param tag [String] The tag associated with the time block.
-    # @param time_block [Hash] A hash containing time block data, where keys are dates and values are hashes of time
-    # slots and their corresponding values.
-    # @return [Hash] The updated time block hash.
-    #
-    # @example
-    #   start_time = Time.new(2024, 10, 21, 8, 0, 0)
-    #   end_time = Time.new(2024, 10, 21, 9, 0, 0)
-    #   tag = 'work'
-    #   time_block = {}
-    #   process_time_block_item(start_time, end_time, tag, time_block)
-    #   #=> { '2024-10-21' => { 8 => [duration, 'work'] } }
-    def process_time_block_item(*args)
-      start_time, end_time, tag, time_block = args
-      block_hour = TimeHelper.count_seconds_per_hour_block(start_time, end_time, tag)
-      date_line = TimeHelper.timestamp_to_date(start_time)
-      time_block[date_line] = add_hashes(time_block[date_line], block_hour)
-      time_block
-    end
-
     # Provides predefined date ranges for filtering.
     #
     # @return [Hash] A hash containing predefined date ranges.
@@ -132,19 +80,5 @@ module Timet
         [summed_number, old_value[1]]
       end
     end
-
-    # Writes the CSV rows for the time report.
-    #
-    # @param csv [CSV] The CSV object to which the rows will be written.
-    # @return [void]
-    #
-    # @example
-    #   csv = CSV.new(file)
-    #   write_csv_rows(csv)
-    def write_csv_rows(csv)
-      items.each do |item|
-        csv << format_item(item)
-      end
-    end
   end
 end

data/lib/timet/version.rb

@@ -6,6 +6,6 @@ module Timet
   # @return [String] The version number in the format 'major.minor.patch'.
   #
   # @example Get the version of the Timet application
-  #   Timet::VERSION # => '1.3.2'
-  VERSION = '1.3.2'
+  #   Timet::VERSION # => '1.4.0'
+  VERSION = '1.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timet
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Frank Vielma
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-25 00:00:00.000000000 Z
+date: 2024-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -82,8 +82,10 @@ files:
 - lib/timet/application_helper.rb
 - lib/timet/color_codes.rb
 - lib/timet/database.rb
-- lib/timet/formatter.rb
 - lib/timet/status_helper.rb
+- lib/timet/table.rb
+- lib/timet/tag_distribution.rb
+- lib/timet/time_block_chart.rb
 - lib/timet/time_helper.rb
 - lib/timet/time_report.rb
 - lib/timet/time_report_helper.rb