delayed_job_groups_plugin 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d5409e2a3bc8eebbe71680ca0275c194b3eb0707
-  data.tar.gz: 781737c5ed0983a1029f7ee1a098924973a2adf7
+SHA256:
+  metadata.gz: e66577a1ef061e5623346875c94024af0dccf4f15f3788d86c9fab410b5a3620
+  data.tar.gz: 4353a8d9b1bcbe29c256367e5ad3502cdd93ebd2a351e90a1c706294661dfd28
 SHA512:
-  metadata.gz: ba7664bd77f42330c748ab9ab642fdf88e235620ba41df98965fcea38620653e9d69743b97c947fa25e5abd2e3227deae21268138178645fb7836fac0814a6b5
-  data.tar.gz: f766f35242d34702ae6a25453777552adf90e134f66ef179e47bc25afef5f6649c2724e60ee3497c3a0645ec74c2c7d2b6b5c74b3803333b99e112d3d2bf2f5f
+  metadata.gz: b872e26617a67db33ca43d8da7bb24ebfaa253a1c110aff02204c7d64f54b4852cf98b6804cefabfb2dba700fdab6f9eda5fe6edd2881490ec26fe59a42fb111
+  data.tar.gz: 16154ad9d50605537785e50dda77f1500bb67fff8035d2c41e311956ff34b312d44749904f6d606436698ddbaae0858816a27a5c690e5fd5d756e8bf4cd17e54

data/.gitignore

@@ -18,3 +18,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+*.gemfile.lock

data/.rspec

@@ -1,2 +1,3 @@
 --color
 --format progress
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_gem:
+  salsify_rubocop: conf/rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+
+Style/FrozenStringLiteralComment:
+  Enabled: true

data/.travis.yml

@@ -1,22 +1,12 @@
 language: ruby
-env:
-  - RAILS_VERSION="~> 3.2.21" JRUBY_OPTS="$JRUBY_OPTS --debug"
-  - RAILS_VERSION="~> 4.0.13" JRUBY_OPTS="$JRUBY_OPTS --debug"
-  - RAILS_VERSION="~> 4.1.9" JRUBY_OPTS="$JRUBY_OPTS --debug"
-  - RAILS_VERSION="~> 4.2.0" JRUBY_OPTS="$JRUBY_OPTS --debug"
+sudo: false
+gemfile:
+  - gemfiles/rails_5.2.gemfile
+  - gemfiles/rails_6.0.gemfile
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - 2.2.0
-  - jruby-19mode
-matrix:
-  exclude:
-    # See https://github.com/salsify/goldiloader/issues/22
-    - rvm: jruby-19mode
-      env: RAILS_VERSION="~> 4.2.0" JRUBY_OPTS="$JRUBY_OPTS --debug"
-    # See https://github.com/rails/rails/pull/18306
-    - rvm: 2.2.0
-      env: RAILS_VERSION="~> 3.2.21" JRUBY_OPTS="$JRUBY_OPTS --debug"
-before_install:
-  - gem install bundler
+  - 2.5.8
+  - 2.6.6
+  - 2.7.2
+script:
+  - bundle exec rspec
+  - bundle exec rubocop

data/Appraisals

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+appraise 'rails-5.2' do
+  gem 'sqlite3', '~> 1.3.6'
+  gem 'activerecord', '5.2.1'
+  gem 'activesupport', '5.2.1'
+end
+
+appraise 'rails-6.0' do
+  gem 'activerecord', '6.0.3'
+  gem 'activesupport', '6.0.3'
+end

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+### 0.5.0
+* Drop support for Ruby 2.3 and 2.4.
+* Drop support for Rails < 5.2.
+* Bugfix for rails version in generated migration files
+
+### 0.4.3
+* Bugfix for `on_completion_job` when `failure_cancels_group` is set to false.
+
+### 0.4.2
+* Add support for Rails 6.0.
+
+### 0.4.1
+* Bugfix for `on_completion_job` and `on_cancellation_job` YAML serialization
+
+### 0.4.0
+* Drop support for Ruby 2.0, 2.1 and 2.2.
+* Add support for Ruby 2.5.
+* Drop support for Rails < 4.2.
+* Add support for Rails 5.2
+
+### 0.3.0
+* Drop support for Ruby 1.9 and 2.0.
+
 ### 0.2.0
 * Change supported delayed job version
 * Clean up lifecycle management in plugin
