delayed_job_groups_plugin 0.4.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e0fcf7a3d3099755aad28122f38afb96cec8896576cb54b47c2b4f7adfd2b94
-  data.tar.gz: 5241cc7d7365f07179896559c1aae27df4bf1e8010a49b2e0a2323f752b9efe4
+  metadata.gz: a6ebba61f2d0ba4a6ab2572a5648030c14b58ae99e4412fbd4a89257128f587a
+  data.tar.gz: 5c1457109671e7ab379f32d3a5e52750de3fd775fa83c3a70723fec29b146d0b
 SHA512:
-  metadata.gz: a6e7381efe91a0aa89492a58f7820e71f3c6d6c35d1e5ddaf4dd777dd63d6707f5f268587569a7da1f57dcd404df859f9980e9bbae1acffbf54c76841f0af8f1
-  data.tar.gz: '029c2dd29ed387c254f869c58295c41b446bfb42f87948e5980047ab47c2f7571fe794b65e7f9aa4d73162771d61361e67d6495f7ba4e02e754da29be0ee611e'
+  metadata.gz: f25332bf31e68b50e1925dd77407caaf0e577f997804dadb24a9c1fce0045353431d48187d69582b3884217a928df2a91157d4ee9e7d8c7e45889860222b89ba
+  data.tar.gz: ff86634ad4296c5c4f2e17cbc0acee72e1c9d97b567298565d2fa457ac69245f47348cc7551dbfe397a9fd8e552a1bd994e7f487cd5fe8cd7a0eaef3da75fd1c

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/.rubocop.yml

@@ -2,7 +2,10 @@ inherit_gem:
   salsify_rubocop: conf/rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.5
+  Exclude:
+    - 'vendor/**/*'
+    - 'gemfiles/vendor/**/*'
 
 Style/FrozenStringLiteralComment:
   Enabled: true

data/Appraisals

@@ -1,21 +1,17 @@
 # frozen_string_literal: true
 
-appraise 'rails-4.2' do
-  gem 'activerecord', '4.2.10'
-  gem 'activesupport', '4.2.10'
-end
-
-appraise 'rails-5.0' do
-  gem 'activerecord', '5.0.7'
-  gem 'activesupport', '5.0.7'
+appraise 'rails-5.2' do
+  gem 'sqlite3', '~> 1.3.6'
+  gem 'activerecord', '5.2.1'
+  gem 'activesupport', '5.2.1'
 end
 
-appraise 'rails-5.1' do
-  gem 'activerecord', '5.1.6'
-  gem 'activesupport', '5.1.6'
+appraise 'rails-6.0' do
+  gem 'activerecord', '6.0.3'
+  gem 'activesupport', '6.0.3'
 end
 
-appraise 'rails-5.2' do
-  gem 'activerecord', '5.2.1 '
-  gem 'activesupport', '5.2.1 '
+appraise 'rails-6.1' do
+  gem 'activerecord', '6.1.0'
+  gem 'activesupport', '6.1.0'
 end

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+### 0.6.2
+* Defer including extension until delayed_job_active_record is loaded
+
+### 0.6.1
+* Fix job_group_id `belongs_to` behavior when `config.active_record.belongs_to_required_by_default` is enabled.
+
+### 0.6.0
+* Add 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
 

data/README.md

