timet 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1bb43c1123df04f10728b72d13245307f1d67d8c1e3234c84ade0cc03836517
-  data.tar.gz: b0f51950af5d3e6c0ac88ca8914194aa579b04cbc13fb3ae75e84d62bacd9cf2
+  metadata.gz: d469231d2981219dd87a4f3e7a456f1e5d047656186343798cc6a5edd4990fdc
+  data.tar.gz: 17c5ff8e151fc7ac540aa85f84ba3e93b6678d50d544e3a8489411235dfdd391
 SHA512:
-  metadata.gz: e835f9f66149d036d3d7528a7563e91af26e0577f5e60e4984ca0471f2758e21e6ce4b5b45d4a150ac7f1eb496ecd339a9b8abad2c86814934c5c9f588e93699
-  data.tar.gz: 9d0d081dd8190b5d3d30a13f5b1067f77e4ffb52a64ae4e1007ed80cedfd04ee26db0aeaef5b8cb4edbcc8e08f8e00686609953daeafdda335fa2ae7e595877c
+  metadata.gz: 4915bac3ff784ebc128e4dc4ba97c9427cc673c04ee7cb14b72f01bc7366d4b8ce741eb060f4caa6d33126ebee6cece04a2ccb3d37aaa8483c8ce36a0f2be540
+  data.tar.gz: cb97abad6c3be282f2ce0d46df2f500da6fbb4ccecdd89574b81110f1da1475a3d7ccf677634b4691a7332880b2ab9cc5e5e32ad9e25291f6210a0958ae48253

data/CHANGELOG.md

@@ -1,5 +1,40 @@
 ## [Unreleased]
 
+## [1.3.2] - 2024-10-25
+
+**Improvements:**
+
+- Refactor and enhance time tracking report formatting.
+  - Refactored the `format_table_header` method to improve readability and use the `blink` and `red` color methods.
+  - Updated the `format_tag_distribution` method to use the `color` method for horizontal bars.
+  - Refactored the `print_time_block_chart` method to use the `start_hour` variable consistently.
+  - Enhanced the `print_header` method to improve alignment and use the `gray` color method.
+  - Refactored the `print_blocks` method to use the `red` color method for weekends and the `underline` method for week numbers.
+  - Added a new `print_footer` method to print the footer of the report.
+  - Refactored the `print_colored_block` method to use the `color` method for colored blocks.
+  - Updated the `application.rb` file to improve the description of the `start` command.
+- Refactor color codes and add new methods.
+  - Removed hardcoded color codes and replaced them with a dynamic color method.
+  - Added new methods for underline, blink, and green color.
+  - Updated the String class extension to use the new color methods.
+  - Added a new file 'color_codes.rb' to the 'lib/timet.rb' require list.
+  - Removed YARD documentation comments from 'lib/timet.rb' as they are no longer needed.
+- Update JSON and SQLite3 dependencies.
+- Add hours per day feature.
+
+**Bug fixes:**
+
+- Refactor error message printing to use color method.
+  - Updated the `print_error` method in `validation_edit_helper.rb` to use the `red` color method instead of hardcoded ANSI escape codes.
+  - This change improves readability and consistency with other color usage in the project.
+
+**Additional Considerations:**
+
+- The changes in this pull request improve the overall user experience by enhancing the visual presentation of the time tracking report and updating the documentation.
+- The refactor of color codes and addition of new methods improve the flexibility and visual effects of terminal output.
+- The update to JSON and SQLite3 dependencies ensures compatibility with the latest versions of these libraries.
+- The addition of the hours per day feature provides more detailed information in the time tracking report.
+
 ## [1.3.1] - 2024-10-24
 
 **Improvements:**

data/README.md

@@ -9,7 +9,7 @@
 
 Timet refers to a command-line tool designed to track your activities by recording the time spent on each task, allowing you to monitor your work hours and productivity directly from your terminal without needing a graphical interface; essentially, it's a way to log your time spent on different projects or tasks using simple text commands
 
-**Key Features:**
+🔑 **Key Features:**
 
 - **Local Data Storage:** Timet utilizes SQLite to store your time tracking data locally, ensuring privacy and security.
 - **Lightweight and Fast:** Its efficient design and local data storage make Timet a speedy and responsive tool.
@@ -22,29 +22,12 @@ Timet refers to a command-line tool designed to track your activities by recordi
 - **Block Time Plot:** Visualizes the distribution of tracked time across a specified range of dates, with bars in each column representing the amount of time tracked during that specific hour. The plot includes a header showing the hours and a row for each date, displaying the time blocks for each hour.
 - **Tag Distribution Plot:** Illustrates the proportion of total tracked time allocated to each tag, showing the relative contribution of each tag to the overall time tracked.
 
