timet 1.5.2 → 1.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f538523396dc470f91334a3abe44915e63dec009a60901a1ae4ef7b432a9a37f
-  data.tar.gz: 262da1d62b413102d4ff33932fa7fb05c10c4b13abcb832d6382683d2d314d8d
+  metadata.gz: f65773f17ed00b4aff9ff1a3157191f8753686755b6ffd2e985bde5927783c99
+  data.tar.gz: b3f6474b4db6fc4f3ebed7b0d976c46061cfc29c85461c6f437a16f48c824aa5
 SHA512:
-  metadata.gz: 4d1d90414bda675c2f09827ec99c63b4e86e04f826e969d07af15a757e29b1cb868d412d17b7995012b1091173cd50e2093009600bb55888b06ffd1c1a4397e0
-  data.tar.gz: cad0f0569224af29941301173dcfa1045c4419db21265b5cdb2d64e5e14f9eeca52d5ada931be7fed1757305ba55bb05823111d974a40c2e57ca0a25c4f8cff7
+  metadata.gz: a0db80d8b3671e64d6afc2d1164c74567fedb707a83493042ffb1e3cc87f8242580442e1ad21afc7fb1fd567c1e0b70de96a4647edcc6aef47f44406790d1a5e
+  data.tar.gz: 394458e551db981b18b6c1e72a9fa0b734031e6c8408f70f1fd7d2498a98e292204eca0835374b03a7e51df47d0fcc63266d696a9744863a31e153210a3e26d1

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 ## [Unreleased]
 
+## [1.5.3] - 2025-01-02
+
+**Improvements:**
+
+- Upgraded dependencies in `Gemfile` and `Gemfile.lock` to their latest compatible versions, including `aws-sdk-s3`, `csv`, `sqlite3`, and others.
+- Refactored `TimeBlockChart` from a module to a class, encapsulating `start_hour` and `end_hour` as instance variables for better state management.
+- Added a `print_footer` method to `tag_distribution.rb` to provide clear explanations for summary metrics (total duration, average duration, and standard deviation).
+- Improved documentation for the `TimeBlockChart` class, including example usage and `attr_reader` for `start_hour` and `end_hour`.
+- Simplified method signatures in `TimeBlockChart` by removing redundant parameters and leveraging instance variables.
+
+**Bug Fixes:**
+
+- Fixed an issue in `tag_distribution.rb` where the calculation of `percentage_value` was redundant and simplified the logic.
+- Corrected the display of the day abbreviation in `TimeBlockChart` to include the full three-letter abbreviation (e.g., "Mon" instead of "Mo").
+- Removed unused code in `time_statistics.rb` that was not contributing to the `totals` method.
+
 ## [1.5.2] - 2024-12-12
 
 **Improvements:**

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(time_block)
+  #   chart.print_time_block_chart(time_block, 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,66 @@ 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
     #
-    # @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.
+    # @param [Hash] time_block The time block data
+    def initialize(time_block)
+      @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 time block chart
     #
-    # @see #print_header
-    # @see #print_blocks
+    # @param [Hash] time_block The time block data
+    # @param [Hash] colors The color mapping for different tags
+    # @return [void]
     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)
+      print_header
+      print_blocks(time_block, colors)
     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_hour [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]
+    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
     #
-    # @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.
+    # @param [Hash] time_block The time block data
+    # @param [Hash] colors The color mapping for different tags
     # @return [void]
-    def print_blocks(time_block, colors, start_hour)
+    def print_blocks(time_block, colors)
       return unless time_block
 
       weeks = []
       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)
+        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 +99,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 +188,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 +201,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

@@ -15,7 +15,6 @@ module Timet
   class TimeReport
     include TimeReportHelper
     include Table
-    include TimeBlockChart
     include TagDistribution
 
     # Provides access to the database instance.
@@ -74,7 +73,8 @@ module Timet
       time_block = table
 
       colors = @items.map { |x| x[3] }.uniq.each_with_index.to_h
-      print_time_block_chart(time_block, colors)
+      chart = TimeBlockChart.new(time_block)
+      chart.print_time_block_chart(time_block, colors)
 
       tag_distribution(colors)
     end

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
@@ -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)

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.5.2'
-  VERSION = '1.5.2'
+  #   Timet::VERSION # => '1.5.3'
+  VERSION = '1.5.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timet
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.5.3
 platform: ruby
 authors:
 - Frank Vielma
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-12 00:00:00.000000000 Z
+date: 2025-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor