msmg_public 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25086e4748d3390c13f01005abcff52c8e155de8
-  data.tar.gz: f09f31683695206c76087f1cd6c2d6ba1867aa36
+  metadata.gz: c0341374246f0297760ce71ebd29c4dee20d0b10
+  data.tar.gz: 7a8e1bcf7b8227172f7e820b1a633fbb3534b39c
 SHA512:
-  metadata.gz: d26eb671838f3374f11c5905ac473a505a819435cc87a73a5cf639106baa74445bc614fc2583d84d94a81b8fa1aa0f5099982d3ad058ef470d35f08dceed81f4
-  data.tar.gz: 730b9fee5a7999645707f42bb6f3314fe32a55eb1453a95aba4e5a20e7a1fc35e1d01a2d939d9baa652ea88643c073f1452afa5d710b431a1b103dd9f44d1c78
+  metadata.gz: d7f80341ccfbf70bc2e28f4557e8c722f135ad85e50cda708719e3a6da9743f765a701fd30fc9a46e8e2615ed1187b8a869b2261ac6b5ab87ca96650f0bb5b52
+  data.tar.gz: 3b83a70c33caf14ca50aa487c84b0b64116449db1cf9475597c890e900ccaca01f47d97cc4cb4d94505aa7dbbdc65871e00c26ab0b5ba0e59a6abb96f90795d2

data/lib/with_retries.rb

@@ -0,0 +1,38 @@
+# Generic WithRetries mixin
+
+# Use to propagate exceptions from the inner block to with_retries handler
+class WrappableError < StandardError
+  attr_reader :wrapped
+
+  def initialize(ex)
+    super
+    @wrapped = ex
+  end
+end
+
+# Generic WithRetries mixin
+module WithRetries
+  # Generic with_retries method
+  # rubocop:disable Metrics/MethodLength
+  def with_retries(retries, operation: 'Operation',
+                   log_method: Kernel.method(:puts))
+    attempt = 1
+    last_ex = nil
+    loop do
+      begin
+        rval = yield
+        last_ex = nil
+        return rval if rval
+      rescue WrappableError => ex
+        # Stash the wrapped exception for later use
+        last_ex = ex.wrapped
+      end
+      log_method.call "#{operation} failed #{attempt}/#{retries} attempts"
+      break if (attempt += 1) > retries
+    end
+    log_method.call "#{operation} attempts totally failed"
+    raise last_ex if last_ex
+    nil
+  end
+  # rubocop:enable all
+end

data/msmg_public.gemspec

@@ -9,7 +9,7 @@ $LOAD_PATH.merge! [File.expand_path('../lib', __FILE__)]
 Gem::Specification.new do |spec|
   raise 'RubyGems 2.0 or newer is required.' unless spec.respond_to?(:metadata)
   spec.name = 'msmg_public'
-  spec.version = '0.2.1'
+  spec.version = '0.3.1'
   spec.authors = ['Andrew Smith']
   spec.email = ['andrew.smith at moneysupermarket.com']
 

data/readme.md

@@ -140,3 +140,36 @@ Allows definition of mandatory and optional attributes that are enforced during
 => `block in build': Unknown field @f used in build (ArgumentError)
 
 ```
+
+## WithRetries
+
+A general retries mixin and exception wrapper class.
+
+```
+class Foo
+  include WithRetries
+  FETCH_TRIES = 5
+
+  def run
+    with_retries(FETCH_TRIES, operation: 'Fetching values') do
+      begin
+        fetchvals
+      rescue SomeErrorThatICanRetryOn, SocketError => ex
+        raise WrappableError, ex
+      end
+    end
+  end
+
+  private
+
+  def fetchvals
+    ...
+  end
+end
+```
+
+with_retries implements an automatic retry around a block of code retrying if a nil or false value ends the block.
+
+It also handles WrappableError exceptions which allow exceptions that can be cared for within the retry to be inhibited until all tries have been performed.
+
+The operation parameter allows some tuning of log messages produced by the mixin and the log_method parameter can be used to change the method used to produce log messages during the retries.

data/test/unit/test_builder_pattern.rb

@@ -7,6 +7,11 @@ class TestBuilder
   attr_mandatory :b, :c
   attr_optional :d
 
+  def initialize
+    super
+    @d = nil
+  end
+
   def sum
     d = @d || 0
     @a + @b + @c + d

data/test/unit/test_with_retries.rb

@@ -0,0 +1,36 @@
+require 'minitest/autorun'
+require 'with_retries'
+
+# Unit Test
+class TestWithRetries < Minitest::Test
+  include WithRetries
+
+  def test_no_exceptions
+    fails = 3
+    tries = 0
+    with_retries(5) do
+      tries += 1
+      (fails -= 1).zero?
+    end
+    assert_equal(3, tries)
+  end
+
+  # rubocop:disable Metrics/MethodLength ok
+  def test_exception_prop
+    tries = 0
+    # Inner block must wrap any errors that should not be immediately fatal
+    # eventually they are propagated out as the original error
+    assert_raises(StandardError) do
+      with_retries(5) do
+        begin
+          tries += 1
+          raise 'Error'
+        rescue StandardError => ex
+          raise WrappableError, ex
+        end
+      end
+    end
+    assert_equal(5, tries)
+  end
+  # rubocop:enable all
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: msmg_public
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Andrew Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-07 00:00:00.000000000 Z
+date: 2018-04-26 00:00:00.000000000 Z
 dependencies: []
 description: MSM pubicly available Ruby
 email:
@@ -24,6 +24,7 @@ files:
 - lib/comparable_by_attr.rb
 - lib/dig.rb
 - lib/to_hash.rb
+- lib/with_retries.rb
 - msmg_public.gemspec
 - readme.md
 - test/test_helper.rb
@@ -31,6 +32,7 @@ files:
 - test/unit/test_comparable_by_attr.rb
 - test/unit/test_dig.rb
 - test/unit/test_to_hash.rb
+- test/unit/test_with_retries.rb
 homepage: https://github.com/MSMFG/msmg_ruby-public
 licenses:
 - Apache-2.0