faktory_worker_ruby 1.1.1 → 1.2.0

data/lib/faktory/mutate.rb

@@ -1,4 +1,4 @@
-require 'faktory/client'
+require "faktory/client"
 
 ##
 #
@@ -13,7 +13,6 @@ require 'faktory/client'
 #   filter.matching("*uid:12345*"))
 # end
 module Faktory
-
   # Valid targets
   RETRIES = "retries"
   SCHEDULED = "scheduled"
@@ -46,6 +45,7 @@ module Faktory
       def jids
         @hash[:jids] ||= []
       end
+
       def jids=(ary)
         @hash[:jids] = Array(ary)
       end
@@ -53,30 +53,30 @@ module Faktory
 
     def discard(target, &block)
       filter = Filter.new
-      block.call(filter) if block
-      mutate('discard', target, filter)
+      block&.call(filter)
+      mutate("discard", target, filter)
     end
 
     def kill(target, &block)
       filter = Filter.new
-      block.call(filter) if block
-      mutate('kill', target, filter)
+      block&.call(filter)
+      mutate("kill", target, filter)
     end
 
     def requeue(target, &block)
       filter = Filter.new
-      block.call(filter) if block
-      mutate('requeue', target, filter)
+      block&.call(filter)
+      mutate("requeue", target, filter)
     end
 
     def clear(target)
-      mutate('discard', target, nil)
+      mutate("discard", target, nil)
     end
 
     private
 
     def mutate(cmd, target, filter)
-      payload = {:cmd => cmd,:target => target}
+      payload = {cmd: cmd, target: target}
       payload[:filter] = filter.hash if filter && !filter.hash.empty?
 
       transaction do
@@ -84,7 +84,6 @@ module Faktory
         ok
       end
     end
-
   end
 end
 

data/lib/faktory/processor.rb

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
-require 'faktory/util'
-require 'faktory/fetch'
-require 'faktory/job_logger'
-require 'thread'
 
+require "faktory/util"
+require "faktory/fetch"
+require "faktory/job_logger"
 module Faktory
   ##
   # The Processor is a standalone thread which:
@@ -22,7 +21,6 @@ module Faktory
   # to replace itself and exits.
   #
   class Processor
-
     include Util
 
     attr_reader :thread
@@ -44,13 +42,13 @@ module Faktory
       @fetcher = Faktory::Fetcher.new(mgr.options)
     end
 
-    def terminate(wait=false)
+    def terminate(wait = false)
       @done = true
       return if !@thread
       @thread.value if wait
     end
 
-    def kill(wait=false)
+    def kill(wait = false)
       @done = true
       return if !@thread
       # unlike the other actors, terminate does not wait
@@ -69,30 +67,28 @@ module Faktory
     private unless $TESTING
 
     def run
-      begin
-        while !@done
-          process_one
-        end
-        @mgr.processor_stopped(self)
-      rescue Faktory::Shutdown
-        @mgr.processor_stopped(self)
-      rescue Exception => ex
-        @mgr.processor_died(self, ex)
+      until @done
+        process_one
       end
+      @mgr.processor_stopped(self)
+    rescue Faktory::Shutdown
+      @mgr.processor_stopped(self)
+    rescue Exception => ex
+      @mgr.processor_died(self, ex)
     end
 
     def process_one
       work = fetch
       if work
         @@busy_lock.synchronize do
-          @@busy_count = @@busy_count + 1
+          @@busy_count += 1
         end
         begin
           @job = work.job
           process(work)
         ensure
           @@busy_lock.synchronize do
-            @@busy_count = @@busy_count - 1
+            @@busy_count -= 1
           end
         end
       else
@@ -101,14 +97,15 @@ module Faktory
     end
 
     def fetch
-      begin
-        work = @fetcher.retrieve_work
-        (logger.info { "Faktory is online, #{Time.now - @down} sec downtime" }; @down = nil) if @down
-        work
-      rescue Faktory::Shutdown
-      rescue => ex
-        handle_fetch_exception(ex)
+      work = @fetcher.retrieve_work
+      if @down
+        (logger.info { "Faktory is online, #{Time.now - @down} sec downtime" }
+         @down = nil)
       end
