faktory_worker_ruby 1.1.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ba3a7a6dbf71b034a2e9a209830f3049132c72b12105262b6ce971df9e602e6
-  data.tar.gz: f0adb0757fdaed227ec36d13786dadf7a9e39b6854589f4c25e65a8c9101cf86
+  metadata.gz: abc45bf7c07e61197705a9283c38e6d399a81701f433d8a5eded1e6cb6b480e3
+  data.tar.gz: ac96de6c442ad806cf3cafa5fc839e5509454a8f315229f4014cddfcd9bbb28e
 SHA512:
-  metadata.gz: 89471fb1dfd8624f9b562c773909378b4c40a4b52fd7dd198b7d2808199b2057a760b2cbcd919b8aa4494569979092c53762dd24e57be6ecfe7143a97540521d
-  data.tar.gz: 734b8145a57e435ecac307006723608998958bd9952a194c804fe033681579530d0ccc84ed591ffe8cfbbc5393abe4bd6b95045c49d02ceb3c87f742f6027905
+  metadata.gz: ef6262279803c776c204d2efd58bb547617519bf8277a78e3a46f3789e39bff21220134556f8c209b3d7fd26eb85627b24062f721de3c87324acb0063ec778e4
+  data.tar.gz: 6de7bd208b4ab94ab57b3513159c5ab047f5144fb6152365d52535e3274f8306a416a1124f1c299fe0269542bdb61670958323b8be2285face085f8e3f53ae35

data/.github/workflows/ci.yml

@@ -2,16 +2,16 @@ name: CI
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
 jobs:
   test:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.5, 2.6, 2.7, '3.0']
+        ruby: ["2.6", "2.7", "3.0", "3.1"]
     runs-on: ubuntu-latest
     services:
       faktory:

data/.standard.yml

@@ -0,0 +1,9 @@
+ruby_version: 2.5.0
+fix: true
+parallel: true
+ignore:
+  - 'lib/**/*':
+    - Style/GlobalVars
+  - 'test/**/*':
+    - Lint/ConstantDefinitionInBlock
+    - Style/GlobalVars

data/Changes.md

@@ -1,5 +1,17 @@
 # Changes
 
