timet 1.5.2 → 1.5.4

data/lib/timet/table.rb

@@ -1,9 +1,21 @@
 # frozen_string_literal: true
 
+# require_relative 'color_codes'
+require 'timet/time_report_helper'
 module Timet
-  # This module is responsible for formatting the output of the `timet` application.
+  # This class is responsible for formatting the output of the `timet` application.
   # It provides methods for formatting the table header, separators, and rows.
-  module Table
+  class Table
+    include TimeReportHelper
+
+    attr_reader :filter, :items
+
+    def initialize(filter, items, db)
+      @filter = filter
+      @items = items
+      @db = db
+    end
+
     # Generates and displays a table summarizing time entries, including headers, time blocks, and total durations.
     #
     # @example
@@ -64,22 +76,26 @@ module Timet
 
     # Processes time entries and generates a time block structure.
     #
-    # @return [Hash] A nested hash representing the time block structure.
+    # This method iterates over each item in the `items` array, displays the time entry (if enabled),
+    # and processes the time block item to build a nested hash representing the time block structure.
+    #
+    # @param display [Boolean] Whether to display the time entry during processing. Defaults to `true`.
+    # @return [Hash] A nested hash representing the time block structure, where keys are dates and values
+    #                are processed time block items.
     #
     # @note
-    #   - The method iterates over each item in the `items` array.
-    #   - For each item, it calls `display_time_entry` to display the time entry.
-    #   - It then processes the time block item using `process_time_block_item`.
+    #   - The method uses `display_time_entry` to display the time entry if `display` is `true`.
+    #   - It processes each time block item using `process_time_block_item`.
     #   - The `TimeHelper.extract_date` method is used to extract the date from the items.
     #
     # @see #display_time_entry
     # @see #process_time_block_item
     # @see TimeHelper#extract_date
-    def process_time_entries
+    def process_time_entries(display: true)
       time_block = Hash.new { |hash, key| hash[key] = {} }
 
-      items.each_with_index do |item, idx|
-        display_time_entry(item, TimeHelper.extract_date(items, idx))
+      @items.each_with_index do |item, idx|
+        display_time_entry(item, TimeHelper.extract_date(@items, idx)) if display
         time_block = process_time_block_item(item, time_block)
       end
 

data/lib/timet/tag_distribution.rb

@@ -41,6 +41,17 @@ module Timet
     def process_and_print_tags(time_stats, total, colors)
       print_summary(time_stats, total)
       print_tags_info(time_stats, total, colors)
+      print_footer
+    end
+
+    # Prints the footer information.
+    #
+    # @return [void] This method outputs the footer information to the standard output.
+    def print_footer
+      puts '-' * 45
+      puts 'T:'.rjust(4).red + 'The total duration'.gray
+      puts 'AVG:'.rjust(4).red + 'The average duration'.gray
+      puts 'SD:'.rjust(4).red + 'The standard deviation of the durations'.gray
     end
 
     # Prints the summary information including total duration, average duration, and standard deviation.
@@ -104,7 +115,7 @@ module Timet
     #   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(1)
+      percentage_value = (value * 100).round(1)
       bar_length = (value * MAX_BAR_LENGTH).round
       [percentage_value, bar_length]
     end

data/lib/timet/time_block_chart.rb

@@ -1,9 +1,24 @@
 # 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 TimeBlockChart
+  #
+  # The TimeBlockChart class is responsible for generating and printing a visual representation
+  # of time blocks for a given set of data. It uses character mapping to represent different
+  # time ranges and provides methods to print the chart with headers, footers, and colored blocks.
+  #
+  # Example usage:
+  #   time_block = {
+  #     "2023-10-01" => { "08" => [3600, "work"], "09" => [1800, "break"] },
+  #     "2023-10-02" => { "10" => [4500, "work"] }
+  #   }
+  #   colors = { "work" => 31, "break" => 32 }
+  #   chart = TimeBlockChart.new(table)
+  #   chart.print_time_block_chart(table, colors)
+  #
+  # @attr_reader [Integer] start_hour The starting hour of the time block
+  # @attr_reader [Integer] end_hour The ending hour of the time block
+  class TimeBlockChart
+    # Character mapping for different time ranges
     CHAR_MAPPING = {
       0..120 => '_',
       121..450 => '▁',
@@ -16,87 +31,115 @@ module Timet
       3151..3600 => '█'
     }.freeze
 
+    # Separator character for the chart
     SEPARATOR_CHAR = '░'
 
-    # Prints a time block chart based on the provided time block and colors.
+    # Initializes a new TimeBlockChart instance.
     #
-    # @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" }
+    # This method sets up the time block chart by processing the time entries from the provided table
+    # and determining the start and end hours for the chart based on the time block data.
     #
-    # @return [void] This method does not return a value; it prints the chart directly to the output.
+    # @param table [Table] The table instance containing the time entries to be processed.
+    # @return [void] This method does not return a value; it initializes the instance variables.
     #
-    # @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
+    #   - The `@time_block` instance variable is populated by processing the time entries from the table.
+    #   - The `@start_hour` and `@end_hour` instance variables are calculated based on the earliest and latest
+    #     hours present in the time block data.
     #
-    # @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_hour = time_block.values.map(&:keys).flatten.uniq.min.to_i
-      print_header(start_hour)
-      print_blocks(time_block, colors, start_hour)
+    # @see Table#process_time_entries
+    def initialize(table)
+      @time_block = table.process_time_entries(display: false)
+      @start_hour = @time_block.values.map(&:keys).flatten.uniq.min.to_i
+      @end_hour = @time_block.values.map(&:keys).flatten.uniq.max.to_i
     end
 
-    # Prints the header of the time block chart.
+    # Prints 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.
+    # This method formats and prints the time block chart, including the header and the time blocks
+    # for each entry. The chart is color-coded based on the provided color mapping for different tags.
     #
-    # @param start_hour [Integer] The starting time for the chart. This should be an integer between 0 and 23.
+    # @param table [Hash] The time block data to be displayed in the chart.
+    # @param colors [Hash] A mapping of tags to colors, used to color-code the time blocks.
+    # @return [void] This method does not return a value; it performs side effects such as printing the chart.
     #
-    # @return [void] This method does not return a value; it prints the header directly to the output.
+    # @example Print a time block chart
+    #   chart = TimeBlockChart.new(table)
+    #   chart.print_time_block_chart(table, colors)
     #
-    # @example
-    #   print_header(10)
-    #   # Output:
-    #   #
-    #   #      ⏳ ↦ [ 10  11  12  13  14  15  16  17  18  19  20  21  22  23]
+    # @note
+    #   - The method first prints the header of the chart, which includes the time range.
+    #   - It then prints the time blocks, using the provided color mapping to visually distinguish
+    #     between different tags.
+    #
+    # @see #print_header
+    # @see #print_blocks
+    def print_time_block_chart(table, colors)
+      print_header
+      print_blocks(table, colors)
+    end
+
+    private
+
+    # Prints the header of the chart
     #
-    # @note The method assumes that the start_hour is within the valid range of 0 to 23.
-    #   If the start_hour is outside this range, the output may not be as expected.
-    def print_header(start_hour)
+    # @return [void]
+    def print_header
       puts
       print ' ' * 19
-      (start_hour..23).each { |hour| print format('%02d', hour).rjust(4) }
+      (@start_hour..@end_hour + 1).each { |hour| print format('%02d', hour).rjust(4) }
       puts
-      puts '┌╴W ╴╴╴╴╴╴⏰╴╴╴╴╴╴┼'.gray + "#{'╴' * (24 - start_hour) * 4}╴╴╴┼".gray
+      puts '┌╴W ╴╴╴╴╴╴⏰╴╴╴╴╴╴┼'.gray + "#{'╴' * (@end_hour - @start_hour + 1) * 4}╴╴╴┼".gray
     end
 
-    # Prints the time blocks for each date in the given time block data structure.
+    # Prints the time blocks for each date in the time block data.
     #
-    # @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
+    # This method iterates over the time block data, formats and prints the date information,
+    # prints the time blocks for each date using the provided color mapping, and calculates
+    # and prints the total hours for each day. It also prints a footer at the end.
+    #
+    # @param table [Hash] The time block data containing the time entries for each date.
+    # @param colors [Hash] A mapping of tags to colors, used to color-code the time blocks.
+    # @return [void] This method does not return a value; it performs side effects such as printing
+    #   the time blocks and related information.
+    #
+    # @example Print time blocks
+    #   chart = TimeBlockChart.new(table)
+    #   chart.print_blocks(table, colors)
+    #
+    # @note
+    #   - The method skips processing if the `table` parameter is `nil`.
+    #   - For each date in the time block data, it formats and prints the date and day of the week.
+    #   - It prints the time blocks using the provided color mapping to visually distinguish
+    #     between different tags.
+    #   - It calculates and prints the total hours for each day.
+    #   - A footer is printed at the end to provide a visual separation.
+    #
+    # @see #format_and_print_date_info
+    # @see #print_time_blocks
+    # @see #calculate_and_print_hours
+    # @see #print_footer
+    def print_blocks(table, colors)
+      return unless table
 
       weeks = []
