delayed_job_groups_plugin 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40f1d73ab96a59d9a844454f73355c43fe4adece
-  data.tar.gz: d3f901a08c15556844f649ec5c63d2ebc8f5ae7f
+  metadata.gz: fcacb139c1ffff95f731afd57e50c3a32efc5952
+  data.tar.gz: d2693d1526a5e8bd6a00d228deee56bf6f7dfd71
 SHA512:
-  metadata.gz: 3b440e778b155e86b9ed22d00b4737b3d16ab951abffae076614ffea30d7e55cead394a51977b4e23b1f7458eda130b47963360cc6dd0aa38e49b939e3c03a68
-  data.tar.gz: 3855f98e948a154ef67918f1ef8f370da4ab3d6f01a9382a723d530e526e350d0ddbafa613adebd3ed8251b5a4dec35e90d2dd5986d83851d95e6c4d9ec791ca
+  metadata.gz: 9de8e698308f1db0c13873b4d72cfe5497e58252e36140a22a4f36db4dd863df85eb947feb3e7cd4fc9405eba47a244b43517208ab24cb868afd94cfc50a440d
+  data.tar.gz: 50abccef280bc1a0342e3d4bae3a1bfed10f3214f55ccced57424fc9d836ee31d4d887b5a4220db4e413d301f63d42b75ea4d176b950ff498405849106cbe36c

data/.travis.yml

@@ -1,10 +1,20 @@
 language: ruby
 env:
-  matrix:
-    - RAILS_VERSION="~> 3.2.19" JRUBY_OPTS="$JRUBY_OPTS --debug"
-    - RAILS_VERSION="~> 4.0.10" JRUBY_OPTS="$JRUBY_OPTS --debug"
+  - 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"
 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"

data/CHANGELOG.md

@@ -1,4 +1,9 @@
 # Changelog
 
+### 0.1.3 (Unreleased)
+
+### 0.1.2
+* Add configuration option to allow failed jobs not to cancel a group.
+
 ### 0.1.1 
 * Update the run_at for all jobs in a JobGroup when it's unblocked.

data/README.md

@@ -35,6 +35,13 @@ Run the required database migrations:
     $ rails generate delayed_job_groups_plugin:install
     $ rake db:migrate
 
+## Upgrading from 0.1.2
+run the following generator to create a migration for the new configuration column.
+
+    $ rails generate migration add_failure_cancels_group_to_delayed_job_groups failure_cancels_group:boolean
+    # add `default: true, null: false` to the generated migration for the failure_cancels_group column
+    $ rake db:migrate
+
 ## Usage
 
 Creating a job group and queueing some jobs:
@@ -91,6 +98,12 @@ job_group = Delayed::JobGroups::JobGroup.create!
 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
