que 0.14.3 → 1.0.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 73f8f07b0a406399663e08cbfd7faddaf5239b5ac08d29320eb8651e76dd1671
-  data.tar.gz: 6fc8445aed22c679a323ac22941e9f9037f668840a97fc16b7915850d494f668
+SHA1:
+  metadata.gz: 9bbd70fe386be02949156458e095b91fc7af2001
+  data.tar.gz: d7029485d2eb220cad37d8b41ca8021a6089e934
 SHA512:
-  metadata.gz: 6020097fb14b30ce4775a34124ef7e40d52d8f56381286bab98e2e670626fac61c137f685f6ba87443143d52eee4e366bed96177bcb4e196b72c84546c022e07
-  data.tar.gz: 916cbe011fc1d742b1559997ad71dbc9822bf68c56ce629d2cf7e01a2bd218dd6b626eb09ac873da0be1e3c770fcfe75a245361e418c01787fc10d7c85b4e1f2
+  metadata.gz: 94f36a7474bf38f0a06839f4ce7afc904bb855e828aff90891ccdfbf87f77e017bd823f3b92ed0bbce3ade75b931d4158c70ee1df3fd4d52d48554a8f7e2c74e
+  data.tar.gz: e90625eb0de12115e779cd2f497db6b4348e26736959f6c4d7b8bd40b58b51c9b086c6f8acaf4569f31b120733648e6bb84cfe6a52dc1628167efead9a016250

data/.gitignore

