timet 1.4.3 → 1.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7754392fd614ebc62c53293166db637a9593f8497b4cc22ea3ea602bc51546f7
-  data.tar.gz: e4f699cf2725be5cf6849a5946323270d078ab1d6fa13892877f17ce161b1d1b
+  metadata.gz: c617b0cdad056a121039feaacfb0fe04df4e3e21cea8d9261e0414a01c2e9014
+  data.tar.gz: cac525344920d23e05ed0cab8798aa70e0153337328cac6bb170c6d96b9b509a
 SHA512:
-  metadata.gz: 2a8be74697ff40c179a0546662fc7b067d0ceddf4da159ea3107c87fef68b3f6cb7a7c3e61ff9c9115bcc799d5d5278fe209629a892077783aa56c77c772c81f
-  data.tar.gz: bd9131bccca060ea7d8a7710d9a96b6c784cfeca7312a9146f8fa5c31d8bd0e40b3a58e82ec670328baf5e92d0d2f8b3fa8e80a47a25a0f771c2cb1a6c5e667b
+  metadata.gz: e48e71078a2cfb0e7f92a67b008f323b487366ad41392e0027a1d229e29680018dbcf1b13012322735f94302e5c0e03576d544dd7b1897fd3973cf49ee7cc1d1
+  data.tar.gz: 2a5a3fdabd064518b57aac6142c690dba881ce3d68ace78bd6770d5679fc11f24a71878a7422a80482aaaffb0e723bd8aa4c9a0ebf2de2fa5b8ee35a3082d98d

data/CHANGELOG.md

@@ -1,5 +1,35 @@
 ## [Unreleased]
 
+## [1.4.4] - 2024-11-12
+
+**Improvements:**
+- Refactored tag distribution and time statistics methods:
+  - Split `process_and_print_tags` into `print_summary` and `print_tags_info` for better modularity and readability.
+  - Added Yardoc comments to document the new methods and updated existing comments for clarity.
+  - Introduced `totals` method in `TimeStatistics` to calculate and return total duration, average duration, and standard deviation.
+- Refactored export methods to `TimeReportHelper`:
+  - Moved `export_csv` and `export_icalendar` methods from `TimeReport` to `TimeReportHelper`.
+  - Created private methods `add_events`, `create_event`, and `convert_to_datetime` in `TimeReportHelper` to handle iCalendar event creation and conversion.
+  - Ensured that the iCalendar file generation logic is encapsulated within the `TimeReportHelper` module.
+
+**Tasks:**
+- Bumped version to 1.4.4.
+- Updated `Gemfile.lock`.
+
+## [1.4.3] - 2024-11-06
+
+**Improvements:**
+- **Refactor export logic**: Introduced a new `ReportExporter` class to handle the export of reports to CSV and iCalendar formats, addressing the Feature Envy code smell and making the `ApplicationHelper` module more modular.
+- **Update gem dependencies**: Updated several gems to their latest versions, including `icalendar`, `sqlite3`, `json`, `parser`, `rubocop`, and `rubocop-ast`.
+- **Refactor `TimeReport` initialization**: Refactored `TimeReport` initialization to use an options hash instead of individual parameters, and added support for exporting tracking summaries to iCalendar format.
+- **Enhance command descriptions**: Improved the descriptions of the `start`, `stop`, `resume`, `summary`, `edit`, `delete`, and `cancel` commands, and added an `--ics` option to the `summary` command for iCalendar export.
+- **Add `icalendar` gem**: Added the `icalendar` gem to support iCalendar functionality and updated the `timet` gem version to `1.4.3`.
+
+**Bug Fixes:**
+- Corrected platform names in the lockfile.
+- Updated the `TimeReport` spec to use the new options hash in the `TimeReport` initialization.
+
+
 ## [1.4.2] - 2024-11-01
 
 **Improvements:**

data/lib/timet/tag_distribution.rb

@@ -34,31 +34,43 @@ module Timet
 
     # 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 time_stats [Object] An object containing the time statistics, including totals and sorted durations by tag.
     # @param total [Numeric] The total duration of all tags combined.
+    # @param colors [Object] An object containing color formatting methods.
     # @return [void] This method outputs the tag distribution information to the standard output.
     def process_and_print_tags(time_stats, total, colors)
-      time_stats.sorted_duration_by_tag.each do |tag, duration|
-        print_tag_info(tag, duration, total, time_stats, colors)
-      end
+      print_summary(time_stats, total)
+      print_tags_info(time_stats, total, colors)
     end
 
-    # Prints the detailed information for a specific tag.
+    # Prints the summary information including total duration, average duration, and standard deviation.
     #
-    # @param tag [String] The tag for which to print the information.
-    # @param duration [Numeric] The duration associated with the tag.
+    # @param time_stats [Object] An object containing the time statistics, including totals.
     # @param total [Numeric] The total duration of all tags combined.
-    # @param time_stats [Object] An object containing time statistics for the tags.
-    # @param colors [Hash] A hash mapping tags to color indices for display.
-    # @return [void] This method outputs the tag information to the standard output.
-    def print_tag_info(tag, duration, total, time_stats, colors)
-      value, bar_length = calculate_value_and_bar_length(duration, total)
-      horizontal_bar = generate_horizontal_bar(bar_length, colors[tag])
-      formatted_tag = tag[0...TAG_SIZE].rjust(TAG_SIZE)
-      stats = generate_stats(tag, time_stats)
+    # @return [void] This method outputs the summary information to the standard output.
+    def print_summary(time_stats, total)
+      avg = (time_stats.totals[:avg] / 60.0).round(1)
+      sd = (time_stats.totals[:sd] / 60.0).round(1)
+      summary = "#{' ' * TAG_SIZE} #{'Summary'.underline}: "
+      summary += "[T: #{(total / 3600.0).round(1)}h, AVG: #{avg}min SD: #{sd}min]".white
+      puts summary
+    end
 
