timet 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5eda40ea4aafce60dc6fef1270ca9d013724c45b29ba43e7974b8212f55ac231
-  data.tar.gz: b5a45e366bbfdb073ccf32ad545b572faac79f018c3a6f8eac60622aed96b02b
+  metadata.gz: 74f9106fb9a60ccd2e2446a58350d3de263459df41ffdf1aa57ca62d267da985
+  data.tar.gz: 77de65d76048301e01e0fb1607862ead7e69ead1647546974ac48b027222b73b
 SHA512:
-  metadata.gz: 0d0cc2dfa64d2af724b2be8543d67f63f5485c4fe81746a29cea29db9b51d1ba5fcf4df98f7cdadb16961f30cd24dff0e65bef93c6f297fe9b61bc9a07b0e15e
-  data.tar.gz: fdd6364f4dad16defed0c484eb29adf27479427387be6cd43587bcdbfb628eea2a99a0712c708a5821e50e1064c476b2481cd2efc49cb302d533b0d632c3f08a
+  metadata.gz: 409da2fabebd3071832c3c67498015a358cf973e9a41da970969aee97e53e779c8372e9c72c3dad835020644cf163be0138097337ca5589343f3f2364d2d177f
+  data.tar.gz: 537cd9eeba10e3bd43246d3c92f736b91ce171568437e15a22b0a0460171185cc5482f3b45348ef759b4daebb016d59126205f2192a168e618f0445b4384b88b

data/CHANGELOG.md

@@ -1,23 +1,59 @@
 ## [Unreleased]
 
+## [0.9.0] - 2024-10-03
+
+**Improvements:**
+
+- Enhanced the gemspec metadata by adding a documentation URI for better discoverability and reference.
+- Improved the `summary` and `edit` methods for better readability and functionality.
+- Simplified the `summary` method by using safe navigation operators and improved conditional checks.
+- Modified the `edit` method to use the return value of `validate_and_update` for displaying the updated item.
+- Updated the `validate_and_update` method to return the updated item after performing the update.
+- Enhanced the `TimeReport` class and added comprehensive RSpec tests.
+- Enhanced the `filter_items` method to support valid date range filters.
+- Added a `valid_date_format?` method to validate date formats.
+- Updated the `formatted_filter` method to handle valid date range filters.
+- Removed the `helpers.rb` file as it was no longer needed.
+- Added comprehensive RSpec tests for the `TimeReport` class, covering initialization, filtering, and date format validation.
+- Modified the `stop` method in `Timet::Application` to use the `update_item` method from `Database` instead of the deprecated `update` method.
+- Updated the `stop` method to fetch the last item's ID and update the 'end' field directly.
+- Updated test cases in `application_spec.rb` to reflect the changes in the `stop` method.
+- Removed test cases for the deprecated `update` method in `database_spec.rb`.
+
+**Bug fixes:**
+
+- Fix bug in calculate_end_time method
+
+**Additional Considerations:**
+
+- The changes in this PR aim to improve code quality, maintainability, and test coverage.
+- The removal of the `helpers.rb` file and unused methods helps to streamline the codebase and reduce technical debt.
+- The updated `stop` method now uses the `update_item` method, ensuring consistency across the codebase.
+- Comprehensive tests have been added for the `TimeReport` class to ensure robust functionality and prevent regressions.
+
 ## [0.8.2] - 2024-10-02
 
 **Improvements:**
+
 - Added optional field and new_value parameters to the edit command.
 - Updated the edit method logic to prompt for field and new_value if they are not provided.
 - Enhanced test coverage to include scenarios where field and new_value are provided directly and when they are not.
 - Updated the README to reflect the new features of the edit command, including both interactive and direct specification modes.
 
 **Additional Considerations:**
+
 - The changes ensure that the edit command is more versatile and user-friendly, catering to both interactive users and those who prefer scripting or automation.
 
 ## [0.8.1] - 2024-10-02
+
 **Bug fixes:**
-  - Fixed a LoadError caused by the byebug gem being required after its removal.
+
+- Fixed a LoadError caused by the byebug gem being required after its removal.
 
 ## [0.8.0] - 2024-10-01
 
 **Improvements:**
+
 - Introduced TimeHelper module to encapsulate time-related functionalities.
 - Replaced direct calls to Time.now.to_i with TimeHelper.current_timestamp for consistency and modularity.
 - Moved current_timestamp method to TimeHelper to centralize time-related logic.
@@ -50,6 +86,7 @@
 - Added a confirmation message when the CSV file is successfully exported.
 
 **Bug fixes:**
+
 - Updated timestamp_to_time method to return nil if the input timestamp is nil.
 - Removed unnecessary &.then syntax for clarity and consistency.
 - Corrected the test expectations to use the correct Unix timestamp.
@@ -61,6 +98,7 @@
 - Added validation to prevent updating start or end times with nil values.
 
 **Tasks:**
+
 - Added ENV['TZ'] = 'UTC' to spec_helper.rb to ensure that all RSpec tests run in the UTC time zone.
 - Updated tests to reflect the new structure and ensure items are returned for export.
 - Updated and added tests to cover the new export logic.
@@ -78,6 +116,7 @@
 - Updated database_spec.rb to reflect the correct status for in-progress items.
 
 **Additional Considerations:**
+
 - Ensured that all timestamps are handled in UTC to avoid timezone issues across different environments.
 - Updated the test to reflect the correct UTC time zone.
 - Ensured consistency in timestamp handling across methods.
@@ -85,6 +124,7 @@
 - Made the application easier to maintain and extend in the future.
 
 **Refactor and enhance time formatting methods**
+
 - Refactored `format_time_string` method in `TimeHelper` to improve readability and maintainability.
 - Added detailed documentation for the `format_time_string` method.
 - Simplified the logic for parsing and validating time components.
@@ -96,31 +136,30 @@
 
 ## [0.2.2] - 2024-09-27
 
-* **Improvements**:
-    * Updated SQLite3 gem version to 2.1.0
+- **Improvements**:
+  - Updated SQLite3 gem version to 2.1.0
 
 ## [0.2.1] - 2024-09-24
 
-* **Improved `resume` behavior:**
-    * If no notes are provided, it will attempt to retrieve them from the last tracked task.
-* **Enhanced `export_sheet` functionality:**
-    * A new `notes` column has been added to the exported CSV file.
-* **Minor bug fixes:**
-    * Resolved issues related to resuming tasks with notes and deleting items.
-
+- **Improved `resume` behavior:**
+  - If no notes are provided, it will attempt to retrieve them from the last tracked task.
+- **Enhanced `export_sheet` functionality:**
+  - A new `notes` column has been added to the exported CSV file.
+- **Minor bug fixes:**
+  - Resolved issues related to resuming tasks with notes and deleting items.
 
 ## [0.2.0] - 2024-09-24
 
-* **Improved code quality:**
-    * Enforces consistent quoting style with `RuboCop` integration.
-    * Removes unused gems (`mini_portile2`) from the `Gemfile`.
-* **Database enhancements:**
-    * Adds a new column named "notes" to the `items` table to store additional information about tracked time entries.
-* **Command-line improvements:**
-    * Allows adding notes to a new time entry using the `start` command with the `--notes` option (e.g., `timet start work --notes="meeting with client"`).
-    * Improves formatting and clarity of some command descriptions.
-* **General code formatting:**
-    * Uses single quotes (`'`) for strings and source paths in the `Gemfile`.
+- **Improved code quality:**
+  - Enforces consistent quoting style with `RuboCop` integration.
+  - Removes unused gems (`mini_portile2`) from the `Gemfile`.
+- **Database enhancements:**
+  - Adds a new column named "notes" to the `items` table to store additional information about tracked time entries.
+- **Command-line improvements:**
+  - Allows adding notes to a new time entry using the `start` command with the `--notes` option (e.g., `timet start work --notes="meeting with client"`).
+  - Improves formatting and clarity of some command descriptions.
+- **General code formatting:**
+  - Uses single quotes (`'`) for strings and source paths in the `Gemfile`.
 
 ## [0.1.0] - 2024-08-01
 

