timet 1.3.2 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d469231d2981219dd87a4f3e7a456f1e5d047656186343798cc6a5edd4990fdc
-  data.tar.gz: 17c5ff8e151fc7ac540aa85f84ba3e93b6678d50d544e3a8489411235dfdd391
+  metadata.gz: 5e9f44f4ee2f1ae5aab382b308364ffeaffa5e09bf21d1578e8f5267ff715f0f
+  data.tar.gz: 13becd17288c93925e91a3c49dcdc7f4f7e7afe41d1469a10a7f931930b2d26d
 SHA512:
-  metadata.gz: 4915bac3ff784ebc128e4dc4ba97c9427cc673c04ee7cb14b72f01bc7366d4b8ce741eb060f4caa6d33126ebee6cece04a2ccb3d37aaa8483c8ce36a0f2be540
-  data.tar.gz: cb97abad6c3be282f2ce0d46df2f500da6fbb4ccecdd89574b81110f1da1475a3d7ccf677634b4691a7332880b2ab9cc5e5e32ad9e25291f6210a0958ae48253
+  metadata.gz: 27fca2e9adef3a4695a497b21106a400e7448caff946efccba034f9bbfcb29962822a632f17e3ab51856de764826257f5d6b33458d69fd9b56eebeb91946e5b8
+  data.tar.gz: df46d99862c3366f63f4ad007fbece638f88ca997fa2085070a78c065306b23888ecbbd5b610ba99582898395201dd00a1a8871de0ef8983d24c9ec3edefe32b

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 ## [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:**

data/README.md

@@ -106,7 +106,7 @@ gem install timet
   +-------+------------+--------+----------+----------+----------+--------------------------+
   ```
 ---
-- **timet resume**: It allows users to quickly resume tracking a task that was previously in progress.
+- **timet resume [id]**: This command allows users to quickly resume tracking a task that was previously in progress. If an id is provided, it resumes the tracking session for the specified task. If no id is provided, it resumes the last completed task.
 
   ```
   Tracked time report [today]:
@@ -177,9 +177,10 @@ gem install timet
 | `timet summary resume (r)`          | Resume tracking the last task.                                              | `timet su r`                      |
 | `timet delete [id]`                 | Delete a task by its ID.                                                    | `timet d [id]`                    |
 | `timet cancel`                      | Cancel active time tracking.                                                | `timet c`                         |
-| `timet edit [id]`                   | Update a task's notes, tag, start or end fields.                            | `timet e [1]`                     |
+| `timet edit [id]`                   | Update a task's notes, tag, start or end fields.                            | `timet e [id]`                    |
 | `timet su [date]`                   | Display a report of tracked time for a specific date.                       | `timet su 2024-01-03`             |
 | `timet su [start_date]..[end_date]` | Display a report of tracked time for a date range.                          | `timet su 2024-01-02..2024-01-03` |
+| `timet resume [id]`                 | Resume tracking a task by ID or the last completed task.                    | `timet resume [id]`               |
 
 ### Date Range in Summary
 

data/lib/timet/application.rb

@@ -69,10 +69,10 @@ 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?
-      end
+      return puts 'A task is currently being tracked.' unless VALID_STATUSES_FOR_INSERTION.include?(@db.item_status)
+
+      @db.insert_item(start_time, tag, notes, pomodoro)
+      play_sound_and_notify(pomodoro * 60, tag) if pomodoro.positive?
       summary
     end
 
@@ -85,13 +85,13 @@ module Timet
     # @example Stop the current tracking session
     #   stop
     #
-    # @note The method checks if the last tracking item is in progress by calling `@db.last_item_status`.
+    # @note The method checks if the last tracking item is in progress by calling `@db.item_status`.
     # @note If the last item is in progress, it fetches the last item's ID using `@db.fetch_last_id` and updates it
     # with the current timestamp.
     # @note The method then fetches the last item using `@db.last_item` and generates a summary if the result
     # is not nil.
     def stop(display = nil)
-      return unless @db.last_item_status == :in_progress
+      return unless @db.item_status == :in_progress
 
       last_id = @db.fetch_last_id
       @db.update_item(last_id, 'end', TimeHelper.current_timestamp)
@@ -99,7 +99,7 @@ module Timet
       summary unless display
     end
 
-    desc 'resume (r)', 'resume last task'
+    desc 'resume (r) [id]', 'resume last task'
     # Resumes the last tracking session if it was completed.
     #
     # @return [void] This method does not return a value; it performs side effects such as resuming a tracking session
@@ -108,35 +108,38 @@ module Timet
     # @example Resume the last tracking session
     #   resume
     #
-    # @note The method checks the status of the last tracking item using `@db.last_item_status`.
+    # @example Resume a specific task by ID
+    #   resume(123)
+    #
+    # @note The method checks the status of the last tracking item using `@db.item_status`.
     # @note If the last item is in progress, it prints a message indicating that a task is currently being tracked.
-    # @note If the last item is complete, it fetches the last item using `@db.last_item`, retrieves the tag and notes,
+    # @note If the last item is complete, it fetches the last item using `@db.find_item` or `@db.last_item`,
+    # retrieves the tag and notes,
     # and calls the `start` method to resume the tracking session.