-      puts "#{formatted_tag}: #{value.to_s.rjust(5)}%  #{horizontal_bar} [#{stats}]"
+    # Prints the detailed information for each tag.
+    #
+    # @param time_stats [Object] An object containing the time statistics, including sorted durations by tag.
+    # @param total [Numeric] The total duration of all tags combined.
+    # @param colors [Object] An object containing color formatting methods.
+    # @return [void] This method outputs the detailed tag information to the standard output.
+    def print_tags_info(time_stats, total, colors)
+      time_stats.sorted_duration_by_tag.each do |tag, duration|
+        value, bar_length = calculate_value_and_bar_length(duration, total)
+        horizontal_bar = generate_horizontal_bar(bar_length, colors[tag])
+        formatted_tag = tag[0...TAG_SIZE].rjust(TAG_SIZE)
+        stats = generate_stats(tag, time_stats)
+
+        puts "#{formatted_tag}: #{value.to_s.rjust(5)}%  #{horizontal_bar} [#{stats}]"
+      end
     end
 
     # Generates a horizontal bar for display based on the bar length and color index.

data/lib/timet/time_report.rb

@@ -96,47 +96,6 @@ module Timet
       total
     end
 
-    # Exports the report to a CSV file.
-    #
-    # @return [void] This method does not return a value; it performs side effects such as writing the CSV file.
-    #
-    # @example Export the report to a CSV file
-    #   time_report.export_csv
-    #
-    # @note The method writes the items to a CSV file and prints a confirmation message.
-    def export_csv
-      file_name = "#{csv_filename}.csv"
-      write_csv(file_name)
-
-      puts "The #{file_name} has been exported."
-    end
-
-    def export_icalendar
-      file_name = "#{ics_filename}.ics"
-
-      cal = Icalendar::Calendar.new
-      items.each do |item|
-        dtstart = Time.at(item[1]).to_datetime
-        end_time = item[2] || TimeHelper.current_timestamp
-        dtend = Time.at(end_time).to_datetime
-
-        tag = item[3]
-        notes = item[4]
-        cal.event do |e|
-          e.dtstart     = dtstart
-          e.dtend       = dtend
-          e.summary     = tag
-          e.description = notes
-          e.ip_class    = 'PRIVATE'
-        end
-      end
-      cal.publish
-
-      File.write(file_name, cal.to_ical)
-
-      puts "The #{file_name} has been generated."
-    end
-
     private
 
     # Writes the items to a CSV file.

data/lib/timet/time_report_helper.rb

@@ -80,5 +80,72 @@ module Timet
         [summed_number, old_value[1]]
       end
     end
+
+    # Exports the report to a CSV file.
+    #
+    # @return [void] This method does not return a value; it performs side effects such as writing the CSV file.
+    #
+    # @example Export the report to a CSV file
+    #   time_report.export_csv
+    #
+    # @note The method writes the items to a CSV file and prints a confirmation message.
+    def export_csv
+      file_name = "#{csv_filename}.csv"
+      write_csv(file_name)
+
+      puts "The #{file_name} has been exported."
+    end
+
+    # Generates an iCalendar file and writes it to disk.
+    #
+    # @return [void]
+    def export_icalendar
+      file_name = "#{ics_filename}.ics"
+      cal = add_events
+
+      File.write(file_name, cal.to_ical)
+
+      puts "The #{file_name} has been generated."
+    end
+
+    private
+
+    # Creates an iCalendar object and adds events to it.
+    #
+    # @return [Icalendar::Calendar] the populated iCalendar object
+    def add_events
+      cal = Icalendar::Calendar.new
+      items.each do |item|
+        event = create_event(item)
+        cal.add_event(event)
+      end
+      cal.publish
+      cal
+    end
+
+    # Creates an iCalendar event from the given item.
+    #
+    # @param item [Array] the item containing event details
+    # @return [Icalendar::Event] the created event
+    def create_event(item)
+      dtstart = convert_to_datetime(item[1])
+      dtend = convert_to_datetime(item[2] || TimeHelper.current_timestamp)
+
+      Icalendar::Event.new.tap do |e|
+        e.dtstart     = dtstart
+        e.dtend       = dtend
+        e.summary     = item[3]
+        e.description = item[4]
+        e.ip_class    = 'PRIVATE'
+      end
+    end
+
+    # Converts a timestamp to a DateTime object.
+    #
+    # @param timestamp [Integer] the timestamp to convert
+    # @return [DateTime] the converted DateTime object
+    def convert_to_datetime(timestamp)
+      Time.at(timestamp).to_datetime
+    end
   end
 end

data/lib/timet/time_statistics.rb

@@ -27,6 +27,19 @@ module Timet
       calculate_durations_by_tag
     end
 
+    # Returns a hash containing the total duration, average duration, and standard deviation of durations.
+    #
+    # @return [Hash] A hash with the following keys:
+    #   - :total [Numeric] The total duration.
+    #   - :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
+
     # Calculates the duration for each tag and updates the @duration_by_tag and @total_duration attributes.
     #
     # @return [void]

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.4.3'
-  VERSION = '1.4.3'
+  #   Timet::VERSION # => '1.4.4'
+  VERSION = '1.4.4'
 end

metadata

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