-      time_block.each_key do |date_string|
+      @time_block.each_key do |date_string|
         date = Date.parse(date_string)
-        day = date.strftime('%a')[0..1]
+        day = date.strftime('%a')[0..2]
 
-        format_and_print_date_info(date_string, day, weeks, start_hour)
+        format_and_print_date_info(date_string, day, weeks)
 
-        time_block_initial = time_block[date_string]
-        print_time_blocks(start_hour, time_block_initial, colors)
+        time_block_initial = @time_block[date_string]
+        print_time_blocks(time_block_initial, colors)
 
         calculate_and_print_hours(time_block_initial)
       end
-      print_footer(start_hour)
+      print_footer
     end
 
-    # Calculates the total hours from the given time block data and prints it.
+    # Calculates and prints the total hours for a day
     #
-    # @param time_block_initial [Hash] A hash containing time block data for a specific date.
+    # @param [Hash] time_block_initial The initial time block data for a day
     # @return [void]
     def calculate_and_print_hours(time_block_initial)
       total_seconds = time_block_initial.values.map { |item| item[0] }.sum
@@ -105,104 +148,88 @@ module Timet
       puts
     end
 
-    # Formats and prints the date information including the week and day.
+    # Formats and prints the date information
     #
-    # @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.
+    # @param [String] date_string The date string
+    # @param [String] day The day of the week
+    # @param [Array] weeks The list of weeks
     # @return [void]
-    def format_and_print_date_info(date_string, day, weeks, start_hour)
+    def format_and_print_date_info(date_string, day, weeks)
       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)
+      week = format_and_print_week(date_string, weeks)
 
-      print '┆'.gray + "#{week} #{weekend} #{day} " + '┆- '.gray
+      print '┆'.gray + "#{week} #{weekend} #{day}" + '┆- '.gray
     end
 
-    # Formats and prints the week information including the separator if necessary.
+    # Formats and prints the week information
     #
-    # @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)
+    # @param [String] date_string The date string
+    # @param [Array] weeks The list of weeks
+    # @return [String] The formatted week string
+    def format_and_print_week(date_string, weeks)
       week, current_index = determine_week(date_string, weeks)
-      print_separator(start_hour, week, current_index)
+      print_separator(week, current_index)
       week
     end
 
-    # Determines the week string based on the date and the previous week.
+    # Determines the week for a given date
     #
-    # @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.
+    # @param [String] date_string The date string
+    # @param [Array] weeks The list of weeks
+    # @return [Array] The week string and 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 = if current_week == weeks[current_index - 1] && current_index.positive?
+               '  '
+             else
+               format('%02d', current_week).to_s.underline
+             end
       [week, current_index]
     end
 
-    # Prints the separator line if the week string is not empty and the current index is positive.
+    # Prints the separator line
     #
-    # @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.
+    # @param [String] week The week string
+    # @param [Integer] current_index The current index
     # @return [void]
