resque 1.27.4 → 2.6.0

data/lib/resque.rb

@@ -23,6 +23,8 @@ require 'resque/thread_signal'
 
 require 'resque/vendor/utf8_util'
 
+require 'resque/railtie' if defined?(Rails::Railtie)
+
 module Resque
   include Helpers
   extend self
@@ -112,13 +114,12 @@ module Resque
   def redis=(server)
     case server
     when String
-      if server =~ /redis\:\/\//
-        redis = Redis.connect(:url => server, :thread_safe => true)
+      if server =~ /rediss?\:\/\//
+        redis = Redis.new(:url => server)
       else
         server, namespace = server.split('/', 2)
         host, port, db = server.split(':')
-        redis = Redis.new(:host => host, :port => port,
-          :thread_safe => true, :db => db)
+        redis = Redis.new(:host => host, :port => port, :db => db)
       end
       namespace ||= :resque
 
@@ -147,26 +148,76 @@ module Resque
     data_store.identifier
   end
 
+  # Set the data store for the processed and failed statistics.
+  #
+  # By default it uses the same as `Resque.redis`, but different stores can be used.
+  #
+  # A custom store needs to obey the following API to work correctly
+  #
+  # class NullDataStore
+  #   # Returns the current value for the given stat.
+  #   def stat(stat)
+  #   end
+  #
+  #   # Increments the stat by the given value.
+  #   def increment_stat(stat, by)
+  #   end
+  #
+  #   # Decrements the stat by the given value.
+  #   def decrement_stat(stat, by)
+  #   end
+  #
+  #   # Clear the values for the given stat.
+  #   def clear_stat(stat)
+  #   end
+  # end
+  def stat_data_store=(stat_data_store)
+    Resque::Stat.data_store = stat_data_store
+  end
+
+  # Returns the data store for the statistics module.
+  def stat_data_store
+    Resque::Stat.data_store
+  end
+
   # Set or retrieve the current logger object
   attr_accessor :logger
 
   DEFAULT_HEARTBEAT_INTERVAL = 60
   DEFAULT_PRUNE_INTERVAL = DEFAULT_HEARTBEAT_INTERVAL * 5
 
+  # Defines how often a Resque worker updates the heartbeat key. Must be less
+  # than the prune interval.
   attr_writer :heartbeat_interval
   def heartbeat_interval
-    @heartbeat_interval || DEFAULT_HEARTBEAT_INTERVAL
+    if defined? @heartbeat_interval
+      @heartbeat_interval
+    else
+      DEFAULT_HEARTBEAT_INTERVAL
+    end
   end
 
+  # Defines how often Resque checks for dead workers.
   attr_writer :prune_interval
   def prune_interval
-    @prune_interval || DEFAULT_PRUNE_INTERVAL
+    if defined? @prune_interval
+      @prune_interval
+    else
+      DEFAULT_PRUNE_INTERVAL
+    end
   end
 
+  # By default, jobs are pushed to the back of the queue and popped from
+  # the front, resulting in "first in, first out" (FIFO) execution order.
+  # Set to true to push jobs to the front of the queue instead, resulting
+  # in "last in, first out" (LIFO) execution order.
   attr_writer :enqueue_front
   def enqueue_front
-    return @enqueue_front unless @enqueue_front.nil?
-    @enqueue_front = false
+    if defined? @enqueue_front
+      @enqueue_front
+    else
+      @enqueue_front = false
+    end
   end
 
   # The `before_first_fork` hook will be run in the **parent** process
@@ -237,6 +288,34 @@ module Resque
     register_hook(:after_pause, block)
   end
 
