waiting 0.2.0 → 0.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OTRlMTI4YjYwOTE2OThkMDE1NjJlYzQ0MmEyNzYzMGNjYTUyZTE2NQ==
+    ZDY2YTVlYTIyZDBmZDhjZTkyNWE1YWU0ZWFiYmFmM2I5Mzg4YjY5ZQ==
   data.tar.gz: !binary |-
-    YmU1NmY4ZDJiZjBlNjg4NzI4YjEwYTg3ZjhhMmVkYTg4NjYyYTdhNw==
+    ZWZjZWEyZDQ5M2Q3ZTJkODZmNmZjZGM1OGU4MmIyNGFjOWE0MzA0Zg==
 SHA512:
   metadata.gz: !binary |-
-    MTk3YWM5YmYxZGU0OTAzNWExNThjNTY1Zjk3MTA1YWU1MmFhOWNjZTg0N2Zh
-    YjJlMzdkMDg0ZTFjYzAwYTM0NzVkOTdhNWMwYzRkMWY3NzExY2E3ZTE2MTYz
-    MzUwYWZlMDU2OTQ0OWU2OTI1YzdhYjg5NWJmYmJkZDdjOGE5MTA=
+    Nzg2N2YzYTJjNmI3NzU5OWFiMmY3OGE2MmEwMDFiMzg0MTcwNGM1NzIxNTM2
+    ODRjYjA4Y2NjMjcwNjE0MjNkNWFmZjU2MzBkZjVhYWI5M2ZhZGEzZWNmYWIw
+    ZDI5NGJkZDg3MjRkMzgxNTIyODNjMWI0MDlkZjgwNjVmMTg1ZmM=
   data.tar.gz: !binary |-
-    NDdhODgxNjZjMmI4YWYwZDRiYjNhNmE0NGFmZDMwZDE3YTQ0YWFkYjFiMDVm
-    MWEzZThhNTVhY2M5MjgwMmRhNzdiYTVhMzRmMjc3MTAxMjg4NWJmMDk1NWM1
-    MTM2N2MzN2Y4MDI2ODNhOTFiMWEwNWI3ZDBjMjViZjg0OGQ5MWY=
+    NzZiMWNkODNkZDdjMTQxNDY5MDY4ZTdiZTM5ZDA1ZmUxMzU1ZjMyZTYzNzgz
+    NGI3MjRiYzY2MzI3MTYyYzUxNjM4NmFhYWMxNTc0ZGM2YWU4NTg3MDI0NDcy
+    MzgyMjhiMjYwY2I4NGNiMTljZmE1NWZlZTFiZGNmYzI1YjA3ZDM=

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/meringu/waiting.svg?branch=master)](https://travis-ci.org/meringu/waiting)
+
 # Waiting
 
 Waits so you don't have to!
@@ -36,6 +38,24 @@ end
 Waiting.wait(interval: interval, max_attempts: max_attempts) do |waiter|
   waiter.done if something
 end
+
+# You can do exponential backoff
+# for example, exp_base of 2 and an interval of 1 second,
+# will wait for: 1,2,4,8...
+Waiting.wait(exp_base: 2) do |waiter|
+  waiter.done if something
+end
+
+# or specify it as a default
+Waiting.default_exp_base = exp_base # exponential backoff base, defaults to 1
+
+# will log options, and give progress updates if you like  
+Waiting.wait do |waiter|
+  puts waiter.attempts
+  puts waiter.exp_base
+  puts waiter.interval
+  puts waiter.max_attempts
+end
 ```
 
 ## Contributing

data/lib/waiting/version.rb

@@ -1,3 +1,3 @@
 module Waiting
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/waiting/waiter.rb

@@ -1,5 +1,10 @@
 module Waiting
   class Waiter
+    attr_accessor :attempts
+    attr_accessor :exp_base
+    attr_accessor :interval
+    attr_accessor :max_attempts
+
     # Waiter is in waiting state to start with
     def initialize
       @done = false

data/lib/waiting.rb

@@ -15,6 +15,18 @@ module Waiting
     @@default_interval = interval
   end
 
+  # get the default exponential base
+  # @return [Float] the base for exponential backoff
+  def self.default_exp_base
+    @@default_exp_base ||= 1
+  end
+
+  # set the default exponential base
+  # @param [Float] exp_base the base for exponential backoff
+  def self.default_exp_base=(exp_base)
+    @@default_exp_base = exp_base
+  end
+
   # get the default max attempts
   # @return [Fixnum] the default max attempts
   def self.default_max_attempts
@@ -33,6 +45,7 @@ module Waiting
   # @option opts [Fixnum] :max_attempts number of attempts before failing
   def self.wait(opts = {})
     interval = opts.fetch(:interval) { default_interval }
+    exp_base = opts.fetch(:exp_base) { default_exp_base }
     max_attempts = opts.fetch(:max_attempts) { default_max_attempts }
 
     waiter = Waiter.new
@@ -43,10 +56,17 @@ module Waiting
       if attempts >= max_attempts
         fail(TimedOutError, "Timed out after #{interval * max_attempts}s")
       end
+
+      waiter.attempts = attempts
+      waiter.exp_base = exp_base
+      waiter.interval = interval
+      waiter.max_attempts = max_attempts
+
       yield(waiter)
       break if waiter.done?
-      sleep interval
+      sleep exp_base ** attempts * interval
       attempts += 1
     end
   end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: waiting
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Henry Muru Paenga
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-02 00:00:00.000000000 Z
+date: 2016-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler