timet 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1bb43c1123df04f10728b72d13245307f1d67d8c1e3234c84ade0cc03836517
-  data.tar.gz: b0f51950af5d3e6c0ac88ca8914194aa579b04cbc13fb3ae75e84d62bacd9cf2
+  metadata.gz: bec76070c29c2eab4a2a5792084a9980c1cd29c0ab3ac80dbae2c6310e74d78a
+  data.tar.gz: 551fe37b00ac0ca015e28fcdd37810216c0ff00ea4b800c97bd0fb539af1df7b
 SHA512:
-  metadata.gz: e835f9f66149d036d3d7528a7563e91af26e0577f5e60e4984ca0471f2758e21e6ce4b5b45d4a150ac7f1eb496ecd339a9b8abad2c86814934c5c9f588e93699
-  data.tar.gz: 9d0d081dd8190b5d3d30a13f5b1067f77e4ffb52a64ae4e1007ed80cedfd04ee26db0aeaef5b8cb4edbcc8e08f8e00686609953daeafdda335fa2ae7e595877c
+  metadata.gz: 290e56a65e8c9e163d1558efe87fb93c8d74522c9aa1410f77a21ea6fe81d4a8270ec03947deb959699940c1c40ff91b4749f9512f1de4e005ac822cb564934a
+  data.tar.gz: 0e27f41ad71bca972355c70c235d900ae0c4ec571c47f9fd7324b979b3036b02f4cd6dd5aaa0464d4dd5ac12f2989ae38aed5e15613c496eb182dacb92f3bf11

data/CHANGELOG.md

@@ -1,5 +1,64 @@
 ## [Unreleased]
 
+## [1.4.0] - 2024-10-29
+
+**Improvements:**
+
+- Introduced constants for fixed tag size and block character in the `TagDistribution` module.
+- Refactored `process_and_print_tags` to use constants directly and ensure tags are truncated to fit within the defined size.
+- Simplified `calculate_value_and_bar_length` method to directly calculate percentage value and bar length using `MAX_BAR_LENGTH`.
+- Renamed `summary` to `report` in `application.rb` for clarity.
+- Integrated `Formatter` functionality into `Table` and `TimeBlockChart` modules.
+- Added new methods in `Table` for formatting specific parts of the table row.
+- Enhanced `TimeBlockChart` with new methods for formatting and printing date information.
+- Integrated `Table` and `TimeBlockChart` into `TimeReport` for a more modular structure.
+- Removed redundant methods from `TimeReportHelper` and ensured all necessary methods are included in the appropriate modules.
+- Added a `blue` method to the `String` class to apply blue color to text and applied it to the total time display in `TimeReport`.
+- Refactored database initialization and column addition logic to improve reusability and maintainability.
+- Refactored Pomodoro session handling and table formatting to improve readability and functionality.
+- Refactored `summary` method to use `time_scope` instead of `filter` for clarity.
+- Refactored insertion logic to improve clarity and prevent redundant checks.
+- Refactored tag distribution formatting into a separate `TagDistribution` module for better code organization.
+
+**Bug fixes:**
+
+- Fixed a typo in the table header title.
+
+## [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.
@@ -68,10 +69,12 @@ module Timet
       notes = options[:notes] || notes
       pomodoro = (options[:pomodoro] || pomodoro).to_i
 
-      if VALID_STATUSES_FOR_INSERTION.include?(@db.last_item_status)
-        @db.insert_item(start_time, tag, notes)
-        play_sound_and_notify(pomodoro * 60, tag) if pomodoro.positive?
+      unless VALID_STATUSES_FOR_INSERTION.include?(@db.last_item_status)
+        return puts 'A task is currently being tracked.'
       end
+
+      @db.insert_item(start_time, tag, notes, pomodoro)
+      play_sound_and_notify(pomodoro * 60, tag) if pomodoro.positive?
       summary
     end
 
@@ -127,15 +130,15 @@ module Timet
       end
     end
 
-    desc 'summary (su) [filter] [tag] --csv=csv_filename',
-         '[filter] => [today (t), yesterday (y), week (w), month (m), [start_date]..[end_date]]  [tag]'
+    desc 'summary (su) [time_scope] [tag] --csv=csv_filename',
+         '[time_scope] => [today (t), yesterday (y), week (w), month (m), [start_date]..[end_date]]  [tag]'
     option :csv, type: :string, desc: 'Export to CSV file'
