activejob-retry 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db6f767b064370ffd9a2b32630bcb21c2629ce6a
-  data.tar.gz: b8cf9fd6ca868b5acad274131906fa71046e4df6
+  metadata.gz: 26e70483f72942ecc312de55cd5bd34280ff459a
+  data.tar.gz: 771d1365fd7fc7581fced033b642ef4188e2e88d
 SHA512:
-  metadata.gz: b69605d70cced8e95f98147aebcbf132fb3600d44798ef57838febbf74bd7d7587ee9792b0f8cbf5c4682cf4ddd440f6e07dd818cccf4c6de68b0e821e072ecb
-  data.tar.gz: 44443de787c728f2e7beeb2fdc4cd62a73bf38a6b61beee1fa3d034d3d822e2b5855372c014f57014ceb288dd3e873d0de38c8c5063e41671c51208435865984
+  metadata.gz: d486c2b1253b045158bdb2880c0b12a0a00ed3aa1d4378de4ce0420710ae8f5c9f775089ab44c80d122384bc3bbc1504cc42f678c6d473742ded17369108a9a6
+  data.tar.gz: d9a91dd6a4beb9687d47fe9ce3df82fc5c29516a09e9d2d699fd017f6dc7b9522abdabecd7224a2952029c6d15ec38281652a64494ddaa00ce8c471183d1598b

data/.rubocop.yml

@@ -20,3 +20,6 @@ Style/Documentation:
 
 Style/DotPosition:
   EnforcedStyle: trailing
