try-until 0.3.0 → 0.4.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OTgyNWMzYmMwZjI0MWQ1OGJkZjRlYjJmNjVhMmM4NjViZjNmZTI3Mw==
+    ZTQ5NDkxMzE4ZDc2MGMzMjQ1OWYzM2NjNTE0NGI4MmUwMGE3M2ZlZA==
   data.tar.gz: !binary |-
-    YzliYTUyOGIwOTExNmUwNjZiZGVlMTMwNmRmZjY1NDc0Y2Y5ZGMxMQ==
+    ODZiMjJjYTllY2U4M2RjYjIyZDJhMjJkZWRlYWVhNjZiMzM2MTc4OA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZjRkOWU5NWI5M2I3OWI4OTJlMzNlNDc3ZTM3Y2I4ZmExNDNkNjU4ZGYyN2U0
-    MjUxNzY0NDhiOWY1YmQxZGEyMTQ4MDFkODFkODI5ZGUwZmRmZDk5YzE2NTlh
-    ZjcyNjZlZGQ0NTRiYzJjNzQ5YTlmZmEzODQ0YmNiYjZhMGNmNmU=
+    MjEwNjg4MDQ5NWFkZWE5MTdmNmFlZjU1MWQ2ZWRlM2I0ODA3NDI2YzFmMjY1
+    YWFiMDg5NTllMjNiY2QxMjYxZjNmODQ1ODA1MGVjNWU2Zjg4YjQxOTNhODBl
+    OWFkNTk5MTIxZWZhMjk0OTA4NDJjN2ZjYzU0ZWJjY2QyNjcwNWQ=
   data.tar.gz: !binary |-
-    ODY3MDVhMzAxNjlkZWRhMDE2NGFlNWE0ZDJhNDk4YzlmZjYxMWNkNTdmNDNi
-    MjgxZGI2NzU2ZjAwY2VlZTJmZTQ2Yzk4NDMxNTk0Y2YxYjRlMjdlMmYzODQ4
-    YWQ3MTRjNzUyZjIyMmRiYTgxOWY1ZWFjZGYyMGIwN2Y2ZWRiNGM=
+    MjI0MGExMjU4Yjc3ZjE1MzcyOWVkMjM5YWI4YjM3MjlhM2Y1ZDE3MzczYTNk
+    OTAwZDA1ZmE1NjkwMmVkYzI3MWQxMmRjZDhkOTI3YmEzY2JkNjY1YWVlYzkz
+    ODlkYjU4YmFlOThhYjM5MDFhMjlhMTdmNTgwYjhiNThkMWRmN2E=

data/lib/try_until/null_printer.rb

@@ -0,0 +1,7 @@
+module TryUntil
+  # Null-Object: Will be used unless user specifies another target for
+  # informational messages printed while Repeatedly does its work
+  class NullPrinter
+    def printf(*args); end
+  end
+end

data/lib/try_until/probe.rb

@@ -11,12 +11,21 @@ module TryUntil
     end
 
     def sample
-      @target.send(@method, *@args)
+      if args_is_one_hash?
+        @target.send(@method, @args)
+      else
+        @target.send(@method, *@args)
+      end
     end
 
     def to_s
       "Probe: #{@target.class}##{@method}(#{@args})"
     end
+
+    private
+    def args_is_one_hash?
+      @args.class == Hash
+    end
   end
 end
 

data/lib/try_until/repeatedly.rb

@@ -5,15 +5,19 @@ module TryUntil
   # result = Repeatedly.new(Probe.new(Object.new, :to_s))
   #   .attempts(5)
   #   .interval(10)
+  #   .delay(120)
   #   .rescues([ ArgumentError, IOError ])
   #   .stop_when(lambda { |response| JSON.parse(response.body)['id'] == 'some_id' })
+  #   .log_to($stdout)
   # .execute
   #
   # Not all of the above settings are required. These are the default values:
-  # attempt    = 3
+  # attempts   = 3
   # interval   = 0
+  # delay      = 0
   # rescues    = []
   # stop_when  = lambda { |response| false }
+  # log_to     = TryUntil::NullPrinter.new
   #
   class Repeatedly
 
@@ -31,6 +35,11 @@ module TryUntil
       self
     end
 
+    def delay(seconds)
+      @delay = seconds
+      self
+    end
+
     def rescues(errors)
       @rescues = errors
       self
@@ -41,6 +50,11 @@ module TryUntil
       self
     end
 
+    def log_to(io)
+      @log_to = io
+      self
+    end
+
     # The heart of this gem: This method will repeatedly call '#sample' on the
     # subject and evaluate if the expectated result is returned.
     # In case of errors it will rescue those and continue, provided the type
@@ -48,14 +62,23 @@ module TryUntil
     def execute
       @attempts = 3 unless @attempts
       @interval = 0 unless @interval
-      @stop_when = lambda { |response| false } unless @stop_when
+      @delay = 0 unless @delay
       @rescues = [] unless @rescues
+      @stop_when = lambda { |response| false } unless @stop_when
+      @log_to = NullPrinter.new unless @log_to
+
+      Kernel.sleep(@delay) if @delay > 0
       count = 0
       while count < @attempts
         begin
           result = @probe.sample
-          return result if @stop_when.call(result)
+          if @stop_when.call(result)
+            log_outcome(count, 'CONDITION_MET')
+            return result
+          end
+          log_outcome(count, 'CONDITION_NOT_MET')
         rescue *@rescues => exception
+          log_outcome(count, exception.class)
           raise exception, "During final attempt (#{@attempts} configured) target returned #{exception}" if count + 1 == @attempts
         ensure
           count += 1
@@ -69,5 +92,10 @@ module TryUntil
       { :probe => @probe.to_s, :attempts => @attempts, :interval => @interval,
         :rescues => @rescues, :stop_when => @stop_when }
     end
+
+    private
+    def log_outcome(count, outcome)
+      @log_to.printf("#{Time.new}|attempt ##{count + 1}|outcome: #{outcome}|#{@attempts - count - 1} attempts left\n")
+    end
   end
 end

data/lib/try_until/version.rb

@@ -1,3 +1,3 @@
 module TryUntil
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/try_until.rb

@@ -1,4 +1,3 @@
 require 'try_until/probe'
 require 'try_until/repeatedly'
-
-
+require 'try_until/null_printer'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: try-until
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Markus Krogemann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-10 00:00:00.000000000 Z
+date: 2013-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -62,6 +62,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/try-until.rb
+- lib/try_until/null_printer.rb
 - lib/try_until/probe.rb
 - lib/try_until/repeatedly.rb
 - lib/try_until/version.rb