-    def resume
-      status = @db.last_item_status
-
-      case status
+    #
+    # @param id [Integer, nil] The ID of the tracking item to resume. If nil, the last item is used.
+    #
+    # @see Database#item_status
+    # @see Database#find_item
+    # @see #start
+    def resume(id = nil)
+      case @db.item_status(id)
       when :in_progress
         puts 'A task is currently being tracked.'
       when :complete
-        last_item = @db.last_item
-        if last_item
-          tag = last_item[FIELD_INDEX['tag']]
-          notes = last_item[FIELD_INDEX['notes']]
-          start(tag, notes)
-        end
+        resume_complete_task(id)
       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.
@@ -150,19 +153,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
@@ -245,13 +248,13 @@ module Timet
     #   cancel
     #
     # @note The method fetches the ID of the last tracking item using `@db.fetch_last_id`.
-    # @note It checks if the last item is in progress by comparing `@db.last_item_status` with `:complete`.
+    # @note It checks if the last item is in progress by comparing `@db.item_status` with `:complete`.
     # @note If the last item is in progress, it deletes the item and prints a confirmation message using
     # `delete_item_and_print_message(id, "Canceled active time tracking #{id}")`.
     # @note If there is no active time tracking, it prints a message indicating that there is no active time tracking.
     def cancel
       id = @db.fetch_last_id
-      return puts 'There is no active time tracking' if @db.last_item_status == :complete
+      return puts 'There is no active time tracking' if @db.item_status == :complete
 
       delete_item_and_print_message(id, "Canceled active time tracking #{id}")
     end
@@ -281,25 +284,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,69 @@ 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
+
+    # Resumes a tracking session for a completed task.
+    #
+    # @param id [Integer, nil] The ID of the tracking item to resume. If nil, the last completed item is used.
+    #
+    # @return [void] This method does not return a value; it performs side effects such as resuming a tracking session.
+    #
+    # @example Resume the last completed task
+    #   resume_complete_task
+    #
+    # @example Resume a specific task by ID
+    #   resume_complete_task(123)
+    #
+    # @note The method fetches the specified or last completed item using `@db.find_item` or `@db.last_item`.
+    # @note If the item is found, it retrieves the tag and notes and calls the `start` method to resume the
+    # tracking session.
+    #
+    # @see Database#find_item
+    # @see Database#last_item
+    # @see #start
+    def resume_complete_task(id)
+      item = id ? @db.find_item(id) : @db.last_item
+      return unless item
+
+      tag, notes = item.values_at(Application::FIELD_INDEX['tag'], Application::FIELD_INDEX['notes'])
+      start(tag, notes)
     end
   end
 end

data/lib/timet/color_codes.rb

@@ -5,7 +5,7 @@ module Timet
   class ColorCodes
     RESET = "\u001b[0m"
     UNDERLINE = "\e[4m"
-    BLINK = "\e[5m["
+    BLINK = "\e[5m"
 
     def self.reset
       RESET
@@ -27,6 +27,10 @@ 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
@@ -35,6 +39,10 @@ class String
     "#{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

data/lib/timet/database.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
 
 require 'sqlite3'
-require_relative 'status_helper'
 module Timet
   # Provides database access for managing time tracking data.
   class Database
-    include StatusHelper
-
     # The default path to the SQLite database file.
     DEFAULT_DATABASE_PATH = File.join(Dir.home, '.timet.db')
 
@@ -28,7 +25,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 +50,27 @@ module Timet
       SQL
     end
 
-    # Adds a new column named "notes" to the "items" table if it doesn't exist.
-    #
-    # @return [void] This method does not return a value; it performs side effects such as executing SQL to add
-    # the column.
-    #
-    # @example Add the notes column to the items table
-    #   add_notes
-    #
-    # @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'
+    # Adds a new column to the specified table if it does not already exist.
+    #
+    # @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 a new 'completed' column to the 'tasks' table
+    #   add_column('tasks', 'completed', 'INTEGER')
+    #
+    # @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 +87,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.
@@ -152,12 +155,15 @@ module Timet
     # @return [Symbol] The status of the last item. Possible values are :no_items, :in_progress, or :complete.
     #
     # @example Determine the status of the last item
-    #   last_item_status
+    #   item_status
     #
     # @note The method executes SQL to fetch the last item and determines its status using the `StatusHelper` module.
-    def last_item_status
-      result = execute_sql('SELECT id, end FROM items ORDER BY id DESC LIMIT 1')
-      StatusHelper.determine_status(result)
+    #
+    # @param id [Integer, nil] The ID of the item to check. If nil, the last item in the table is used.
+    #
+    def item_status(id = nil)
+      id = fetch_last_id if id.nil?
+      determine_status(find_item(id))
     end
 
     # Finds an item in the items table by its ID.
@@ -235,5 +241,33 @@ module Timet
 
       format '%<hours>02d:%<minutes>02d:%<seconds>02d', hours: hours, minutes: minutes, seconds: seconds
     end
+
+    # 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 determine_status(result)
+      return :no_items if result.nil?
+
+      last_item_end = result[2]
+      return :in_progress unless last_item_end
+
+      :complete
+    end
   end
 end