+      work
+    rescue Faktory::Shutdown
+    rescue => ex
+      handle_fetch_exception(ex)
     end
 
     def handle_fetch_exception(ex)
@@ -131,9 +128,9 @@ module Faktory
           # the Reloader.  It handles code loading, db connection management, etc.
           # Effectively this block denotes a "unit of work" to Rails.
           @reloader.call do
-            klass  = constantize(payload['jobtype'.freeze])
+            klass = constantize(payload["jobtype"])
             jobinst = klass.new
-            jobinst.jid = payload['jid'.freeze]
+            jobinst.jid = payload["jid"]
             yield jobinst
           end
         end
@@ -145,7 +142,7 @@ module Faktory
       begin
         dispatch(payload) do |jobinst|
           Faktory.worker_middleware.invoke(jobinst, payload) do
-            jobinst.perform(*payload['args'.freeze])
+            jobinst.perform(*payload["args"])
           end
         end
         work.acknowledge
@@ -155,7 +152,7 @@ module Faktory
         # and immediately restart it.
         work.fail(shut)
       rescue Exception => ex
-        handle_exception(ex, { :context => "Job raised exception", :job => work.job })
+        handle_exception(ex, {context: "Job raised exception", job: work.job})
         work.fail(ex)
         raise ex
       end
@@ -166,13 +163,12 @@ module Faktory
     end
 
     def constantize(str)
-      names = str.split('::')
+      names = str.split("::")
       names.shift if names.empty? || names.first.empty?
 
       names.inject(Object) do |constant, name|
         constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
       end
     end
-
   end
 end

data/lib/faktory/rails.rb

@@ -1,64 +1,67 @@
 # frozen_string_literal: true
+
 module Faktory
-  class Rails < ::Rails::Engine
-    # This hook happens after `Rails::Application` is inherited within
-    # config/application.rb and before config is touched, usually within the
-    # class block. Definitely before config/environments/*.rb and
-    # config/initializers/*.rb.
-    config.before_configuration do
-      if defined?(::ActiveJob)
-        require 'active_job/queue_adapters/faktory_adapter'
+  if defined?(::Rails)
+    class Rails < ::Rails::Engine
+      # This hook happens after `Rails::Application` is inherited within
+      # config/application.rb and before config is touched, usually within the
+      # class block. Definitely before config/environments/*.rb and
+      # config/initializers/*.rb.
+      config.before_configuration do
+        if defined?(::ActiveJob)
+          require "active_job/queue_adapters/faktory_adapter"
+        end
       end
-    end
 
-    config.after_initialize do
-      # This hook happens after all initializers are run, just before returning
-      # from config/environment.rb back to faktory/cli.rb.
-      # We have to add the reloader after initialize to see if cache_classes has
-      # been turned on.
-      #
-      # None of this matters on the client-side, only within the Faktory executor itself.
-      #
-      Faktory.configure_worker do |_|
-        if ::Rails::VERSION::MAJOR < 5
-          raise "Your current version of Rails, #{::Rails::VERSION::STRING}, is not supported"
-        end
+      config.after_initialize do
+        # This hook happens after all initializers are run, just before returning
+        # from config/environment.rb back to faktory/cli.rb.
+        # We have to add the reloader after initialize to see if cache_classes has
+        # been turned on.
+        #
+        # None of this matters on the client-side, only within the Faktory executor itself.
+        #
+        Faktory.configure_worker do |_|
+          if ::Rails::VERSION::MAJOR < 5
+            raise "Your current version of Rails, #{::Rails::VERSION::STRING}, is not supported"
+          end
 
-        Faktory.options[:reloader] = Faktory::Rails::Reloader.new
-      end
+          Faktory.options[:reloader] = Faktory::Rails::Reloader.new
+        end
 
