good_job 4.6.0 → 4.8.0

data/lib/good_job/configuration.rb

@@ -35,6 +35,8 @@ module GoodJob
     DEFAULT_DASHBOARD_LIVE_POLL_ENABLED = true
     # Default enqueue_after_transaction_commit
     DEFAULT_ENQUEUE_AFTER_TRANSACTION_COMMIT = false
+    # Default enable_pauses setting
+    DEFAULT_ENABLE_PAUSES = false
 
     def self.validate_execution_mode(execution_mode)
       raise ArgumentError, "GoodJob execution mode must be one of #{EXECUTION_MODES.join(', ')}. It was '#{execution_mode}' which is not valid." unless execution_mode.in?(EXECUTION_MODES)
@@ -369,6 +371,16 @@ module GoodJob
       DEFAULT_ENQUEUE_AFTER_TRANSACTION_COMMIT
     end
 
+    # Whether the job processing can be paused.
+    # @return [Boolean]
+    def enable_pauses
+      return options[:enable_pauses] unless options[:enable_pauses].nil?
+      return rails_config[:enable_pauses] unless rails_config[:enable_pauses].nil?
+      return ActiveModel::Type::Boolean.new.cast(env['GOOD_JOB_ENABLE_PAUSES']) unless env['GOOD_JOB_ENABLE_PAUSE'].nil?
+
+      DEFAULT_ENABLE_PAUSES
+    end
+
     # Whether running in a web server process.
     # @return [Boolean, nil]
     def in_webserver?

data/lib/good_job/version.rb

@@ -2,7 +2,7 @@
 
 module GoodJob
   # GoodJob gem version.
-  VERSION = '4.6.0'
+  VERSION = '4.8.0'
 
   # GoodJob version as Gem::Version object
   GEM_VERSION = Gem::Version.new(VERSION)

data/lib/good_job.rb

@@ -292,6 +292,38 @@ module GoodJob
   def self.migrated?
     GoodJob::BatchRecord.jobs_finished_at_migrated?
   end
+
+  # Pause job execution for a given queue or job class.
+  # @param queue [String, nil] Queue name to pause
+  # @param job_class [String, nil] Job class name to pause
+  # @return [void]
+  def self.pause(queue: nil, job_class: nil)
+    GoodJob::Setting.pause(queue: queue, job_class: job_class)
+  end
+
+  # Unpause job execution for a given queue or job class.
+  # @param queue [String, nil] Queue name to unpause
+  # @param job_class [String, nil] Job class name to unpause
+  # @param label [String, nil] Label to unpause
+  # @return [void]
+  def self.unpause(queue: nil, job_class: nil, label: nil)
+    GoodJob::Setting.unpause(queue: queue, job_class: job_class, label: label)
+  end
+
+  # Check if job execution is paused for a given queue or job class.
+  # @param queue [String, nil] Queue name to check
+  # @param job_class [String, nil] Job class name to check
+  # @param label [String, nil] Label to check
+  # @return [Boolean]
+  def self.paused?(queue: nil, job_class: nil, label: nil)
+    GoodJob::Setting.paused?(queue: queue, job_class: job_class, label: label)
+  end
+
+  # Get a list of all paused queues and job classes
+  # @return [Hash] Hash with :queues, :job_classes, :labels arrays of paused items
+  def self.paused(type = nil)
+    GoodJob::Setting.paused(type)
+  end
 end
 
 ActiveSupport.run_load_hooks(:good_job, GoodJob)

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 4.6.0
+  version: 4.8.0
 platform: ruby
 authors:
 - Ben Sheldon
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-12 00:00:00.000000000 Z
+date: 2025-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -259,6 +258,7 @@ files:
 - app/controllers/good_job/frontends_controller.rb
 - app/controllers/good_job/jobs_controller.rb
 - app/controllers/good_job/metrics_controller.rb
+- app/controllers/good_job/pauses_controller.rb
 - app/controllers/good_job/performance_controller.rb
 - app/controllers/good_job/processes_controller.rb
 - app/filters/good_job/base_filter.rb
@@ -313,6 +313,9 @@ files:
 - app/views/good_job/jobs/_table.erb
 - app/views/good_job/jobs/index.html.erb
 - app/views/good_job/jobs/show.html.erb
+- app/views/good_job/pauses/_group.html.erb
+- app/views/good_job/pauses/_pause.html.erb
+- app/views/good_job/pauses/index.html.erb
 - app/views/good_job/performance/index.html.erb
 - app/views/good_job/performance/show.html.erb
 - app/views/good_job/processes/index.html.erb
@@ -396,7 +399,6 @@ metadata:
   homepage_uri: https://github.com/bensheldon/good_job
   source_code_uri: https://github.com/bensheldon/good_job
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options:
 - "--title"
 - GoodJob - a multithreaded, Postgres-based ActiveJob backend for Ruby on Rails
@@ -418,8 +420,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A multithreaded, Postgres-based ActiveJob backend for Ruby on Rails
 test_files: []