@@ -100,7 +100,8 @@ 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)
 ```
 

data/delayed_job_groups.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = Dir.glob('spec/**/*')
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.3'
+  spec.required_ruby_version = '>= 2.5'
 
   spec.add_dependency 'delayed_job', '>= 4.1'
   spec.add_dependency 'delayed_job_active_record', '>= 4.1'
@@ -27,13 +27,14 @@ Gem::Specification.new do |spec|
   spec.post_install_message = 'See https://github.com/salsify/delayed_job_groups_plugin#installation for upgrade/installation notes.'
 
   spec.add_development_dependency 'appraisal'
-  spec.add_dependency 'activerecord', '>= 4.2', '< 5.3'
-  spec.add_development_dependency 'coveralls'
+  spec.add_dependency 'activerecord', '>= 5.2', '< 7'
+  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', '~> 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'

data/gemfiles/rails_5.2.gemfile

@@ -2,7 +2,8 @@
 
 source "https://rubygems.org"
 
-gem "activerecord", "5.2.1 "
-gem "activesupport", "5.2.1 "
+gem "sqlite3", "~> 1.3.6"
+gem "activerecord", "5.2.1"
+gem "activesupport", "5.2.1"
 
 gemspec path: "../"

data/gemfiles/{rails_5.0.gemfile → rails_6.0.gemfile}

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "activerecord", "5.0.7"
-gem "activesupport", "5.0.7"
+gem "activerecord", "6.0.3"
+gem "activesupport", "6.0.3"
 
 gemspec path: "../"

data/gemfiles/{rails_5.1.gemfile → rails_6.1.gemfile}

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "activerecord", "5.1.6"
-gem "activesupport", "5.1.6"
+gem "activerecord", "6.1.0"
+gem "activesupport", "6.1.0"
 
 gemspec path: "../"

data/lib/delayed/job_groups/job_extensions.rb

@@ -15,7 +15,7 @@ module Delayed
           attr_accessible :job_group_id, :blocked
         end
 
-        belongs_to :job_group, class_name: 'Delayed::JobGroups::JobGroup'
+        belongs_to :job_group, class_name: 'Delayed::JobGroups::JobGroup', required: false
 
         class << self
           prepend ReadyToRunExtension

data/lib/delayed/job_groups/plugin.rb

@@ -28,8 +28,9 @@ module Delayed
 
         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
@@ -44,6 +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/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Delayed
+  module JobGroups
+    class Railtie < ::Rails::Railtie
+      config.after_initialize do
+        Delayed::Backend::ActiveRecord::Job.include(Delayed::JobGroups::JobExtensions)
+      end
+    end
+  end
+end

data/lib/delayed/job_groups/version.rb

@@ -2,6 +2,6 @@
 
 module Delayed
   module JobGroups
-    VERSION = '0.4.1'
+    VERSION = '0.6.2'
   end
 end

data/lib/delayed_job_groups_plugin.rb

@@ -11,6 +11,12 @@ 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)
+if defined?(Rails::Railtie)
+  # Postpone initialization to railtie for correct order
+  require 'delayed/job_groups/railtie'
+else
+  # Do the same as in the railtie
+  Delayed::Backend::ActiveRecord::Job.include(Delayed::JobGroups::JobExtensions)
+end
 
 Delayed::Worker.plugins << Delayed::JobGroups::Plugin

data/lib/generators/delayed_job_groups_plugin/install_generator.rb

@@ -11,7 +11,7 @@ module DelayedJobGroupsPlugin
     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)

data/lib/generators/delayed_job_groups_plugin/templates/{migration.rb → migration.erb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class CreateDelayedJobGroups < ActiveRecord::Migration
+class CreateDelayedJobGroups < ActiveRecord::Migration[<%= ActiveRecord::VERSION::MAJOR %>.<%= ActiveRecord::VERSION::MINOR %>]
 
   def up
     add_column(:delayed_jobs, :blocked, :boolean, default: false, null: false)

data/spec/delayed/job_groups/job_extensions_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+describe "delayed job extensions" do
+  it "provides an optional job_group_id" do
+    job_group = Delayed::JobGroups::JobGroup.create!
+    expect(Delayed::Job.new(job_group_id: job_group.id)).to be_valid
+    expect(Delayed::Job.new).to be_valid
+  end
+end

data/spec/delayed/job_groups/job_group_spec.rb

@@ -103,7 +103,7 @@ describe Delayed::JobGroups::JobGroup do
 
     context "when on failed jobs exist" do
       before do
-        job.update_attributes!(failed_at: Time.now)
+        job.update!(failed_at: Time.now)
         Delayed::JobGroups::JobGroup.check_for_completion(job_group.id)
       end
 
@@ -229,7 +229,7 @@ describe Delayed::JobGroups::JobGroup do
     let(:failure_cancels_group) { true }
 
     before do
-      job_group.update_attributes!(failure_cancels_group: failure_cancels_group)
+      job_group.update!(failure_cancels_group: failure_cancels_group)
     end
 
     context "when failures should cancel the group" do

data/spec/delayed/job_groups/plugin_spec.rb

@@ -83,6 +83,7 @@ describe Delayed::JobGroups::Plugin do
 
         # Run the job which should fail and cancel the JobGroup
         Delayed::Worker.new.work_off(1)
+        # Completion job is not invoked
         expect(CompletionJob.invoked).to be(false)
         expect(failed_job_count).to eq 1
         expect(queued_job_count).to eq 0
@@ -92,7 +93,7 @@ describe Delayed::JobGroups::Plugin do
 
     context "with failure_cancels_group disabled" do
 
-      before { job_group.update_attributes!(failure_cancels_group: false) }
+      before { job_group.update!(failure_cancels_group: false) }
 
       it "does not cancel the group" do
         Delayed::Worker.max_attempts = 1
@@ -109,6 +110,59 @@ describe Delayed::JobGroups::Plugin do
         expect(failed_job_count).to eq 1
         expect(queued_job_count).to eq 1
         expect(job_group_count).to eq 1
+
+        # Run the last job
+        Delayed::Worker.new.work_off(1)
+        expect(failed_job_count).to eq 1
+        expect(queued_job_count).to eq 1
+        expect(job_group_count).to eq 0
+
+        # Run the completion job
+        Delayed::Worker.new.work_off(1)
+        # Completion job is invoked
+        expect(CompletionJob.invoked).to be(true)
+        expect(failed_job_count).to eq 1
+        expect(queued_job_count).to eq 0
+        expect(job_group_count).to eq 0
+      end
+
+      it "runs completion job if last job failed" do
+        Delayed::Worker.max_attempts = 2
+
+        job_group.enqueue(NoOpJob.new)
+        job_group.enqueue(FailingJob.new)
+        job_group.mark_queueing_complete
+        expect(queued_job_count).to eq 2
+        expect(job_group_count).to eq 1
+
+        # Run the non failing job
+        Delayed::Worker.new.work_off(1)
+        expect(failed_job_count).to eq 0
+        expect(queued_job_count).to eq 1
+        expect(job_group_count).to eq 1
+
+        # Run the job which should error
+        Delayed::Worker.new.work_off(1)
+        # Completion job is not invoked
+        expect(CompletionJob.invoked).to be(false)
+        expect(failed_job_count).to eq 0
+        expect(queued_job_count).to eq 1
+        expect(job_group_count).to eq 1
+
+        # Run the job again which should fail
+        Timecop.travel(1.minute.from_now)
+        Delayed::Worker.new.work_off(1)
+        expect(failed_job_count).to eq 1
+        expect(queued_job_count).to eq 1
+        expect(job_group_count).to eq 0
+
+        # Run the completion job
+        Delayed::Worker.new.work_off(1)
+        # Completion job is invoked
+        expect(CompletionJob.invoked).to be(true)
+        expect(failed_job_count).to eq 1
+        expect(queued_job_count).to eq 0
+        expect(job_group_count).to eq 0
       end
     end
   end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: delayed_job_groups_plugin
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Joel Turkel
 - Randy Burkes
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-01-18 00:00:00.000000000 Z
+date: 2021-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: delayed_job
@@ -59,34 +59,34 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '7'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: coveralls_reborn
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.18.0
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
@@ -157,6 +157,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  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: salsify_rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -222,10 +236,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - Gemfile
@@ -233,21 +247,22 @@ files:
 - README.md
 - Rakefile
 - delayed_job_groups.gemspec
-- gemfiles/rails_4.2.gemfile
-- gemfiles/rails_5.0.gemfile
-- gemfiles/rails_5.1.gemfile
 - gemfiles/rails_5.2.gemfile
+- gemfiles/rails_6.0.gemfile
+- gemfiles/rails_6.1.gemfile
 - lib/delayed/job_groups/compatibility.rb
 - lib/delayed/job_groups/job_extensions.rb
 - lib/delayed/job_groups/job_group.rb
 - lib/delayed/job_groups/plugin.rb
+- lib/delayed/job_groups/railtie.rb
 - lib/delayed/job_groups/version.rb
 - lib/delayed/job_groups/yaml_loader.rb
 - lib/delayed_job_groups_plugin.rb
 - lib/generators/delayed_job_groups_plugin/install_generator.rb
-- lib/generators/delayed_job_groups_plugin/templates/migration.rb
+- lib/generators/delayed_job_groups_plugin/templates/migration.erb
 - spec/db/database.yml
 - spec/db/schema.rb
+- spec/delayed/job_groups/job_extensions_spec.rb
 - spec/delayed/job_groups/job_group_spec.rb
 - spec/delayed/job_groups/plugin_spec.rb
 - spec/delayed/job_groups/yaml_loader_spec.rb
@@ -266,16 +281,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Delayed::Job job groups plugin
 test_files:
@@ -284,5 +298,6 @@ test_files:
 - spec/delayed/job_groups/plugin_spec.rb
 - spec/delayed/job_groups/job_group_spec.rb
 - spec/delayed/job_groups/yaml_loader_spec.rb
+- spec/delayed/job_groups/job_extensions_spec.rb
 - spec/db/schema.rb
 - spec/db/database.yml

data/.travis.yml

@@ -1,14 +0,0 @@
-language: ruby
-sudo: false
-gemfile:
-  - gemfiles/rails_4.2.gemfile
-  - gemfiles/rails_5.0.gemfile
-  - gemfiles/rails_5.1.gemfile
-  - gemfiles/rails_5.2.gemfile
-rvm:
-  - 2.3.8
-  - 2.4.5
-  - 2.5.3
-script:
-  - bundle exec rspec
-  - bundle exec rubocop

data/gemfiles/rails_4.2.gemfile

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