delayed_job_groups_plugin 0.3.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d1a906f965ab26f60407c3a5b10a9e1405b39e3c
-  data.tar.gz: 7cf5b5a7b17135b3de0788de8da05b6852101fc3
+SHA256:
+  metadata.gz: '08082884f93f3a0b28ca97d8d212b5ad59defaf7ecc08987654e81433ee2f3ab'
+  data.tar.gz: 6e1287e9ddced955fa2be1e29d4444c53051321908ba8e4b863bd41f44f2c6a9
 SHA512:
-  metadata.gz: ac0d877eeac021a5da0d2bf48185fa5507c35e89d8791fd0ccf6de52181cc961c3fde975eee83be4b8dacbb252743f566d35362072c779a59e71c4a515fb497e
-  data.tar.gz: ded7fd3760219acbf979050767a58147c12c2f7aea7ba74523672ea41a21c413399ab64c416adeef7715047fda953aafdb0203cee7955d7e759d79248b7931dd
+  metadata.gz: f1e613c4575fba5d4c15a140ecb0968fe308d7f46bc229c87fd38b547d14fbd5aa80118b8bd73218a8024a0a342387cc06b566c88f36f91ab40215765db1e6e9
+  data.tar.gz: a1684af456260bbe492af11d894837cfa5e4fb0c27cbc799e5df65b1aa08d51b1cdb869e99ec97a3de4f388449174243ddda99a64222c880f24b38377d0008f9

data/.circleci/config.yml

@@ -0,0 +1,72 @@
+version: 2.1
+jobs:
+  lint:
+    docker:
+      - image: salsify/ruby_ci:2.5.8
+    working_directory: ~/delayed_job_groups
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - v1-gems-ruby-2.5.8-{{ checksum "delayed_job_groups.gemspec" }}-{{ checksum "Gemfile" }}
+            - v1-gems-ruby-2.5.8-
+      - run:
+          name: Install Gems
+          command: |
+            if ! bundle check --path=vendor/bundle; then
+              bundle install --path=vendor/bundle --jobs=4 --retry=3
+              bundle clean
+            fi
+      - save_cache:
+          key: v1-gems-ruby-2.5.8-{{ checksum "delayed_job_groups.gemspec" }}-{{ checksum "Gemfile" }}
+          paths:
+            - "vendor/bundle"
+            - "gemfiles/vendor/bundle"
+      - run:
+          name: Run Rubocop
+          command: bundle exec rubocop
+  test:
+    parameters:
+      gemfile:
+        type: string
+    docker:
+      - image: salsify/ruby_ci:2.5.8
+    environment:
+      CIRCLE_TEST_REPORTS: "test-results"
+      BUNDLE_GEMFILE: << parameters.gemfile >>
+    working_directory: ~/delayed_job_groups
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - v1-gems-ruby-2.5.8-{{ checksum "delayed_job_groups.gemspec" }}-{{ checksum "<< parameters.gemfile >>" }}
+            - v1-gems-ruby-2.5.8-
+      - run:
+          name: Install Gems
+          command: |
+            if ! bundle check --path=vendor/bundle; then
+              bundle install --path=vendor/bundle --jobs=4 --retry=3
+              bundle clean
+            fi
+      - save_cache:
+          key: v1-gems-ruby-2.5.8-{{ checksum "delayed_job_groups.gemspec" }}-{{ checksum "<< parameters.gemfile >>" }}
+          paths:
+            - "vendor/bundle"
+            - "gemfiles/vendor/bundle"
+      - run:
+          name: Run Tests
+          command: |
+            bundle exec rspec --format RspecJunitFormatter --out $CIRCLE_TEST_REPORTS/rspec/junit.xml --format progress spec
+      - store_test_results:
+          path: "test-results"
+workflows:
+  build:
+    jobs:
+      - lint
+      - test:
+          matrix:
+            parameters:
+              gemfile:
+              - "gemfiles/rails_5.2.gemfile"
+              - "gemfiles/rails_6.0.gemfile"
+              - "gemfiles/rails_6.1.gemfile"

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,11 @@
+inherit_gem:
+  salsify_rubocop: conf/rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - 'vendor/**/*'
+    - 'gemfiles/vendor/**/*'
+
+Style/FrozenStringLiteralComment:
+  Enabled: true

data/Appraisals

@@ -0,0 +1,17 @@
+# 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
+
+appraise 'rails-6.1' do
+  gem 'activerecord', '6.1.0'
+  gem 'activesupport', '6.1.0'
+end

data/CHANGELOG.md

@@ -1,6 +1,29 @@
 # Changelog
 
-### 0.3.0 (unreleased)
+### 0.6.0
+* A support for Rails 6.1.
+
+### 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
@@ -13,5 +36,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,37 +10,33 @@ 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.1'
+  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.2'])
-  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'appraisal'
+  spec.add_dependency 'activerecord', '>= 5.2', '< 7'
+  spec.add_development_dependency 'coveralls_reborn', '>= 0.18.0'
   spec.add_development_dependency 'database_cleaner', '>= 1.2'
-  # rspec < 3.5 requires rake < 11.0
-  spec.add_development_dependency 'rake', '< 11.0'
-  spec.add_development_dependency 'rspec', '>= 2.14', '< 2.99'
-  spec.add_development_dependency 'simplecov', '~> 0.7.1'
+  spec.add_development_dependency 'mime-types'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'rspec-its'
+  spec.add_development_dependency 'rspec_junit_formatter'
+  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/gemfiles/rails_6.1.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "6.1.0"
+gem "activesupport", "6.1.0"
+
+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,4 +1,4 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
 module Delayed
   module JobGroups

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: '::Delayed::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: '::Delayed::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.3.0'
+    VERSION = '0.6.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