+
+Style/GuardClause:
+  Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.2.0 - January 1, 2015
+
+- Renamed retry_exceptions to retryable_exceptions (patch by [@greysteil](https://github.com/greysteil)
+
 ## 0.1.1 - January 1, 2015
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    activejob-retry (0.1.0)
+    activejob-retry (0.2.0)
       activejob (>= 4.2)
       activesupport (>= 4.2)
 

data/README.md

@@ -14,7 +14,7 @@ class ProcessWebhook < ActiveJob::Base
   queue_as :webhooks
 
   # Constant delay between attempts:
-  constant_retry limit: 3, delay: 5, retry_exceptions: [TimeoutError, NetworkError]
+  constant_retry limit: 3, delay: 5, retryable_exceptions: [TimeoutError, NetworkError]
 
   # Or, variable delay between attempts:
   variable_retry delays: [1, 5, 10, 30]
@@ -40,7 +40,7 @@ class ProcessWebhook < ActiveJob::Base
 end
 ```
 
-#### `constant_retry` options
+#### constant_retry options
 `limit`
 :    Maximum number of times to attempt the job (default: 1).
 
@@ -50,13 +50,13 @@ end
 `delay`
 :    Time between attempts (default: 0).
 
-`retry_exceptions`
+`retryable_exceptions`
 :    A whitelist of exceptions to retry (default: nil, i.e. all exceptions will result in a retry).
 
 `fatal_exceptions`
 :    A blacklist of exceptions to not retry (default: []).
 
-#### `variable_retry` options
+#### variable_retry options
 
 `delays`
 :    __required__ An array of delays between attempts. The first attempt will occur whenever you originally enqueued the job to happen.
@@ -67,7 +67,7 @@ end
 `max_delay_multiplier`
 :    The other end of the range for `min_delay_multiplier`. If one is supplied, both must be.
 
-`retry_exceptions`
+`retryable_exceptions`
 :    Same as for `constant_retry`.
 
 `fatal_exceptions`

data/lib/active_job/retry/constant_backoff_strategy.rb

@@ -5,15 +5,15 @@ module ActiveJob
     class ConstantBackoffStrategy
       def initialize(options)
         ConstantOptionsValidator.new(options).validate!
-        @retry_limit      = options.fetch(:limit, 1)
-        @retry_delay      = options.fetch(:delay, 0)
-        @fatal_exceptions = options.fetch(:fatal_exceptions, [])
-        @retry_exceptions = options.fetch(:retry_exceptions, nil)
+        @retry_limit          = options.fetch(:limit, 1)
+        @retry_delay          = options.fetch(:delay, 0)
+        @fatal_exceptions     = options.fetch(:fatal_exceptions, [])
+        @retryable_exceptions = options.fetch(:retryable_exceptions, nil)
       end
 
       def should_retry?(attempt, exception)
         return false if retry_limit_reached?(attempt)
-        return false unless retry_exception?(exception)
+        return false unless retryable_exception?(exception)
         true
       end
 
@@ -23,15 +23,15 @@ module ActiveJob
 
       private
 
-      attr_reader :retry_limit, :fatal_exceptions, :retry_exceptions
+      attr_reader :retry_limit, :fatal_exceptions, :retryable_exceptions
 
       def retry_limit_reached?(attempt)
         return false unless retry_limit
         attempt >= retry_limit
       end
 
-      def retry_exception?(exception)
-        if retry_exceptions.nil?
+      def retryable_exception?(exception)
+        if retryable_exceptions.nil?
           !exception_blacklisted?(exception)
         else
           exception_whitelisted?(exception)
@@ -39,7 +39,7 @@ module ActiveJob
       end
 
       def exception_whitelisted?(exception)
-        retry_exceptions.any? { |ex| exception.is_a?(ex) }
+        retryable_exceptions.any? { |ex| exception.is_a?(ex) }
       end
 
       def exception_blacklisted?(exception)

data/lib/active_job/retry/constant_options_validator.rb

@@ -12,11 +12,14 @@ module ActiveJob
         validate_infinite_limit!
         validate_delay!
         validate_not_both_exceptions!
-        # Fatal exceptions must be an array (cannot be nil, since then all exceptions
-        # would be fatal - for that just set `limit: 0`)
+        # Fatal exceptions must be an array (cannot be nil, since then all
+        # exceptions would be fatal - for that just set `limit: 0`)
         validate_array_of_exceptions!(:fatal_exceptions)
-        # Retry exceptions must be an array of exceptions or `nil` to retry any exception
-        validate_array_of_exceptions!(:retry_exceptions) if options[:retry_exceptions]
+        # Retryable exceptions must be an array of exceptions or `nil` to retry
+        # any exception
+        if options[:retryable_exceptions]
+          validate_array_of_exceptions!(:retryable_exceptions)
+        end
       end
 
       private
@@ -56,10 +59,10 @@ module ActiveJob
       end
 
       def validate_not_both_exceptions!
-        return unless options[:fatal_exceptions] && options[:retry_exceptions]
+        return unless options[:fatal_exceptions] && options[:retryable_exceptions]
 
         raise InvalidConfigurationError,
-              'fatal_exceptions and retry_exceptions cannot be used together'
+              'fatal_exceptions and retryable_exceptions cannot be used together'
       end
 
       def validate_array_of_exceptions!(key)

data/lib/active_job/retry/version.rb

@@ -1,5 +1,5 @@
 module ActiveJob
   module Retry
-    VERSION = '0.1.1'
+    VERSION = '0.2.0'
   end
 end

data/spec/retry/constant_backoff_strategy_spec.rb

@@ -75,7 +75,7 @@ RSpec.describe ActiveJob::Retry::ConstantBackoffStrategy do
     end
 
     context 'with whitelist' do
-      let(:options) { { limit: 10, retry_exceptions: [RuntimeError] } }
+      let(:options) { { limit: 10, retryable_exceptions: [RuntimeError] } }
 
       context 'Exception' do
         let(:exception) { Exception.new }

data/spec/retry/constant_options_validator_spec.rb

@@ -25,18 +25,18 @@ RSpec.describe ActiveJob::Retry::ConstantOptionsValidator do
       it { is_expected.to_not raise_error }
     end
 
-    context 'fatal exceptions' do
+    context 'fatal_exceptions' do
       let(:options) { { fatal_exceptions: [RuntimeError] } }
       it { is_expected.to_not raise_error }
     end
 
-    context 'retry exceptions' do
-      let(:options) { { retry_exceptions: [StandardError, NoMethodError] } }
+    context 'retryable_exceptions' do
+      let(:options) { { retryable_exceptions: [StandardError, NoMethodError] } }
       it { is_expected.to_not raise_error }
     end
 
     context 'multiple options' do
-      let(:options) { { limit: 3, delay: 10, retry_exceptions: [RuntimeError] } }
+      let(:options) { { limit: 3, delay: 10, retryable_exceptions: [RuntimeError] } }
 
       it { is_expected.to_not raise_error }
     end
@@ -63,18 +63,18 @@ RSpec.describe ActiveJob::Retry::ConstantOptionsValidator do
       it { is_expected.to raise_error(ActiveJob::Retry::InvalidConfigurationError) }
     end
 
-    context 'bad fatal exceptions' do
+    context 'bad fatal_exceptions' do
       let(:options) { { fatal_exceptions: ['StandardError'] } }
       it { is_expected.to raise_error(ActiveJob::Retry::InvalidConfigurationError) }
     end
 
-    context 'bad retry exceptions' do
-      let(:options) { { retry_exceptions: [:runtime] } }
+    context 'bad retryable_exceptions' do
+      let(:options) { { retryable_exceptions: [:runtime] } }
       it { is_expected.to raise_error(ActiveJob::Retry::InvalidConfigurationError) }
     end
 
     context 'retry and fatal exceptions together' do
-      let(:options) { { fatal_exceptions: [StandardError], retry_exceptions: [] } }
+      let(:options) { { fatal_exceptions: [StandardError], retryable_exceptions: [] } }
       it { is_expected.to raise_error(ActiveJob::Retry::InvalidConfigurationError) }
     end
   end

data/spec/retry/variable_backoff_strategy_spec.rb

@@ -61,7 +61,7 @@ RSpec.describe ActiveJob::Retry::VariableBackoffStrategy do
     end
 
     context 'with whitelist' do
-      let(:options) { { delays: [10], retry_exceptions: [RuntimeError] } }
+      let(:options) { { delays: [10], retryable_exceptions: [RuntimeError] } }
 
       context 'Exception' do
         let(:exception) { Exception.new }

data/spec/retry/variable_options_validator_spec.rb

@@ -27,13 +27,15 @@ RSpec.describe ActiveJob::Retry::VariableOptionsValidator do
       it { is_expected.to_not raise_error }
     end
 
-    context 'retry exceptions' do
-      let(:options) { { delays: [], retry_exceptions: [StandardError, NoMethodError] } }
+    context 'retryable_exceptions' do
+      let(:options) do
+        { delays: [], retryable_exceptions: [StandardError, NoMethodError] }
+      end
       it { is_expected.to_not raise_error }
     end
 
     context 'multiple options' do
-      let(:options) { { delays: [0, 10, 60], retry_exceptions: [RuntimeError] } }
+      let(:options) { { delays: [0, 10, 60], retryable_exceptions: [RuntimeError] } }
 
       it { is_expected.to_not raise_error }
     end
@@ -70,13 +72,13 @@ RSpec.describe ActiveJob::Retry::VariableOptionsValidator do
       it { is_expected.to raise_error(ActiveJob::Retry::InvalidConfigurationError) }
     end
 
-    context 'bad retry exceptions' do
-      let(:options) { { retry_exceptions: [:runtime] } }
+    context 'bad retryable_exceptions' do
+      let(:options) { { retryable_exceptions: [:runtime] } }
       it { is_expected.to raise_error(ActiveJob::Retry::InvalidConfigurationError) }
     end
 
     context 'retry and fatal exceptions together' do
-      let(:options) { { fatal_exceptions: [StandardError], retry_exceptions: [] } }
+      let(:options) { { fatal_exceptions: [StandardError], retryable_exceptions: [] } }
       it { is_expected.to raise_error(ActiveJob::Retry::InvalidConfigurationError) }
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activejob-retry
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Isaac Seymour
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-01 00:00:00.000000000 Z
+date: 2015-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob