active_job_tracker 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3102a3e7bcb824b3db71003baa5f401f0598178c503b1f5b4b49f7c3e580d835
-  data.tar.gz: e043943a466eb2d514a906acd8ae2b72c9fe0a294f0b080f0ddceb6e561affef
+  metadata.gz: 3fa0e770ace4f14af8adb0907741243fd3c73e5da3be0ce81c9759ceab1ab06e
+  data.tar.gz: 42121c16e596aabd423ed4899997cdb909e1c61620cbe231a80e1f3674e3059e
 SHA512:
-  metadata.gz: f030c69148089178e8d0dd8693835af4407bb9d62ea789f08b3875fff399d282603eae68411e1eb10acff0f0d707c0e6470f53114df0534f369816c49ca3d460
-  data.tar.gz: 0146a953fee7b01f7e203eff001e974799f8e8ba364dcc79fa54a5a6b81eb6d13670354bd1fbb1dc59cf95b62d8b7b9c4b1bdb3f35103ba29be6414eae3cb7dc
+  metadata.gz: 0a9d3c246ade707d9504a7ca986ee17e0c5db4e4dbd42bd6de360983f631523d589eecc2dd8f5a382e247d0ce2112dc108131e053907f0bf0198b496c7f2fc02
+  data.tar.gz: b844a3cd0174ea768cd07f67e4f8b1e5ac0e4565ef9147335147f90d93df576ad9f2dc4aa2b55287ed1cfb6fe9364e80c2b4c2a99f73968c5686addea38cd77b

data/README.md

@@ -1,8 +1,12 @@
+❤️ I'm looking for a full-time position. Please consider hiring me.
+
 # ActiveJobTracker
 
 ActiveJobTracker provides persisted, real-time tracking and monitoring of ActiveJob jobs in Ruby on Rails applications. It allows you to track job status, progress, and errors with a simple API and real-time UI updates via ActionCable.
 
-<img width="796" alt="Screenshot 2025-03-04 at 1 09 38 PM" src="https://github.com/user-attachments/assets/d34e6fb8-bb3c-4d71-a737-2f7597a23c43" />
+<div align="center">
+<img width="500" alt="Screenshot 2025-03-04 at 1 09 38 PM" src="https://github.com/user-attachments/assets/d34e6fb8-bb3c-4d71-a737-2f7597a23c43" />
+</div>
 
 ## Features
 
@@ -10,7 +14,7 @@ ActiveJobTracker provides persisted, real-time tracking and monitoring of Active
 - Monitor job progress with percentage completion
 - Real-time UI updates via ActionCable
 - Error tracking and reporting
-- Efficient progress caching to minimize database updates
+- Efficient progress write-behind caching to minimize database updates
 - Configurable options
 
 ## Installation
@@ -66,6 +70,10 @@ ActiveJobTracker.configure do |config|
   # Whether to include the style in the job tracker (default: true)
   # When true, the gem's CSS styles are automatically included
   config.include_style = true
