que 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2be51744809f55950825aa7bbb6c3e4d7d4d0927a439dfdf2c1f3658f53cfc84
-  data.tar.gz: f1c7b10f27e57fd11288f50789cef31574e11a333733dfbae93e870841dabf28
+  metadata.gz: 967eded27a81df945b65911275dcdc7925113727bfd06fbc42cb780a3bfb6fcf
+  data.tar.gz: 87607b262263b13623b4b09822a478c02179e57cfa503f253e3e678ac8b1490a
 SHA512:
-  metadata.gz: 93688d24737b750e85c1769bebc6d1344264a8b9757c855150c1dd022104a6400e205442db443bf12c8623325a8178b5379ff647faecd47ada873ead78d5ce7e
-  data.tar.gz: 7fc7c9e34adb2f779f947c0d8326da32c40ba47c7fe4501e343fc177d3115275a25e28b8b407aa62a3ce7d095760f4f392fb9f501892918fc5d2dc3802871f93
+  metadata.gz: 3d8242fe07445a6f4658f322dd1a7cdb8918c8a56c2bfad2db49c58695b4ebae183e6a56159abc4ff74316006e7d95459ab6cfd8a4c98410eea50a2e4fb52509
+  data.tar.gz: 24fdf63cab7ff6e8a2ffa6ed598718d3c2ae2cbc6ef61de22ab6f1541b0cc23bab980fe5d10bbcb54823b2a529cd1cdc9d57437db3905e802bec92a04ea3ed94

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 1.2.0 (2022-02-23)
+
+- **Deprecated**
+    + Providing job options as top level keyword arguments to Job.enqueue is now deprecated. Support will be dropped in `2.0`. Job options should be nested under the `job_options` keyword arg instead. See [#336](https://github.com/que-rb/que/pull/336)
+
 ### 1.1.0 (2022-02-21)
 
 - **Features**:

data/lib/que/job.rb

@@ -57,22 +57,18 @@ module Que
 
       def enqueue(
         *args,
-        queue:     nil,
-        priority:  nil,
-        run_at:    nil,
-        job_class: nil,
-        tags:      nil,
+        job_options: {},
         **arg_opts
       )
-
+        arg_opts, job_options = _extract_job_options(arg_opts, job_options.dup)
         args << arg_opts if arg_opts.any?
 
-        if tags
-          if tags.length > MAXIMUM_TAGS_COUNT
-            raise Que::Error, "Can't enqueue a job with more than #{MAXIMUM_TAGS_COUNT} tags! (passed #{tags.length})"
+        if job_options[:tags]
+          if job_options[:tags].length > MAXIMUM_TAGS_COUNT
+            raise Que::Error, "Can't enqueue a job with more than #{MAXIMUM_TAGS_COUNT} tags! (passed #{job_options[:tags].length})"
           end
 
-          tags.each do |tag|
+          job_options[:tags].each do |tag|
             if tag.length > MAXIMUM_TAG_LENGTH
               raise Que::Error, "Can't enqueue a job with a tag longer than 100 characters! (\"#{tag}\")"
             end
@@ -80,13 +76,13 @@ module Que
         end
 
         attrs = {
-          queue:    queue    || resolve_que_setting(:queue) || Que.default_queue,
-          priority: priority || resolve_que_setting(:priority),
-          run_at:   run_at   || resolve_que_setting(:run_at),
+          queue:    job_options[:queue]    || resolve_que_setting(:queue) || Que.default_queue,
+          priority: job_options[:priority] || resolve_que_setting(:priority),
+          run_at:   job_options[:run_at]   || resolve_que_setting(:run_at),
           args:     Que.serialize_json(args),
-          data:     tags ? Que.serialize_json(tags: tags) : "{}",
+          data:     job_options[:tags] ? Que.serialize_json(tags: job_options[:tags]) : "{}",
           job_class: \
-            job_class || name ||
+            job_options[:job_class] || name ||
               raise(Error, "Can't enqueue an anonymous subclass of Que::Job"),
         }
 
@@ -139,6 +135,27 @@ module Que
           end
         end
       end
+
+      def _extract_job_options(arg_opts, job_options)
+        deprecated_job_option_names = []
+
+        %i[queue priority run_at job_class tags].each do |option_name|
+          next unless arg_opts.key?(option_name) && job_options[option_name].nil?
+
+          job_options[option_name] = arg_opts.delete(option_name)
+          deprecated_job_option_names << option_name
+        end
+
+        _log_job_options_deprecation(deprecated_job_option_names)
+
+        [arg_opts, job_options]
+      end
+
+      def _log_job_options_deprecation(deprecated_job_option_names)
+        return unless deprecated_job_option_names.any?
+
+        warn "Passing job options like (#{deprecated_job_option_names.join(', ')}) to `JobClass.enqueue` as top level keyword args has been deprecated and will be removed in version 2.0. Please wrap job options in an explicit `job_options` keyword arg instead."
+      end
     end
 
     # Set up some defaults.

data/lib/que/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Que
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: que
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Chris Hanks
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-21 00:00:00.000000000 Z
+date: 2022-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -106,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.6
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: A PostgreSQL-based Job Queue