+## 1.3.0
+
+- Fix `faktory/testing` [#74]
+- Provide more batch helper methods along with a more complex
+  workflow in `examples/complex_workflow.rb`.
+
+## 1.2.0
+
+- Dup options before deep merging [#67]
+- Provide default values for `jid` and `queue` if unset
+- Integrate `standard` linter. Update codebase.
+
 ## 1.1.1
 
 - Fix OpenSSL error [#59]

data/Gemfile

@@ -1,5 +1,8 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-gem 'simplecov', require: false, group: :test
+gem "simplecov", require: false, group: :test
+gem "standard", group: [:development, :test]
 
 gemspec
+
+gem "activejob"

data/Gemfile.lock

@@ -1,52 +1,78 @@
 PATH
   remote: .
   specs:
-    faktory_worker_ruby (1.1.0)
+    faktory_worker_ruby (1.3.0)
       connection_pool (~> 2.2, >= 2.2.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activejob (6.1.3.2)
-      activesupport (= 6.1.3.2)
+    activejob (7.0.4.3)
+      activesupport (= 7.0.4.3)
       globalid (>= 0.3.6)
-    activesupport (6.1.3.2)
+    activesupport (7.0.4.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    concurrent-ruby (1.1.9)
-    connection_pool (2.2.5)
+    ast (2.4.2)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.0)
     docile (1.4.0)
-    globalid (0.4.2)
-      activesupport (>= 4.2.0)
-    i18n (1.8.10)
+    globalid (1.1.0)
+      activesupport (>= 5.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.4)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    minitest (5.18.0)
     minitest-hooks (1.5.0)
       minitest (> 5.3)
-    rake (13.0.3)
-    simplecov (0.21.2)
+    parallel (1.22.1)
+    parser (3.2.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rubocop (1.48.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.16.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.3)
-    tzinfo (2.0.4)
+    simplecov_json_formatter (0.1.4)
+    standard (1.25.3)
+      language_server-protocol (~> 3.17.0.2)
+      rubocop (~> 1.48.1)
+      rubocop-performance (~> 1.16.0)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    zeitwerk (2.4.2)
+    unicode-display_width (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activejob (>= 5.2.0)
+  activejob
   faktory_worker_ruby!
   minitest (~> 5)
   minitest-hooks
   rake
   simplecov
-
-BUNDLED WITH
-   2.1.4
+  standard

data/Rakefile

@@ -1,10 +1,11 @@
-require 'bundler/gem_tasks'
-require 'rake/testtask'
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "standard/rake"
 
 Rake::TestTask.new(:test) do |test|
   test.libs += ["test"]
   test.warning = true
-  test.pattern = 'test/**/*_test.rb'
+  test.pattern = "test/**/*_test.rb"
 end
 
-task :default => :test
+task default: ["standard:fix", :test]

data/bin/faktory-worker

@@ -4,7 +4,7 @@
 # RUBYOPT=-w bundle exec faktory
 $TESTING = false
 
-require_relative '../lib/faktory/cli'
+require_relative "../lib/faktory/cli"
 
 begin
   cli = Faktory::CLI.instance
@@ -12,7 +12,7 @@ begin
   cli.run
 rescue => e
   raise e if $DEBUG
-  STDERR.puts e.message
-  STDERR.puts e.backtrace.join("\n")
+  warn e.message
+  warn e.backtrace.join("\n")
   exit 1
 end

data/faktory_worker_ruby.gemspec

@@ -1,19 +1,17 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/faktory/version', __FILE__)
+require File.expand_path("../lib/faktory/version", __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.name          = "faktory_worker_ruby"
-  gem.authors       = ["Mike Perham"]
-  gem.email         = ["mike@contribsys.com"]
-  gem.summary       = "Ruby worker for Faktory"
-  gem.description   = "Ruby worker for Faktory."
-  gem.homepage      = "https://github.com/contribsys/faktory_worker_ruby"
-  gem.license       = "LGPL-3.0"
+  gem.name = "faktory_worker_ruby"
+  gem.authors = ["Mike Perham"]
+  gem.email = ["mike@contribsys.com"]
+  gem.summary = "Ruby worker for Faktory"
+  gem.description = "Ruby worker for Faktory."
+  gem.homepage = "https://github.com/contribsys/faktory_worker_ruby"
+  gem.license = "LGPL-3.0"
 
-  gem.executables   = ['faktory-worker']
-  gem.files         = `git ls-files | grep -Ev '^(test|myapp|examples)'`.split("\n")
-  gem.test_files    = []
-  gem.version       = Faktory::VERSION
+  gem.executables = ["faktory-worker"]
+  gem.files = `git ls-files | grep -Ev '^(test|myapp|examples)'`.split("\n")
+  gem.version = Faktory::VERSION
   gem.required_ruby_version = ">= 2.5.0"
 
   gem.metadata = {
@@ -21,12 +19,12 @@ Gem::Specification.new do |gem|
     "bug_tracker_uri" => "https://github.com/contribsys/faktory_worker_ruby/issues",
     "documentation_uri" => "https://github.com/contribsys/faktory_worker_ruby/wiki",
     "changelog_uri" => "https://github.com/contribsys/faktory_worker_ruby/blob/master/Changes.md",
-    "source_code_uri" => "https://github.com/contribsys/faktory_worker_ruby",
+    "source_code_uri" => "https://github.com/contribsys/faktory_worker_ruby"
   }
 
-  gem.add_dependency                  'connection_pool', '~> 2.2', ">= 2.2.2"
-  gem.add_development_dependency      'activejob', '>= 5.2.0'
-  gem.add_development_dependency      'minitest', '~> 5'
-  gem.add_development_dependency      'minitest-hooks'
-  gem.add_development_dependency      'rake'
+  gem.add_dependency "connection_pool", "~> 2.2", ">= 2.2.2"
+  gem.add_development_dependency "activejob", ">= 5.2.0"
+  gem.add_development_dependency "minitest", "~> 5"
+  gem.add_development_dependency "minitest-hooks"
+  gem.add_development_dependency "rake"
 end

data/lib/active_job/queue_adapters/faktory_adapter.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'active_job'
+require "active_job"
 
 module ActiveJob
   module QueueAdapters
@@ -10,21 +10,21 @@ module ActiveJob
     #
     #   Rails.application.config.active_job.queue_adapter = :faktory
     class FaktoryAdapter
-      def enqueue(job) #:nodoc:
+      def enqueue(job) # :nodoc:
         enqueue_at(job, nil)
       end
 
-      def enqueue_at(job, timestamp) #:nodoc:
+      def enqueue_at(job, timestamp) # :nodoc:
         jid = SecureRandom.hex(12)
         job.provider_job_id = jid
         hash = {
-          "jid"     => jid,
+          "jid" => jid,
           "jobtype" => JobWrapper.to_s,
-          "custom"  => {
-            "wrapped" => job.class.to_s,
+          "custom" => {
+            "wrapped" => job.class.to_s
           },
-          "queue"   => job.queue_name,
-          "args"    => [ job.serialize ],
+          "queue" => job.queue_name,
+          "args" => [job.serialize]
         }
         opts = job.faktory_options_hash.dup
         hash["at"] = Time.at(timestamp).utc.to_datetime.rfc3339(9) if timestamp
@@ -40,7 +40,7 @@ module ActiveJob
         end
       end
 
-      class JobWrapper #:nodoc:
+      class JobWrapper # :nodoc:
         include Faktory::Job
 
         def perform(job_data)
@@ -55,7 +55,7 @@ module ActiveJob
     self.faktory_options_hash = {}
 
     def self.faktory_options(hsh)
-      self.faktory_options_hash = self.faktory_options_hash.stringify_keys.merge(hsh.stringify_keys)
+      self.faktory_options_hash = faktory_options_hash.stringify_keys.merge(hsh.stringify_keys)
     end
   end
 end

data/lib/faktory/batch.rb

@@ -87,10 +87,14 @@ module Faktory
     attr_reader :bid
     attr_accessor :description, :parent_bid
 
-    def initialize(bid=nil)
+    def initialize(bid = nil)
       @bid = bid
     end
 
+    def parent=(parent)
+      @parent_bid = parent.bid
+    end
+
     def success=(val)
       raise "Batch cannot be modified once created" if bid
       @success = to_callback(val)
@@ -127,9 +131,9 @@ module Faktory
     def to_callback(val)
       case val
       when String
-        basic_job.merge({ "jobtype" => val })
+        basic_job.merge({"jobtype" => val})
       when Class
-        basic_job.merge({ "jobtype" => val })
+        basic_job.merge({"jobtype" => val})
       when Hash
         basic_job.merge(val)
       else
@@ -139,9 +143,9 @@ module Faktory
 
     def basic_job
       {
-        "jid"   => SecureRandom.hex(12),
-        "args"  => [],
-        "queue" => "default",
+        "jid" => SecureRandom.hex(12),
+        "args" => [],
+        "queue" => "default"
       }
     end
   end
@@ -152,7 +156,7 @@ module Faktory
     end
 
     def hash
-      @hash ||= Faktory.server{|c| c.batch_status(@bid) }
+      @hash ||= Faktory.server { |c| c.batch_status(@bid) }
     end
 
     def created_at

data/lib/faktory/cli.rb

@@ -1,20 +1,20 @@
-# encoding: utf-8
 # frozen_string_literal: true
+
 $stdout.sync = true
 
-require 'yaml'
-require 'singleton'
-require 'optparse'
-require 'erb'
-require 'fileutils'
+require "yaml"
+require "singleton"
+require "optparse"
+require "erb"
+require "fileutils"
 
 module Faktory
   class CLI
   end
 end
 
-require 'faktory'
-require 'faktory/util'
+require "faktory"
+require "faktory/util"
 
 module Faktory
   class CLI
@@ -30,7 +30,7 @@ module Faktory
       @code = nil
     end
 
-    def parse(args=ARGV)
+    def parse(args = ARGV)
       @code = nil
 
       setup_options(args)
@@ -52,16 +52,14 @@ module Faktory
       print_banner
 
       self_read, self_write = IO.pipe
-      sigs = %w(INT TERM TTIN TSTP)
+      sigs = %w[INT TERM TTIN TSTP]
 
       sigs.each do |sig|
-        begin
-          trap sig do
-            self_write.puts(sig)
-          end
-        rescue ArgumentError
-          puts "Signal #{sig} not supported"
+        trap sig do
+          self_write.puts(sig)
         end
+      rescue ArgumentError
+        puts "Signal #{sig} not supported"
       end
 
       logger.info "Running in #{RUBY_DESCRIPTION}"
@@ -77,23 +75,23 @@ module Faktory
       # Starting here the process will now have multiple threads running.
       fire_event(:startup)
 
-      logger.debug { "Client Middleware: #{Faktory.client_middleware.map(&:klass).join(', ')}" }
-      logger.debug { "Worker Middleware: #{Faktory.worker_middleware.map(&:klass).join(', ')}" }
+      logger.debug { "Client Middleware: #{Faktory.client_middleware.map(&:klass).join(", ")}" }
+      logger.debug { "Worker Middleware: #{Faktory.worker_middleware.map(&:klass).join(", ")}" }
 
-      logger.info 'Starting processing, hit Ctrl-C to stop' if $stdout.tty?
+      logger.info "Starting processing, hit Ctrl-C to stop" if $stdout.tty?
 
-      require 'faktory/launcher'
+      require "faktory/launcher"
       @launcher = Faktory::Launcher.new(options)
 
       begin
         launcher.run
 
-        while readable_io = IO.select([self_read])
-          signal = readable_io.first[0].gets.strip
+        while self_read.wait_readable
+          signal = self_read.gets.strip
           handle_signal(signal)
         end
       rescue Interrupt
-        logger.info 'Shutting down'
+        logger.info "Shutting down"
         launcher.stop
         # Explicitly exit so busy Processor threads can't block
         # process shutdown.
@@ -103,7 +101,7 @@ module Faktory
     end
 
     def self.banner
-%q{
+      %q{
                     ,,,,
             ,,,,    |  |
             |  |    |  |
@@ -122,17 +120,17 @@ module Faktory
     def handle_signal(sig)
       Faktory.logger.debug "Got #{sig} signal"
       case sig
-      when 'INT'
+      when "INT"
         raise Interrupt
-      when 'TERM'
+      when "TERM"
         # Heroku sends TERM and then waits 30 seconds for process to exit.
         raise Interrupt
-      when 'TSTP'
+      when "TSTP"
         Faktory.logger.info "Received TSTP, no longer accepting new work"
         launcher.quiet
-      when 'TTIN'
+      when "TTIN"
         Thread.list.each do |thread|
-          Faktory.logger.warn "Thread TID-#{thread.object_id.to_s(36)} #{thread['faktory_label']}"
+          Faktory.logger.warn "Thread TID-#{thread.object_id.to_s(36)} #{thread["faktory_label"]}"
           if thread.backtrace
             Faktory.logger.warn thread.backtrace.join("\n")
           else
@@ -146,15 +144,15 @@ module Faktory
 
     def print_banner
       # Print logo and banner for development
-      if environment == 'development' && $stdout.tty?
-        puts "\e[#{31}m"
+      if environment == "development" && $stdout.tty?
+        puts "\e[31m"
         puts Faktory::CLI.banner
         puts "\e[0m"
       end
     end
 
     def set_environment(cli_env)
-      @environment = cli_env || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
+      @environment = cli_env || ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"
     end
 
     alias_method :die, :exit
@@ -178,18 +176,18 @@ module Faktory
     end
 
     def boot_system
-      ENV['RACK_ENV'] = ENV['RAILS_ENV'] = environment
+      ENV["RACK_ENV"] = ENV["RAILS_ENV"] = environment
 
       raise ArgumentError, "#{options[:require]} does not exist" unless File.exist?(options[:require])
 
       if File.directory?(options[:require])
-        require 'rails'
-        require 'faktory/rails'
+        require "rails"
+        require "faktory/rails"
         require File.expand_path("#{options[:require]}/config/environment.rb")
         options[:tag] ||= default_tag
       else
-        not_required_message = "#{options[:require]} was not required, you should use an explicit path: " +
-            "./#{options[:require]} or /path/to/#{options[:require]}"
+        not_required_message = "#{options[:require]} was not required, you should use an explicit path: " \
+          "./#{options[:require]} or /path/to/#{options[:require]}"
 
         require(options[:require]) || raise(ArgumentError, not_required_message)
       end
@@ -198,8 +196,8 @@ module Faktory
     def default_tag
       dir = ::Rails.root
       name = File.basename(dir)
-      if name.to_i != 0 && prevdir = File.dirname(dir) # Capistrano release directory?
-        if File.basename(prevdir) == 'releases'
+      if name.to_i != 0 && (prevdir = File.dirname(dir)) # Capistrano release directory?
+        if File.basename(prevdir) == "releases"
           return File.basename(File.dirname(prevdir))
         end
       end
@@ -207,10 +205,10 @@ module Faktory
     end
 
     def validate!
-      options[:queues] << 'default' if options[:queues].empty?
+      options[:queues] << "default" if options[:queues].empty?
 
       if !File.exist?(options[:require]) ||
-         (File.directory?(options[:require]) && !File.exist?("#{options[:require]}/config/application.rb"))
+          (File.directory?(options[:require]) && !File.exist?("#{options[:require]}/config/application.rb"))
         logger.info "=================================================================="
         logger.info "  Please point Faktory to a Rails application or a Ruby file  "
         logger.info "  to load your worker classes with -r [DIR|FILE]."
@@ -228,19 +226,19 @@ module Faktory
       opts = {}
 
       @parser = OptionParser.new do |o|
-        o.on '-c', '--concurrency INT', "processor threads to use" do |arg|
+        o.on "-c", "--concurrency INT", "processor threads to use" do |arg|
           opts[:concurrency] = Integer(arg)
         end
 
-        o.on '-e', '--environment ENV', "Application environment" do |arg|
+        o.on "-e", "--environment ENV", "Application environment" do |arg|
           opts[:environment] = arg
         end
 
-        o.on '-g', '--tag TAG', "Process tag for procline" do |arg|
+        o.on "-g", "--tag TAG", "Process tag for procline" do |arg|
           opts[:tag] = arg
         end
 
-        o.on '-l', '--label LABEL', "Process label to use in Faktory UI" do |arg|
+        o.on "-l", "--label LABEL", "Process label to use in Faktory UI" do |arg|
           (opts[:labels] ||= []) << arg
         end
 
@@ -249,11 +247,11 @@ module Faktory
           parse_queue opts, queue, weight
         end
 
-        o.on '-r', '--require [PATH|DIR]', "Location of Rails application with workers or file to require" do |arg|
+        o.on "-r", "--require [PATH|DIR]", "Location of Rails application with workers or file to require" do |arg|
           opts[:require] = arg
         end
 
-        o.on '-t', '--timeout NUM', "Shutdown timeout" do |arg|
+        o.on "-t", "--timeout NUM", "Shutdown timeout" do |arg|
           opts[:timeout] = Integer(arg)
         end
 
@@ -261,11 +259,11 @@ module Faktory
           opts[:verbose] = arg
         end
 
-        o.on '-C', '--config PATH', "path to YAML config file" do |arg|
+        o.on "-C", "--config PATH", "path to YAML config file" do |arg|
           opts[:config_file] = arg
         end
 
-        o.on '-V', '--version', "Print version and exit" do |arg|
+        o.on "-V", "--version", "Print version and exit" do |arg|
           puts "Faktory #{Faktory::VERSION}"
           die(0)
         end
@@ -294,12 +292,10 @@ module Faktory
     def parse_config(cfile)
       opts = {}
       if File.exist?(cfile)
-        opts = YAML.load(ERB.new(IO.read(cfile)).result) || opts
+        src = ERB.new(IO.read(cfile)).result
+        opts = YAML.safe_load(src, permitted_classes: [Symbol], aliases: true) || {}
         opts = opts.merge(opts.delete(environment) || {})
         parse_queues(opts, opts.delete(:queues) || [])
-      else
-        # allow a non-existent config file so Faktory
-        # can be deployed by cap with just the defaults.
       end
       opts
     end
@@ -308,9 +304,9 @@ module Faktory
       queues_and_weights.each { |queue_and_weight| parse_queue(opts, *queue_and_weight) }
     end
 
-    def parse_queue(opts, q, weight=nil)
+    def parse_queue(opts, q, weight = nil)
       [weight.to_i, 1].max.times do
-       (opts[:queues] ||= []) << q
+        (opts[:queues] ||= []) << q
       end
       opts[:strict] = false if weight.to_i > 0
     end