bogo 0.1.28 → 0.1.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c174f6ad37a9e19f3dfe03122c33a495806dccb3
-  data.tar.gz: 3912483719bc84e6af89542580c05dd45aaef600
+  metadata.gz: e2bc7e71e08bfe678b9ebe7ffd966ffca3092e43
+  data.tar.gz: ffd41d8ceee8a00c968342b87d32101fa1d58caf
 SHA512:
-  metadata.gz: 0fac9b5a22d68c59244e2285812eb78eddab548692b61cae3bc249df04a9ea551a2392c99be411589b5bdbed39bc91118c10eedd7f761f8c80959ad22db88b3a
-  data.tar.gz: b56a8eac111a44ad7d71eefa03cfdf79a8ff652f2b976e958da93d57faca47877cb1d9edc20df87157114c096d1842f5c9db14e830ddb539e9a7bc94a919f1f6
+  metadata.gz: db23673068170fd07463703a5709bdae78a9b0185d68cc52d77001c9791415a27a939a3dbf34b4a7893e631918e6797ae85d6c1aace3b5698a17deacad4896a2
+  data.tar.gz: a4ac702da3acf7702440a8625fc5366834108acee91820a162bd491d0ae74d8e49fdf56a589c5d02e51d8946bf3847ad15e711b835609185a6ed2557cc472e71

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.1.30
+* [Lazy] Inspect data prior to checksum to prevent circular issues
+* [Retry] Support custom block to determine retry
+
 ## v0.1.28
 * [Smash] Ensure valid data type on checksum generation
 * [Retry] Add new retry abstract and concrete subclasses

data/README.md

@@ -310,5 +310,71 @@ e_file.close
 puts "File exists: #{File.exists?(path)}"
 ```
 
+## Retry
+
+Retry an action until success or maximum number of attempts
+has been reached.
+
+### `Bogo::Retry`
+
+This is an abstract class and does not provide actual retry
+functionality. Custom concrete implementations must define a
+`#wait_on_failure` method that provides the number of seconds
+to wait until the next attempt.
+
+The `Bogo::Retry` does provide an easy way to generate a
+retry instance:
+
+```ruby
+Bogo::Retry.build(:flat, :wait_interval => 2) do
+  puts 'This is run within a Bogo::Retry::Flat instance!'
+end
+```
+
+If the value of the action is required, disable auto run
+and explicitly start the retry:
+
+```ruby
+value = Bogo::Retry.build(:flat, :auto_run => false) do
+  puts 'This is run within a Bogo::Retry::Flat instance!'
+  42
+end.run!
+```
+
+A block can also be provided to `run!` which will be called
+when an exception is rescued to determine if the request should
+be retried:
+
+```ruby
+value = Bogo::Retry.build(:flat, :auto_run => false) do
+  puts 'This is run within a Bogo::Retry::Flat instance!'
+  42
+end.run! do |exception|
+  exception.is_a?(ErrorThatShouldBeRetried)
+end
+```
+
+#### `Bogo::Retry::Flat`
+
+The flat retry implementation will always wait the `wait_interval`
+value before retry.
+
+* `:wait_interval` - Numeric (default: 5)
+
+#### `Bogo::Retry::Linear`
+
+The linear retry implementation will increase the wait time between
+retries at a linear rate before retry:
+
+* `:wait_interval` - Numeric (default: 5)
+
+#### `Bogo::Retry::Exponential`
+
+The exponential retry implementation will increase the wait time
+between retries at an exponential rate before retry:
+
+* `:wait_interval` - Numeric (default: 5)
+* `:wait_exponent` - Numeric (default: 2)
+
 # Info
 * Repository: https://github.com/spox/bogo

data/lib/bogo/lazy.rb

@@ -67,7 +67,7 @@ module Bogo
       def valid_state
         data.merge!(dirty)
         dirty.clear
-        @_checksum = Digest::SHA256.hexdigest(MultiJson.dump(data).to_s)
+        @_checksum = Digest::SHA256.hexdigest(MultiJson.dump(data.inspect).to_s)
         self
       end
 
@@ -81,7 +81,7 @@ module Bogo
         else
           if(@_checksum)
             !dirty.empty? ||
-              @_checksum != Digest::SHA256.hexdigest(MultiJson.dump(data))
+              @_checksum != Digest::SHA256.hexdigest(MultiJson.dump(data.inspect).to_s)
           else
             true
           end

data/lib/bogo/retry.rb

@@ -52,7 +52,10 @@ module Bogo
 
     # Run action until success
     #
-    # return [Object] result of action
+    # @yield optional to allow custom exception check
+    # @yieldparam [Exception] exception caught
+    # @yieldreturn [TrueClass, FalseClass] if retry should be peformed
+    # @return [Object] result of action
     def run!
       if(dead)
         raise RuntimeError.new "Action has already reached maximum allowed attempts (#{max_attempts})!"
@@ -61,6 +64,9 @@ module Bogo
           log_attempt!
           action.call
         rescue => e
+          if(block_given?)
+            raise unless yield(e)
+          end
           if(max_attempts.nil? || attempts < max_attempts)
             interval = wait_on_failure(e)
             if(ui)
@@ -72,7 +78,7 @@ module Bogo
             sleep(interval)
             retry
           else
-            if(ui)
+            if(ui && max_attempts.to_i > 0)
               ui.error "#{description} failed (#{e.class}: #{e}) - Maximum number of attempts reached!"
             end
             @dead = true
@@ -135,24 +141,17 @@ module Bogo
 
       # @return [Numeric]
       attr_reader :wait_interval
-      # @return [Numeric]
-      attr_reader :wait_multiplier
 
       # Create a new linear retry instance
       #
       # @param args [Hash]
       # @option args [Numeric] :wait_interval Defaults to 5 seconds
-      # @option args [Numeric] :wait_multiplier Defaults to 2
       # @return [self]
       def initialize(args={}, &block)
         @wait_interval = args[:wait_interval].to_f
-        @wait_multiplier = args[:wait_multiplier].to_f
         unless(@wait_interval > 0)
           @wait_interval = 5
         end
-        unless(@wait_multiplier > 0)
-          @wait_multiplier = 2
-        end
         super
       end
 

data/lib/bogo/version.rb

@@ -1,4 +1,4 @@
 module Bogo
   # Current library version
-  VERSION = Gem::Version.new('0.1.28')
+  VERSION = Gem::Version.new('0.1.30')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bogo
 version: !ruby/object:Gem::Version
-  version: 0.1.28
+  version: 0.1.30
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-01 00:00:00.000000000 Z
+date: 2015-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie