active_job_tracker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3102a3e7bcb824b3db71003baa5f401f0598178c503b1f5b4b49f7c3e580d835
+  data.tar.gz: e043943a466eb2d514a906acd8ae2b72c9fe0a294f0b080f0ddceb6e561affef
+SHA512:
+  metadata.gz: f030c69148089178e8d0dd8693835af4407bb9d62ea789f08b3875fff399d282603eae68411e1eb10acff0f0d707c0e6470f53114df0534f369816c49ca3d460
+  data.tar.gz: 0146a953fee7b01f7e203eff001e974799f8e8ba364dcc79fa54a5a6b81eb6d13670354bd1fbb1dc59cf95b62d8b7b9c4b1bdb3f35103ba29be6414eae3cb7dc

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,273 @@
+# 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" />
+
+## Features
+
+- Track job status (pending, running, completed, failed)
+- Monitor job progress with percentage completion
+- Real-time UI updates via ActionCable
+- Error tracking and reporting
+- Efficient progress caching to minimize database updates
+- Configurable options
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_job_tracker'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+After installation, run the generators to set up the gem:
+
+```bash
+# Create the necessary database migrations
+rails generate active_job_tracker:migrations
+
+# Run the migrations
+rails db:migrate
+
+# Generate the configuration initializer (optional)
+rails generate active_job_tracker:initializer
+```
+
+## Configuration
+
+You can configure ActiveJobTracker with the following options:
+
+```ruby
+# config/initializers/active_job_tracker.rb
+ActiveJobTracker.configure do |config|
+  # Default target value for jobs (default: 100)
+  # This represents the total number of items to process in a job
+  config.default_target = 100
+
+  # Default cache threshold for progress updates (default: 10)
+  # Progress updates are batched until this threshold is reached to reduce database writes
+  config.cache_threshold = 10
+
+  # Whether to automatically broadcast changes (default: true)
+  # When true, job updates are automatically broadcast via ActionCable
+  config.auto_broadcast = true
+
+  # Default partial path for rendering job trackers
+  # (default: 'active_job_tracker/active_job_tracker')
+  config.default_partial = 'active_job_tracker/active_job_tracker'
+
+  # 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
+end
+```
+
+## Usage
+
+### Basic Setup
+
+Set up the model that creates jobs:
+
+```ruby
+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
+
+  def create_jobs
+    # The tracked record must be passed into the job as the first argument
+    ProcessImportJob.perform_later(self)
+  end
+end
+
+```
+
+Include the `ActiveJobTracker` module in your job classes:
+
+```ruby
+class ProcessImportJob < ApplicationJob
+  include ActiveJobTracker
+
+  def perform(csv_upload)
+    # Your job logic here
+  end
+end
+```
+
+This automatically tracks the job's status (pending, running, completed, failed) throughout its lifecycle.
+
+### Tracking Progress
+
+To track progress within your job:
+
+```ruby
+class ProcessImportJob < ApplicationJob
+  include ActiveJobTracker
+
+  def perform(file_path)
+    records = CSV.read(file_path)
+
+    # Set the target (here, total number of items to process)
+    # Defaults to 100 if unspecified
+    active_job_tracker_target(records.size)
+
+    records.each do |record|
+      # Process item
+
+      # Update progress (increments by 1)
+      active_job_tracker_progress
+    end
+  end
+end
+```
+
+For more efficient progress tracking with many updates, use threadsafe progress caching:
+
+```ruby
+# In your job
+def perform
+  # You can override the cache threshold for when to flush progress updates to the database
+  active_job_tracker_cache_threshold(20)
+  active_job_tracker_target(records.size)
+  1000.times do |i|
+    # Process item
+
+    # This will only update the database every 20th increment
+    active_job_tracker_progress(cache: true)
+  end
+end
+```
+
+### Displaying Progress in Views
+
+#### Basic Usage
+
+To display job progress in your views:
+
+```erb
+<%= active_job_tracker_wrapper do %>
+  <% @csv_uploads.each do |csv_upload| %>
+    <% if (job = csv_upload.job) %>
+      <%= render partial: 'active_job_tracker/active_job_tracker', locals: { active_job_tracker_record: job } %>
+    <% end %>
+  <% end %>
+<% end %>
+```
+
+This will render a default tracker UI with progress bar, status badge, and job information.
+
+#### 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
+
+```erb
+<%= active_job_tracker_wrapper(html_options: { class: 'custom-container' }) do %>
+  <% ActiveJobTrackerRecord.find_each do |tracker| %>
+    <div class="custom-tracker" id="active_job_tracker_<%= tracker.id %>">
+      <h3>Job #<%= tracker.id %></h3>
+
+      <div class="status">
+        Status: <span class="badge"><%= tracker.status %></span>
+      </div>
+
+      <div class="progress-bar">
+        <progress value="<%= tracker.current %>" max="<%= tracker.target %>"></progress>
+        <span><%= tracker.progress_percentage %>%</span>
+      </div>
+
+      <% if tracker.started_at.present? %>
+        <div class="timing">
+          Started: <%= tracker.started_at %>
+          <% if tracker.completed_at.present? %>
+            <br>Completed: <%= tracker.completed_at %>
+            <br>Duration: <%= tracker.duration %> seconds
+          <% end %>
+        </div>
+      <% end %>
+
+      <% if tracker.failed? && tracker.error.present? %>
+        <div class="error">
+          <h4>Error:</h4>
+          <p><%= tracker.error %></p>
+          <% if tracker.backtrace.present? %>
+            <pre><%= tracker.backtrace %></pre>
+          <% end %>
+        </div>
+      <% end %>
+    </div>
+  <% end %>
+<% end %>
+```
+
+### Helper Methods
+
+The gem provides the following helper method for displaying job trackers:
+
+- `active_job_tracker_wrapper(options = {}, &block)` - Renders a wrapper for job trackers with Turbo Stream support
+
+### Available Model Methods
+
+The `ActiveJobTrackerRecord` model provides these useful methods:
+
+```ruby
+# Progress calculation
+tracker.progress_ratio       # => 0.75 (ratio between 0 and 1)
+tracker.progress_percentage  # => 75 (percentage between 0 and 100)
+
+# Time tracking
+tracker.duration  # => 123.45 (seconds since started_at)
+
+# Status methods (from enum)
+tracker.pending?    # => true/false
+tracker.running?    # => true/false
+tracker.completed?  # => true/false
+tracker.failed?     # => true/false
+```
+
+### Error Handling
+
+Errors are automatically tracked when a job fails. The gem adds a rescue_from handler that logs the error details before re-raising the exception:
+
+```ruby
+# This happens automatically when you include ActiveJobTracker
+rescue_from(Exception) do |exception|
+  active_job_tracker_log_error(exception)
+  raise exception
+end
+```
+
+To handle errors:
+
+```ruby
+def perform
+  begin
+    # Risky operation
+  rescue => e
+    # Handle the error
+  end
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/seenasabti/active_job_tracker.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/stylesheets/active_job_tracker/style.css

@@ -0,0 +1,197 @@
+/* ActiveJob Tracker - Modern Styling */
+.active_job_tracker {
+    --primary-color: #4f46e5;
+    --primary-light: #6366f1;
+    --completed-color: #059669;
+    --danger-color: #dc2626;
+    --danger-light: #ef4444;
+    --neutral-100: #f4f4f5;
+    --neutral-200: #e4e4e7;
+    --neutral-300: #d4d4d8;
+    --neutral-400: #a1a1aa;
+    --neutral-500: #71717a;
+    --neutral-600: #52525b;
+    --neutral-800: #27272a;
+    --shadow-sm: 0 1px 2px 0 rgba(0, 0, 0, 0.05);
+    --shadow-md: 0 4px 6px -1px rgba(0, 0, 0, 0.1),
+    0 2px 4px -1px rgba(0, 0, 0, 0.06);
+    width: 100%;
+    margin: 0.75rem auto;
+    background-color: white;
+    border-radius: 0.5rem;
+    overflow: hidden;
+    box-shadow: var(--shadow-sm);
+    border: 1px solid var(--neutral-200);
+    transition: all 0.2s ease;
+}
+
+.active_job_tracker progress::-webkit-progress-bar {
+    background-color: var(--neutral-200);
+    border-radius: 6px;
+}
+
+.active_job_tracker-default {
+    padding: 1rem;
+}
+
+.active_job_tracker-header {
+    display: flex;
+    align-items: center;
+    justify-content: space-between;
+    margin-bottom: 1rem;
+    flex-wrap: wrap;
+    gap: 0.5rem;
+}
+
+.active_job_tracker-status-badge {
+    padding: 0.375rem 0.75rem;
+    border-radius: 9999px;
+    font-size: 0.75rem;
+    font-weight: 600;
+    letter-spacing: 0.025em;
+    text-transform: uppercase;
+    display: inline-flex;
+    align-items: center;
+    box-shadow: var(--shadow-sm);
+}
+
+.active_job_tracker-title {
+    font-size: 1.125rem;
+    font-weight: 600;
+    display: inline-flex;
+    align-items: center;
+    color: var(--neutral-800);
+}
+
+.active_job_tracker-progress-wrapper {
+    display: flex;
+    align-items: center;
+    gap: 5px;
+    margin-bottom: 0.75rem;
+}
+
+.active_job_tracker-progress {
+    flex: 1;
+    height: 8px;
+    appearance: none;
+    border-radius: 4px;
+    overflow: hidden;
+    transition: all 0.4s ease-in-out;
+}
+
+.active_job_tracker-progress-label {
+    font-size: 0.875rem;
+    font-weight: 600;
+    color: var(--neutral-600);
+    width: 2rem;
+    text-align: right;
+}
+
+.active_job_tracker-body {
+    padding: 0.5rem 0;
+}
+
+.active_job_tracker-progress-container {
+    margin: 1rem 0;
+    transition: transform 0.2s ease;
+}
+
+/* Status Styles */
+.active_job_tracker-status-pending .active_job_tracker-status-badge {
+    background-color: var(--neutral-500);
+    color: white;
+}
+
+.active_job_tracker-status-pending progress::-webkit-progress-value {
+    background: var(--neutral-400);
+}
+
+.active_job_tracker-status-pending progress::-moz-progress-bar {
+    background: var(--neutral-400);
+}
+
+.active_job_tracker-status-running .active_job_tracker-status-badge {
+    background-color: var(--primary-color);
+    color: white;
+}
+
+.active_job_tracker-status-running progress::-webkit-progress-value {
+    background: linear-gradient(
+            90deg,
+            var(--primary-light),
+            var(--primary-color)
+    );
+    background-size: 200% 100%;
+}
+
+.active_job_tracker-status-running progress::-moz-progress-bar {
+    background: linear-gradient(
+            90deg,
+            var(--primary-light),
+            var(--primary-color)
+    );
+    background-size: 200% 100%;
+}
+
+.active_job_tracker-status-completed .active_job_tracker-status-badge {
+    background-color: var(--completed-color);
+    color: white;
+}
+
+.active_job_tracker-status-completed progress::-webkit-progress-value {
+    background: var(--completed-color);
+}
+
+.active_job_tracker-status-completed progress::-moz-progress-bar {
+    background: var(--completed-color);
+}
+
+.active_job_tracker-status-failed .active_job_tracker-status-badge {
+    background-color: var(--danger-color);
+    color: white;
+}
+
+.active_job_tracker-status-failed progress::-webkit-progress-value {
+    background: var(--danger-color);
+}
+
+.active_job_tracker-status-failed progress::-moz-progress-bar {
+    background: var(--danger-color);
+}
+
+/* Responsive Styles */
+@media (max-width: 768px) {
+    .active_job_tracker {
+        margin: 1rem 0;
+    }
+
+    .active_job_tracker-default {
+        padding: 1rem;
+    }
+
+    .active_job_tracker-header {
+        flex-direction: column;
+        align-items: flex-start;
+        gap: 0.75rem;
+    }
+}
+
+@media (max-width: 640px) {
+    .active_job_tracker-default {
+        padding: 0.875rem;
+    }
+
+    .active_job_tracker-progress-container {
+        padding: 0.5rem;
+        margin: 1rem 0;
+    }
+
+    .active_job_tracker-progress-wrapper {
+        gap: 0.75rem;
+    }
+
+    .active_job_tracker-error pre {
+        font-size: 0.75rem;
+        max-height: 12rem;
+    }
+}

data/app/helpers/active_job_tracker/records_helper.rb

@@ -0,0 +1,11 @@
+module ActiveJobTracker
+  module RecordsHelper
+    def active_job_tracker_wrapper(options = {}, &block)
+      render partial: "active_job_tracker/active_job_tracker_wrapper",
+       locals: {
+        content: capture(&block),
+        options: options
+       }
+    end
+  end
+end

data/app/models/active_job_tracker_record.rb

@@ -0,0 +1,99 @@
+class ActiveJobTrackerRecord < ApplicationRecord
+  enum :status, { pending: 0, running: 1, completed: 2, failed: 3 }
+  validates :job_id, presence: true, uniqueness: true
+  belongs_to :active_job_trackable, polymorphic: true
+
+  after_update :broadcast_changes, if: -> { ActiveJobTracker.configuration.auto_broadcast }
+
+  # Class-level mutex for thread-safety
+  @@mutex = Mutex.new
+
+  def cache_threshold=(value)
+    @cache_threshold = value || ActiveJobTracker.configuration.cache_threshold
+  end
+
+  def cache_threshold
+    @cache_threshold ||= ActiveJobTracker.configuration.cache_threshold
+  end
+
+  def progress_cache
+    Rails.cache.fetch(progress_cache_key, expires_in: 1.week) { 0 }.to_i
+  end
+
+  def progress_cache=(value)
+    Rails.cache.write(progress_cache_key, value, expires_in: 1.week)
+  end
+
+  def progress_cache_key
+    "active_job_tracker:#{self.id}:progress_cache"
+  end
+
+  def progress_percentage
+    (progress_ratio * 100).to_i
+  end
+
+  def duration
+    return nil unless started_at
+    end_time = completed_at || failed_at || Time.current
+    (end_time - started_at).to_f
+  end
+
+  def progress_ratio
+    return 0.0 if target.to_i.zero?
+    [ current.to_f / target.to_f, 1.0 ].min
+  end
+
+  def progress(use_cache = true)
+    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
+        Rails.cache.write(key, new_value, expires_in: 1.week)
+
+        should_flush = new_value >= self.cache_threshold
+      end
+
+      # Flush outside the mutex to avoid deadlocks
+      flush_progress_cache if should_flush
+    else
+      with_lock do
+        self.current += 1
+        save!
+      end
+    end
+    self
+  end
+
+  def flush_progress_cache
+    key = progress_cache_key
+
+    cache_value = 0
+    @@mutex.synchronize do
+      cache_value = Rails.cache.read(key).to_i
+      Rails.cache.delete(key)
+    end
+
+    if cache_value > 0
+      with_lock do
+        self.current += cache_value
+        save!
+      end
+    end
+  end
+
+  private
+
+  def broadcast_changes
+    broadcast_replace_to(
+     "active_job_trackers",
+     target: "active_job_tracker_#{self.id}",
+     partial: ActiveJobTracker.configuration.default_partial,
+     locals: {
+      active_job_tracker_record: self
+     }
+    )
+  end
+end

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

@@ -0,0 +1,23 @@
+<%
+  html_classes = %W[active_job_tracker active_job_tracker-status-#{active_job_tracker_record.status}]
+  id = "active_job_tracker_#{active_job_tracker_record.id}"
+%>
+
+<div id="<%= id %>" class="<%= html_classes.join(" ") %>">
+  <div class="active_job_tracker-default">
+    <div class="active_job_tracker-body">
+      <div class="active_job_tracker-progress-container">
+        <div class="active_job_tracker-header">
+          <span class="active_job_tracker-title">
+            Job #<%= active_job_tracker_record.id %>
+          </span>
+          <span class="active_job_tracker-status-badge"><%= active_job_tracker_record.status %></span>
+        </div>
+        <div class="active_job_tracker-progress-wrapper">
+          <progress class="active_job_tracker-progress" value="<%= active_job_tracker_record.current %>" max="<%= active_job_tracker_record.target %>"></progress>
+          <span class="active_job_tracker-progress-label"><%= active_job_tracker_record.progress_percentage %>%</span>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>

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

@@ -0,0 +1,13 @@
+<% if ActiveJobTracker.configuration.include_style %>
+  <%= stylesheet_link_tag "active_job_tracker/style", media: "all" %>
+<% end %>
+
+<%
+  html_options ||= {}
+  css_class = html_options[:class] || "active_job_tracker-container"
+%>
+<%= turbo_stream_from "active_job_trackers" %>
+<div class="<%= css_class %>" data-controller="active_job_tracker-container">
+  <%= content %>
+</div>
+

data/lib/active_job_tracker/configuration.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ActiveJobTracker
+  # Configuration options for ActiveJobTracker
+  class Configuration
+    # Default target value for jobs
+    # @return [Integer]
+    attr_accessor :default_target
+
+    # Default cache threshold for progress updates
+    # @return [Integer]
+    attr_accessor :cache_threshold
+
+    # Whether to automatically broadcast changes
+    # @return [Boolean]
+    attr_accessor :auto_broadcast
+
+    # Default partial path for rendering job trackers
+    # @return [String]
+    attr_accessor :default_partial
+
+    # Whether to include the style in the job tracker
+    # @return [Boolean]
+    attr_accessor :include_style
+
+    # Initialize with default values
+    def initialize
+      @default_target = 100
+      @cache_threshold = 10
+      @auto_broadcast = true
+      @default_partial = "active_job_tracker/active_job_tracker"
+      @include_style = true
+    end
+  end
+end

data/lib/active_job_tracker/engine.rb

@@ -0,0 +1,16 @@
+module ActiveJobTracker
+  class Engine < ::Rails::Engine
+    isolate_namespace ActiveJobTracker
+
+    generators do
+      require "generators/active_job_tracker/initializer_generator"
+      require "generators/active_job_tracker/migrations_generator"
+    end
+
+    initializer "active_job_tracker.helpers" do
+      ActiveSupport.on_load(:action_controller_base) do
+        helper ActiveJobTracker::RecordsHelper
+      end
+    end
+  end
+end

data/lib/active_job_tracker/version.rb

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

data/lib/active_job_tracker.rb

@@ -0,0 +1,81 @@
+require "active_job_tracker/version"
+require "active_job_tracker/engine"
+require "active_job_tracker/configuration"
+
+module ActiveJobTracker
+  extend ActiveSupport::Concern
+
+  class Error < StandardError
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  included do
+    before_enqueue :initialize_tracker
+    before_perform :mark_as_running
+    after_perform :mark_as_completed
+
+    rescue_from(Exception) do |exception|
+      active_job_tracker_log_error(exception)
+      raise exception
+    end
+  end
+
+  def active_job_tracker_cache_threshold(value)
+    active_job_tracker.cache_threshold = value
+  end
+
+  def active_job_tracker_target(target)
+    active_job_tracker.update(target: target)
+  end
+
+  def active_job_tracker_progress(cache: false)
+    active_job_tracker.progress(cache)
+  end
+
+  def active_job_tracker
+    @active_job_tracker ||= ::ActiveJobTrackerRecord.find_or_create_by(job_id: job_id, active_job_trackable: trackable)
+  end
+
+  def trackable
+    raise ArgumentError, "Trackable object is required as the first argument." if arguments.empty?
+    arguments.first
+  end
+
+  def initialize_tracker
+    active_job_tracker.update(
+     status: "pending",
+     started_at: nil,
+     completed_at: nil,
+     target: ActiveJobTracker.configuration.default_target,
+     current: 0
+    )
+  end
+
+  def mark_as_running
+    active_job_tracker.update(status: "running", started_at: Time.current)
+  end
+
+  def mark_as_completed
+    active_job_tracker.flush_progress_cache
+    if active_job_tracker.current == active_job_tracker.target
+      active_job_tracker.update(status: "completed", completed_at: Time.current)
+    end
+  end
+
+  def active_job_tracker_log_error(exception)
+    active_job_tracker.flush_progress_cache
+    active_job_tracker.update(
+     status: "failed",
+     failed_at: Time.current,
+     error: exception.message,
+     backtrace: exception.backtrace&.join("\n").to_s.truncate(1000)
+    )
+  end
+end

data/lib/generators/active_job_tracker/initializer_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ActiveJobTracker
+  module Generators
+    class InitializerGenerator < Rails::Generators::Base
+      desc "Creates an initializer file for configuring ActiveJobTracker"
+
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_initializer
+        template "config/initializers/active_job_tracker.rb", "config/initializers/active_job_tracker.rb"
+      end
+    end
+  end
+end

data/lib/generators/active_job_tracker/migrations_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ActiveJobTracker
+  module Generators
+    class MigrationsGenerator < Rails::Generators::Base
+      desc "Creates migration files for ActiveJobTracker"
+
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_migrations
+        migration_files = Dir.glob(File.join(self.class.source_root, "migrations", "*.rb"))
+        migration_files.each do |file|
+          migration_filename = File.basename(file)
+          new_filename = "#{Time.now.utc.strftime("%Y%m%d%H%M%S")}_#{migration_filename}"
+          copy_file "migrations/#{migration_filename}", "db/migrate/#{new_filename}"
+          sleep(1) if migration_files.count > 1
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# Configuration for ActiveJobTracker
+# This file was generated by the active_job_tracker gem
+ActiveJobTracker.configure do |config|
+  # Default target value for jobs (default: 100)
+  # This represents the total number of items to process in a job
+  config.default_target = 100
+
+  # Default cache threshold for progress updates (default: 10)
+  # Progress updates are batched until this threshold is reached to reduce database writes
+  config.cache_threshold = 10
+
+  # Whether to automatically broadcast changes (default: true)
+  # When true, job updates are automatically broadcast via ActionCable
+  config.auto_broadcast = true
+
+  # Default partial path for rendering job trackers
+  # (default: 'active_job_tracker/shared/active_job_tracker')
+  config.default_partial = "active_job_tracker/active_job_tracker"
+
+  # 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
+end

data/lib/generators/active_job_tracker/templates/migrations/create_active_job_tracker_records.rb

@@ -0,0 +1,21 @@
+class CreateActiveJobTrackerRecords < ActiveRecord::Migration[8.0]
+  def change
+    create_table :active_job_tracker_records do |t|
+      t.belongs_to :active_job_trackable, polymorphic: true, index: { name: "index_active_job_tracker_records_on_active_job_trackable" }
+
+      t.string :job_id, null: false, index: true
+      t.integer :status, default: 0, null: false
+      t.integer :current, default: 0, null: false
+      t.integer :target, default: 100, null: false
+
+      t.text :error
+      t.text :backtrace
+
+      t.datetime :started_at
+      t.datetime :failed_at
+      t.datetime :completed_at
+
+      t.timestamps
+    end
+  end
+end

data/lib/tasks/active_job_tracker_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :active_job_tracker do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: active_job_tracker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Seena Sabti
+bindir: bin
+cert_chain: []
+date: 2025-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.1
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: propshaft
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails-omakase
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: ActiveJobTracker provides a way to track the progress of ActiveJob jobs.
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/stylesheets/active_job_tracker/style.css
+- app/helpers/active_job_tracker/records_helper.rb
+- 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
+- lib/active_job_tracker.rb
+- lib/active_job_tracker/configuration.rb
+- lib/active_job_tracker/engine.rb
+- lib/active_job_tracker/version.rb
+- lib/generators/active_job_tracker/initializer_generator.rb
+- lib/generators/active_job_tracker/migrations_generator.rb
+- lib/generators/active_job_tracker/templates/config/initializers/active_job_tracker.rb
+- lib/generators/active_job_tracker/templates/migrations/create_active_job_tracker_records.rb
+- lib/tasks/active_job_tracker_tasks.rake
+homepage: https://github.com/seenasabti/active_job_tracker
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/seenasabti/active_job_tracker
+  source_code_uri: https://github.com/seenasabti/active_job_tracker
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: ActiveJobTracker provides a way to track the progress of ActiveJob jobs.
+test_files: []