+  # The `queue_empty` hook will be run in the **parent** process when
+  # the worker finds no more jobs in the queue and becomes idle.
+  #
+  # Call with a block to register a hook.
+  # Call with no arguments to return all registered hooks.
+  def queue_empty(&block)
+    block ? register_hook(:queue_empty, block) : hooks(:queue_empty)
+  end
+
+  # Register a queue_empty proc.
+  def queue_empty=(block)
+    register_hook(:queue_empty, block)
+  end
+
+  # The `worker_exit` hook will be run in the **parent** process
+  # after the worker has existed (via SIGQUIT, SIGTERM, SIGINT, etc.).
+  #
+  # Call with a block to register a hook.
+  # Call with no arguments to return all registered hooks.
+  def worker_exit(&block)
+    block ? register_hook(:worker_exit, block) : hooks(:worker_exit)
+  end
+
+  # Register a worker_exit proc.
+  def worker_exit=(block)
+    register_hook(:worker_exit, block)
+  end
+
   def to_s
     "Resque Client connected to #{redis_id}"
   end
@@ -284,8 +363,8 @@ module Resque
     data_store.queue_size(queue)
   end
 
-  # Returns an array of items currently queued. Queue name should be
-  # a string.
+  # Returns an array of items currently queued, or the item itself
+  # if count = 1. Queue name should be a string.
   #
   # start and count should be integer and can be used for pagination.
   # start is the item to begin, count is how many items to return.
@@ -424,7 +503,7 @@ module Resque
   # Given a class, try to extrapolate an appropriate queue based on a
   # class instance variable or `queue` method.
   def queue_from_class(klass)
-    klass.instance_variable_get(:@queue) ||
+    (klass.instance_variable_defined?(:@queue) && klass.instance_variable_get(:@queue)) ||
       (klass.respond_to?(:queue) and klass.queue)
   end
 