@@ -12,6 +12,8 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
+spec/temp/*.rb
 test/tmp
 test/version_tmp
 tmp
+vendor/*

data/CHANGELOG.md

@@ -1,26 +1,120 @@
-### 0.14.3 (2018-03-02)
+### 1.0.0.beta (2017-10-25)
 
-*   Recorded errors now always include the error class, so that empty error messages can still be helpful. (  joehorsnell)
+*   **A schema upgrade to version 4 will be required for this release.** See [the migration doc](https://github.com/chanks/que/blob/master/docs/migrating.md) for information if you're upgrading from a previous release.
 
-*   Recorded error messages are now truncated to the first 500 characters.
+    *   Please note that this migration requires a rewrite of the jobs table, which makes it O(n) with the size of the table. If you have a very large backlog of jobs you may want to schedule downtime for this migration.
 
-### 0.14.2 (2018-01-05)
+*   Que's implementation has been changed from one in which worker threads hold their own PG connections and lock their own jobs to one in which a single thread (and PG connection) locks jobs through LISTEN/NOTIFY and batch polling, and passes jobs along to worker threads. This has many benefits, including:
 
-*   Deprecate the Que.disable_prepared_statements= accessors.
+    *   Jobs queued for immediate processing can be actively distributed to workers with LISTEN/NOTIFY, which is more efficient than having workers repeatedly poll for new jobs.
 
-*   Add Que.use_prepared_statements= configuration accessors.
+    *   When polling is necessary (to pick up jobs that are scheduled for the future or that need to be retried due to errors), jobs can be locked and fetched in batches, rather than one at a time.
 
-*   Update the generated Rails migration to declare a version. (NARKOZ)
+    *   Individual workers no longer need to monopolize their own (usually idle) connections while working jobs, so Ruby processes will require fewer Postgres connections.
 
-### 0.14.1 (2017-12-14)
+    *   PgBouncer or another external connection pool can be used for workers' connections (though not for the connection used to lock and listen for jobs).
 
-*   Fix a bug with typecasting boolean values on Rails 5+.
+*   Other features introduced in this version include:
 
-### 0.14.0 (2017-08-11)
+    *   Much better support for all versions of ActiveJob.
 
-*   Fix incompatibility with Rails 5.1.
+        *   In particular, you may (optionally) include `Que::ActiveJob::JobExtensions` into `ApplicationJob` to get support for all of Que's job helper methods.
 
-*   Drop support for waking an in-process worker when an ActiveRecord transaction commits.
+    *   Custom middleware that wrap running jobs are now supported.
+
+    *   Support for categorizing jobs with tags.
+
+    *   Support for configuring a `maximum_retry_count` on individual job classes.
+
+    *   Job configuration options are now inheritable, so job class hierarchies are more useful.
+
+    *   There are now built-in models for ActiveRecord and Sequel to allow inspecting the queue easily.
+
+    *   Jobs that have finished working may optionally be retained in the database indefinitely.
+
+        *   To keep a job record, replace the `destroy` calls in your jobs with `finish`. `destroy` will still delete records entirely, for jobs that you don't want to keep.
+
+        *   If you don't resolve a job yourself one way or another, Que will still `destroy` the job for you by default.
+
+        *   Finished jobs have a timestamp set in the finished_at column.
+
+    *   Jobs that have errored too many times will now be marked as expired, and won't be retried again.
+
+        *   You can configure a maximum_retry_count in your job classes, to set the threshold at which a job will be marked expired. The default is 15.
+
+        *   To manually mark a job as expired (and keep it in the database but not try to run it again) you can call `expire` helper in your job.
+
+    *   You can now set job priority thresholds for individual workers, to ensure that there will always be space available for high-priority jobs.
+
+    *   `Que.job_states` returns a list of locked jobs and the hostname/pid of the Ruby processes that have locked them.
+
+    *   `Que.connection_proc=` has been added, to allow for the easy integration of custom connection pools.
+
+*   In keeping with semantic versioning, the major version is being bumped since the new implementation requires some backwards-incompatible changes. These changes include:
+
+    *   Support for MRI Rubies before 2.2 has been dropped.
+
+    *   Support for Postgres versions before 9.5 has been dropped (JSONB and upsert support is required).
+
+    *   JRuby support has been dropped. It will be reintroduced whenever the jruby-pg gem is production-ready.
+
+    *   The `que:work` rake task has been removed. Use the `que` executable instead.
+
+        *   Therefore, configuring workers using QUE_* environment variables is no longer supported. Please pass the appropriate options to the `que` executable instead.
+
+    *   The `mode` setter has been removed.
+
+        *   To run jobs synchronously when they are enqueued (the old `:sync` behavior) you can set `Que.run_synchronously = true`.
+
+        *   To start up the worker pool (the old :async behavior) you should use the `que` executable to start up a worker process. There's no longer a supported API for running workers outside of the `que` executable.
+
+    *   The way Que uses prepared statements internally has changed. This shouldn't affect anyone's use of Que, except that the `disable_prepared_statements` configuration option is no longer necessary and has been removed.
+
+        *   Specifically, while Que previously used prepared statements for most of its built-in queries, now only the polling query uses it, due to its complexity. Since the polling query is only run through a dedicated connection, it's no longer possible for prepared statements to conflict with external connection pools, which was the reason that `disable_prepared_statements` was supported in the first place.
+
+    *   In addition to `Que.disable_prepared_statements=`, the following methods are not meaningful under the new implementation and have been removed:
+
+        *   The `Que.wake_interval` getter and setter.
+
+        *   The `Que.worker_count` getter and setter.
+
+        *   `Que.wake!`
+
+        *   `Que.wake_all!`
+
+    *   Since Que needs a dedicated Postgres connection to manage job locks, running Que through a single PG connection is no longer supported.
+
+        *   It's not clear that anyone ever actually did this.
+
+    *   `Que.worker_states` has been removed, as the connection that locks a job is no longer the one that the job is using to run. Its functionality has been partially replaced with `Que.job_states`.
+
+    *   When using Rails, for simplicity, job attributes and keys in argument hashes are now converted to symbols when retrieved from the database, rather than being converted to instances of HashWithIndifferentAccess.
+
+    *   Arguments passed to jobs are now deep-frozen, to prevent unexpected behavior when the args are mutated and the job is reenqueued.
+
+    *   Since JSONB is now used to store arguments, the order of argument hashes is no longer maintained.
+
+        *   It wouldn't have been a good idea to rely on this anyway.
+
+    *   Calling Que.log() directly is no longer supported/recommended.
+
+    *   Features marked as deprecated in the final 0.x releases have been removed.
+
+*   Finally, if you've built up your own tooling and customizations around Que, you may need to be aware of some DB schema changes made in the migration to schema version #4.
+
+    *   The `job_id` column has been renamed `id` and is now the primary key. This makes it easier to manage the queue using an ActiveRecord model.
+
+    *   Finished jobs are now kept in the DB, unless you explicitly call `destroy`. If you want to query the DB for only jobs that haven't finished yet, add a `WHERE finished_at IS NULL` condition to your query, or use the not_finished scope on one of the provided ORM models.
+
+    *   There is now an `expired_at` timestamp column, which is set when a job reaches its maximum number of retries and will not be attempted again.
+
+    *   Due to popular demand, the default queue name is now "default" rather than an empty string. The migration will move pending jobs under the "" queue to the "default" queue.
+
+    *   The `last_error` column has been split in two, to `last_error_message` and `last_error_backtrace`. These two columns are now limited to 500 and 10,000 characters, respectively. The migration will split old error data correctly, and truncate it if necessary.
+
+    *   Names for queues and job classes are now limited to 500 characters, which is still far longer than either of these values should reasonably be.
+
+    *   There is now a `data` JSONB column which is used to support various ways of organizing jobs (setting tags on them, etc).
 
 ### 0.13.1 (2017-07-05)
 
@@ -158,7 +252,7 @@
 
 *   **A schema upgrade to version 3 is required for this release.** See [the migration doc](https://github.com/chanks/que/blob/master/docs/migrating.md) for information if you're upgrading from a previous release.
 
-*   You can now run a job's logic directly (without enqueueing it) like `MyJob.run(arg1, arg2, :other_arg => arg3)`. This is useful when a job class encapsulates logic that you want to invoke without involving the entire queue.
+*   You can now run a job's logic directly (without enqueueing it) like `MyJob.run(arg1, arg2, other_arg: arg3)`. This is useful when a job class encapsulates logic that you want to invoke without involving the entire queue.
 
 *   You can now check the current version of Que's database schema with `Que.db_version`.
 
@@ -184,7 +278,7 @@
 
 *   The default priority for jobs is now 100 (it was 1 before). Like always (and like delayed_job), a lower priority means it's more important. You can migrate the schema version to 2 to set the new default value on the que_jobs table, though it's only necessary if you're doing your own INSERTs - if you use `MyJob.queue`, it's already taken care of.
 
-*   Added a migration system to make it easier to change the schema when updating Que. You can now write, for example, `Que.migrate!(:version => 2)` in your migrations. Migrations are run transactionally.
+*   Added a migration system to make it easier to change the schema when updating Que. You can now write, for example, `Que.migrate!(version: 2)` in your migrations. Migrations are run transactionally.
 
 *   The logging format has changed to be more easily machine-readable. You can also now customize the logging format by assigning a callable to Que.log_formatter=. See the new doc on [logging](https://github.com/chanks/que/blob/master/docs/logging.md)) for details. The default logger level is INFO - for less critical information (such as when no jobs were found to be available or when a job-lock race condition has been detected and avoided) you can set the QUE_LOG_LEVEL environment variable to DEBUG.
 

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Chris Hanks
+Copyright (c) 2013-2017 Chris Hanks
 
 MIT License
 

data/README.md

@@ -1,11 +1,11 @@
 # Que
 
-**TL;DR: Que is a high-performance alternative to DelayedJob or QueueClassic that improves the reliability of your application by protecting your jobs with the same [ACID guarantees](https://en.wikipedia.org/wiki/ACID) as the rest of your data.**
+**TL;DR: Que is a high-performance job queue that improves the reliability of your application by protecting your jobs with the same [ACID guarantees](https://en.wikipedia.org/wiki/ACID) as the rest of your data.**
 
 Que ("keɪ", or "kay") is a queue for Ruby and PostgreSQL that manages jobs using [advisory locks](http://www.postgresql.org/docs/current/static/explicit-locking.html#ADVISORY-LOCKS), which gives it several advantages over other RDBMS-backed queues:
 
   * **Concurrency** - Workers don't block each other when trying to lock jobs, as often occurs with "SELECT FOR UPDATE"-style locking. This allows for very high throughput with a large number of workers.
-  * **Efficiency** - Locks are held in memory, so locking a job doesn't incur a disk write. These first two points are what limit performance with other queues - all workers trying to lock jobs have to wait behind one that's persisting its UPDATE on a locked_at column to disk (and the disks of however many other servers your database is synchronously replicating to). Under heavy load, Que's bottleneck is CPU, not I/O.
+  * **Efficiency** - Locks are held in memory, so locking a job doesn't incur a disk write. These first two points are what limit performance with other queues. Under heavy load, Que's bottleneck is CPU, not I/O.
   * **Safety** - If a Ruby process dies, the jobs it's working won't be lost, or left in a locked or ambiguous state - they immediately become available for any other worker to pick up.
 
 Additionally, there are the general benefits of storing jobs in Postgres, alongside the rest of your data, rather than in Redis or a dedicated queue:
@@ -17,11 +17,12 @@ Additionally, there are the general benefits of storing jobs in Postgres, alongs
 
 Que's primary goal is reliability. You should be able to leave your application running indefinitely without worrying about jobs being lost due to a lack of transactional support, or left in limbo due to a crashing process. Que does everything it can to ensure that jobs you queue are performed exactly once (though the occasional repetition of a job can be impossible to avoid - see the docs on [how to write a reliable job](https://github.com/chanks/que/blob/master/docs/writing_reliable_jobs.md)).
 
-Que's secondary goal is performance. It won't be able to match the speed or throughput of a dedicated queue, or maybe even a Redis-backed queue, but it should be fast enough for most use cases. In [benchmarks of RDBMS queues](https://github.com/chanks/queue-shootout) using PostgreSQL 9.3 on a AWS c3.8xlarge instance, Que approaches 10,000 jobs per second, or about twenty times the throughput of DelayedJob or QueueClassic. You are encouraged to try things out on your own production hardware, though.
+Que's secondary goal is performance. The worker process is multithreaded, so that a single process can run many jobs simultaneously.
 
-Que also includes a worker pool, so that multiple threads can process jobs in the same process. It can even do this in the background of your web process - if you're running on Heroku, for example, you don't need to run a separate worker dyno.
-
-Que is tested on Ruby 2.0, Rubinius and JRuby (with the `jruby-pg` gem, which is [not yet functional with ActiveRecord](https://github.com/chanks/que/issues/4#issuecomment-29561356)). It requires Postgres 9.2+ for the JSON datatype.
+Compatibility:
+- MRI Ruby 2.2+
+- PostgreSQL 9.5+
+- Rails 4.1+ (optional)
 
 **Please note** - Que's job table undergoes a lot of churn when it is under high load, and like any heavily-written table, is susceptible to bloat and slowness if Postgres isn't able to clean it up. The most common cause of this is long-running transactions, so it's recommended to try to keep all transactions against the database housing Que's job table as short as possible. This is good advice to remember for any high-activity database, but bears emphasizing when using tables that undergo a lot of writes.
 
@@ -43,39 +44,54 @@ Or install it yourself as:
 
 ## Usage
 
-The following assumes you're using Rails 4.0 and ActiveRecord. *Que hasn't been tested with versions of Rails before 4.0, and may or may not work with them.* See the [/docs directory](https://github.com/chanks/que/blob/master/docs) for instructions on using Que [outside of Rails](https://github.com/chanks/que/blob/master/docs/advanced_setup.md), and with [Sequel](https://github.com/chanks/que/blob/master/docs/using_sequel.md) or [no ORM](https://github.com/chanks/que/blob/master/docs/using_plain_connections.md), among other things.
+First, create the queue schema in a migration. For example:
 
-First, generate and run a migration for the job table.
+``` ruby
+class CreateQueSchema < ActiveRecord::Migration[5.0]
+  def up
+    # Whenever you use Que in a migration, always specify the version you're
+    # migrating to. If you're unsure what the current version is, check the
+    # changelog.
+    Que.migrate!(version: 4)
+  end
 
-    $ bin/rails generate que:install
-    $ bin/rake db:migrate
+  def down
+    # Migrate to version 0 to remove Que entirely.
+    Que.migrate!(version: 0)
+  end
+end
+```
 
 Create a class for each type of job you want to run:
 
-
 ``` ruby
 # app/jobs/charge_credit_card.rb
 class ChargeCreditCard < Que::Job
   # Default settings for this job. These are optional - without them, jobs
   # will default to priority 100 and run immediately.
-  @priority = 10
-  @run_at = proc { 1.minute.from_now }
+  self.run_at = proc { 1.minute.from_now }
 
-  def run(user_id, options)
+  # We use the Linux priority scale - a lower number is more important.
+  self.priority = 10
+
+  def run(credit_card_id, user_id:)
     # Do stuff.
-    user = User[user_id]
-    card = CreditCard[options[:credit_card_id]]
+    user = User.find(user_id)
+    card = CreditCard.find(credit_card_id)
 
-    ActiveRecord::Base.transaction do
+    User.transaction do
       # Write any changes you'd like to the database.
-      user.update_attributes :charged_at => Time.now
+      user.update charged_at: Time.now
 
       # It's best to destroy the job in the same transaction as any other
-      # changes you make. Que will destroy the job for you after the run
-      # method if you don't do it yourself, but if your job writes to the
-      # DB but doesn't destroy the job in the same transaction, it's
-      # possible that the job could be repeated in the event of a crash.
+      # changes you make. Que will mark the job as destroyed for you after the
+      # run method if you don't do it yourself, but if your job writes to the DB
+      # but doesn't destroy the job in the same transaction, it's possible that
+      # the job could be repeated in the event of a crash.
       destroy
+
+      # If you'd rather leave the job record in the database to maintain a job
+      # history, simply replace the `destroy` call with a `finish` call.
     end
   end
 end
@@ -84,38 +100,24 @@ end
 Queue your job. Again, it's best to do this in a transaction with other changes you're making. Also note that any arguments you pass will be serialized to JSON and back again, so stick to simple types (strings, integers, floats, hashes, and arrays).
 
 ``` ruby
-ActiveRecord::Base.transaction do
+CreditCard.transaction do
   # Persist credit card information
   card = CreditCard.create(params[:credit_card])
-  ChargeCreditCard.enqueue(current_user.id, :credit_card_id => card.id)
+  ChargeCreditCard.enqueue(card.id, user_id: current_user.id)
 end
 ```
 
 You can also add options to run the job after a specific time, or with a specific priority:
 
 ``` ruby
-# The default priority is 100, and a lower number means a higher priority. 5 would be very important.
-ChargeCreditCard.enqueue current_user.id, :credit_card_id => card.id, :run_at => 1.day.from_now, :priority => 5
+ChargeCreditCard.enqueue card.id, user_id: current_user.id, run_at: 1.day.from_now, priority: 5
 ```
 
-To determine what happens when a job is queued, you can set Que's mode. There are a few options for the mode:
-
-  * `Que.mode = :off` - In this mode, queueing a job will simply insert it into the database - the current process will make no effort to run it. You should use this if you want to use a dedicated process to work tasks (there's an executable included that will do this, `que`). This is the default when running `bin/rails console`.
-  * `Que.mode = :async` - In this mode, a pool of background workers is spun up, each running in their own thread. See the docs for [more information on managing workers](https://github.com/chanks/que/blob/master/docs/managing_workers.md).
-  * `Que.mode = :sync` - In this mode, any jobs you queue will be run in the same thread, synchronously (that is, `MyJob.enqueue` runs the job and won't return until it's completed). This makes your application's behavior easier to test, so it's the default in the test environment.
-
-**If you're using ActiveRecord to dump your database's schema, [set your schema_format to :sql](http://guides.rubyonrails.org/migrations.html#types-of-schema-dumps) so that Que's table structure is managed correctly.** (You can use schema_format as :ruby if you want but keep in mind this is highly advised against, as some parts of Que will not work.)
+## Testing
 
+There are a couple ways to do testing. You may want to set `Que::Job.run_synchronously = true`, which will cause JobClass.enqueue to simply execute the job's logic synchronously, as if you'd run JobClass.run(*your_args). Or, you may want to leave it disabled so you can assert on the job state once they are stored in the database.
 
-## Related Projects
-
-  * [que-web](https://github.com/statianzo/que-web) is a Sinatra-based UI for inspecting your job queue.
-  * [que-testing](https://github.com/statianzo/que-testing) allows making assertions on enqueued jobs.
-  * [que-scheduler](https://github.com/hlascelles/que-scheduler) is a cron scheduler for Que jobs that runs on Que itself.
-  * [que-go](https://github.com/bgentry/que-go) is a port of Que for the Go programming language. It uses the same table structure, so that you can use the same job queue from Ruby and Go applications.
-  * [wisper-que](https://github.com/joevandyk/wisper-que) adds support for Que to [wisper](https://github.com/krisleech/wisper).
-
-If you have a project that uses or relates to Que, feel free to submit a PR adding it to the list!
+**If you're using ActiveRecord to dump your database's schema, please [set your schema_format to :sql](http://guides.rubyonrails.org/migrations.html#types-of-schema-dumps) so that Que's table structure is managed correctly.** This is a good idea regardless, as the `:ruby` schema format doesn't support many of PostgreSQL's advanced features.
 
 
 ## Community and Contributing
@@ -129,12 +131,14 @@ Regarding contributions, one of the project's priorities is to keep Que as simpl
 
 ### Specs
 
-A note on running specs - Que's worker system is multithreaded and therefore prone to race conditions (especially on interpreters without a global lock, like Rubinius or JRuby). As such, if you've touched that code, a single spec run passing isn't a guarantee that any changes you've made haven't introduced bugs. One thing I like to do before pushing changes is rerun the specs many times and watching for hangs. You can do this from the command line with something like:
+A note on running specs - Que's worker system is multithreaded and therefore prone to race conditions. As such, if you've touched that code, a single spec run passing isn't a guarantee that any changes you've made haven't introduced bugs. One thing I like to do before pushing changes is rerun the specs many times and watching for hangs. You can do this from the command line with something like:
 
-    for i in {1..1000}; do bundle exec rspec -b --seed $i; done
+    for i in {1..1000}; do SEED=$i bundle exec rake; done
 
 This will iterate the specs one thousand times, each with a different ordering. If the specs hang, note what the seed number was on that iteration. For example, if the previous specs finished with a "Randomized with seed 328", you know that there's a hang with seed 329, and you can narrow it down to a specific spec with:
 
-    for i in {1..1000}; do LOG_SPEC=true bundle exec rspec -b --seed 329; done
+    for i in {1..1000}; do LOG_SPEC=true SEED=328 bundle exec rake; done
 
 Note that we iterate because there's no guarantee that the hang would reappear with a single additional run, so we need to rerun the specs until it reappears. The LOG_SPEC parameter will output the name and file location of each spec before it is run, so you can easily tell which spec is hanging, and you can continue narrowing things down from there.
+
+Another helpful technique is to replace an `it` spec declaration with `hit` - this will run that particular spec 100 times during the run.

data/bin/command_line_interface.rb

@@ -0,0 +1,239 @@
+# frozen_string_literal: true
+
+require 'optparse'
+require 'logger'
+require 'uri'
+
+module Que
+  module CommandLineInterface
+    # Have a sensible default require file for Rails.
+    RAILS_ENVIRONMENT_FILE = './config/environment.rb'
+
+    class << self
+      # Need to rely on dependency injection a bit to make this method cleanly
+      # testable :/
+      def parse(
+        args:,
+        output:,
+        default_require_file: RAILS_ENVIRONMENT_FILE
+      )
+
+        options        = {}
+        queues         = []
+        log_level      = 'info'
+        log_internals  = false
+        poll_interval  = 5
+        connection_url = nil
+
+        parser =
+          OptionParser.new do |opts|
+            opts.banner = 'usage: que [options] [file/to/require] ...'
+
+            opts.on(
+              '-h',
+              '--help',
+              "Show this help text.",
+            ) do
+              output.puts opts.help
+              return 0
+            end
+
+            opts.on(
+              '-i',
+              '--poll-interval [INTERVAL]',
+              Float,
+              "Set maximum interval between polls for available jobs, " \
+                "in seconds (default: 5)",
+            ) do |i|
+              poll_interval = i
+            end
+
+            opts.on(
+              '-l',
+              '--log-level [LEVEL]',
+              String,
+              "Set level at which to log to STDOUT " \
+                "(debug, info, warn, error, fatal) (default: info)",
+            ) do |l|
+              log_level = l
+            end
+
+            opts.on(
+              '-q',
+              '--queue-name [NAME]',
+              String,
+              "Set a queue name to work jobs from. " \
+                "Can be passed multiple times. " \
+                "(default: the default queue only)",
+            ) do |queue_name|
+              queues << queue_name
+            end
+
+            opts.on(
+              '-v',
+              '--version',
+              "Print Que version and exit.",
+            ) do
+              require 'que'
+              output.puts "Que version #{Que::VERSION}"
+              return 0
+            end
+
+            opts.on(
+              '-w',
+              '--worker-count [COUNT]',
+              Integer,
+              "Set number of workers in process (default: 6)",
+            ) do |w|
+              options[:worker_count] = w
+            end
+
+            opts.on(
+              '--connection-url [URL]',
+              String,
+              "Set a custom database url to connect to for locking purposes.",
+            ) do |url|
+              connection_url = url
+            end
+
+            opts.on(
+              '--log-internals',
+              "Log verbosely about Que's internal state. " \
+                "Only recommended for debugging issues",
+            ) do |l|
+              log_internals = true
+            end
+
+            opts.on(
+              '--maximum-buffer-size [SIZE]',
+              Integer,
+              "Set maximum number of jobs to be cached in this process " \
+                "awaiting a worker (default: 8)",
+            ) do |s|
+              options[:maximum_queue_size] = s
+            end
+
+            opts.on(
+              '--minimum-buffer-size [SIZE]',
+              Integer,
+              "Set minimum number of jobs to be cached in this process " \
+                "awaiting a worker (default: 2)",
+            ) do |s|
+              options[:minimum_queue_size] = s
+            end
+
+            opts.on(
+              '--wait-period [PERIOD]',
+              Float,
+              "Set maximum interval between checks of the in-memory job queue, " \
+                "in milliseconds (default: 50)",
+            ) do |p|
+              options[:wait_period] = p
+            end
+
+            opts.on(
+              '--worker-priorities [LIST]',
+              Array,
+              "List of priorities to assign to workers, " \
+                "unspecified workers take jobs of any priority (default: 10,30,50)",
+            ) do |p|
+              options[:worker_priorities] = p.map(&:to_i)
+            end
+          end
+
+        parser.parse!(args)
+
+        if args.length.zero?
+          if File.exist?(default_require_file)
+            args << default_require_file
+          else
+            output.puts <<-OUTPUT
+You didn't include any Ruby files to require!
+Que needs to be able to load your application before it can process jobs.
+(Or use `que -h` for a list of options)
+OUTPUT
+            return 1
+          end
+        end
+
+        args.each do |file|
+          begin
+            require file
+          rescue LoadError
+            output.puts "Could not load file '#{file}'"
+            return 1
+          end
+        end
+
+        Que.logger ||= Logger.new(STDOUT)
+
+        if log_internals
+          Que.internal_logger = Que.logger
+        end
+
+        begin
+          Que.logger.level = Logger.const_get(log_level.upcase)
+        rescue NameError
+          output.puts "Unsupported logging level: #{log_level} (try debug, info, warn, error, or fatal)"
+          return 1
+        end
+
+        if queues.any?
+          queues_hash = {}
+
+          queues.each do |queue|
+            name, interval = queue.split('=')
+            p              = interval ? Float(interval) : poll_interval
+
+            Que.assert(p > 0.01) { "Poll intervals can't be less than 0.01 seconds!" }
+
+            queues_hash[name] = p
+          end
+
+          options[:queues] = queues_hash
+        end
+
+        options[:poll_interval] = poll_interval
+
+        if connection_url
+          uri = URI.parse(connection_url)
+
+          options[:connection] =
+            PG::Connection.open(
+              host:     uri.host,
+              user:     uri.user,
+              password: uri.password,
+              port:     uri.port || 5432,
+              dbname:   uri.path[1..-1],
+            )
+        end
+
+        locker =
+          begin
+            Que::Locker.new(options)
+          rescue => e
+            output.puts(e.message)
+            return 1
+          end
+
+        # It's a bit sloppy to use a global for this when a local variable would
+        # do, but we want to stop the locker from the CLI specs, so...
+        $stop_que_executable = false
+        %w[INT TERM].each { |signal| trap(signal) { $stop_que_executable = true } }
+
+        loop do
+          sleep 0.01
+          break if $stop_que_executable || locker.stopping?
+        end
+
+        output.puts ''
+        output.puts "Finishing Que's current jobs before exiting..."
+
+        locker.stop!
+
+        output.puts "Que's jobs finished, exiting..."
+        return 0
+      end
+    end
+  end
+end