-    def print_separator(start_hour, week, current_index)
+    def print_separator(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
+      puts "┆#{sep * 17}┼#{sep * (@end_hour - @start_hour + 1) * 4}#{sep * 3}┼#{sep * 4}".gray
     end
 
-    # Prints the footer of the report.
+    # Prints the footer of the chart
     #
-    # @param start_hour [Integer] The start time used to calculate the footer length.
-    # @return [void] This method does not return a value; it prints directly to the standard output.
-    def print_footer(start_hour)
+    # @return [void]
+    def print_footer
       timet = "\e]8;;https://github.com/frankvielma/timet/\aTimet\e]8;;\a".green
-      puts '└╴╴╴╴╴╴╴'.gray + timet + "╴╴╴╴╴┴#{'╴' * (24 - start_hour) * 4}╴╴╴┴".gray
+      puts '└╴╴╴╴╴╴╴'.gray + timet + "╴╴╴╴╴┴#{'╴' * (@end_hour - @start_hour + 1) * 4}╴╴╴┴".gray
       puts
     end
 
-    # Prints time blocks for each hour from the start time to 23.
+    # Prints the time blocks for a given day
     #
-    # @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.
+    # @param [Hash] time_block_initial The initial time block data for a day
+    # @param [Hash] colors The color mapping for different tags
     # @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|
+    def print_time_blocks(time_block_initial, colors)
+      (@start_hour..@end_hour).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.
+    # Gets the formatted block character for a given hour
     #
-    # @example
-    #   time_block_initial = {
-    #     '01' => ['block_char_data', 'tag']
-    #   }
-    #   get_formatted_block_char(1, time_block_initial) #=> ['tag', 'block_char']
+    # @param [Integer] hour The hour
+    # @param [Hash] time_block_initial The initial time block data for a day
+    # @return [Array] The tag and block character
     def get_formatted_block_char(hour, time_block_initial)
       formatted_hour = format('%02d', hour)
       hour_data = time_block_initial[formatted_hour]
@@ -210,15 +237,12 @@ module Timet
       [tag, get_block_char(hour_data&.first)]
     end
 
-    # Prints a colored block character based on the provided tag and block character.
+    # Prints the colored 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'
+    # @param [String] block_char The block character
+    # @param [String] tag The tag
+    # @param [Hash] colors The color mapping for different tags
+    # @return [void]
     def print_colored_block(block_char, tag, colors)
       color_code = colors[tag]
       block = block_char * 2
@@ -226,10 +250,10 @@ module Timet
       print colored_block.rjust(4)
     end
 
-    # Determines the block character based on the value.
+    # Gets the block character for a given value
     #
-    # @param value [Integer] The value to determine the block character for.
-    # @return [String] The block character corresponding to the value.
+    # @param [Integer, nil] value The value
+    # @return [String] The block character
     def get_block_char(value)
       return ' ' unless value
 

data/lib/timet/time_report.rb

@@ -14,8 +14,6 @@ module Timet
   # a formatted table with the relevant information.
   class TimeReport
     include TimeReportHelper
-    include Table
-    include TimeBlockChart
     include TagDistribution
 
     # Provides access to the database instance.
@@ -33,37 +31,55 @@ module Timet
     # Initializes a new instance of the TimeReport class.
     #
     # @param db [Database] The database instance to use for fetching data.
-    # @param options [Hash] A hash containing optional parameters.
-    # @option options [String, nil] :filter The filter to apply when fetching items. Possible values include 'today',
-    #   'yesterday', 'week', 'month', or a date range in the format 'YYYY-MM-DD..YYYY-MM-DD'.
-    # @option options [String, nil] :tag The tag to filter the items by.
-    # @option options [String, nil] :csv The filename to use when exporting the report to CSV.
-    # @option options [String, nil] :ics The filename to use when exporting the report to iCalendar.
-    #
-    # @return [void] This method does not return a value; it performs side effects such as initializing the
-    # instance variables.
+    # @param options [Hash] A hash containing optional parameters for configuring the report.
+    # @option options [String, nil] :filter The filter to apply when fetching items. Possible values include:
+    #   - 'today': Filters items for the current day.
+    #   - 'yesterday': Filters items for the previous day.
+    #   - 'week': Filters items for the current week.
+    #   - 'month': Filters items for the current month.
+    #   - A date range in the format 'YYYY-MM-DD..YYYY-MM-DD': Filters items within the specified date range.
+    # @option options [String, nil] :tag The tag to filter the items by. Only items with this tag will be included.
+    # @option options [String, nil] :csv The filename to use when exporting the report to CSV. If provided, the report
+    #   will be exported to the specified file.
+    # @option options [String, nil] :ics The filename to use when exporting the report to iCalendar format. If provided,
+    #   the report will be exported to the specified file.
+    #
+    # @return [void] This method does not return a value; it initializes the instance variables and prepares the report.
     #
     # @example Initialize a new TimeReport instance with a filter and tag
     #   TimeReport.new(db, filter: 'today', tag: 'work', csv: 'report.csv', ics: 'icalendar.ics')
+    #
+    # @example Initialize a new TimeReport instance with a date range filter
+    #   TimeReport.new(db, filter: '2023-10-01..2023-10-31', tag: 'project')
+    #
+    # @note
+    #   - If no filter is provided, all items from the database will be fetched.
+    #   - The `@table` instance variable is initialized with the filtered items and filter configuration.
     def initialize(db, options = {})
       @db = db
       @csv_filename = options[:csv]
       @ics_filename = options[:ics]
       @filter = formatted_filter(options[:filter])
       @items = options[:filter] ? filter_items(@filter, options[:tag]) : @db.all_items
+      @table = Table.new(@filter, @items, @db)
     end
 
     # Displays the report of tracked time entries.
     #
+    # This method formats and prints the report, including the table header, rows, total duration,
+    # a time block chart, and tag distribution. If no tracked time entries are found for the specified filter,
+    # it displays a message indicating no data is available.
+    #
     # @return [void] This method does not return a value; it performs side effects such as printing the report.
     #
     # @example Display the report
     #   time_report.display
     #
-    # @note The method formats and prints the table header, rows, and total duration.
-    #
-    # @param items [Array<Hash>] The list of time entries to be displayed.
-    # @param options [Hash] Additional options for customizing the display (e.g., color scheme).
+    # @note
+    #   - The method checks if there are any tracked time entries. If not, it prints a message and exits.
+    #   - It uses the `@table` instance to format and display the table.
+    #   - A time block chart is generated and printed using the `TimeBlockChart` class.
+    #   - The tag distribution is calculated and displayed based on the unique colors assigned to tags.
     #
     # @see #table
     # @see #print_time_block_chart
@@ -71,29 +87,38 @@ module Timet
     def display
       return puts 'No tracked time found for the specified filter.' if @items.empty?
 
-      time_block = table
-
+      @table.table
       colors = @items.map { |x| x[3] }.uniq.each_with_index.to_h
-      print_time_block_chart(time_block, colors)
-
+      chart = TimeBlockChart.new(@table)
+      chart.print_time_block_chart(@table, colors)
       tag_distribution(colors)
     end
 
     # Displays a single row of the report.
     #
-    # @param item [Array] The item to display.
+    # This method formats and prints a single row of the report, including the table header, the specified row,
+    # a separator, and the total duration. It is used to display individual time entries in a structured format.
+    #
+    # @param item [Array] The item (time entry) to display. The item is expected to contain the necessary data
+    #   for the row, such as the time, description, and duration.
     #
     # @return [void] This method does not return a value; it performs side effects such as printing the row.
     #
     # @example Display a single row
     #   time_report.show_row(item)
     #
-    # @note The method formats and prints the table header, row, and total duration.
+    # @note
+    #   - The method uses the `@table` instance to format and display the table header and row.
+    #   - A separator is printed after the row to visually distinguish it from other rows.
+    #   - The total duration is displayed at the end of the row.
+    #
+    # @see #table
+    # @see #display_time_entry
     def show_row(item)
-      header
-      display_time_entry(item)
-      puts separator
-      total
+      @table.header
+      @table.display_time_entry(item)
+      puts @table.separator
+      @table.total
     end
 
     private

data/lib/timet/time_statistics.rb

@@ -34,8 +34,6 @@ module Timet
     #   - :avg [Numeric] The average duration.
     #   - :sd [Numeric] The standard deviation of the durations.
     def totals
-      @duration_by_tag.values.flatten
-
       durations = @duration_by_tag.values.flatten
       { total: @total_duration, avg: durations.mean, sd: durations.standard_deviation }
     end

data/lib/timet/validation_edit_helper.rb

@@ -51,7 +51,8 @@ module Timet
     # @note The method formats the date value and checks if it is valid.
     # @note If the date value is valid, it updates the time field with the new value.
     # @note If the date value is invalid, it prints an error message.
-    def process_and_update_time_field(item, field, date_value, id)
+    def process_and_update_time_field(*args)
+      item, field, date_value, id = args
       formatted_date = TimeHelper.format_time_string(date_value)
 
       return print_error(date_value) unless formatted_date
@@ -82,17 +83,17 @@ module Timet
     #
     # @param item [Array] The tracking item to be updated.
     # @param field [String] The time field to be updated.
-    # @param formatted_value [String] The formatted date value.
+    # @param new_time [String] The new time value.
     #
     # @return [Time] The updated time value.
     #
     # @example Update the 'start' field of a tracking item with a formatted date value
-    #   update_time_field(item, 'start', '2023-10-01 12:00:00')
-    def update_time_field(item, field, formatted_value)
+    #   update_time_field(item, 'start', '11:10:00')
+    def update_time_field(item, field, new_time)
       field_index = Timet::Application::FIELD_INDEX[field]
       timestamp = item[field_index]
       current_time = Time.at(timestamp || TimeHelper.current_timestamp).to_s.split
-      current_time[1] = formatted_value
+      current_time[1] = new_time
       DateTime.strptime(current_time.join(' '), '%Y-%m-%d %H:%M:%S %z').to_time
     end
 
@@ -107,7 +108,8 @@ module Timet
     #
     # @example Validate a new 'start' time value
     #   valid_time_value?(item, 'start', 1633072800, 1)
-    def valid_time_value?(item, field, new_value_epoch, id)
+    def valid_time_value?(*args)
+      item, field, new_value_epoch, id = args
       item_start = fetch_item_start(item)
       item_end = fetch_item_end(item)
       item_before_end = fetch_item_before_end(id, item_start)