-Example:
 
-```bash
-Tracked time report [today]:
-+-------+------------+--------+----------+----------+----------+--------------------------+
-| Id    | Date       | Tag    | Start    | End      | Duration | Notes                    |
-+-------+------------+--------+----------+----------+----------+--------------------------+
-|    20 | 2024-10-10 | Tag8   | 19:26:58 | 20:26:58 | 01:00:00 | Notes 2                  |
-|    19 |            | Tag3   | 07:52:26 | 08:52:26 | 01:00:00 | Notes 7                  |
-+-------+------------+--------+----------+----------+----------+--------------------------+
-|                                           Total:  | 02:00:00 |                          |
-+-------+------------+--------+----------+----------+----------+--------------------------+
-
-⏳ ↦ [ 00  01  02  03  04  05  06  07  08  09  10  11  12  13  14  15  16  17  18  19  20  21  22  23 ]
-     [                             ▂▂  ▇▇                                          ▅▅  ▄▄             ]
-
-    Tag8:    50.0%  ▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅
-    Tag3:    50.0%  ▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅
-```
+Examples:
 
-![Timet monthly report](monthly_report.webp)
+![Timet1 demo](timet1.gif)
 
-## Requirements
+## ✔️ Requirements
 
 - Ruby version: >= 3.0.0
 - sqlite3: > 1.7
@@ -55,7 +38,7 @@ Old versions of Ruby and Sqlite:
 
 - [Ruby >= 2.4](https://github.com/frankvielma/timet/tree/ruby-2.4.0)
 
-## Installation
+## 💾 Installation
 
 Install the gem by executing:
 
@@ -63,7 +46,7 @@ Install the gem by executing:
 gem install timet
 ```
 
-## Usage
+## ⏳ Usage
 
 ### Command Aliases
 
@@ -180,7 +163,7 @@ gem install timet
   +-------+------------+--------+----------+----------+----------+--------------------------+
   ```
 
-## Command Reference
+## 📋  Command Reference
 
 | Command                             | Description                                                                 | Example Usage                     |
 | ----------------------------------- | --------------------------------------------------------------------------- | --------------------------------- |

data/lib/timet/application.rb

@@ -36,7 +36,8 @@ module Timet
     VALID_STATUSES_FOR_INSERTION = %i[no_items complete].freeze
 
     desc "start [tag] --notes='' --pomodoro=[min]",
-         'Starts tracking time for a task labeled with the provided [tag],  notes and "pomodoro time" in minutes (optional).'
+         'Starts tracking time for a task labeled with the provided [tag],  notes and "pomodoro time" in minutes
+         (optional).'
     option :notes, type: :string, desc: 'Add a note'
     option :pomodoro, type: :numeric, desc: 'Pomodoro time in minutes'
     # Starts a new tracking session with the given tag and optional notes.

data/lib/timet/color_codes.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Timet
+  # ColorCodes class
+  class ColorCodes
+    RESET = "\u001b[0m"
+    UNDERLINE = "\e[4m"
+    BLINK = "\e[5m["
+
+    def self.reset
+      RESET
+    end
+
+    def self.underline
+      UNDERLINE
+    end
+
+    def self.blink
+      BLINK
+    end
+
+    def self.color(num)
+      "\u001b[38;5;#{num}m"
+    end
+  end
+end
+
+# Extend String class globally
+class String
+  def gray
+    "#{Timet::ColorCodes.color(242)}#{self}#{Timet::ColorCodes.reset}"
+  end
+
+  def red
+    "#{Timet::ColorCodes.color(1)}#{self}#{Timet::ColorCodes.reset}"
+  end
+
+  def underline
+    "#{Timet::ColorCodes.underline}#{self}#{Timet::ColorCodes.reset}"
+  end
+
+  def blink
+    "#{Timet::ColorCodes.blink}#{self}#{Timet::ColorCodes.reset}"
+  end
+
+  def green
+    "#{Timet::ColorCodes.color(10)}#{self}#{Timet::ColorCodes.reset}"
+  end
+
+  def color(num)
+    "#{Timet::ColorCodes.color(num)}#{self}#{Timet::ColorCodes.reset}"
+  end
+end

data/lib/timet/database.rb

@@ -171,7 +171,7 @@ module Timet
     #
     # @note The method executes SQL to find the item with the given ID in the 'items' table.
     def find_item(id)
-      execute_sql("select * from items where id=#{id}").first
+      execute_sql("SELECT * from items where id=#{id}").first
     end
 
     # Fetches all items from the items table that have a start time greater than or equal to today.

data/lib/timet/formatter.rb

@@ -26,8 +26,9 @@ module Timet
     #
     # @note The method constructs a string representing the table header and prints it.
     def format_table_header
+      title = "Tracked time report #{@filter.blink.red}]:"
       header = <<~TABLE
-        Tracked time report \e[5m\u001b[31m[#{@filter}]\033[0m:
+        #{title}
         #{format_table_separator}
         \033[32m| Id    | Date       | Tag    | Start    | End      | Duration | Notes              |\033[0m
         #{format_table_separator}
@@ -87,8 +88,8 @@ module Timet
     #     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
+    #     #    timet:   66.67%  ====================
+    #     #   nextjs:   33.33%  ==========
     #
     #   @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.
@@ -113,7 +114,8 @@ module Timet
       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"
+        horizontal_bar = (block * bar_length).to_s.color(colors[tag] + 1)
+        puts "#{tag.rjust(8)}: #{value.to_s.rjust(7)}%  #{horizontal_bar}"
       end
     end
 
@@ -154,9 +156,9 @@ module Timet
     # @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)
+      start_hour = time_block.values.map(&:keys).flatten.uniq.min.to_i
+      print_header(start_hour)
+      print_blocks(time_block, colors, start_hour)
     end
 
     # Prints the header of the time block chart.
@@ -164,7 +166,7 @@ module Timet
     # 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.
+    # @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.
     #
@@ -174,13 +176,14 @@ module Timet
     #   #
     #   #      ⏳ ↦ [ 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)
+    # @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)
       puts
-      print "\u001b[38;5;244m┌╴W ╴╴╴╴╴⏰ ╴╴╴╴╴╴┬\u001b[0m "
-      (start_time..23).each { |hour| print format('%02d', hour).ljust(4) }
-      puts ''
+      print ' ' * 19
+      (start_hour..23).each { |hour| print format('%02d', hour).rjust(4) }
+      puts
+      puts '┌╴W ╴╴╴╴╴╴⏰╴╴╴╴╴╴┼'.gray + "#{'╴' * (24 - start_hour) * 4}╴╴╴┼".gray
     end
 
     # Prints the block characters for each hour in the time block chart.
@@ -200,17 +203,17 @@ module Timet
     #   #
     #   # (followed by two newlines)
     #
-    def print_blocks(time_block, colors, start_time)
+    def print_blocks(time_block, colors, start_hour)
       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
+        weekend = date_string
         if %w[Sa Su].include?(day)
-          day = "\u001b[38;5;1m#{day}\u001b[0m"
-          date1 = "\u001b[38;5;1m#{date1}\u001b[0m"
+          day = day.red
+          weekend = weekend.red
         end
 
         weeks << date.cweek
@@ -218,15 +221,29 @@ module Timet
         week = if (weeks[n] == weeks[n - 1]) && n.positive?
                  '  '
                else
-                 "\e[4m#{weeks[n]}\e[0m"
+                 weeks[n].to_s.underline
                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 "
+        puts "┆                 ┆#{' ' * (24 - start_hour) * 4}   ┼░░░░".gray if week != '  ' && n.positive?
+        print '┆'.gray + "#{week} #{weekend} #{day} " + '┆- '.gray
         time_block_initial = time_block[date_string]
-        print_time_blocks(start_time, time_block_initial, colors)
+        print_time_blocks(start_hour, time_block_initial, colors)
+
+        total_seconds = time_block_initial.values.map { |item| item[0] }.sum
+        hours_per_day = (total_seconds / 3600.0).round(1)
+        print "-┆#{hours_per_day}h".gray
         puts
       end
-      puts "\u001b[38;5;244m└╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴┴\u001b[0m"
+      print_footer(start_hour)
+    end
+
+    # Prints the footer of the report.
+    #
+    # @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)
+      timet = "\e]8;;https://github.com/frankvielma/timet/\aTimet\e]8;;\a".green
+      puts '└╴╴╴╴╴╴╴'.gray + timet + "╴╴╴╴╴┴#{'╴' * (24 - start_hour) * 4}╴╴╴┴".gray
+      puts
     end
 
     # Prints time blocks for each hour from the start time to 23.
@@ -281,8 +298,8 @@ module Timet
     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)
+      colored_block = color_code ? "#{block.color(color_code + 1)}  " : block
+      print colored_block.rjust(4)
     end
 
     # Determines the block character based on the value.

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.3.2'
+  VERSION = '1.3.2'
 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.3.2
 platform: ruby
 authors:
 - Frank Vielma
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-24 00:00:00.000000000 Z
+date: 2024-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -80,6 +80,7 @@ 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