+job_group = Delayed::JobGroups::JobGroup.create!(failure_cancels_group: false)
+```
+
 ## Supported Platforms
 
 * Only the Delayed Job Active Record backend is supported.

data/delayed_job_groups.gemspec

@@ -6,8 +6,8 @@ require 'delayed/job_groups/version'
 Gem::Specification.new do |spec|
   spec.name          = 'delayed_job_groups_plugin'
   spec.version       = Delayed::JobGroups::VERSION
-  spec.authors       = ['Joel Turkel']
-  spec.email         = ['jturkel@salsify.com']
+  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.homepage      = 'https://github.com/salsify/delayed_job_groups_plugin'
@@ -20,6 +20,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'delayed_job', '>= 3.0'
   spec.add_dependency 'delayed_job_active_record', '>= 0.4'
 
+  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', '< 4.1'])
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'database_cleaner', '>= 1.2'

data/lib/delayed/job_groups/job_group.rb

@@ -8,7 +8,7 @@ module Delayed
 
       if Delayed::JobGroups::Compatibility.mass_assignment_security_enabled?
         attr_accessible :on_completion_job, :on_completion_job_options, :blocked, :on_cancellation_job,
-                        :on_cancellation_job_options
+                        :on_cancellation_job_options, :failure_cancels_group
       end
 
       serialize :on_completion_job
@@ -16,7 +16,7 @@ module Delayed
       serialize :on_cancellation_job
       serialize :on_cancellation_job_options, Hash
 
-      validates :queueing_complete, :blocked, inclusion: [true, false]
+      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

data/lib/delayed/job_groups/plugin.rb

@@ -34,7 +34,7 @@ module Delayed
           # 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.
-          if job.in_job_group? && job.job_group
+          if job.in_job_group? && job.job_group && job.job_group.failure_cancels_group?
             job.job_group.cancel
           end
         end

data/lib/delayed/job_groups/version.rb

@@ -2,6 +2,6 @@
 
 module Delayed
   module JobGroups
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
   end
 end

data/lib/generators/delayed_job_groups_plugin/templates/migration.rb

@@ -21,6 +21,7 @@ class CreateDelayedJobGroups < ActiveRecord::Migration
       t.text :on_completion_job_options
       t.text :on_cancellation_job
       t.text :on_cancellation_job_options
+      t.boolean :failure_cancels_group, default: true, null: false
       t.boolean :queueing_complete, default: false, null: false
       t.boolean :blocked, default: false, null: false
     end

data/spec/db/schema.rb

@@ -23,6 +23,7 @@ ActiveRecord::Schema.define(:version => 0) do
     t.text :on_completion_job_options
     t.text :on_cancellation_job
     t.text :on_cancellation_job_options
+    t.boolean :failure_cancels_group, default: true, null: false
     t.boolean :queueing_complete, default: false, null: false
     t.boolean :blocked, default: false, null: false
   end

data/spec/delayed/job_groups/job_group_spec.rb

@@ -225,4 +225,26 @@ describe Delayed::JobGroups::JobGroup do
       running_job.should_not have_been_destroyed
     end
   end
+
+  describe "#failure_cancels_group?" do
+    let(:failure_cancels_group) { true }
+
+    before do
+      job_group.update_attributes!(failure_cancels_group: failure_cancels_group)
+    end
+
+    context "when failures should cancel the group" do
+      it "returns true" do
+        expect(job_group.failure_cancels_group?).to be true
+      end
+    end
+
+    context "when failures should not cancel the group" do
+      let(:failure_cancels_group) { false }
+
+      it "returns false" do
+        expect(job_group.failure_cancels_group?).to be false
+      end
+    end
+  end
 end

data/spec/delayed/job_groups/plugin_spec.rb

@@ -74,21 +74,48 @@ describe Delayed::JobGroups::Plugin do
     queued_job_count.should eq 0
   end
 
-  it "cancels the job group if a job fails" do
-    Delayed::Worker.max_attempts = 1
+  describe "job failures" do
+
+    context "with failure_cancels_group enabled" do
+      it "cancels the group" do
+        Delayed::Worker.max_attempts = 1
+
+        job_group.enqueue(FailingJob.new)
+        job_group.enqueue(NoOpJob.new)
+        job_group.mark_queueing_complete
+        queued_job_count.should eq 2
+        job_group_count.should eq 1
+
+        # Run the job which should fail and cancel the JobGroup
+        Delayed::Worker.new.work_off(1)
+        CompletionJob.invoked.should be_false
+        failed_job_count.should eq 1
+        queued_job_count.should eq 0
+        job_group_count.should eq 0
+      end
+    end
 
-    job_group.enqueue(FailingJob.new)
-    job_group.enqueue(NoOpJob.new)
-    job_group.mark_queueing_complete
-    queued_job_count.should eq 2
-    job_group_count.should eq 1
+    context "with failure_cancels_group disabled" do
 
-    # Run the job which should fail and cancel the JobGroup
-    Delayed::Worker.new.work_off(1)
-    CompletionJob.invoked.should be_false
-    failed_job_count.should eq 1
-    queued_job_count.should eq 0
-    job_group_count.should eq 0
+      before { job_group.update_attributes!(failure_cancels_group: false) }
+
+      it "does not cancel the group" do
+        Delayed::Worker.max_attempts = 1
+
+        job_group.enqueue(FailingJob.new)
+        job_group.enqueue(NoOpJob.new)
+        job_group.mark_queueing_complete
+        queued_job_count.should eq 2
+        job_group_count.should eq 1
+
+        # Run the job which should fail don't cancel the JobGroup
+        Delayed::Worker.new.work_off(1)
+        CancellationJob.invoked.should be_false
+        failed_job_count.should eq 1
+        queued_job_count.should eq 1
+        job_group_count.should eq 1
+      end
+    end
   end
 
   it "doesn't retry failed jobs if the job group has been canceled" do

metadata

@@ -1,178 +1,180 @@
 --- !ruby/object:Gem::Specification
 name: delayed_job_groups_plugin
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Joel Turkel
+- Randy Burkes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-01 00:00:00.000000000 Z
+date: 2015-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: delayed_job
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: delayed_job_active_record
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.4'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '4.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '4.1'
 - !ruby/object:Gem::Dependency
   name: coveralls
   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: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rake
   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: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.14'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '2.99'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.14'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '2.99'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.1
 - !ruby/object:Gem::Dependency
   name: timecop
   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: sqlite3
   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'
 description: Aggregates Delayed::Job jobs into groups with group level management
   and lifecycle callbacks
 email:
 - jturkel@salsify.com
+- rlburkes@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -197,23 +199,24 @@ homepage: https://github.com/salsify/delayed_job_groups_plugin
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: See https://github.com/salsify/delayed_job_groups_plugin#installation
+  for upgrade/installation notes.
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Delayed::Job job groups plugin