bogo 0.1.26 → 0.1.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7e400810bf3504865b80afad6d8382992d174ee
-  data.tar.gz: 975826f4297df7023982b96d0c5807dff072b0d0
+  metadata.gz: c174f6ad37a9e19f3dfe03122c33a495806dccb3
+  data.tar.gz: 3912483719bc84e6af89542580c05dd45aaef600
 SHA512:
-  metadata.gz: c8e162b1c52619ab538c1ac3e64f954738f0d646e04acd6fc7403762b68d79f4b938c6e98c78383ac53cf1c629e332ac5f315135a564063734e408bc9e295831
-  data.tar.gz: 9eee1d3be0b4219b9bd9713f6c693256f99e310476db4714687f7499272bb4e8c24d39da4305c5bedb196b931dc46fa418c03c82b5c4ccd0fe3a456aec4231e2
+  metadata.gz: 0fac9b5a22d68c59244e2285812eb78eddab548692b61cae3bc249df04a9ea551a2392c99be411589b5bdbed39bc91118c10eedd7f761f8c80959ad22db88b3a
+  data.tar.gz: b56a8eac111a44ad7d71eefa03cfdf79a8ff652f2b976e958da93d57faca47877cb1d9edc20df87157114c096d1842f5c9db14e830ddb539e9a7bc94a919f1f6

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.1.28
+* [Smash] Ensure valid data type on checksum generation
+* [Retry] Add new retry abstract and concrete subclasses
+
 ## v0.1.26
 * [Smash] Fix behavior around accessing falsey values
 

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))
+        @_checksum = Digest::SHA256.hexdigest(MultiJson.dump(data).to_s)
         self
       end
 
@@ -106,7 +106,7 @@ module Bogo
       # Disable dirty state
       def always_clean!
         self.class_eval do
-          def dirty?; false; end
+          def dirty?(*args); false; end
           def valid_state; self; end
           alias_method :dirty, :data
         end

data/lib/bogo/retry.rb

@@ -0,0 +1,205 @@
+require 'bogo'
+
+module Bogo
+
+  # Perform action and retry until successful or abort
+  class Retry
+
+    # Create a type of retry
+    #
+    # @param type [String, Symbol] name of retry type
+    # @param args [Object] instantiation arguments
+    # @yield instantiation block
+    # @return [Retry] specific subclass instance
+    def self.build(type, *args, &block)
+      klass = self.const_get(Bogo::Utility.camel(type))
+      klass.new(*args, &block)
+    end
+
+    # @return [Proc] action to perform
+    attr_reader :action
+    # @return [Integer] number of attempts
+    attr_reader :attempts
+    # @return [TrueClass, FalseClass] retry is dead
+    attr_reader :dead
+    # @return [String] description of action
+    attr_reader :description
+    # @return [Integer] maximum number of attempts
+    attr_reader :max_attempts
+    # @return [Bogo::Ui] UI to direct warnings
+    attr_reader :ui
+
+    # Create a new retry instance
+    #
+    # @param args [Hash]
+    # @option args [String] :description action description
+    # @option args [Bogo::Ui] :ui output failure/retry notifications
+    # @option args [Integer] :max_attempts maximum number of retries
+    # @return [self]
+    def initialize(args={}, &block)
+      unless(block)
+        raise ArgumentError.new 'Expecting block but no block was provided!'
+      end
+      args = args.to_smash
+      @ui = args[:ui]
+      @description = args.fetch(:description, 'Task')
+      @max_attempts = args[:max_attempts]
+      @action = block
+      @attempts = 0
+      @dead = false
+      run! unless args[:auto_run] == false
+    end
+
+    # Run action until success
+    #
+    # return [Object] result of action
+    def run!
+      if(dead)
+        raise RuntimeError.new "Action has already reached maximum allowed attempts (#{max_attempts})!"
+      else
+        begin
+          log_attempt!
+          action.call
+        rescue => e
+          if(max_attempts.nil? || attempts < max_attempts)
+            interval = wait_on_failure(e)
+            if(ui)
+              if(max_attempts)
+                attempt_info = "[Attempt #{attempts}/#{max_attempts}]"
+              end
+              ui.warn "#{description} failed (#{e.class}: #{e}) - Retry in #{interval.to_i} seconds #{attempt_info}"
+            end
+            sleep(interval)
+            retry
+          else
+            if(ui)
+              ui.error "#{description} failed (#{e.class}: #{e}) - Maximum number of attempts reached!"
+            end
+            @dead = true
+            raise e
+          end
+        end
+      end
+    end
+
+    # @return [Integer]
+    def retries
+      attempts > 0 ? attempts - 1 : 0
+    end
+
+    protected
+
+    # Amount of time to wait
+    #
+    # @param error [StandardError] failure exception
+    # @return [Numeric] amount of wait time
+    def wait_on_failure(error)
+      raise NotImplementedError
+    end
+
+    # @return [Intenger]
+    def log_attempt!
+      @attempts = attempts.next
+    end
+
+    # Flat retry implementation
+    class Flat < Retry
+
+      # @return [Numeric]
+      attr_reader :wait_interval
+
+      # Create a new flat retry instance
+      #
+      # @param args [Hash]
+      # @option args [Numeric] :wait_interval Defaults to 5 seconds
+      # @return [self]
+      def initialize(args={}, &block)
+        @wait_interval = args[:wait_interval].to_f
+        unless(@wait_interval > 0)
+          @wait_interval = 5
+        end
+        super
+      end
+
+      protected
+
+      # @return [Numeric] wait time
+      def wait_on_failure(*_)
+        wait_interval
+      end
+
+    end
+
+    # Linear retry implementation
+    class Linear < Retry
+
+      # @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
+
+      protected
+
+      # @return [Numeric] wait time
+      def wait_on_failure(*_)
+        wait_interval * attempts
+      end
+
+    end
+
+    # Exponential retry implementation
+    class Exponential < Retry
+
+      # @return [Numeric]
+      attr_reader :wait_interval
+      # @return [Numeric]
+      attr_reader :wait_exponent
+
+      # Create a new linear retry instance
+      #
+      # @param args [Hash]
+      # @option args [Numeric] :wait_interval Defaults to 5 seconds
+      # @option args [Numeric] :wait_exponent Defaults to 2
+      # @return [self]
+      def initialize(args={}, &block)
+        @wait_interval = args[:wait_interval].to_f
+        @wait_exponent = args[:wait_exponent].to_f
+        unless(@wait_interval > 0)
+          @wait_interval = 5
+        end
+        unless(@wait_exponent > 0)
+          @wait_exponent = 2
+        end
+        super
+      end
+
+      protected
+
+      # @return [Numeric] wait time
+      def wait_on_failure(*_)
+        retries == 0 ? wait_interval : (wait_interval + retries) ** wait_exponent
+      end
+
+    end
+
+  end
+
+end

data/lib/bogo/version.rb

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

data/lib/bogo.rb

@@ -7,6 +7,7 @@ module Bogo
   autoload :Lazy, 'bogo/lazy'
   autoload :Memoization, 'bogo/memoization'
   autoload :PriorityQueue, 'bogo/priority_queue'
+  autoload :Retry, 'bogo/retry'
   autoload :Smash, 'bogo/smash'
   autoload :Utility, 'bogo/utility'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bogo
 version: !ruby/object:Gem::Version
-  version: 0.1.26
+  version: 0.1.28
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-22 00:00:00.000000000 Z
+date: 2015-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -85,6 +85,7 @@ files:
 - lib/bogo/lazy.rb
 - lib/bogo/memoization.rb
 - lib/bogo/priority_queue.rb
+- lib/bogo/retry.rb
 - lib/bogo/smash.rb
 - lib/bogo/utility.rb
 - lib/bogo/version.rb
@@ -113,3 +114,4 @@ signing_key:
 specification_version: 4
 summary: Helper libraries
 test_files: []
+has_rdoc: