active_job_tracker 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fa0e770ace4f14af8adb0907741243fd3c73e5da3be0ce81c9759ceab1ab06e
-  data.tar.gz: 42121c16e596aabd423ed4899997cdb909e1c61620cbe231a80e1f3674e3059e
+  metadata.gz: 2b8342cf50be46737b9d191b7d631008c6cecad77fc81d1e0fcfca23c4ff6007
+  data.tar.gz: 02a1d61e46c41f6241b8be9d25ba311c42f882b1db71e94afc7d19062bbe3e31
 SHA512:
-  metadata.gz: 0a9d3c246ade707d9504a7ca986ee17e0c5db4e4dbd42bd6de360983f631523d589eecc2dd8f5a382e247d0ce2112dc108131e053907f0bf0198b496c7f2fc02
-  data.tar.gz: b844a3cd0174ea768cd07f67e4f8b1e5ac0e4565ef9147335147f90d93df576ad9f2dc4aa2b55287ed1cfb6fe9364e80c2b4c2a99f73968c5686addea38cd77b
+  metadata.gz: 1b46f5815fd0809154e222e50e388f6aa49bde11cb904d12bb8ff12fe9ecf1ccf2f41b0e250620b09accf18f0755e3e275b997380ee9284d9b1e290f6b2ead6b
+  data.tar.gz: f60e1e47250e60af0693f3a9f81cfcc8777289b2640e1a0b8f96b2b29bd3d61f9e42624148169fc2ba3b32ef186ee2e9c3c75f43784368020c36444b35d1f0e9

data/README.md

@@ -63,6 +63,9 @@ ActiveJobTracker.configure do |config|
   # When true, job updates are automatically broadcast via ActionCable
   config.auto_broadcast = true
 
+  # Whether to raise an error when progress increments the current value beyond the target value (default: false)
+  config.raise_error_when_target_exceeded = false
+
   # Default partial path for rendering job trackers
   # (default: 'active_job_tracker/active_job_tracker')
   config.default_partial = 'active_job_tracker/active_job_tracker'
@@ -130,13 +133,27 @@ class ProcessImportJob < ApplicationJob
     records.each do |record|
       # Process item
 
-      # Update progress (increments by 1)
+      # Update progress (increments by 1 by default)
       active_job_tracker_progress
     end
   end
 end
 ```
 
+Optionally, you can use a custom value to increment your progress by:
+
+```ruby
+def perform
+  # Default target is 100
+
+  10.times do
+    # Process item
+
+    active_job_tracker_progress(increment_by: 10)
+  end
+end
+```
+
 For more efficient progress tracking with many updates, use threadsafe progress caching:
 
 ```ruby
@@ -269,7 +286,7 @@ end
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rails test` to run the tests.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/app/models/active_job_tracker_record.rb

@@ -43,14 +43,15 @@ class ActiveJobTrackerRecord < ApplicationRecord
     [ current.to_f / target.to_f, 1.0 ].min
   end
 
-  def progress(use_cache = true)
+  def progress(use_cache: true, increment_by: 1)
     if use_cache
       key = progress_cache_key
       should_flush = false
 
       @@mutex.synchronize do
         current_value = Rails.cache.fetch(key, expires_in: 1.week) { 0 }.to_i
-        new_value = current_value + 1
+        new_value = incremented_value(current_value: current_value, increment_by: increment_by)
+
         Rails.cache.write(key, new_value, expires_in: 1.week)
 
         should_flush = new_value >= self.cache_threshold
@@ -60,7 +61,7 @@ class ActiveJobTrackerRecord < ApplicationRecord
       flush_progress_cache if should_flush
     else
       with_lock do
-        self.current += 1
+        self.current = incremented_value(current_value: current, increment_by: increment_by)
         save!
       end
     end
@@ -86,6 +87,22 @@ class ActiveJobTrackerRecord < ApplicationRecord
 
   private
 
+  def incremented_value(current_value:, increment_by:)
+    new_value = current_value + increment_by
+
+    if new_value > target
+      if ActiveJobTracker.configuration.raise_error_when_target_exceeded
+        raise ActiveJobTracker::Error::TargetExceeded.new(
+          "The current value of #{new_value} exceeds the target value of #{target}"
+        )
+      end
+
+      target
+    else
+      new_value
+    end
+  end
+
   def broadcast_changes
     ActiveJobTracker.configuration.turbo_stream_channel.constantize.broadcast_replace_to(
      "active_job_trackers",

data/lib/active_job_tracker/configuration.rb

@@ -19,6 +19,10 @@ module ActiveJobTracker
     # @return [String]
     attr_accessor :default_partial
 
+    # Whether to raise an error when progress increments the current value beyond the target value
+    # @return [Boolean]
+    attr_accessor :raise_error_when_target_exceeded
+
     # Whether to include the style in the job tracker
     # @return [Boolean]
     attr_accessor :include_style
@@ -32,6 +36,7 @@ module ActiveJobTracker
       @default_target = 100
       @cache_threshold = 10
       @auto_broadcast = true
+      @raise_error_when_target_exceeded = false
       @default_partial = "active_job_tracker/active_job_tracker"
       @include_style = true
       @turbo_stream_channel = "Turbo::StreamsChannel"

data/lib/active_job_tracker/version.rb

@@ -1,3 +1,3 @@
 module ActiveJobTracker
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/active_job_tracker.rb

@@ -6,6 +6,7 @@ module ActiveJobTracker
   extend ActiveSupport::Concern
 
   class Error < StandardError
+    class TargetExceeded < Error; end
   end
 
   def self.configuration
@@ -35,8 +36,8 @@ module ActiveJobTracker
     active_job_tracker.update(target: target)
   end
 
-  def active_job_tracker_progress(cache: false)
-    active_job_tracker.progress(cache)
+  def active_job_tracker_progress(cache: false, increment_by: 1)
+    active_job_tracker.progress(use_cache: cache, increment_by: increment_by)
   end
 
   def active_job_tracker

data/lib/generators/active_job_tracker/templates/config/initializers/active_job_tracker.rb

@@ -15,6 +15,9 @@ ActiveJobTracker.configure do |config|
   # When true, job updates are automatically broadcast via ActionCable
   config.auto_broadcast = true
 
+  # Whether to raise an error when progress increments the current value beyond the target value
+  config.raise_error_when_target_exceeded = false
+
   # Default partial path for rendering job trackers
   # (default: 'active_job_tracker/shared/active_job_tracker')
   config.default_partial = "active_job_tracker/active_job_tracker"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: active_job_tracker
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Seena Sabti
 bindir: bin
 cert_chain: []
-date: 2025-03-09 00:00:00.000000000 Z
+date: 2025-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -23,6 +23,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 8.0.1
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.11
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement