timet 1.3.2 → 1.4.1

data/lib/timet/time_report.rb

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

data/lib/timet/time_report_helper.rb

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

data/lib/timet/version.rb

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

metadata

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

data/lib/timet/status_helper.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module Timet
-  # Provides helper methods to determine the status of time tracking results.
-  module StatusHelper
-    # Determines the status of a time tracking result based on the presence and end time of items.
-    #
-    # @param result [Array] The result set containing time tracking items.
-    #
-    # @return [Symbol] The status of the time tracking result. Possible values are
-    # :no_items, :in_progress, or :complete.
-    #
-    # @example Determine the status of an empty result set
-    #   StatusHelper.determine_status([]) # => :no_items
-    #
-    # @example Determine the status of a result set with an in-progress item
-    #   StatusHelper.determine_status([[1, nil]]) # => :in_progress
-    #
-    # @example Determine the status of a result set with a completed item
-    #   StatusHelper.determine_status([[1, 1633072800]]) # => :complete
-    #
-    # @note The method checks if the result set is empty and returns :no_items if true.
-    # @note If the last item in the result set has no end time, it returns :in_progress.
-    # @note If the last item in the result set has an end time, it returns :complete.
-    def self.determine_status(result)
-      return :no_items if result.empty?
-
-      last_item_end = result.first[1]
-      return :in_progress unless last_item_end
-
-      :complete
-    end
-  end
-end