+
+  # Custom Turbo Stream channel name (default: 'active_job_tracker')
+  # Use this to customize the ActionCable channel name for real-time updates
+  config.turbo_stream_channel = 'Turbo::StreamsChannel'
 end
 ```
 
@@ -80,9 +88,9 @@ class CsvUpload < ApplicationRecord
   # Sets up polymorphic association to tie this record to the ActiveJobTracker
   has_one :job, as: :active_job_trackable, class_name: 'ActiveJobTrackerRecord'
 
-  after_create :create_jobs
+  after_create :process_import
 
-  def create_jobs
+  def process_import
     # The tracked record must be passed into the job as the first argument
     ProcessImportJob.perform_later(self)
   end
@@ -167,6 +175,7 @@ This will render a default tracker UI with progress bar, status badge, and job i
 #### Custom Rendering
 
 You can customize the tracker UI by creating your own partials and using the ActiveJobTrackerRecord model attributes:
+
 - Make sure to set the `config.default_partial` to the new partial path
 - Each job block needs to be wrapped with `id="active_job_tracker_<%= tracker.id %>"` for turbo to update your frontend
 

data/app/models/active_job_tracker_record.rb

@@ -87,7 +87,7 @@ class ActiveJobTrackerRecord < ApplicationRecord
   private
 
   def broadcast_changes
-    broadcast_replace_to(
+    ActiveJobTracker.configuration.turbo_stream_channel.constantize.broadcast_replace_to(
      "active_job_trackers",
      target: "active_job_tracker_#{self.id}",
      partial: ActiveJobTracker.configuration.default_partial,

data/app/views/active_job_tracker/_active_job_tracker_wrapper.html.erb

@@ -6,7 +6,7 @@
   html_options ||= {}
   css_class = html_options[:class] || "active_job_tracker-container"
 %>
-<%= turbo_stream_from "active_job_trackers" %>
+<%= turbo_stream_from "active_job_trackers", channel: ActiveJobTracker.configuration.turbo_stream_channel %>
 <div class="<%= css_class %>" data-controller="active_job_tracker-container">
   <%= content %>
 </div>

data/app/views/active_job_tracker/_radial_progress.html.erb

@@ -0,0 +1,41 @@
+<%
+  percentage = active_job_tracker_record.progress_percentage
+  status = active_job_tracker_record.status
+  
+  # Calculate the stroke-dasharray and stroke-dashoffset for the circle
+  circumference = 2 * Math::PI * 45 # 45 is the radius of the circle
+  stroke_dashoffset = circumference * (1 - percentage / 100.0)
+%>
+
+<div class="active_job_tracker-radial-progress">
+  <svg width="100" height="100" viewBox="0 0 100 100">
+    <circle 
+      class="active_job_tracker-radial-progress-bg" 
+      cx="50" 
+      cy="50" 
+      r="45" 
+      fill="none" 
+      stroke-width="8"
+    />
+    <circle 
+      class="active_job_tracker-radial-progress-fill active_job_tracker-radial-progress-<%= status %>" 
+      cx="50" 
+      cy="50" 
+      r="45" 
+      fill="none" 
+      stroke-width="8"
+      stroke-dasharray="<%= circumference %>"
+      stroke-dashoffset="<%= stroke_dashoffset %>"
+      transform="rotate(-90 50 50)"
+    />
+    <text 
+      class="active_job_tracker-radial-progress-text" 
+      x="50" 
+      y="50" 
+      text-anchor="middle" 
+      dominant-baseline="middle"
+    >
+      <%= percentage %>%
+    </text>
+  </svg>
+</div> 

data/lib/active_job_tracker/configuration.rb

@@ -23,6 +23,10 @@ module ActiveJobTracker
     # @return [Boolean]
     attr_accessor :include_style
 
+    # The turbo stream channel to use for broadcasting job tracker updates
+    # @return [String]
+    attr_accessor :turbo_stream_channel
+
     # Initialize with default values
     def initialize
       @default_target = 100
@@ -30,6 +34,7 @@ module ActiveJobTracker
       @auto_broadcast = true
       @default_partial = "active_job_tracker/active_job_tracker"
       @include_style = true
+      @turbo_stream_channel = "Turbo::StreamsChannel"
     end
   end
 end

data/lib/active_job_tracker/version.rb

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

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

@@ -22,4 +22,8 @@ ActiveJobTracker.configure do |config|
   # Whether to include the style in the job tracker (default: true)
   # When true, the gem's CSS styles are automatically included
   config.include_style = true
+
+  # The turbo stream channel to use for broadcasting job tracker updates
+  # (default: 'Turbo::StreamsChannel')
+  config.turbo_stream_channel = "Turbo::StreamsChannel"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: active_job_tracker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Seena Sabti
 bindir: bin
 cert_chain: []
-date: 2025-03-06 00:00:00.000000000 Z
+date: 2025-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -120,6 +120,7 @@ files:
 - app/models/active_job_tracker_record.rb
 - app/views/active_job_tracker/_active_job_tracker.html.erb
 - app/views/active_job_tracker/_active_job_tracker_wrapper.html.erb
+- app/views/active_job_tracker/_radial_progress.html.erb
 - lib/active_job_tracker.rb
 - lib/active_job_tracker/configuration.rb
 - lib/active_job_tracker/engine.rb