-    # Generates a summary of tracking items based on the provided filter and tag, and optionally exports the summary
+    # Generates a summary of tracking items based on the provided time_scope and tag, and optionally exports the summary
     # to a CSV file.
     #
-    # @param filter [String, nil] The filter to apply when generating the summary. Possible values include 'today',
-    # 'yesterday', 'week', 'month', or a date range in the format '[start_date]..[end_date]'.
-    # @param tag [String, nil] The tag to filter the tracking items by.
+    # @param time_scope [String, nil] The time_scope to apply when generating the summary. Possible values include
+    # 'today', 'yesterday', 'week', 'month', or a date range in the format '[start_date]..[end_date]'.
+    # @param tag [String, nil] The tag to time_scope the tracking items by.
     #
     # @return [void] This method does not return a value; it performs side effects such as displaying the summary and
     # exporting to CSV if specified.
@@ -149,19 +152,19 @@ module Timet
     # @example Generate a summary for a date range and export to CSV
     #   summary('2023-01-01..2023-01-31', nil, csv: 'summary.csv')
     #
-    # @note The method initializes a `TimeReport` object with the database, filter, tag, and optional CSV filename.
+    # @note The method initializes a `TimeReport` object with the database, time_scope, tag, and optional CSV filename.
     # @note The method calls `display` on the `TimeReport` object to show the summary.
     # @note If a CSV filename is provided and there are items to export, the method calls `export_sheet` to export the
     # summary to a CSV file.
     # @note If no items are found to export, it prints a message indicating that no items were found.
-    def summary(filter = nil, tag = nil)
+    def summary(time_scope = nil, tag = nil)
       csv_filename = options[:csv]&.split('.')&.first
-      summary = TimeReport.new(@db, filter, tag, csv_filename)
+      report = TimeReport.new(@db, time_scope, tag, csv_filename)
 
-      summary.display
-      items = summary.items
+      report.display
+      items = report.items
       if csv_filename && items.any?
-        summary.export_sheet
+        report.export_sheet
       elsif items.empty?
         puts 'No items found to export'
       end
@@ -280,25 +283,5 @@ module Timet
     def version
       puts Timet::VERSION
     end
-
-    private
-
-    # Deletes a tracking item from the database by its ID and prints a confirmation message.
-    #
-    # @param id [Integer] The ID of the tracking item to be deleted.
-    # @param message [String] The message to be printed after the item is deleted.
-    #
-    # @return [void] This method does not return a value; it performs side effects such as deleting the tracking item
-    # and printing a message.
-    #
-    # @example Delete a tracking item with ID 1 and print a confirmation message
-    #   delete_item_and_print_message(1, 'Deleted item 1')
-    #
-    # @note The method deletes the tracking item from the database using `@db.delete_item(id)`.
-    # @note After deleting the item, the method prints the provided message using `puts message`.
-    def delete_item_and_print_message(id, message)
-      @db.delete_item(id)
-      puts message
-    end
   end
 end

data/lib/timet/application_helper.rb

@@ -109,10 +109,10 @@ module Timet
     # @param tag [String] A tag or label for the session, used in the notification message.
     # @return [void]
     def run_linux_session(time, tag)
-      notification_command = "notify-send --icon=clock 'Pomodoro session complete! (tag: #{tag}) Time for a break.'"
+      notification_command = "notify-send --icon=clock '#{show_message(tag)}'"
       command = "sleep #{time} && tput bel && tt stop 0 && #{notification_command} &"
       pid = spawn(command)
-      Process.wait(pid)
+      Process.detach(pid)
     end
 
     # Runs a Pomodoro session on a macOS system.
@@ -120,11 +120,42 @@ module Timet
     # @param time [Integer] The duration of the Pomodoro session in seconds.
     # @param _tag [String] A tag or label for the session, not used in the notification message on macOS.
     # @return [void]
-    def run_mac_session(time, _tag)
-      notification_command = "osascript -e 'display notification \"Pomodoro session complete! Time for a break.\"'"
+    def run_mac_session(time, tag)
+      notification_command = "osascript -e 'display notification \"#{show_message(tag)}\"'"
       command = "sleep #{time} && afplay /System/Library/Sounds/Basso.aiff && tt stop 0 && #{notification_command} &"
       pid = spawn(command)
