timet 1.3.1 → 1.4.0

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/validation_edit_helper.rb

@@ -75,7 +75,7 @@ module Timet
     # @example Print an error message for an invalid date
     #   print_error('Invalid date: 2023-13-32')
     def print_error(message)
-      puts "\u001b[31mInvalid date: #{message}\033[0m"
+      puts "Invalid date: #{message}".red
     end
 
     # Updates a time field (start or end) of a tracking item with a formatted date value.

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.1'
-  VERSION = '1.3.1'
+  #   Timet::VERSION # => '1.4.0'
+  VERSION = '1.4.0'
 end

data/lib/timet.rb

@@ -1,18 +1,6 @@
 # frozen_string_literal: true
 
-# Require the Timet::Application class from the 'timet/application' file.
-#
-# @note This statement loads the Timet::Application class, which is responsible for handling the command-line
-# interface and user commands.
 require_relative 'timet/application'
-
-# Require the Timet::Database class from the 'timet/database' file.
-#
-# @note This statement loads the Timet::Database class, which provides database access for managing time tracking data.
 require_relative 'timet/database'
-
-# Require the Timet::TimeReport class from the 'timet/time_report' file.
-#
-# @note This statement loads the Timet::TimeReport class, which is responsible for displaying a report
-# of tracked time entries.
 require_relative 'timet/time_report'
+require_relative 'timet/color_codes'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timet
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Frank Vielma
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-24 00:00:00.000000000 Z
+date: 2024-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -80,9 +80,12 @@ files:
 - lib/timet.rb
 - lib/timet/application.rb
 - 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

data/lib/timet/formatter.rb

@@ -1,298 +0,0 @@
-# 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 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
-    # 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
-      header = <<~TABLE
-        Tracked time report \e[5m\u001b[31m[#{@filter}]\033[0m:
-        #{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%  \u001b[38;5;42m====================\u001b[0m
-    #     #   nextjs:   33.33%  \u001b[38;5;42m==========\u001b[0m
-    #
-    #   @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)
-        puts "#{tag.rjust(8)}: #{value.to_s.rjust(7)}%  \u001b[38;5;#{colors[tag] + 1}m#{block * bar_length}\u001b[0m"
-      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
-
-    # 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)
-    #
-    # @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.
-    #
-    # 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(10)
-    #   # Output:
-    #   #
-    #   #      ⏳ ↦ [ 10  11  12  13  14  15  16  17  18  19  20  21  22  23]
-    #
-    # @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 "\u001b[38;5;244m┌╴W ╴╴╴╴╴⏰ ╴╴╴╴╴╴┬\u001b[0m "
-      (start_time..23).each { |hour| print format('%02d', hour).ljust(4) }
-      puts ''
-    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)
-    #
-    def print_blocks(time_block, colors, start_time)
-      return unless time_block
-
-      weeks = []
-      time_block.each_key do |date_string|
-        date = Date.parse(date_string)
-        day = date.strftime('%a')[0..1]
-        date1 = date_string
-        if %w[Sa Su].include?(day)
-          day = "\u001b[38;5;1m#{day}\u001b[0m"
-          date1 = "\u001b[38;5;1m#{date1}\u001b[0m"
-        end
-
-        weeks << date.cweek
-        n = weeks.size - 1
-        week = if (weeks[n] == weeks[n - 1]) && n.positive?
-                 '  '
-               else
-                 "\e[4m#{weeks[n]}\e[0m"
-               end
-        puts "\u001b[38;5;244m┆                 ┆\u001b[0m" if week != '  ' && n.positive?
-        print "\u001b[38;5;244m┆\u001b[0m#{week} #{date1} #{day} \u001b[38;5;244m┆\u001b[0m "
-        time_block_initial = time_block[date_string]
-        print_time_blocks(start_time, time_block_initial, colors)
-        puts
-      end
-      puts "\u001b[38;5;244m└╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴┴\u001b[0m"
-    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.
-    #
-    # @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)
-      return ' ' unless value
-
-      CHAR_MAPPING.find { |range, _| range.include?(value) }&.last || ' '
-    end
-  end
-end