timet 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db3c3e635b08a071bc271be5788a4b689f0a28203dea81c2dc73a78c312b089e
-  data.tar.gz: 2c5c831731c0ec619064653b8239381a53e5c973f92f347e98a74de8c07547e0
+  metadata.gz: 822542486f30f170aa48dccd0577637caed0010047b085022653f3ae4d0cb848
+  data.tar.gz: 96b166cdd9ac9fe69ee546fec4d68e47d113df05f986b4aff61cc71358c1c9ea
 SHA512:
-  metadata.gz: 0b98ea65edc254804e58c16ce0f200209ee57b9b3629fc182ec822c1b359380015bdaf281db64a9bd96acaa5ded45489f4464602ae90ab3e11916556e879e88a
-  data.tar.gz: fba083a2484a17a3af3efb5c0d2dcad4b08f463d162b6689c4a6445948d6f2bd517ef0b3efd794d0b0b05a818799798446a65902cf97ebe94519f884aa2c9927
+  metadata.gz: 0c950e2ff135ba0f665a70960c0389a55ac83ccf863dbdcee219d83d4fbc1939b79411c6e549e082f8b0abc1e9df223079dc5f784bf466f18a8ec9a7d52be039
+  data.tar.gz: 4d76b845a5b3af8ad142e8a1edb65309f9b637b755af129401f7fdcfcc6635c1deabb37665302649fc3eaa3f4cf73f2212114111bc594dbdf6e62b5d1956c7ed

data/CHANGELOG.md

@@ -1,18 +1,66 @@
 ## [Unreleased]
 
+## [1.3.0] - 2024-10-22
+
+**Improvements:**
+
+- **Refactor `TimeReport` to use `TimeReportHelper` module for utility methods:**
+
+  - Extracted utility methods (`add_hashes`, `date_ranges`, `format_item`, `valid_date_format?`) into a new `TimeReportHelper` module.
+  - Updated `TimeReport` class to include `TimeReportHelper` module.
+  - Removed redundant utility methods from `TimeReport` class.
+  - Updated `display` method to use `process_time_entries` from `TimeReportHelper`.
+  - Updated `write_csv` method to use `write_csv_rows` from `TimeReportHelper`.
+  - Updated `print_time_block_chart` method to pass `colors` parameter to `format_tag_distribution`.
+  - Adjusted formatting in `total` method for better alignment.
+
+- **Refactor `Timet::Formatter` to improve readability and modularity:**
+
+  - Introduced a constant `CHAR_MAPPING` to store block characters for different value ranges.
+  - Refactored `format_notes` method to use a more descriptive variable name for the maximum length.
+  - Updated `format_tag_distribution` method to accept `colors` parameter and pass it to `process_and_print_tags`.
+  - Extracted the logic for calculating `value` and `bar_length` into a separate method `calculate_value_and_bar_length`.
+  - Refactored `process_and_print_tags` to accept `colors` parameter and use the new `calculate_value_and_bar_length` method.
+  - Updated `print_time_block_chart` method to accept `colors` parameter and pass it to `print_blocks`.
+  - Refactored `print_blocks` method to accept `colors` and `start_time` parameters and use the new `print_time_blocks` method.
+  - Introduced `print_time_blocks` method to handle the printing of time blocks for each hour from the start time to 23.
+  - Introduced `get_formatted_block_char` method to retrieve the formatted block character and its associated tag for a given hour.
+  - Refactored `print_colored_block` method to use the `block` variable for clarity.
+  - Updated `get_block_char` method to use the `CHAR_MAPPING` constant for determining the block character.
+
+- **Refactor `TimeHelper` methods and add new functionality:**
+  - Simplified nil checks in `format_time`, `timestamp_to_date`, and `timestamp_to_time` methods by using `unless` instead of `if`.
+  - Extracted the logic for calculating block end time and seconds into a new method `calculate_block_end_time_and_seconds`.
+  - Updated `count_seconds_per_hour_block` to use the new `calculate_block_end_time_and_seconds` method.
+  - Added a new method `append_tag_to_hour_blocks` to append a tag to each value in the `hour_blocks` hash.
+  - Removed the `aggregate_hash_values` method as it is no longer needed.
+  - Updated YARD documentation for all methods to reflect the changes.
+
+**Bug fixes:**
+
+- [ ] No bug fixes in this PR.
+
+**Tasks:**
+
+- Update `README.md` to reflect the changes.
+- Update `Gemfile` and version to reflect the latest changes.
+
 ## [1.2.1] - 2024-10-18
 
 **Improvements:**
+
 - Updated the time block chart formatting to use square brackets for better visual representation.
 - Refactored the `play_sound_and_notify` method to avoid redundant platform checks and introduced platform-specific session runners.
 - Improved readability and maintainability of the `format_tag_distribution` method by extracting logic into a new private method.
 - Updated the `rubocop` gem from `~> 1.65` to `~> 1.67`.
 
 ### Bug fixes:
+
 - Fixed a `NoMethodError` caused by an undefined method `process_and_print_tags` in the `format_tag_distribution` method.
 - Fixed line length violations in several files to comply with `rubocop` rules.
 
 ### Additional Considerations:
+
 - The changes in this pull request should be thoroughly tested to ensure that they do not introduce any regressions.
 - Future improvements could include further refactoring to extract more logic into separate methods or classes, depending on the complexity and requirements of the application.
 

data/README.md

@@ -19,7 +19,7 @@ Timet refers to a command-line tool designed to track your activities by recordi
 - **Querying and Reporting:** Generate detailed reports for specific periods.
 - **CSV Export:** Easily export your time tracking data to CSV format for further analysis or sharing.
 - **Pomodoro Integration:** The pomodoro option in the start command enhances time tracking by integrating the Pomodoro Technique.
-- **Block Time Plot:** Visualizes the distribution of tracked time across a 24-hour period, with bars in each column representing the amount of time tracked during that specific hour.
+- **Block Time Plot:** Visualizes the distribution of tracked time across a specified range of dates, with bars in each column representing the amount of time tracked during that specific hour. The plot includes a header showing the hours and a row for each date, displaying the time blocks for each hour.
 - **Tag Distribution Plot:** Illustrates the proportion of total tracked time allocated to each tag, showing the relative contribution of each tag to the overall time tracked.
 
 Example:
@@ -42,6 +42,8 @@ Tracked time report [today]:
     Tag3:    50.0%  ▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅
 ```
 
+![Timet monthly report](monthly_report.webp)
+
 ## Requirements
 
 - Ruby version: >= 3.0.0
@@ -233,7 +235,7 @@ Many people have contacted me asking how to contribute. Any contribution, from a
 
 **Bitcoin Address:**
 ```sh
-bc1qkg9me2jsuhpzu2hp9kkpxagwtf9ewnyfl4kszl 
+bc1qkg9me2jsuhpzu2hp9kkpxagwtf9ewnyfl4kszl
 ```
 
 ![Buy me a coffee!](btc.png)

data/lib/timet/formatter.rb

@@ -4,6 +4,18 @@ 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
+    CHAR_MAPPING = {
+      0..120 => '_',
+      121..450 => '▁',
+      451..900 => '▂',
+      901..1350 => '▃',
+      1351..1800 => '▄',
+      1801..2250 => '▅',
+      2251..2700 => '▆',
+      2701..3150 => '▇',
+      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
@@ -61,9 +73,10 @@ module Timet
     # @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 if notes.nil?
+      return ' ' * spaces unless notes
 
-      notes = "#{notes.slice(0, spaces - 3)}..." if notes.length > spaces - 3
+      max_length = spaces - 3
+      notes = "#{notes.slice(0, max_length)}..." if notes.length > max_length
       notes.ljust(spaces)
     end
 
@@ -79,13 +92,13 @@ module Timet
     #
     #   @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)
+    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)
+      process_and_print_tags(sorted_duration_by_tag, factor, total, colors)
     end
 
     # Processes and prints the tag distribution information.
@@ -95,55 +108,78 @@ module Timet
     # @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(sorted_duration_by_tag, factor, total)
+    def process_and_print_tags(*args)
+      sorted_duration_by_tag, factor, total, colors = args
       block = '▅'
       sorted_duration_by_tag.each do |tag, duration|
-        value = (duration.to_f / total * 100).round(2)
-        bar_length = (value / factor).to_i
-        color = rand(256)
-        puts "#{tag.rjust(8)}: #{value.to_s.rjust(7)}%  \u001b[38;5;#{color}m#{block * bar_length}\u001b[0m"
+        value, bar_length = calculate_value_and_bar_length(duration, total, factor)
+        puts "#{tag.rjust(8)}: #{value.to_s.rjust(7)}%  \u001b[38;5;#{colors[tag] + 1}m#{block * bar_length}\u001b[0m"
       end
     end
 
-    # Prints the entire time block chart.
+    # Calculates the value and bar length for a given duration, total duration, and factor.
     #
-    # This method orchestrates the printing of the entire time block chart by calling
-    # the `print_header` and `print_blocks` methods. It also prints the separator line
-    # between the header and the blocks, and adds a double newline at the end for
-    # separation.
+    # @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.
     #
-    # @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_time_block_chart(time_block)
-    #   # Output:
-    #   # ⏳ ↦ [ 00  01  02  03  04  05  06  07  08  09  10  11  12  13  14  15  16  17  18  19  20  21  22  23 ]
-    #   #      [ ▁ ▂ ▃ ▄ ▅ ▆ ▇ █ ▁ ▂ ▃ ▄ ▅ ▆ ▇ █ ▁ ▂ ▃ ▄ ▅ ▆ ▇ █
-    #   #
-    #   # (followed by two newlines)
+    #   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
+
+    # Prints a time block chart based on the provided time block and colors.
+    #
+    # @param time_block [Hash] A hash where the keys are time blocks and the values are hashes of time slots and their
+    # corresponding values.
+    #   Example: { "block1" => { 10 => "value1", 11 => "value2" }, "block2" => { 12 => "value3" } }
+    # @param colors [Hash] A hash where the keys are time slots and the values are the colors to be used
+    # for those slots.
+    #   Example: { 10 => "red", 11 => "blue", 12 => "green" }
+    #
+    # @return [void] This method does not return a value; it prints the chart directly to the output.
+    #
+    # @example
+    #   time_block = { "block1" => { 10 => "value1", 11 => "value2" }, "block2" => { 12 => "value3" } }
+    #   colors = { 10 => "red", 11 => "blue", 12 => "green" }
+    #   print_time_block_chart(time_block, colors)
     #
-    def print_time_block_chart(time_block)
-      print_header
-      print '     [ '
-      print_blocks(time_block)
+    # @note This method relies on two helper methods: `print_header` and `print_blocks`.
+    #   Ensure these methods are defined and available in the scope where `print_time_block_chart` is called.
+    #
+    # @see #print_header
+    # @see #print_blocks
+    def print_time_block_chart(time_block, colors)
+      start_time = time_block.values.map(&:keys).flatten.uniq.min.to_i
+      print_header(start_time)
+      print_blocks(time_block, colors, start_time)
     end
 
     # Prints the header of the time block chart.
     #
-    # This method outputs the header line of the chart, which includes the hours
-    # from 00 to 23, formatted and aligned for readability.
+    # The header includes a visual representation of the time slots from the given start time to 23.
+    # Each time slot is formatted as a two-digit number and aligned to the right within a fixed width.
+    #
+    # @param start_time [Integer] The starting time for the chart. This should be an integer between 0 and 23.
+    #
+    # @return [void] This method does not return a value; it prints the header directly to the output.
     #
     # @example
-    #   print_header
+    #   print_header(10)
     #   # Output:
-    #   # ⏳ ↦ [ 00  01  02  03  04  05  06  07  08  09  10  11  12  13  14  15  16  17  18  19  20  21  22  23
+    #   #
+    #   #      ⏳ ↦ [ 10  11  12  13  14  15  16  17  18  19  20  21  22  23]
     #
-    def print_header
+    # @note The method assumes that the start_time is within the valid range of 0 to 23.
+    #   If the start_time is outside this range, the output may not be as expected.
+    def print_header(start_time)
       puts
-      print '⏳ ↦ [ '
-      (0..23).each { |hour| print format('%02d', hour).ljust(4) }
+      print '     ⏳ ↦ [ '
+      (start_time..23).each { |hour| print format('%02d', hour).ljust(4) }
       print ']'
       puts
     end
@@ -165,15 +201,72 @@ module Timet
     #   #
     #   # (followed by two newlines)
     #
-    def print_blocks(time_block)
+    def print_blocks(time_block, colors, start_time)
       return unless time_block
 
-      (0..23).each do |hour|
-        block_char = get_block_char(time_block[format('%02d', hour)])
-        print (block_char * 2).ljust(4)
+      time_block.each_key do |item|
+        print "#{item}  "
+        time_block_initial = time_block[item]
+        print_time_blocks(start_time, time_block_initial, colors)
+        puts
       end
-      print ']'
-      puts "\n\n"
+      puts "\n"
+    end
+
+    # Prints time blocks for each hour from the start time to 23.
+    #
+    # @param start_time [Integer] The starting hour for printing time blocks.
+    # @param time_block_initial [Hash] A hash containing time block data, where keys are formatted hours and values
+    # are arrays containing block data.
+    # @param colors [Hash] A hash mapping tags to color codes.
+    # @return [void]
+    #
+    # @example
+    #   time_block_initial = {
+    #     '01' => ['block_char_data', 'tag']
+    #   }
+    #   colors = { 'tag' => 1 }
+    #   print_time_blocks(1, time_block_initial, colors) # Prints time blocks for hours 1 to 23
+    def print_time_blocks(start_time, time_block_initial, colors)
+      (start_time..23).each do |hour|
+        tag, block_char = get_formatted_block_char(hour, time_block_initial)
+        print_colored_block(block_char, tag, colors)
+      end
+    end
+
+    # Returns the formatted block character and its associated tag for a given hour.
+    #
+    # @param hour [Integer] The hour for which to retrieve the block character.
+    # @param time_block_initial [Hash] A hash containing time block data, where keys are formatted hours and values
+    # are arrays containing block data.
+    # @return [Array<(String, String)>] An array containing the tag and the block character.
+    #
+    # @example
+    #   time_block_initial = {
+    #     '01' => ['block_char_data', 'tag']
+    #   }
+    #   get_formatted_block_char(1, time_block_initial) #=> ['tag', 'block_char']
+    def get_formatted_block_char(hour, time_block_initial)
+      formatted_hour = format('%02d', hour)
+      hour_data = time_block_initial[formatted_hour]
+      tag = hour_data&.last
+      [tag, get_block_char(hour_data&.first)]
+    end
+
+    # Prints a colored block character based on the provided tag and block character.
+    #
+    # @param block_char [String] The block character to be printed.
+    # @param tag [String] The tag associated with the block character, used to determine the color.
+    # @param colors [Hash] A hash mapping tags to color codes.
+    #
+    # @example
+    #   colors = { 'tag' => 1 }
+    #   print_colored_block('X', 'tag', colors) # Prints a colored block character 'XX'
+    def print_colored_block(block_char, tag, colors)
+      color_code = colors[tag]
+      block = block_char * 2
+      colored_block = color_code ? "\u001b[38;5;#{color_code + 1}m#{block}\u001b[0m  " : block
+      print colored_block.ljust(4)
     end
 
     # Determines the block character based on the value.
@@ -181,19 +274,9 @@ module Timet
     # @param value [Integer] The value to determine the block character for.
     # @return [String] The block character corresponding to the value.
     def get_block_char(value)
-      range_to_char = {
-        0..120 => ' ',
-        121..450 => '▁',
-        451..900 => '▂',
-        901..1350 => '▃',
-        1351..1800 => '▄',
-        1801..2250 => '▅',
-        2251..2700 => '▆',
-        2701..3150 => '▇',
-        3151..3600 => '█'
-      }
-
-      range_to_char.find { |range, _| range.include?(value) }&.last || ' '
+      return ' ' unless value
+
+      CHAR_MAPPING.find { |range, _| range.include?(value) }&.last || ' '
     end
   end
 end

data/lib/timet/time_helper.rb

@@ -15,7 +15,7 @@ module Timet
     # @example Format a timestamp
     #   TimeHelper.format_time(1633072800) # => '2021-10-01 12:00:00'
     def self.format_time(timestamp)
-      return nil if timestamp.nil?
+      return nil unless timestamp
 
       Time.at(timestamp).strftime('%Y-%m-%d %H:%M:%S')
     end
@@ -28,7 +28,7 @@ module Timet
     # @example Convert a timestamp to a date string
     #   TimeHelper.timestamp_to_date(1633072800) # => '2021-10-01'
     def self.timestamp_to_date(timestamp)
-      return nil if timestamp.nil?
+      return nil unless timestamp
 
       Time.at(timestamp).strftime('%Y-%m-%d')
     end
@@ -41,7 +41,7 @@ module Timet
     # @example Convert a timestamp to a time string
     #   TimeHelper.timestamp_to_time(1633072800) # => '12:00:00'
     def self.timestamp_to_time(timestamp)
-      return nil if timestamp.nil?
+      return nil unless timestamp
 
       Time.at(timestamp).strftime('%H:%M:%S')
     end
@@ -186,53 +186,51 @@ module Timet
     #   result = count_seconds_per_hour_block(start_time, end_time)
     #   # Output: {"08"=>1800, "09"=>1800, "10"=>3600, "11"=>1200}
     #
-    def self.count_seconds_per_hour_block(start_time, end_time)
+    def self.count_seconds_per_hour_block(start_time, end_time, tag)
       hour_blocks = Hash.new(0)
 
       current_time = Time.at(start_time)
       end_time = Time.at(end_time || current_timestamp)
 
       while current_time < end_time
-        current_hour = current_time.hour
-        next_hour_boundary = Time.new(current_time.year, current_time.month, current_time.day, current_hour + 1)
-
-        block_end_time = [next_hour_boundary, end_time].min
-        seconds_in_block = (block_end_time - current_time).to_i
-
-        hour_block = current_time.strftime('%H')
-        hour_blocks[hour_block] += seconds_in_block
+        block_end_time, hour_blocks = calculate_block_end_time_and_seconds(current_time, end_time, hour_blocks)
 
         current_time = block_end_time
       end
 
-      hour_blocks
+      append_tag_to_hour_blocks(hour_blocks, tag)
     end
 
-    # Aggregates the values of the same keys from an array of hashes.
-    #
-    # This method takes an array of hashes, reverses it, and then aggregates the values
-    # for the same keys into a single hash. If a key appears in multiple hashes, its
-    # values are summed.
-    #
-    # @param time_block [Array<Hash>] An array of hashes where each hash contains key-value pairs.
-    # @return [Hash] A hash where the keys are the aggregated keys from the input hashes
-    #                and the values are the summed values for each key.
-    # @example
-    #   time_block = [
-    #     {"01": 10},
-    #     {"01": 30},
-    #     {"02": 50}
-    #   ]
-    #   result = aggregate_hash_values(time_block)
-    #   # Output: {"01"=>40, "02"=>50}
-    #
-    def self.aggregate_hash_values(time_block)
-      time_block.reverse.each_with_object({}) do |hash, acc|
-        hash.each do |key, value|
-          acc[key] ||= 0
-          acc[key] += value
-        end
+    # Calculates the end time of the current block and the number of seconds in the block.
+    # Additionally, it updates the `hour_blocks` hash with the number of seconds for the current hour block.
+    #
+    # @param current_time [Time] The current time.
+    # @param end_time [Time] The end time of the overall period.
+    # @param hour_blocks [Hash] A hash where each key represents an hour block and the value is the number of seconds
+    # in that block.
+    # @return [Array<(Time, Hash)>] An array containing the end time of the current block and the updated
+    # `hour_blocks` hash.
+    def self.calculate_block_end_time_and_seconds(current_time, end_time, hour_blocks)
+      current_hour = current_time.hour
+      next_hour_boundary = Time.new(current_time.year, current_time.month, current_time.day, current_hour + 1)
+
+      block_end_time = [next_hour_boundary, end_time].min
+      seconds_in_block = (block_end_time - current_time).to_i
+      hour_block = current_time.strftime('%H')
+      hour_blocks[hour_block] += seconds_in_block
+
+      [block_end_time, hour_blocks]
+    end
+
+    # @param hour_blocks [Hash] A hash where each key represents an hour block and the value is some data associated
+    # with that hour block.
+    # @param tag [Object] The tag to append to each value in the hash.
+    # @return [Hash] The modified hash with the tag appended to each value.
+    def self.append_tag_to_hour_blocks(hour_blocks, tag)
+      hour_blocks.each do |key, value|
+        hour_blocks[key] = [value, tag]
       end
+      hour_blocks
     end
   end
 end

data/lib/timet/time_report.rb

@@ -4,6 +4,7 @@ require 'date'
 require 'csv'
 require_relative 'status_helper'
 require_relative 'formatter'
+require_relative 'time_report_helper'
 
 module Timet
   # The TimeReport class is responsible for displaying a report of tracked time
@@ -11,6 +12,7 @@ module Timet
   # a formatted table with the relevant information.
   class TimeReport
     include Formatter
+    include TimeReportHelper
 
     # Provides access to the database instance.
     attr_reader :db
@@ -53,23 +55,14 @@ module Timet
       return puts 'No tracked time found for the specified filter.' if items.empty?
 
       format_table_header
-      duration_by_tag = Hash.new(0)
-      time_block = []
-      items.each_with_index do |item, idx|
-        date = TimeHelper.extract_date(items, idx)
-        display_time_entry(item, date)
-        time_block << TimeHelper.count_seconds_per_hour_block(item[1], item[2])
-        duration_by_tag[item[3]] += TimeHelper.calculate_duration(item[1], item[2])
-      end
+      time_block, duration_by_tag = process_time_entries
       puts format_table_separator
       total
 
-      if Time.now.to_i - items.map { |x| x[1] }.min < 86_400
-        time_block_reverse = TimeHelper.aggregate_hash_values(time_block)
-        print_time_block_chart(time_block_reverse)
-      end
+      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)
+      format_tag_distribution(duration_by_tag, colors)
     end
 
     # Displays a single row of the report.
@@ -119,33 +112,10 @@ module Timet
     def write_csv(file_name)
       CSV.open(file_name, 'w') do |csv|
         csv << %w[ID Start End Tag Notes]
-        items.each do |item|
-          csv << format_item(item)
-        end
+        write_csv_rows(csv)
       end
     end
 
-    # Formats an item for CSV export.
-    #
-    # @param item [Array] The item to format.
-    #
-    # @return [Array] The formatted item.
-    #
-    # @example Format an item for CSV export
-    #   format_item(item)
-    #
-    # @note The method formats the item's ID, start time, end time, tag, and notes.
-    def format_item(item)
-      id, start_time, end_time, tags, notes = item
-      [
-        id,
-        TimeHelper.format_time(start_time),
-        TimeHelper.format_time(end_time),
-        tags,
-        notes
-      ]
-    end
-
     # Displays a single time entry in the report.
     #
     # @param item [Array] The item to display.
@@ -180,7 +150,7 @@ module Timet
       total = @items.map do |item|
         TimeHelper.calculate_duration(item[1], item[2])
       end.sum
-      puts "|#{' ' * 37}\033[94mTotal:  | #{@db.seconds_to_hms(total).rjust(8)} |\033[0m                          |"
+      puts "|#{' ' * 43}\033[94mTotal:  | #{@db.seconds_to_hms(total).rjust(8)} |\033[0m                    |"
       puts format_table_separator
     end
 
@@ -208,24 +178,6 @@ module Timet
       end
     end
 
-    # Provides predefined date ranges for filtering.
-    #
-    # @return [Hash] A hash containing predefined date ranges.
-    #
-    # @example Get the predefined date ranges
-    #   date_ranges
-    #
-    # @note The method returns a hash with predefined date ranges for 'today', 'yesterday', 'week', and 'month'.
-    def date_ranges
-      today = Date.today
-      {
-        'today' => [today, nil],
-        'yesterday' => [today - 1, nil],
-        'week' => [today - 7, today + 1],
-        'month' => [today - 30, today + 1]
-      }
-    end
-
     # Filters the items by date range and tag.
     #
     # @param start_date [Date] The start date of the range.
@@ -273,22 +225,5 @@ module Timet
 
       'today'
     end
-
-    # Validates the date format.
-    #
-    # @param date_string [String] The date string to validate.
-    #
-    # @return [Boolean] True if the date format is valid, otherwise false.
-    #
-    # @example Validate the date format
-    #   valid_date_format?('2021-10-01') # => true
-    #
-    # @note The method validates the date format for single dates and date ranges.
-    def valid_date_format?(date_string)
-      date_format_single = /^\d{4}-\d{2}-\d{2}$/
-      date_format_range = /^\d{4}-\d{2}-\d{2}\.\.\d{4}-\d{2}-\d{2}$/
-
-      date_string.match?(date_format_single) || date_string.match?(date_format_range)
-    end
   end
 end

data/lib/timet/time_report_helper.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+module Timet
+  # The TimeReportHelper module provides a collection of utility methods for processing and formatting time report data.
+  # It includes methods for processing time entries, handling time blocks, formatting items for CSV export,
+  # 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.
+    #
+    # @example Get the predefined date ranges
+    #   date_ranges
+    #
+    # @note The method returns a hash with predefined date ranges for 'today', 'yesterday', 'week', and 'month'.
+    def date_ranges
+      today = Date.today
+      tomorrow = today + 1
+      {
+        'today' => [today, nil],
+        'yesterday' => [today - 1, nil],
+        'week' => [today - 7, tomorrow],
+        'month' => [today - 30, tomorrow]
+      }
+    end
+
+    # Formats an item for CSV export.
+    #
+    # @param item [Array] The item to format.
+    #
+    # @return [Array] The formatted item.
+    #
+    # @example Format an item for CSV export
+    #   format_item(item)
+    #
+    # @note The method formats the item's ID, start time, end time, tag, and notes.
+    def format_item(item)
+      id, start_time, end_time, tags, notes = item
+      [
+        id,
+        TimeHelper.format_time(start_time),
+        TimeHelper.format_time(end_time),
+        tags,
+        notes
+      ]
+    end
+
+    # Validates the date format.
+    #
+    # @param date_string [String] The date string to validate.
+    #
+    # @return [Boolean] True if the date format is valid, otherwise false.
+    #
+    # @example Validate the date format
+    #   valid_date_format?('2021-10-01') # => true
+    #
+    # @note The method validates the date format for single dates and date ranges.
+    def valid_date_format?(date_string)
+      date_format_single = /^\d{4}-\d{2}-\d{2}$/
+      date_format_range = /^\d{4}-\d{2}-\d{2}\.\.\d{4}-\d{2}-\d{2}$/
+
+      date_string.match?(date_format_single) || date_string.match?(date_format_range)
+    end
+
+    # Merges two hashes, summing the numeric values of corresponding keys.
+    #
+    # @param base_hash [Hash] The base hash to which the additional hash will be merged.
+    # @param additional_hash [Hash] The additional hash whose values will be added to the base hash.
+    # @return [Hash] A new hash with the summed values.
+    #
+    # @example
+    #   base_hash = { 'key1' => [10, 'tag1'], 'key2' => [20, 'tag2'] }
+    #   additional_hash = { 'key1' => [5, 'tag1'], 'key3' => [15, 'tag3'] }
+    #   add_hashes(base_hash, additional_hash)
+    #   #=> { 'key1' => [15, 'tag1'], 'key2' => [20, 'tag2'], 'key3' => [15, 'tag3'] }
+    def add_hashes(base_hash, additional_hash)
+      base_hash.merge(additional_hash) do |_key, old_value, new_value|
+        summed_number = old_value[0] + new_value[0]
+        [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.2.1'
-  VERSION = '1.2.1'
+  #   Timet::VERSION # => '1.3.0'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timet
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Frank Vielma
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-18 00:00:00.000000000 Z
+date: 2024-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -86,8 +86,10 @@ files:
 - lib/timet/status_helper.rb
 - lib/timet/time_helper.rb
 - lib/timet/time_report.rb
+- lib/timet/time_report_helper.rb
 - lib/timet/validation_edit_helper.rb
 - lib/timet/version.rb
+- monthly_report.webp
 - sig/timet.rbs
 - timet.webp
 homepage: https://frankvielma.github.io/posts/timet-a-powerful-command-line-tool-for-tracking-your-time/