exp_retry 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9850572e1bc83790a190b3a1dceefe49aa5347446baff1dedaba4153e9db44a5
-  data.tar.gz: 49ec726f23195038cffcec915327332376143f7fd8a3174d52f654959ade8d0b
+  metadata.gz: dcf20e1954c741739c256c324c0511bd503d470177bddea6e440954df9b8b0e3
+  data.tar.gz: a698f18df11aea017d8a38c86c9840637008df8d0f94e7ac36cd50630a8eb3b1
 SHA512:
-  metadata.gz: 32a086e6cf019fd5ff1bacffbac83158b7dded1c50ace23933fbcc1a65090adba06008fecdf798a44a6c5a70eee9778e3e519d3c15732234a870277c0989a4f3
-  data.tar.gz: 4ff08790d9a50336a95eea5fe206cf9fcd83fbe6dd81a624ab27a1baee085b680d1c2ff03a137e0c7ece69b65a0fdc22d1f89367739ca5c7b4e6cc80a82fd5e1
+  metadata.gz: 2e8d7f73a2a9e089035b92931f1a10da74223d37721ac5791f3e77e33845b120a1181203cb18d1aea5f906b1cf82322d8d743f1233f3cd7d97232bf7785de72b
+  data.tar.gz: e1157a628e18cf70532756d65edeeb32c456160b6c6897a6c7c379dedea7f498bf45adcd27288dafdcff70f4cd5159ac6c6d45c9d7fb26788c87f0d3948e0168

data/.rubocop.yml

@@ -0,0 +1,79 @@
+require:
+  - rubocop-rspec
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - bin/**/*
+    - config/**/*
+    - db/**/*
+    - vendor/**/*
+    - tmp/**/*
+
+Layout/IndentFirstHashElement:
+  EnforcedStyle: consistent
+Layout/AccessModifierIndentation:
+  EnforcedStyle: outdent
+Layout/EmptyLinesAroundAccessModifier:
+  Enabled: true
+Layout/AlignArray:
+  Enabled: true
+Layout/AlignHash:
+  Enabled: true
+Layout/EmptyLineAfterGuardClause:
+  Enabled: true
+Layout/SpaceInsideBlockBraces:
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: no_space
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: no_space
+Layout/SpaceInsideArrayLiteralBrackets:
+  EnforcedStyle: no_space
+
+Lint/UnusedMethodArgument:
+  Enabled: true
+Lint/UselessAssignment:
+  Enabled: true
+
+Metrics/LineLength:
+  Max: 100
+Metrics/MethodLength:
+  Enabled: true
+Metrics/ClassLength:
+  Enabled: true
+  Max: 125
+Metrics/ModuleLength:
+  Max: 125
+Metrics/ParameterLists:
+  Enabled: true
+Metrics/CyclomaticComplexity:
+  Enabled: true
+Metrics/AbcSize:
+  Enabled: true
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+Naming/UncommunicativeMethodParamName:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: true
+Style/NumericLiterals:
+  Enabled: true
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+Style/AndOr:
+  Enabled: true
+Style/ClassCheck:
+  Enabled: true
+Style/GuardClause:
+  Enabled: true
+
+Security/Eval:
+  Enabled: true
+Security/JSONLoad:
+  Enabled: true
+Security/YAMLLoad:
+  Enabled: true

data/Gemfile

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    exp_retry (0.0.11)
+    exp_retry (0.0.12)
 
 GEM
   remote: https://rubygems.org/

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/exp-retry.gemspec

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 Gem::Specification.new do |s|
   s.name          = 'exp_retry'
-  s.version       = '0.0.11'
+  s.version       = '0.0.12'
   s.date          = '2019-06-15'
   s.summary       = 'Exponential backoff retry'
   s.description   = 'A simple exponential backoff retry wrapper.'