@@ -483,7 +562,7 @@ module Resque
   # Returns a hash, similar to redis-rb's #info, of interesting stats.
   def info
     return {
-      :pending   => queue_sizes.inject(0) { |sum, (queue_name, queue_size)| sum + queue_size },
+      :pending   => queue_sizes.inject(0) { |sum, (_queue_name, queue_size)| sum + queue_size },
       :processed => Stat[:processed],
       :queues    => queues.size,
       :workers   => workers.size.to_i,
@@ -504,9 +583,9 @@ module Resque
   def queue_sizes
     queue_names = queues
 
-    sizes = redis.pipelined do
+    sizes = redis.pipelined do |piped|
       queue_names.each do |name|
-        redis.llen("queue:#{name}")
+        piped.llen("queue:#{name}")
       end
     end
 
@@ -517,11 +596,11 @@ module Resque
   def sample_queues(sample_size = 1000)
     queue_names = queues
 
-    samples = redis.pipelined do
+    samples = redis.pipelined do |piped|
       queue_names.each do |name|
         key = "queue:#{name}"
-        redis.llen(key)
-        redis.lrange(key, 0, sample_size - 1)
+        piped.llen(key)
+        piped.lrange(key, 0, sample_size - 1)
       end
     end
 
@@ -543,6 +622,8 @@ module Resque
 
   private
 
+  @hooks = Hash.new { |h, k| h[k] = [] }
+
   # Register a new proc as a hook. If the block is nil this is the
   # equivalent of removing all hooks of the given name.
   #
@@ -550,26 +631,18 @@ module Resque
   def register_hook(name, block)
     return clear_hooks(name) if block.nil?
 
-    @hooks ||= {}
-    @hooks[name] ||= []
-
     block = Array(block)
     @hooks[name].concat(block)
   end
 
   # Clear all hooks given a hook name.
   def clear_hooks(name)
-    @hooks && @hooks[name] = []
-  end
-
-  # Retrieve all hooks
-  def hooks
-    @hooks || {}
+    @hooks[name] = []
   end
 
   # Retrieve all hooks of a given name.
   def hooks(name)
-    (@hooks && @hooks[name]) || []
+    @hooks[name]
   end
 end
 

data/lib/tasks/redis.rake

@@ -17,7 +17,7 @@ class RedisRunner
   end
 
   def self.config
-    @config ||= if File.exists?(redis_dir + 'etc/redis.conf')
+    @config ||= if File.exist?(redis_dir + 'etc/redis.conf')
                   redis_dir + 'etc/redis.conf'
                 else
                   redis_dir + '../etc/redis.conf'
@@ -30,7 +30,7 @@ class RedisRunner
 
   # Just check for existance of dtach socket
   def self.running?
-    File.exists? dtach_socket
+    File.exist? dtach_socket
   end
 
   def self.start
@@ -90,10 +90,10 @@ namespace :redis do
 
     if ENV['PREFIX']
       bin_dir = "#{ENV['PREFIX']}/bin"
-      sh "mkdir -p #{bin_dir}" unless File.exists?("#{bin_dir}")
+      sh "mkdir -p #{bin_dir}" unless File.exist?("#{bin_dir}")
 
       conf_dir = "#{ENV['PREFIX']}/etc"
-      sh "mkdir -p #{conf_dir}" unless File.exists?("#{conf_dir}")
+      sh "mkdir -p #{conf_dir}" unless File.exist?("#{conf_dir}")
     end
 
     %w(redis-benchmark redis-cli redis-server).each do |bin|
@@ -102,7 +102,7 @@ namespace :redis do
 
     puts "Installed redis-benchmark, redis-cli and redis-server to #{bin_dir}"
 
-    unless File.exists?("#{conf_dir}/redis.conf")
+    unless File.exist?("#{conf_dir}/redis.conf")
       sh "cp #{INSTALL_DIR}/redis.conf #{conf_dir}/redis.conf"
       puts "Installed redis.conf to #{conf_dir} \n You should look at this file!"
     end
@@ -115,9 +115,9 @@ namespace :redis do
 
   desc "Download package"
   task :download do
-    sh "rm -rf #{INSTALL_DIR}/" if File.exists?("#{INSTALL_DIR}/.svn")
-    sh "git clone git://github.com/antirez/redis.git #{INSTALL_DIR}" unless File.exists?(INSTALL_DIR)
-    sh "cd #{INSTALL_DIR} && git pull" if File.exists?("#{INSTALL_DIR}/.git")
+    sh "rm -rf #{INSTALL_DIR}/" if File.exist?("#{INSTALL_DIR}/.svn")
+    sh "git clone git://github.com/antirez/redis.git #{INSTALL_DIR}" unless File.exist?(INSTALL_DIR)
+    sh "cd #{INSTALL_DIR} && git pull" if File.exist?("#{INSTALL_DIR}/.git")
   end
 end
 
@@ -135,7 +135,7 @@ namespace :dtach do
 
     if ENV['PREFIX']
       bin_dir = "#{ENV['PREFIX']}/bin"
-      sh "mkdir -p #{bin_dir}" unless File.exists?("#{bin_dir}")
+      sh "mkdir -p #{bin_dir}" unless File.exist?("#{bin_dir}")
     end
 
     sh "cp #{INSTALL_DIR}/dtach-0.8/dtach #{bin_dir}"
@@ -147,7 +147,7 @@ namespace :dtach do
 
   desc "Download package"
   task :download do
-    unless File.exists?("#{INSTALL_DIR}/dtach-0.8.tar.gz")
+    unless File.exist?("#{INSTALL_DIR}/dtach-0.8.tar.gz")
       require 'net/http'
 
       url = 'http://downloads.sourceforge.net/project/dtach/dtach/0.8/dtach-0.8.tar.gz'

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: resque
 version: !ruby/object:Gem::Version
-  version: 1.27.4
+  version: 2.6.0
 platform: ruby
 authors:
 - Chris Wanstrath
 - Steve Klabnik
 - Terence Lee
+- Michael Bianco
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-15 00:00:00.000000000 Z
+date: 2023-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-namespace
@@ -18,28 +19,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: vegas
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -82,6 +69,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: thin
+  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: webrick
+  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'
 description: |2
       Resque is a Redis-backed Ruby library for creating background jobs,
       placing those jobs on multiple queues, and processing them later.
@@ -128,18 +143,18 @@ files:
 - lib/resque/log_formatters/very_verbose_formatter.rb
 - lib/resque/logging.rb
 - lib/resque/plugin.rb
+- lib/resque/railtie.rb
 - lib/resque/server.rb
-- lib/resque/server/helpers.rb
 - lib/resque/server/public/favicon.ico
 - lib/resque/server/public/idle.png
-- lib/resque/server/public/jquery-1.12.4.min.js
+- lib/resque/server/public/jquery-3.6.0.min.js
 - lib/resque/server/public/jquery.relatize_date.js
+- lib/resque/server/public/main.js
 - lib/resque/server/public/poll.png
 - lib/resque/server/public/ranger.js
 - lib/resque/server/public/reset.css
 - lib/resque/server/public/style.css
 - lib/resque/server/public/working.png
-- lib/resque/server/test_helper.rb
 - lib/resque/server/views/error.erb
 - lib/resque/server/views/failed.erb
 - lib/resque/server/views/failed_job.erb
@@ -155,20 +170,22 @@ files:
 - lib/resque/server/views/stats.erb
 - lib/resque/server/views/workers.erb
 - lib/resque/server/views/working.erb
+- lib/resque/server_helper.rb
 - lib/resque/stat.rb
 - lib/resque/tasks.rb
 - lib/resque/thread_signal.rb
 - lib/resque/vendor/utf8_util.rb
-- lib/resque/vendor/utf8_util/utf8_util_18.rb
-- lib/resque/vendor/utf8_util/utf8_util_19.rb
 - lib/resque/version.rb
+- lib/resque/web_runner.rb
 - lib/resque/worker.rb
 - lib/tasks/redis.rake
 - lib/tasks/resque.rake
-homepage: http://resque.github.io/
+homepage: https://github.com/resque/resque
 licenses:
 - MIT
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/resque/resque/blob/master/HISTORY.md
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options:
 - "--charset=UTF-8"
@@ -178,15 +195,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Resque is a Redis-backed queueing system.

data/lib/resque/server/helpers.rb

@@ -1,64 +0,0 @@
-Resque::Server.helpers do
-  ####################
-  #failed.erb helpers#
-  ####################
-
-  def failed_date_format
-    "%Y/%m/%d %T %z"
-  end
-
-  def failed_multiple_queues?
-    return @multiple_failed_queues if defined?(@multiple_failed_queues)
-    @multiple_failed_queues = Resque::Failure.queues.size > 1
-  end
-
-  def failed_size
-    @failed_size ||= Resque::Failure.count(params[:queue], params[:class])
-  end
-
-  def failed_per_page
-    @failed_per_page = if params[:class]
-      failed_size
-    else
-      20
-    end
-  end
-
-  def failed_start_at
-    params[:start].to_i
-  end
-
-  def failed_end_at
-    if failed_start_at + failed_per_page > failed_size
-      failed_size
-    else
-      failed_start_at  + failed_per_page - 1
-    end
-  end
-
-  def failed_order
-    params[:order] || 'desc'
-  end
-
-  def failed_class_counts(queue = params[:queue])
-    classes = Hash.new(0)
-    Resque::Failure.each(0, Resque::Failure.count(queue), queue) do |_, item|
-      class_name = item['payload']['class'] if item['payload']
-      class_name ||= "nil"
-      classes[class_name] += 1
-    end
-    classes
-  end
-
-  def page_entries_info(start, stop, size, name = nil)
-    if size == 0
-      name ? "No #{name}s" : '<b>0</b>'
-    elsif size == 1
-      'Showing <b>1</b>' + (name ? " #{name}" : '')
-    elsif size > failed_per_page
-      "Showing #{start}-#{stop} of <b>#{size}</b>" + (name ? " #{name}s" : '')
-    else
-      "Showing #{start} to <b>#{size - 1}</b>" + (name ? " #{name}s" : '')
-    end
-  end
-end