@@ -10,5 +33,5 @@
 ### 0.1.2
 * Add configuration option to allow failed jobs not to cancel a group.
 
-### 0.1.1 
+### 0.1.1
 * Update the run_at for all jobs in a JobGroup when it's unblocked.

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/README.md

@@ -100,15 +100,16 @@ job_group.cancel
 
 Configuration to allow failed jobs not to cancel the group
 ```ruby
-# We can optionally pass options that will allow jobs to fail without cancelling the group
+# We can optionally pass options that will allow jobs to fail without cancelling the group.
+# This also allows the on_completion job to fire once all jobs have either succeeded or failed. 
 job_group = Delayed::JobGroups::JobGroup.create!(failure_cancels_group: false)
 ```
 
 ## Supported Platforms
 
 * Only the Delayed Job Active Record backend is supported.
-* Tested with Rails 3.2 and 4.0.
-* Tested with MRI 1.9.3, 2.0.0, 2.1.0 and JRuby in 1.9 mode.
+* Tested with Rails 4.2 through 5.2.
+* Tested with MRI 2.3 through 2.5.
 
 ## Contributing
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/setup'
 Bundler::GemHelper.install_tasks
 

data/delayed_job_groups.gemspec

@@ -1,4 +1,6 @@
-# encoding: UTF-8
+
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'delayed/job_groups/version'
@@ -8,34 +10,32 @@ Gem::Specification.new do |spec|
   spec.version       = Delayed::JobGroups::VERSION
   spec.authors       = ['Joel Turkel', 'Randy Burkes']
   spec.email         = ['jturkel@salsify.com', 'rlburkes@gmail.com']
-  spec.description   = %q{Aggregates Delayed::Job jobs into groups with group level management and lifecycle callbacks}
-  spec.summary       = %q{Delayed::Job job groups plugin}
+  spec.description   = 'Aggregates Delayed::Job jobs into groups with group level management and lifecycle callbacks'
+  spec.summary       = 'Delayed::Job job groups plugin'
   spec.homepage      = 'https://github.com/salsify/delayed_job_groups_plugin'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.test_files    = Dir.glob('spec/**/*')
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.5'
+
   spec.add_dependency 'delayed_job', '>= 4.1'
-  spec.add_dependency 'delayed_job_active_record', '>= 0.4'
+  spec.add_dependency 'delayed_job_active_record', '>= 4.1'
 
   spec.post_install_message = 'See https://github.com/salsify/delayed_job_groups_plugin#installation for upgrade/installation notes.'
 
-  spec.add_development_dependency 'activerecord', ENV.fetch('RAILS_VERSION', ['>= 3.2', '< 5.0'])
-  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'appraisal'
+  spec.add_dependency 'activerecord', '>= 5.2', '< 6.1'
+  spec.add_development_dependency 'coveralls_reborn', '>= 0.18.0'
   spec.add_development_dependency 'database_cleaner', '>= 1.2'
+  spec.add_development_dependency 'mime-types'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '>= 2.14', '< 2.99'
-  spec.add_development_dependency 'simplecov', '~> 0.7.1'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'rspec-its'
+  spec.add_development_dependency 'salsify_rubocop', '0.52.1.1'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'timecop'
-  spec.add_development_dependency 'mime-types', '~> 2'
-
-  if RUBY_PLATFORM == 'java'
-    spec.add_development_dependency 'jdbc-sqlite3'
-    spec.add_development_dependency 'activerecord-jdbcsqlite3-adapter'
-  else
-    spec.add_development_dependency 'sqlite3'
-  end
-
 end

data/gemfiles/rails_5.2.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sqlite3", "~> 1.3.6"
+gem "activerecord", "5.2.1 "
+gem "activesupport", "5.2.1 "
+
+gemspec path: "../"

data/gemfiles/rails_6.0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "6.0.3"
+gem "activesupport", "6.0.3"
+
+gemspec path: "../"

data/lib/delayed/job_groups/compatibility.rb

@@ -1,4 +1,4 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
 require 'active_support/version'
 require 'active_record/version'
@@ -8,7 +8,7 @@ module Delayed
     module Compatibility
 
       def self.mass_assignment_security_enabled?
-        ::ActiveRecord::VERSION::MAJOR < 4 || defined?(::ActiveRecord::MassAssignmentSecurity)
+        defined?(::ActiveRecord::MassAssignmentSecurity)
       end
 
     end

data/lib/delayed/job_groups/job_extensions.rb

@@ -1,9 +1,14 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
 module Delayed
   module JobGroups
     module JobExtensions
       extend ActiveSupport::Concern
+      module ReadyToRunExtension
+        def ready_to_run(worker_name, max_run_time)
+          super(worker_name, max_run_time).where(blocked: false)
+        end
+      end
 
       included do
         if Delayed::JobGroups::Compatibility.mass_assignment_security_enabled?
@@ -13,15 +18,9 @@ module Delayed
         belongs_to :job_group, class_name: 'Delayed::JobGroups::JobGroup'
 
         class << self
-
-          # Patch ready_to_run to exclude blocked jobs
-          def ready_to_run_with_blocked_filtering(worker_name, max_run_time)
-            ready_to_run_without_blocked_filtering(worker_name, max_run_time).where(blocked: false)
-          end
-          alias_method_chain :ready_to_run, :blocked_filtering
+          prepend ReadyToRunExtension
         end
       end
-
       def in_job_group?
         job_group_id.present?
       end

data/lib/delayed/job_groups/job_group.rb

@@ -1,4 +1,6 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
+require_relative 'yaml_loader'
 
 module Delayed
   module JobGroups
@@ -11,29 +13,19 @@ module Delayed
                         :on_cancellation_job_options, :failure_cancels_group
       end
 
-      serialize :on_completion_job
+      serialize :on_completion_job, Delayed::JobGroups::YamlLoader
       serialize :on_completion_job_options, Hash
-      serialize :on_cancellation_job
+      serialize :on_cancellation_job, Delayed::JobGroups::YamlLoader
       serialize :on_cancellation_job_options, Hash
 
       validates :queueing_complete, :blocked, :failure_cancels_group, inclusion: [true, false]
 
-      if ActiveRecord::VERSION::MAJOR >= 4
-        has_many :active_jobs, -> { where(failed_at: nil) }, class_name: Job
-      else
-        has_many :active_jobs, class_name: Job, conditions: {failed_at: nil}
-      end
-
+      has_many :active_jobs, -> { where(failed_at: nil) }, class_name: '::Delayed::Job'
 
       # Only delete dependent jobs that are unlocked so we can determine if there are in-flight jobs
       # for canceled job groups
-      if ActiveRecord::VERSION::MAJOR >= 4
-        has_many :queued_jobs, -> { where(failed_at: nil, locked_by: nil) }, class_name: Job,
-                 dependent: :delete_all
-      else
-        has_many :queued_jobs, class_name: Job, conditions: {failed_at: nil, locked_by: nil},
-                 dependent: :delete_all
-      end
+      has_many :queued_jobs, -> { where(failed_at: nil, locked_by: nil) }, class_name: '::Delayed::Job',
+                dependent: :delete_all
 
       def mark_queueing_complete
         with_lock do
@@ -78,7 +70,7 @@ module Delayed
         end
       end
 
-      def self.has_pending_jobs?(job_group_ids)
+      def self.has_pending_jobs?(job_group_ids) # rubocop:disable Naming/PredicateName
         job_group_ids = Array(job_group_ids)
         return false if job_group_ids.empty?
         Delayed::Job.where(job_group_id: job_group_ids, failed_at: nil).exists?

