retryable 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 441e4e21d1cbf851bc4ce28f99774b1b0e0058920f401926259b08d311fc6f4d
-  data.tar.gz: 0c7b6ec7ac61587f68c4186405e00b4f2021558520b692ebe6b013503bccf97d
+  metadata.gz: 166388a879ef75725b9a8195680f0018ecaf92d65355171e3755ab45479c9882
+  data.tar.gz: 4c89395fee2436620a17586627af3cae189aefc2b60b195682853c73dec7d0e3
 SHA512:
-  metadata.gz: 9ff21470b65d4037e2cc88b00f8404d72327cb3891fde218794242b76b7e7d90de8c1e6cb88756effe70886a84d515efb0c08ac4f491962b85f2689423e44d87
-  data.tar.gz: bcc68f82b11fae2876ae81730c5d953291428b8524dc68e221961666375216004ed447af9ad3eac1b1f7342eb110ab1597320c3a0469afcad4e276383262958d
+  metadata.gz: 8669644175373da9208bfacd9978a620eda7b2f0789fbfc2149e1333af74456c91699f3adacbd116502360b0457f781f7d9748a48bf01bc21a885314df0a4269
+  data.tar.gz: a4780ebe5eaae4c1f91412dfd2a31948c14467a072cca3f737b3bcbb49b9526bb0fe78669df110879d47a50e6c4b05d4825558bec3df0608d79230d633db9327

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## Retryable 3.0.2 ##
+
+*   :log_method param has been added for flexible logging of your retries. It is silent by default.
+
 ## Retryable 3.0.1 ##
 
 *   :matching param from now on could be called in form of array with multiple matching conditions. This version is backwards compatible with 3.0.0

data/README.md