@@ -12,7 +14,7 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- spec/*`.split("\n")
 
-  s.required_ruby_version = '~> 2.2'
+  s.required_ruby_version = '~> 2.3'
 
   s.add_development_dependency 'rake',      '~> 12.2', '>= 12.2.1'
   s.add_development_dependency 'rspec',     '~> 3.7',  '>= 3.7.0'

data/lib/exp_retry.rb

@@ -2,14 +2,18 @@
 
 # Exponential backoff retry wrapper
 class ExpRetry
+  attr_accessor :retries
+  attr_reader :exception
+
   def self.for(retries: 3, exception: StandardError, verbose: false)
     new(retries: retries, exception: exception, verbose: verbose).call { yield }
   end
 
-  def initialize(retries: 3, exception: StandardError, verbose: false)
+  def initialize(retries: 3, exception: StandardError, wait: 1000, verbose: false)
     @retries = retries
     @exception = exception
     @verbose = verbose
+    @wait = wait
   end
 
   def call
@@ -19,20 +23,26 @@ class ExpRetry
     retry
   end
 
-  private
+private
 
   def check(exception)
-    retried > @retries ? raise(exception) : delay(exception)
+    raise(exception) unless retries.positive?
+
+    decrement
+    delay
   end
 
-  def retried
-    @retried ||= 0
-    @retried += 1
+  def decrement
+    @retries -= 1
   end
 
-  def delay(exception)
-    output = "*** #{exception}. Retrying in #{2**@retried} seconds..."
+  def delay
+    output = "*** #{@exception}. Retrying in #{time} seconds..."
     @verbose ? puts(output) : print('-')
-    sleep 2**@retried
+    sleep time
+  end
+
+  def time
+    2**retries * (@wait.to_f / 1000)
   end
 end

data/spec/.rubocop.yml

@@ -0,0 +1,7 @@
+Metrics/BlockLength:
+  Enabled: false
+Metrics/LineLength:
+  Max: 100
+
+RSpec/ExampleLength:
+  Enabled: false

data/spec/lib/exp_retry_spec.rb

@@ -3,23 +3,25 @@
 require 'spec_helper'
 
 RSpec.describe ExpRetry do
-  it 'should allow normal execution' do
-    r = ExpRetry.new.call { 'Something' }
+  let(:wait) { 10 }
+
+  it 'allows normal execution' do
+    r = described_class.new.call { 'Something' }
 
     expect(r).to eql('Something')
   end
 
-  it 'should allow normal execution using for' do
-    r = ExpRetry.for { 'Something' }
+  it 'allows normal execution using for' do
+    r = described_class.for { 'Something' }
 
     expect(r).to eql('Something')
   end
 
-  it 'should allow normal execution with a single failure' do
-    @fail_once = true
-    r = ExpRetry.new.call do
-      if @fail_once
-        @fail_once = false
+  it 'allows normal execution with a single failure' do
+    fail_once = true
+    r = described_class.new(wait: wait).call do
+      if fail_once
+        fail_once = false
         raise 'Fail once'
       end
       'Something'
@@ -28,11 +30,11 @@ RSpec.describe ExpRetry do
     expect(r).to eql('Something')
   end
 
-  it 'should allow normal execution with multiple exceptions' do
-    @fail_once = true
-    r = ExpRetry.new(exception: [RuntimeError, ArgumentError]).call do
-      if @fail_once
-        @fail_once = false
+  it 'allows normal execution with multiple exceptions' do
+    fail_once = true
+    r = described_class.new(exception: [RuntimeError, ArgumentError], wait: wait).call do
+      if fail_once
+        fail_once = false
         raise 'Fail once again'
       end
       'Something'
@@ -41,21 +43,21 @@ RSpec.describe ExpRetry do
     expect(r).to eql('Something')
   end
 
-  it 'should raise after too many retries' do
+  it 'raises after too many retries' do
     expect do
-      ExpRetry.new.call { raise 'Fail forever' }
+      described_class.new(wait: wait).call { raise 'Fail forever' }
     end.to raise_error(RuntimeError, 'Fail forever')
   end
 
-  it 'should raise after too many retries with a specified exception class' do
+  it 'raises after too many retries with a specified exception class' do
     expect do
-      ExpRetry.new(exception: RuntimeError).call { raise 'Fail forever again' }
+      described_class.new(exception: RuntimeError, wait: wait).call { raise 'Fail forever again' }
     end.to raise_error(RuntimeError, 'Fail forever again')
   end
 
-  it 'should not retry for a non-matching exception class' do
+  it 'does not retry for a non-matching exception class' do
     expect do
-      ExpRetry.new(exception: RuntimeError).call { raise ArgumentError }
+      described_class.new(exception: RuntimeError, wait: wait).call { raise ArgumentError }
     end.to raise_error(ArgumentError)
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/setup'
 Bundler.setup
 require 'simplecov'
@@ -7,5 +9,4 @@ SimpleCov.minimum_coverage(100)
 require 'exp_retry'
 
 RSpec.configure do |config|
-  #
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exp_retry
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - Julian Fiander
@@ -77,6 +77,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -84,6 +85,7 @@ files:
 - Readme.md
 - exp-retry.gemspec
 - lib/exp_retry.rb
+- spec/.rubocop.yml
 - spec/lib/exp_retry_spec.rb
 - spec/spec_helper.rb
 homepage: http://rubygems.org/gems/exp_retry
@@ -100,7 +102,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="