-      begin
-        # https://github.com/rails/rails/pull/41248
-        if defined?(::Mail::SMTP)
-          ::Mail::SMTP::DEFAULTS[:read_timeout] ||= 5
-          ::Mail::SMTP::DEFAULTS[:open_timeout] ||= 5
+        begin
+          # https://github.com/rails/rails/pull/41248
+          if defined?(::Mail::SMTP)
+            ::Mail::SMTP::DEFAULTS[:read_timeout] ||= 5
+            ::Mail::SMTP::DEFAULTS[:open_timeout] ||= 5
+          end
+        rescue
+          # ignore
         end
-      rescue => ex
-        # ignore
       end
-    end
 
-    class Reloader
-      def initialize(app = ::Rails.application)
-        @app = app
-      end
+      class Reloader
+        def initialize(app = ::Rails.application)
+          @app = app
+        end
 
-      def call
-        @app.reloader.wrap do
-          yield
+        def call
+          @app.reloader.wrap do
+            yield
+          end
         end
-      end
 
-      def inspect
-        "#<Faktory::Rails::Reloader @app=#{@app.class.name}>"
+        def inspect
+          "#<Faktory::Rails::Reloader @app=#{@app.class.name}>"
+        end
       end
     end
-  end if defined?(::Rails)
+  end
 
   if defined?(::Rails) && ::Rails::VERSION::MAJOR < 5
-    $stderr.puts("**************************************************")
-    $stderr.puts("🚫 ERROR: Faktory Worker does not support Rails versions under 5.x - please ensure your workers are updated")
-    $stderr.puts("**************************************************")
-    $stderr.puts("")
+    warn("**************************************************")
+    warn("🚫 ERROR: Faktory Worker does not support Rails versions under 5.x - please ensure your workers are updated")
+    warn("**************************************************")
+    warn("")
   end
 end

data/lib/faktory/testing.rb

@@ -10,7 +10,7 @@ module Faktory
 
     def self.__set_test_mode(mode)
       if block_given?
-        current_mode = self.__test_mode
+        current_mode = __test_mode
         begin
           self.__test_mode = mode
           yield
@@ -33,31 +33,31 @@ module Faktory
     def self.inline!(&block)
       # Only allow inline testing inside of a block
       # https://github.com/mperham/sidekiq/issues/3495
-      unless block_given?
-        raise 'Must provide a block to Faktory::Testing.inline!'
+      unless block
+        raise "Must provide a block to Faktory::Testing.inline!"
       end
 
       __set_test_mode(:inline, &block)
     end
 
     def self.enabled?
-      self.__test_mode != :disable
+      __test_mode != :disable
     end
 
     def self.disabled?
-      self.__test_mode == :disable
+      __test_mode == :disable
     end
 
     def self.fake?
-      self.__test_mode == :fake
+      __test_mode == :fake
     end
 
     def self.inline?
-      self.__test_mode == :inline
+      __test_mode == :inline
     end
 
     def self.constantize(str)
-      names = str.split('::')
+      names = str.split("::")
       names.shift if names.empty? || names.first.empty?
 
       names.inject(Object) do |constant, name|
@@ -81,14 +81,14 @@ module Faktory
     def push(job)
       if Faktory::Testing.inline?
         job = Faktory.load_json(Faktory.dump_json(job))
-        job_class = Faktory::Testing.constantize(job['jobtype'])
-        job_class.new.perform(*job['args'])
-        return job['jid']
+        job_class = Faktory::Testing.constantize(job["jobtype"])
+        job_class.new.perform(*job["args"])
+        job["jid"]
       elsif Faktory::Testing.fake?
         job = Faktory.load_json(Faktory.dump_json(job))
-        job.merge!('enqueued_at' => Time.now.to_f) unless job['at']
-        Queues.push(job['queue'], job['jobtype'], job)
-        return job['jid']
+        job["enqueued_at"] = Time.now.to_f unless job["at"]
+        Queues.push(job["queue"], job["jobtype"], job)
+        job["jid"]
       else
         real_push(job)
       end
@@ -259,27 +259,26 @@ module Faktory
     #   Then I should receive a welcome email to "foo@example.com"
     #
     module ClassMethods
-
       # Queue for this worker
       def queue