@@ -2,7 +2,6 @@
 
 [![Gem Version](https://badge.fury.io/rb/retryable.svg)](https://badge.fury.io/rb/retryable)
 [![Build Status](https://travis-ci.org/nfedyashev/retryable.png?branch=master)](https://travis-ci.org/nfedyashev/retryable)
-[![Dependency Status](https://www.versioneye.com/ruby/retryable/badge.svg)](https://www.versioneye.com/ruby/retryable)
 [![Code Climate](https://codeclimate.com/github/nfedyashev/retryable/badges/gpa.svg)](https://codeclimate.com/github/nfedyashev/retryable)
 [![Test Coverage](https://codeclimate.com/github/nfedyashev/retryable/badges/coverage.svg)](https://codeclimate.com/github/nfedyashev/retryable/coverage)
 
@@ -57,10 +56,10 @@ end
 ```
 
 Do something, retry up to four times for either `ArgumentError` or
-`TimeoutError` exceptions.
+`Timeout::Error` exceptions.
 
 ``` ruby
-Retryable.retryable(tries: 5, on: [ArgumentError, TimeoutError]) do
+Retryable.retryable(tries: 5, on: [ArgumentError, Timeout::Error]) do
   # code here
 end
 ```
@@ -83,29 +82,31 @@ end
 
 ## Defaults
 
-    tries: 2,
-    on: StandardError,
-    sleep: 1,
-    matching : /.*/,
+    contexts: {},
     ensure: proc { },
     exception_cb: proc { },
+    log_method: proc { },
+    matching : /.*/,
     not: [],
+    on: StandardError,
+    sleep: 1,
     sleep_method: lambda { |n| Kernel.sleep(n) },
-    contexts: {}
+    tries: 2
 
 Retryable also could be configured globally to change those defaults:
 
 ```ruby
 Retryable.configure do |config|
+  config.contexts     = {}
   config.ensure       = proc {}
   config.exception_cb = proc {}
+  config.log_method   = proc {}
   config.matching     = /.*/
+  config.not          = []
   config.on           = StandardError
   config.sleep        = 1
-  config.tries        = 2
-  config.not          = []
   config.sleep_method = Celluloid.method(:sleep)
-  config.contexts     = {}
+  config.tries        = 2
 end
 ```
 
@@ -160,6 +161,28 @@ Retryable.retryable(exception_cb: exception_cb) do
 end
 ```
 
+Logging
+--------
+
+```ruby
+
+# or extract it to global config instead:
+log_method = lambda do |retries, exception|
+  Logger.new(STDOUT).debug("[Attempt ##{retries}] Retrying because [#{exception.class} - #{exception.message}]: #{exception.backtrace.first(5).join(' | ')}")
+end
+
+Retryable.retryable(log_method: log_method, matching: /IO timeout/) do |retries, exception|
+  raise "oops IO timeout!" if retries == 0
+end
+#D, [2018-09-01T18:19:06.093811 #22535] DEBUG -- : [Attempt #1] Retrying because [RuntimeError - oops IO timeout!]: (irb#1):6:in `block in irb_binding' | /home/nikita/Projects/retryable/lib/retryable.rb:73:in `retryable' | (irb#1):6:in `irb_binding' | /home/nikita/.rvm/rubies/ruby-2.5.0/lib/ruby/2.5.0/irb/workspace.rb:85:in `eval' | /home/nikita/.rvm/rubies/ruby-2.5.0/lib/ruby/2.5.0/irb/workspace.rb:85:in `evaluate'
+```
+
+If you prefer to use Rails' native logger:
+
+log_method = lambda do |retries, exception|
+  Rails.logger.debug("[Attempt ##{retries}] Retrying because [#{exception.class} - #{exception.message}]: #{exception.backtrace.first(5).join(' | ')}")
+end
+
 Contexts
 --------
 

data/lib/retryable.rb

@@ -1,8 +1,12 @@
 require 'retryable/version'
 require 'retryable/configuration'
+require 'forwardable'
 
+# Runs a code block, and retries it when an exception occurs. It's great when working with flakey webservices (for example).
 module Retryable
   class << self
+    extend Forwardable
+
     # A Retryable configuration object. Must act like a hash and return sensible
     # values for all Retryable configuration options. See Retryable::Configuration.
     attr_writer :configuration
@@ -14,12 +18,13 @@ module Retryable
     #     config.contexts     = {}
     #     config.ensure       = proc {}
     #     config.exception_cb = proc {}
+    #     config.log_method   = proc {}
     #     config.matching     = /.*/
+    #     config.not          = []
     #     config.on           = StandardError
     #     config.sleep        = 1
-    #     config.tries        = 2
-    #     config.not          = []
     #     config.sleep_method = ->(seconds) { Kernel.sleep(seconds) }
+    #     config.tries        = 2
     #   end
     def configure
       yield(configuration)
@@ -31,8 +36,10 @@ module Retryable
       @configuration ||= Configuration.new
     end
 
+    delegate [:enabled?, :enable, :disable] => :configuration
+
     def with_context(context_key, options = {}, &block)
-      unless configuration.contexts.keys.include? context_key
+      unless configuration.contexts.key?(context_key)
         raise ArgumentError, "#{context_key} not found in Retryable.configuration.contexts. Available contexts: #{configuration.contexts.keys}"
       end
       retryable(configuration.contexts[context_key].merge(options), &block) if block
@@ -40,35 +47,28 @@ module Retryable
 
     alias retryable_with_context with_context
 
-    def enabled?
-      configuration.enabled?
-    end
-
-    def enable
-      configuration.enable
-    end
-
-    def disable
-      configuration.disable
-    end
-
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/PerceivedComplexity
     def retryable(options = {})
       opts = configuration.to_hash
 
       check_for_invalid_options(options, opts)
       opts.merge!(options)
 
+      # rubocop:disable Style/NumericPredicate
       return if opts[:tries] == 0
+      # rubocop:enable Style/NumericPredicate
 
       on_exception = opts[:on].is_a?(Array) ? opts[:on] : [opts[:on]]
       not_exception = opts[:not].is_a?(Array) ? opts[:not] : [opts[:not]]
 
-      matching = [opts[:matching]].flatten
+      matching = opts[:matching].is_a?(Array) ? opts[:matching] : [opts[:matching]]
       tries = opts[:tries]
       retries = 0
       retry_exception = nil
 
       begin
+        opts[:log_method].call(retries, retry_exception) if retries > 0
         return yield retries, retry_exception
       rescue *not_exception
         raise
@@ -94,6 +94,8 @@ module Retryable
         opts[:ensure].call(retries)
       end
     end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/PerceivedComplexity
 
     private
 
@@ -111,7 +113,7 @@ module Retryable
         when Regexp
           message =~ candidate
         else
-          raise ArgumentError, ":matches must be a string or regex"
+          raise ArgumentError, ':matches must be a string or regex'
         end
       end
     end

data/lib/retryable/configuration.rb

@@ -5,6 +5,7 @@ module Retryable
       :contexts,
       :ensure,
       :exception_cb,
+      :log_method,
       :matching,
       :not,
       :on,
@@ -21,12 +22,14 @@ module Retryable
       @contexts     = {}
       @ensure       = proc {}
       @exception_cb = proc {}
+      @log_method   = proc {}
       @matching     = /.*/
+      @not          = []
       @on           = StandardError
       @sleep        = 1
-      @tries        = 2
-      @not          = []
       @sleep_method = ->(seconds) { Kernel.sleep(seconds) }
+      @tries        = 2
+
       @enabled      = true
     end
 

data/lib/retryable/version.rb

@@ -15,7 +15,7 @@ module Retryable
 
     # @return [Integer]
     def patch
-      1
+      2
     end
 
     # @return [Hash]

data/retryable.gemspec

@@ -1,4 +1,7 @@
+# rubocop:disable Style/ExpandPathArguments
 lib = File.expand_path('../lib', __FILE__)
+# rubocop:enable Style/ExpandPathArguments
+
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'retryable/version'
 

data/spec/retryable_logging_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+require 'logger'
+
+RSpec.describe Retryable do
+  describe '.retryable' do
+    before do
+      described_class.enable
+      expect(Kernel).to receive(:sleep)
+    end
+
+    let(:retryable) do
+      -> { Retryable.retryable(tries: 2) { |tries| raise StandardError, "because foo" if tries < 1 } }
+    end
+
+    context 'given default configuration' do
+      it 'does not output anything' do
+        expect { retryable.call }.not_to output.to_stdout_from_any_process
+      end
+    end
+
+    context 'given custom STDOUT logger config option' do
+      it 'does not output anything' do
+        described_class.configure do |config|
+          config.log_method = lambda do |retries, exception|
+             Logger.new(STDOUT).debug("[Attempt ##{retries}] Retrying because [#{exception.class} - #{exception.message}]: #{exception.backtrace.first(5).join(' | ')}")
+          end
+        end
+
+        expect { retryable.call }.to output(/\[Attempt #1\] Retrying because \[StandardError - because foo\]/).to_stdout_from_any_process
+      end
+    end
+  end
+end
+

data/spec/retryable_spec.rb

@@ -126,11 +126,11 @@ RSpec.describe Retryable do
 
     it 'catches an exception in the list of matches' do
       expect(Kernel).to receive(:sleep).once.with(1)
-      counter(matching: [/IO timeout/, "IO tymeout"]) { |c, _e| raise 'yo, IO timeout!' if c == 0 }
+      counter(matching: [/IO timeout/, 'IO tymeout']) { |c, _e| raise 'yo, IO timeout!' if c == 0 }
       expect(counter.count).to eq(2)
 
       expect(Kernel).to receive(:sleep).once.with(1)
-      counter(matching: [/IO timeout/, "IO tymeout"]) { |c, _e| raise 'yo, IO tymeout!' if c == 0 }
+      counter(matching: [/IO timeout/, 'IO tymeout']) { |c, _e| raise 'yo, IO tymeout!' if c == 0 }
       expect(counter.count).to eq(4)
     end
 
@@ -140,6 +140,7 @@ RSpec.describe Retryable do
       end.to raise_error ArgumentError, '[Retryable] Invalid options: bad_option'
     end
 
+    # rubocop:disable Rspec/InstanceVariable
     it 'accepts a callback to run after an exception is rescued' do
       expect do
         described_class.retryable(sleep: 0, exception_cb: proc { |e| @raised = e.to_s }) do |tries|
@@ -149,6 +150,7 @@ RSpec.describe Retryable do
 
       expect(@raised).to eq('this is fun!')
     end
+    # rubocop:enable Rspec/InstanceVariable
 
     it 'does not retry on :not exception' do
       expect do

data/spec/spec_helper.rb

@@ -1,7 +1,11 @@
 require 'retryable'
 require 'simplecov'
 
+require 'pry'
+
+# rubocop:disable Style/ExpandPathArguments
 Dir.glob(File.expand_path('../support/**/*.rb', __FILE__), &method(:require))
+# rubocop:enable Style/ExpandPathArguments
 
 SimpleCov.start
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: retryable
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Nikita Fedyashev
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-11 00:00:00.000000000 Z
+date: 2018-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,6 +44,7 @@ files:
 - retryable.gemspec
 - spec/retryable/configuration_spec.rb
 - spec/retryable/version_spec.rb
+- spec/retryable_logging_spec.rb
 - spec/retryable_spec.rb
 - spec/retryable_with_context_spec.rb
 - spec/spec_helper.rb
@@ -68,13 +69,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Retrying code blocks in Ruby
 test_files:
 - spec/retryable/configuration_spec.rb
 - spec/retryable/version_spec.rb
+- spec/retryable_logging_spec.rb
 - spec/retryable_spec.rb
 - spec/retryable_with_context_spec.rb
 - spec/spec_helper.rb