data/lib/delayed/job_groups/plugin.rb

@@ -1,4 +1,4 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
 require 'delayed_job'
 require 'set'
@@ -8,7 +8,7 @@ module Delayed
     class Plugin < Delayed::Plugin
 
       callbacks do |lifecycle|
-        lifecycle.before(:error) do |worker, job|
+        lifecycle.before(:error) do |_worker, job|
           # If the job group has been cancelled then don't let the job be retried
           if job.in_job_group? && job_group_cancelled?(job.job_group_id)
             def job.max_attempts
@@ -17,7 +17,7 @@ module Delayed
           end
         end
 
-        lifecycle.before(:failure) do |worker, job|
+        lifecycle.before(:failure) do |_worker, job|
           # If a job in the job group fails, then cancel the whole job group.
           # Need to check that the job group is present since another
           # job may have concurrently cancelled it.
@@ -26,17 +26,16 @@ module Delayed
           end
         end
 
-        lifecycle.after(:perform) do |worker, job|
+        lifecycle.after(:perform) do |_worker, job|
           # Make sure we only check to see if the job group is complete
-          # if the job succeeded
-          if job.in_job_group? && job_completed?(job)
+          # if the job succeeded or the job has failed (maxed out retries) with failure_cancels_group
+          # set to false
+          if job.in_job_group? && (job_completed?(job) || job_acceptably_failed?(job))
             JobGroup.check_for_completion(job.job_group_id)
           end
         end
       end
 
-      private
-
       def self.job_group_cancelled?(job_group_id)
         !JobGroup.exists?(job_group_id)
       end
@@ -46,7 +45,12 @@ module Delayed
         # if it has completed
         job.destroyed?
       end
+
+      def self.job_acceptably_failed?(job)
+        # Job has set failed_at (retries have maxed out) and failure_cancels_group is false signaling
+        # that the group should complete despite failures.
+        job.failed_at.present? && job.job_group.present? && !job.job_group.failure_cancels_group?
+      end
     end
   end
 end
-

data/lib/delayed/job_groups/version.rb

@@ -1,7 +1,7 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
 module Delayed
   module JobGroups
-    VERSION = '0.2.0'
+    VERSION = '0.5.0'
   end
 end

data/lib/delayed/job_groups/yaml_loader.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Delayed
+  module JobGroups
+    module YamlLoader
+      def self.load(yaml)
+        return yaml unless yaml.is_a?(String) && /^---/.match(yaml)
+        YAML.load_dj(yaml)
+      end
+
+      def self.dump(object)
+        return if object.nil?
+        YAML.dump(object)
+      end
+    end
+  end
+end

data/lib/delayed_job_groups_plugin.rb

@@ -1,4 +1,4 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
 require 'active_support'
 require 'active_record'
@@ -8,6 +8,7 @@ require 'delayed/job_groups/compatibility'
 require 'delayed/job_groups/job_extensions'
 require 'delayed/job_groups/job_group'
 require 'delayed/job_groups/plugin'
+require 'delayed/job_groups/yaml_loader'
 require 'delayed/job_groups/version'
 
 Delayed::Backend::ActiveRecord::Job.send(:include, Delayed::JobGroups::JobExtensions)

data/lib/generators/delayed_job_groups_plugin/install_generator.rb

@@ -1,4 +1,4 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
 require 'rails/generators'
 require 'rails/generators/migration'
@@ -8,10 +8,10 @@ module DelayedJobGroupsPlugin
   class InstallGenerator < Rails::Generators::Base
     include Rails::Generators::Migration
 
-    self.source_paths << File.join(File.dirname(__FILE__), 'templates')
+    source_paths << File.join(File.dirname(__FILE__), 'templates')
 
     def create_migration_file
-      migration_template('migration.rb', 'db/migrate/create_delayed_job_groups.rb')
+      migration_template('migration.erb', 'db/migrate/create_delayed_job_groups.rb')
     end
 
     def self.next_migration_number(dirname)