-        self.faktory_options["queue"]
+        faktory_options["queue"]
       end
 
       # Jobs queued for this worker
       def jobs
-        Queues.jobs_by_worker[self.to_s]
+        Queues.jobs_by_worker[to_s]
       end
 
       # Clear all jobs for this worker
       def clear
-        Queues.clear_for(queue, self.to_s)
+        Queues.clear_for(queue, to_s)
       end
 
       # Drain and run all jobs for this worker
       def drain
         while jobs.any?
           next_job = jobs.first
-          Queues.delete_for(next_job["jid"], next_job["queue"], self.to_s)
+          Queues.delete_for(next_job["jid"], next_job["queue"], to_s)
           process_job(next_job)
         end
       end
@@ -288,17 +287,17 @@ module Faktory
       def perform_one
         raise(EmptyQueueError, "perform_one called with empty job queue") if jobs.empty?
         next_job = jobs.first
-        Queues.delete_for(next_job["jid"], queue, self.to_s)
+        Queues.delete_for(next_job["jid"], queue, to_s)
         process_job(next_job)
       end
 
       def process_job(job)
         worker = new
-        worker.jid = job['jid']
-        worker.bid = job['bid'] if worker.respond_to?(:bid=)
-        #Faktory::Testing.server_middleware.invoke(worker, job, job['queue']) do
-          execute_job(worker, job['args'])
-        #end
+        worker.jid = job["jid"]
+        worker.bid = job["bid"] if worker.respond_to?(:bid=)
+        # Faktory::Testing.server_middleware.invoke(worker, job, job['queue']) do
+        execute_job(worker, job["args"])
+        # end
       end
 
       def execute_job(worker, args)
@@ -328,5 +327,4 @@ module Faktory
       end
     end
   end
-
 end

data/lib/faktory/tracking.rb

@@ -1,6 +1,5 @@
 module Faktory
   module Trackable
-
     ##
     # Tracking allows a long-running Faktory job to report its progress:
     #
@@ -22,10 +21,10 @@ module Faktory
     # 4. reserve_until allows a job to dynamically extend its reservation so it is not garbage collected by Faktory while running
     # 5. you can only reserve up to 24 hours.
     #
-    def track_progress(percent, desc=nil, reserve_until:nil)
-      hash = { 'jid' => jid, 'percent' => percent.to_i, 'desc' => desc }
+    def track_progress(percent, desc = nil, reserve_until: nil)
+      hash = {"jid" => jid, "percent" => percent.to_i, "desc" => desc}
       hash["reserve_until"] = convert(reserve_until) if reserve_until
-      Faktory.server {|c| c.set_track(hash) }
+      Faktory.server { |c| c.set_track(hash) }
     end
 
     private

data/lib/faktory/util.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
-require 'socket'
-require 'securerandom'
-require 'faktory/exception_handler'
+
+require "socket"
+require "securerandom"
+require "faktory/exception_handler"
 
 module Faktory
   ##
@@ -15,13 +16,13 @@ module Faktory
     def watchdog(last_words)
       yield
     rescue Exception => ex
-      handle_exception(ex, { context: last_words })
+      handle_exception(ex, {context: last_words})
       raise ex
     end
 
     def safe_thread(name, &block)
       Thread.new do
-        Thread.current['faktory_label'.freeze] = name
+        Thread.current["faktory_label"] = name
         watchdog(name, &block)
       end
     end
@@ -35,7 +36,7 @@ module Faktory
     end
 
     def hostname
-      ENV['DYNO'] || Socket.gethostname
+      ENV["DYNO"] || Socket.gethostname
     end
 
     def process_nonce
@@ -46,15 +47,13 @@ module Faktory
       @@identity ||= "#{hostname}:#{$$}:#{process_nonce}"
     end
 
-    def fire_event(event, reverse=false)
+    def fire_event(event, reverse = false)
       arr = Faktory.options[:lifecycle_events][event]
       arr.reverse! if reverse
       arr.each do |block|
-        begin
-          block.call
-        rescue => ex
-          handle_exception(ex, { context: "Exception during Faktory lifecycle event.", event: event })
-        end
+        block.call
+      rescue => ex
+        handle_exception(ex, {context: "Exception during Faktory lifecycle event.", event: event})
       end
       arr.clear
     end

data/lib/faktory/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Faktory
-  VERSION = "1.1.1"
+  VERSION = "1.2.0"
 end

data/lib/faktory.rb

@@ -1,24 +1,24 @@
-# encoding: utf-8
 # frozen_string_literal: true
-require 'faktory/version'
 
-require 'faktory/logging'
-require 'faktory/client'
-require 'faktory/middleware/chain'
-require 'faktory/job'
-require 'faktory/connection'
+require "faktory/version"
 
-require 'json'
+require "faktory/logging"
+require "faktory/client"
+require "faktory/middleware/chain"
+require "faktory/job"
+require "faktory/connection"
+
+require "json"
 
 module Faktory
-  NAME = 'Faktory'.freeze
-  LICENSE = 'See LICENSE and the LGPL-3.0 for licensing details.'
+  NAME = "Faktory"
+  LICENSE = "See LICENSE and the LGPL-3.0 for licensing details."
 
   DEFAULTS = {
-    queues: ['default'],
+    queues: ["default"],
     concurrency: 10,
-    require: '.',
-    environment: 'development',
+    require: ".",
+    environment: "development",
     # As of 2017, Heroku's process timeout is 30 seconds.
     # After 30 seconds, processes are KILLed so assume 25
     # seconds to gracefully shutdown and 5 seconds to hard
@@ -28,19 +28,20 @@ module Faktory
     lifecycle_events: {
       startup: [],
       quiet: [],
-      shutdown: [],
+      shutdown: []
     },
-    reloader: proc { |&block| block.call },
+    reloader: proc { |&block| block.call }
   }
 
   DEFAULT_JOB_OPTIONS = {
-    'retry' => 25,
-    'queue' => 'default'
+    "retry" => 25,
+    "queue" => "default"
   }
 
   def self.options
     @options ||= DEFAULTS.dup
   end
+
   def self.options=(opts)
     @options = opts
   end
@@ -101,8 +102,9 @@ module Faktory
 
   def self.default_job_options=(hash)
     # stringify
-    @default_job_options = default_job_options.merge(Hash[hash.map{|k, v| [k.to_s, v]}])
+    @default_job_options = default_job_options.merge(hash.map { |k, v| [k.to_s, v] }.to_h)
   end
+
   def self.default_job_options
     defined?(@default_job_options) ? @default_job_options : DEFAULT_JOB_OPTIONS
   end
@@ -110,6 +112,7 @@ module Faktory
   def self.load_json(string)
     JSON.parse(string)
   end
+
   def self.dump_json(object)
     JSON.generate(object)
   end
@@ -117,6 +120,7 @@ module Faktory
   def self.logger
     Faktory::Logging.logger
   end
+
   def self.logger=(log)
     Faktory::Logging.logger = log
   end
@@ -138,7 +142,7 @@ module Faktory
   #
   # The default error handler logs errors to Faktory.logger.
   def self.error_handlers
-    self.options[:error_handlers]
+    options[:error_handlers]
   end
 
   # Register a block to run at a point in the Faktory lifecycle.
@@ -164,5 +168,5 @@ module Faktory
   class Shutdown < Interrupt; end
 end
 
-require 'faktory/rails' if defined?(::Rails::Engine)
-require 'faktory/batch'
+require "faktory/rails" if defined?(::Rails::Engine)
+require "faktory/batch"

data/lib/faktory_worker_ruby.rb

@@ -1 +1 @@
-require 'faktory'
+require "faktory"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faktory_worker_ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Mike Perham
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-15 00:00:00.000000000 Z
+date: 2023-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -96,6 +96,7 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
 - ".gitignore"
+- ".standard.yml"
 - Changes.md
 - Gemfile
 - Gemfile.lock
@@ -153,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.4.4
 signing_key:
 specification_version: 4
 summary: Ruby worker for Faktory