data/README.md

@@ -150,6 +150,25 @@ gem install timet
 | `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 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`            |
+
+
+
+### Date Range in Summary
+
+The `timet summary` command now supports specifying a date range for generating reports. This allows users to filter and summarize data within specific date intervals. The date format is in ISO 8601 format (YYYY-MM-DD).
+
+#### Examples:
+- **Single Date**: Display a report for a specific date.
+  ```sh
+  timet su 2024-01-03
+  ```
+
+- **Date Range**: Display a report for a date range.
+  ```sh
+  timet su 2024-01-02..2024-01-03
+  ```
 
 
 ## Data

data/lib/timet/application.rb

@@ -22,7 +22,7 @@ module Timet
 
     def initialize(*args)
       super
-      @db = Timet::Database.new
+      @db = Database.new
     end
 
     FIELD_INDEX = {
@@ -34,7 +34,7 @@ module Timet
 
     VALID_STATUSES_FOR_INSERTION = %i[no_items complete].freeze
 
-    desc "start [tag] --notes='...'", "start time tracking  --notes='my notes...'"
+    desc "start [tag] --notes=''", "start time tracking  --notes='my notes...'"
     option :notes, type: :string, desc: 'Add a note'
     def start(tag, notes = nil)
       start_time = TimeHelper.current_timestamp
@@ -46,8 +46,10 @@ module Timet
 
     desc 'stop', 'stop time tracking'
     def stop
-      stop = TimeHelper.current_timestamp
-      @db.update(stop) if @db.last_item_status == :in_progress
+      if @db.last_item_status == :in_progress
+        last_id = @db.fetch_last_id
+        @db.update_item(last_id, 'end', TimeHelper.current_timestamp)
+      end
       result = @db.last_item
 
       return unless result
@@ -73,16 +75,17 @@ module Timet
     end
 
     desc 'summary (su) [filter] [tag] --csv=csv_filename',
-         "Display a summary of tracked time filter => [today (t), yesterday (y), week (w), month (m)] [tag]
-          and export to csv_filename"
+         '  [filter] => [today (t), yesterday (y), week (w), month (m), [start_date]..[end_date]]  [tag]'
     option :csv, type: :string, desc: 'Export to CSV file'
     def summary(filter = nil, tag = nil)
-      csv_filename = options[:csv].split('.')[0] if options[:csv]
+      csv_filename = options[:csv]&.split('.')&.first
       summary = TimeReport.new(@db, filter, tag, csv_filename)
+
       summary.display
-      if csv_filename && summary.items.any?
+      items = summary.items
+      if csv_filename && items.any?
         summary.export_sheet
-      elsif summary.items.empty?
+      elsif items.empty?
         puts 'No items found to export'
       end
     end
@@ -99,9 +102,8 @@ module Timet
         new_value = prompt_for_new_value(item, field)
       end
 
-      validate_and_update(item, field, new_value)
-
-      summary.display
+      updated_item = validate_and_update(item, field, new_value)
+      display_item(updated_item)
     end
 
     desc 'delete (d) [id]', 'delete a task'

data/lib/timet/database.rb

@@ -42,24 +42,16 @@ module Timet
       execute_sql('INSERT INTO items (start, tag, notes) VALUES (?, ?, ?)', [start, tag, notes])
     end
 
-    # Updates the end time of the last item
-    def update(stop)
-      last_id = fetch_last_id
-      return unless last_id
+    def update_item(id, field, value)
+      return if %w[start end].include?(field) && value.nil?
 
-      execute_sql('UPDATE items SET end = ? WHERE id = ?', [stop, last_id])
+      execute_sql("UPDATE items SET #{field}='#{value}' WHERE id = #{id}")
     end
 
     def delete_item(id)
       execute_sql("DELETE FROM items WHERE id = #{id}")
     end
 
-    def update_item(id, field, value)
-      return if %w[start end].include?(field) && value.nil?
-
-      execute_sql("UPDATE items SET #{field}='#{value}' WHERE id = #{id}")
-    end
-
     # Fetches the ID of the last inserted item
     def fetch_last_id
       result = execute_sql('SELECT id FROM items ORDER BY id DESC LIMIT 1').first
@@ -79,18 +71,6 @@ module Timet
       execute_sql("select * from items where id=#{id}").first
     end
 
-    # Calculates the total time elapsed since the last recorded time.
-    def total_time
-      last_item = execute_sql('SELECT * FROM items ORDER BY id DESC LIMIT 1').first
-      return '00:00:00' unless last_item
-
-      start_time = last_item[1]
-      end_time = last_item[2]
-
-      total_seconds = end_time ? end_time - start_time : TimeHelper.current_timestamp - start_time
-      seconds_to_hms(total_seconds)
-    end
-
     def all_items
       execute_sql("SELECT * FROM items where start >= '#{Date.today.to_time.to_i}' ORDER BY id DESC")
     end

data/lib/timet/time_helper.rb

@@ -35,7 +35,7 @@ module Timet
     end
 
     def self.calculate_end_time(start_date, end_date)
-      end_date ||= start_date + 1
+      end_date = end_date ? end_date + 1 : start_date + 1
       date_to_timestamp(end_date)
     end
 

data/lib/timet/time_report.rb

@@ -92,6 +92,9 @@ module Timet
       if date_ranges.key?(filter)
         start_date, end_date = date_ranges[filter]
         filter_by_date_range(start_date, end_date, tag)
+      elsif valid_date_format?(filter)
+        start_date, end_date = filter.split('..').map { |x| Date.parse(x) }
+        filter_by_date_range(start_date, end_date, tag)
       else
         puts 'Invalid filter. Supported filters: today, yesterday, week, month'
         []
@@ -118,12 +121,27 @@ module Timet
     end
 
     def formatted_filter(filter)
-      return 'today' if %w[today t].include?(filter)
-      return 'yesterday' if %w[yesterday y].include?(filter)
-      return 'week' if %w[week w].include?(filter)
-      return 'month' if %w[month m].include?(filter)
+      filter_map = {
+        'today' => %w[today t],
+        'yesterday' => %w[yesterday y],
+        'week' => %w[week w],
+        'month' => %w[month m]
+      }
+
+      filter_map.each do |key, values|
+        return key if values.include?(filter)
+      end
+
+      return filter if filter && valid_date_format?(filter)
 
       'today'
     end
+
+    def valid_date_format?(date_string)
+      date_format_single = /^\d{4}-\d{2}-\d{2}$/
+      date_format_range = /^\d{4}-\d{2}-\d{2}\.\.\d{4}-\d{2}-\d{2}$/
+
+      date_string.match?(date_format_single) || date_string.match?(date_format_range)
+    end
   end
 end

data/lib/timet/validation_edit_helper.rb

@@ -18,6 +18,8 @@ module Timet
       else
         @db.update_item(id, field, new_value)
       end
+
+      @db.find_item(id)
     end
 
     private

data/lib/timet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Timet
-  VERSION = '0.8.2'
+  VERSION = '0.9.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timet
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0
 platform: ruby
 authors:
 - Frank Vielma
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-02 00:00:00.000000000 Z
+date: 2024-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -93,6 +93,7 @@ metadata:
   homepage_uri: https://frankvielma.github.io/posts/timet-a-powerful-command-line-tool-for-tracking-your-time/
   source_code_uri: https://github.com/frankvielma/timet
   changelog_uri: https://github.com/frankvielma/timet/blob/main/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/timet
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []