marj 6.0.0 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d0039931eb3f0bd43ce090b0b581d6544b26fda022729f6371f4c8ac393076e
-  data.tar.gz: 6abb66afe0bc56064be4ecee3f3e59e78adcf10afb83654529387b785f817335
+  metadata.gz: 1fd27db3bb7a04aee0b4e6cf043e35bde5329143194584bcb03b75ef00896f5d
+  data.tar.gz: d89fd27053c6beeb6aeddcaac59fd1a0ddd4b2a481a4dd0f9b96b3cbbbc29bde
 SHA512:
-  metadata.gz: ec25e50e772072eb6d13ebcb04a67e8ee4602782b62edab07e9521817993f6d92bac376bff90a6aeca1c724fa61dc4ba04ac1fe8ce9659139d2dcd98c397bce4
-  data.tar.gz: f78b5ba741202818a5374c95fddcb6258b091d4feba4b2de1d1f9de8d1422b99348bf5e354619d215b32b9b7f8d4055ef95d271055cf489e4049b06b40d3463c
+  metadata.gz: 5b1304cba5e2780fa9fd24432624e37a0a1746efefa9ffaf11573875a2333b1ae9fda8f419b94f30f953c59be0896dae6b90e808b089bbac2324cbe787d2ed8d
+  data.tar.gz: c9b6926e5ef0cad9fc33d510eb9102d570e4ace04322cfc62c44367651a42034c7be5f2dbbf88fc851c13fc6acfc005056d342676bcd505f356696b8fa0305c1

data/README.md

@@ -4,7 +4,7 @@ A minimal database-backed ActiveJob queueing backend.
 
 ## Quick Links
 
-API docs: https://gemdocs.org/gems/marj/6.0.0/ <br>
+API docs: https://gemdocs.org/gems/marj/6.1.0/ <br>
 RubyGems: https://rubygems.org/gems/marj <br>
 Changelog: https://github.com/nicholasdower/marj/releases <br>
 Issues: https://github.com/nicholasdower/marj/issues <br>
@@ -61,7 +61,7 @@ Marj relies on existing ActiveJob APIs, for example:
 
 ```ruby
 job.enqueue         # Enqueues a job
-job.perform_now     # Performs a job
+job.perform_now     # Executes a job
 ```
 
 Additionally, it extends the ActiveJob API with methods required for a
@@ -104,6 +104,8 @@ class CreateJobs < ActiveRecord::Migration[7.1]
       table.string   :timezone,             null: false
     end
 
+    add_index :jobs, %i[job_class]
+    add_index :jobs, %i[queue_name]
     add_index :jobs, %i[enqueued_at]
     add_index :jobs, %i[scheduled_at]
     add_index :jobs, %i[priority scheduled_at enqueued_at]
@@ -161,25 +163,25 @@ end
 job = SomeJob.perform_later('foo')
 
 # Query jobs
-SomeJob.query(:all)
-SomeJob.query(:due)
-SomeJob.query(:due, queue: :foo)
-SomeJob.query('8720417d-8fff-4fcf-bc16-22aaef8543d2')
+Marj.query(:all)
+Marj.query(:due)
+Marj.query(:due, queue: :foo)
+Marj.query('8720417d-8fff-4fcf-bc16-22aaef8543d2')
 
 # Execute a job
 job.perform_now
 
 # Execute jobs which are due (single query)
-SomeJob.query(:due).map(&:perform_now)
+Marj.query(:due).map(&:perform_now)
 
 # Execute jobs which are due (multiple queries)
-loop {
-  SomeJob.query(:due, :first)&.tap(&:perform_now) || break
+loop do
+  Marj.query(:due, :first)&.tap(&:perform_now) || break
 end
 
 # Execute jobs as they become due
 loop do
-  SomeJob.query(:due).each(&:perform_now) rescue logger.error($!)
+  Marj.query(:due).each(&:perform_now) rescue logger.error($!)
 ensure
   sleep 5.seconds
 end
@@ -457,7 +459,7 @@ job = SomeJob.new.deserialize(other_job.serialize)
 job = SomeJob.perform_later
 job = SomeJob.perform_later(args)
 
-# Create without enqueueing and run (only enqueued on failure if retryable)
+# Create without enqueueing and run (only enqueued on retryable failure)
 SomeJob.perform_now
 SomeJob.perform_now(args)
 ```
@@ -478,7 +480,7 @@ SomeJob.perform_later(SomeJob.new(args))
 SomeJob.perform_later(args)
 SomeJob.set(options).perform_later(args)
 
-# After a failure during execution
+# After a retryable execution failure
 SomeJob.perform_now(args)
 ActiveJob::Base.execute(SomeJob.new(args).serialize)
 
@@ -492,7 +494,7 @@ SomeJob.set(options).perform_all_later(SomeJob.new, SomeJob.new, options:)
 ### Executing Jobs
 
 ```ruby
-# Executed without enqueueing, enqueued on failure if retryable
+# Executed without enqueueing, enqueued on retryable failure
 SomeJob.new(args).perform_now
 SomeJob.perform_now(args)
 ActiveJob::Base.execute(SomeJob.new(args).serialize)

data/lib/marj.rb

@@ -34,7 +34,7 @@ require_relative 'marj_adapter'
 # See https://github.com/nicholasdower/marj
 module Marj
   # The Marj version.
-  VERSION = '6.0.0'
+  VERSION = '6.1.0'
 
   Kernel.autoload(:Record, File.expand_path(File.join('marj', 'record.rb'), __dir__))
 

data/lib/marj_adapter.rb

@@ -24,6 +24,12 @@ class MarjAdapter
     @discard_proc = discard
   end
 
+  # Returns whether jobs enqueued during a transaction should actually be enqueued only after the
+  # transaction is committed.
+  def enqueue_after_transaction_commit?
+    false
+  end
+
   # Enqueue a job for immediate execution.
   #
   # @param job [ActiveJob::Base] the job to enqueue

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: marj
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 6.1.0
 platform: ruby
 authors:
 - Nick Dower
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-05 00:00:00.000000000 Z
+date: 2024-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -56,8 +56,8 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/nicholasdower/marj/issues
-  changelog_uri: https://github.com/nicholasdower/marj/releases/tag/v6.0.0
-  documentation_uri: https://www.rubydoc.info/github/nicholasdower/marj/v6.0.0
+  changelog_uri: https://github.com/nicholasdower/marj/releases/tag/v6.1.0
+  documentation_uri: https://www.rubydoc.info/github/nicholasdower/marj/v6.1.0
   homepage_uri: https://github.com/nicholasdower/marj
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/nicholasdower/marj