-      Process.wait(pid)
+      Process.detach(pid)
+    end
+
+    # Generates a message indicating that a Pomodoro session is complete and it's time for a break.
+    #
+    # @param tag [String] The tag associated with the completed Pomodoro session.
+    # @return [String] A message indicating the completion of the Pomodoro session and suggesting a break.
+    #
+    # @example
+    #   show_message("work")
+    #   # => "Pomodoro session complete (work). Time for a break."
+    #
+    def show_message(tag)
+      "Pomodoro session complete (#{tag}). Time for a break."
+    end
+
+    # Deletes a tracking item from the database by its ID and prints a confirmation message.
+    #
+    # @param id [Integer] The ID of the tracking item to be deleted.
+    # @param message [String] The message to be printed after the item is deleted.
+    #
+    # @return [void] This method does not return a value; it performs side effects such as deleting the tracking item
+    # and printing a message.
+    #
+    # @example Delete a tracking item with ID 1 and print a confirmation message
+    #   delete_item_and_print_message(1, 'Deleted item 1')
+    #
+    # @note The method deletes the tracking item from the database using `@db.delete_item(id)`.
+    # @note After deleting the item, the method prints the provided message using `puts message`.
+    def delete_item_and_print_message(id, message)
+      @db.delete_item(id)
+      puts message
     end
   end
 end

data/lib/timet/color_codes.rb

@@ -0,0 +1,61 @@
+# 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 white
+    "#{Timet::ColorCodes.color(246)}#{self}#{Timet::ColorCodes.reset}"
+  end
+
+  def gray
+    "#{Timet::ColorCodes.color(242)}#{self}#{Timet::ColorCodes.reset}"
+  end
+
+  def red
+    "#{Timet::ColorCodes.color(1)}#{self}#{Timet::ColorCodes.reset}"
+  end
+
+  def blue
+    "#{Timet::ColorCodes.color(12)}#{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

@@ -28,7 +28,9 @@ module Timet
     def initialize(database_path = DEFAULT_DATABASE_PATH)
       @db = SQLite3::Database.new(database_path)
       create_table
-      add_notes
+
+      add_column('items', 'notes', 'TEXT')
+      add_column('items', 'pomodoro', 'INTEGER')
     end
 
     # Creates the items table if it doesn't already exist.
@@ -51,23 +53,27 @@ module Timet
       SQL
     end
 
-    # Adds a new column named "notes" to the "items" table if it doesn't exist.
+    # Adds a new column to the specified table if it does not already exist.
     #
-    # @return [void] This method does not return a value; it performs side effects such as executing SQL to add
-    # the column.
+    # @param table_name [String] The name of the table to which the column will be added.
+    # @param new_column_name [String] The name of the new column to be added.
+    # @param date_type [String] The data type of the new column (e.g., 'INTEGER', 'TEXT', 'BOOLEAN').
+    # @return [void] This method does not return a value; it performs side effects such as adding the column and
+    # printing a message.
     #
-    # @example Add the notes column to the items table
-    #   add_notes
+    # @example Add a new 'completed' column to the 'tasks' table
+    #   add_column('tasks', 'completed', 'INTEGER')
     #
-    # @note The method checks if the 'notes' column already exists and adds it if it does not.
-    def add_notes
-      table_name = 'items'
-      new_column_name = 'notes'
+    # @note The method first checks if the column already exists in the table using `pragma_table_info`.
+    # @note If the column exists, the method returns without making any changes.
+    # @note If the column does not exist, the method executes an SQL `ALTER TABLE` statement to add the column.
+    # @note The method prints a message indicating that the column has been added.
+    def add_column(table_name, new_column_name, date_type)
       result = execute_sql("SELECT count(*) FROM pragma_table_info('items') where name='#{new_column_name}'")
       column_exists = result[0][0].positive?
       return if column_exists
 
-      execute_sql("ALTER TABLE #{table_name} ADD COLUMN #{new_column_name} TEXT")
+      execute_sql("ALTER TABLE #{table_name} ADD COLUMN #{new_column_name} #{date_type}")
       puts "Column '#{new_column_name}' added to table '#{table_name}'."
     end
 
@@ -84,8 +90,8 @@ module Timet
     #   insert_item(1633072800, 'work', 'Completed task X')
     #
     # @note The method executes SQL to insert a new row into the 'items' table.
-    def insert_item(start, tag, notes)
-      execute_sql('INSERT INTO items (start, tag, notes) VALUES (?, ?, ?)', [start, tag, notes])
+    def insert_item(start, tag, notes, pomodoro = nil)
+      execute_sql('INSERT INTO items (start, tag, notes, pomodoro) VALUES (?, ?, ?, ?)', [start, tag, notes, pomodoro])
     end
 
     # Updates an existing item in the items table.
@@ -171,7 +177,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.