waiting 0.3.0 → 1.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZDY2YTVlYTIyZDBmZDhjZTkyNWE1YWU0ZWFiYmFmM2I5Mzg4YjY5ZQ==
-  data.tar.gz: !binary |-
-    ZWZjZWEyZDQ5M2Q3ZTJkODZmNmZjZGM1OGU4MmIyNGFjOWE0MzA0Zg==
+SHA1:
+  metadata.gz: b08f089788fa4aa60a91cfc69b2a680a35f20f22
+  data.tar.gz: 72039eb831a615731eb8f45047b629df86d45ae4
 SHA512:
-  metadata.gz: !binary |-
-    Nzg2N2YzYTJjNmI3NzU5OWFiMmY3OGE2MmEwMDFiMzg0MTcwNGM1NzIxNTM2
-    ODRjYjA4Y2NjMjcwNjE0MjNkNWFmZjU2MzBkZjVhYWI5M2ZhZGEzZWNmYWIw
-    ZDI5NGJkZDg3MjRkMzgxNTIyODNjMWI0MDlkZjgwNjVmMTg1ZmM=
-  data.tar.gz: !binary |-
-    NzZiMWNkODNkZDdjMTQxNDY5MDY4ZTdiZTM5ZDA1ZmUxMzU1ZjMyZTYzNzgz
-    NGI3MjRiYzY2MzI3MTYyYzUxNjM4NmFhYWMxNTc0ZGM2YWU4NTg3MDI0NDcy
-    MzgyMjhiMjYwY2I4NGNiMTljZmE1NWZlZTFiZGNmYzI1YjA3ZDM=
+  metadata.gz: ea6d32881afd57b5f9924d012a93535d7a6e9598f51a6d79affef040b6868e6adcfbc640f57d67b9b6fc836b20ab4198d9c233e963c180bc567fc974a12ae504
+  data.tar.gz: dcb1edb32ce17edc4798e413c68b1a15d7f20f11d7171e183b78e9d668c5395e8e91b2cd0813756b921780978fccf11cd7149bce07a9529434a2e03cec6ad1a7

data/.rubocop.yml

@@ -0,0 +1,3 @@
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cmd: 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/unit/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+end

data/README.md

@@ -25,36 +25,87 @@ Or install it yourself as:
 ```ruby
 require 'waiting'
 
-# optional
-Waiting.default_max_attempts = max_attempts # defaults to 60
-Waiting.default_interval = interval # seconds, defaults to 5
 
-# will poll every interval max_attempts times until something returns true
+# Optionally set defaults.
+#
+Waiting.exp_base = exp_base         # defaults to 1
+Waiting.interval = interval         # defaults to 5
+Waiting.max_attempts = max_attempts # defaults to 60
+Waiting.max_interval = max_interval # defaults to nil
+
+
+# Will poll every interval, max_attempts times until something is true
+#
 Waiting.wait do |waiter|
   waiter.done if something
 end
 
-# You can also specify the max_attempts and interval this way
-Waiting.wait(interval: interval, max_attempts: max_attempts) do |waiter|
+
+# Override the defaults here
+#
+Waiting.wait(exp_base: exp_base,
+             interval: interval,
+             max_attempts: max_attempts,
+             max_interval: max_interval
+            ) 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|
+
+# Or make an instance of Waiting to pass around
+#
+waiting = Waiting.new(exp_base: exp_base,
+                      interval: interval,
+                      max_attempts: max_attempts,
+                      max_interval: max_interval
+                     ) 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
+# And get it to wait
+#
+waiting.wait
+
+
+# Or overide any parameters here again
+#
+waiting.wait(exp_base: exp_base,
+             interval: interval,
+             max_attempts: max_attempts,
+             max_interval: max_interval
+            ) do |waiter|
+  waiter.done if something
+end
+
+
+# Access the wait parameters during the wait
+#
+waiting.wait do |waiter|
+  puts "attempts: #{waiter.attempts}"
+  puts "exp_base: #{waiter.exp_base}"
+  puts "interval: #{waiter.interval}"
+  puts "max_attempts: #{waiter.max_attempts}"
+  puts "max_interval: #{waiter.max_interval}"
+  waiter.done if something
+end
+# =>
+#   attempts: 0
+#   exp_base: 1
+#   interval: 5
+#   max_attempts: 60
+#   max_interval: nil
+
+
+# Leverage exp base for exponential back off
+#
+# Will wait for: 1, 2, 4, 8, 16, 16, 16...
+#
+waiting.wait(exp_base: 2,
+             interval: 1,
+             max_attempts: 16
+            ) do |waiter|
+  waiter.done if something
 end
 ```
 

data/lib/waiting.rb

@@ -1,72 +1,103 @@
-require 'waiting/timed_out_error'
 require 'waiting/waiter'
-require 'waiting/version'
 
-module Waiting
-  # get the default wait interval
-  # @return [Fixnum] the interval in seconds
-  def self.default_interval
-    @@default_interval ||= 5
-  end
+# Waits for things so you don't have to
+#
+class Waiting
+  # @param interval [Numeric] Polling interval in seconds.
+  # @param max_attempts [Numeric] Number of attempts before timing out.
+  # @param exp_base [Numeric] Increases the interval by the power of attempts.
+  # @param max_interval [Numeric] Interval limit for exponential backoff.
+  #
+  # @yield Block to check if the wait is over.
+  # @yieldparam waiter [Waiting::Waiter] call +#done+ if the wait is over
+  #
+  def initialize(exp_base: self.class.default_exp_base,
+                 interval: self.class.default_interval,
+                 max_attempts: self.class.default_max_attempts,
+                 max_interval: self.class.default_max_interval,
+                 &block)
 
-  # set the default wait interval
-  # @param [Fixnum] interval the interval in seconds
-  def self.default_interval=(interval)
-    @@default_interval = interval
-  end
+    @exp_base = exp_base
+    @interval = interval
+    @max_attempts = max_attempts
+    @max_interval = max_interval
 
-  # get the default exponential base
-  # @return [Float] the base for exponential backoff
-  def self.default_exp_base
-    @@default_exp_base ||= 1
+    @block = block
   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
+  class << self
+    # The default exp base
+    #
+    # @return [Numeric]
+    #
+    attr_accessor :default_exp_base
 
-  # get the default max attempts
-  # @return [Fixnum] the default max attempts
-  def self.default_max_attempts
-    @@default_max_attempts ||= 60
-  end
+    # The default interval
+    #
+    # @return [Numeric]
+    #
+    attr_accessor :default_interval
 
-  # set the default max attempts
-  # @param [Fixnum] max_attempts the default max attempts
-  def self.default_max_attempts=(max_attempts)
-    @@default_max_attempts = max_attempts
-  end
+    # The default max attempts
+    #
+    # @return [Numeric]
+    #
+    attr_accessor :default_max_attempts
 
-  # wait for something, call #ok on the waiter to signal the wait is over
-  # @param [Hash] opts the options to wait with.
-  # @option opts [Fixnum] :interval polling interval in seconds for checking
-  # @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 }
+    # The default max interval
+    #
+    # @return [Numeric]
+    #
+    attr_accessor :default_max_interval
+  end
 
-    waiter = Waiter.new
+  self.default_exp_base = 1
+  self.default_interval = 5
+  self.default_max_attempts = 60
+  self.default_max_interval = nil
 
-    attempts = 0
+  # @param interval [Numeric] Polling interval in seconds.
+  # @param max_attempts [Numeric] Number of attempts before timing out.
+  # @param exp_base [Numeric] Increases the interval by the power of attempts.
+  # @param max_interval [Numeric] Interval limit for exponential backoff.
+  #
+  # @yield Block to check if the wait is over.
+  # @yieldparam waiter [Waiting::Waiter] call +#done+ if the wait is over
+  #
+  def wait(exp_base: @exp_base,
+           interval: @interval,
+           max_attempts: @max_attempts,
+           max_interval: @max_interval,
+           &block)
 
-    loop do
-      if attempts >= max_attempts
-        fail(TimedOutError, "Timed out after #{interval * max_attempts}s")
-      end
+    Waiter.new(
+      exp_base: exp_base,
+      interval: interval,
+      max_attempts: max_attempts,
+      max_interval: max_interval
+    ).wait(&(block || @block))
+  end
 
-      waiter.attempts = attempts
-      waiter.exp_base = exp_base
-      waiter.interval = interval
-      waiter.max_attempts = max_attempts
+  # @see +#wait+
+  #
+  # @param interval [Numeric] Polling interval in seconds.
+  # @param max_attempts [Numeric] Number of attempts before timing out.
+  # @param exp_base [Numeric] Increases the interval by the power of attempts.
+  # @param max_interval [Numeric] Interval limit for exponential backoff.
+  #
+  # @yield Block to check if the wait is over.
+  # @yieldparam waiter [Waiting::Waiter] call +#done+ if the wait is over
+  #
+  def self.wait(exp_base: default_exp_base,
+                interval: default_interval,
+                max_attempts: default_max_attempts,
+                max_interval: default_max_interval,
+                &block)
 
-      yield(waiter)
-      break if waiter.done?
-      sleep exp_base ** attempts * interval
-      attempts += 1
-    end
+    new(exp_base: exp_base,
+        interval: interval,
+        max_attempts: max_attempts,
+        max_interval: max_interval,
+        &block).wait
   end
-
 end

data/lib/waiting/timed_out_error.rb

@@ -1,5 +1,6 @@
-module Waiting
-  class TimedOutError < StandardError
-
-  end
-end
+class Waiting
+  # Raised when the wait times out
+  #
+  class TimedOutError < StandardError
+  end
+end

data/lib/waiting/version.rb

@@ -1,3 +1,5 @@
-module Waiting
-  VERSION = '0.3.0'
+class Waiting
+  # The version of Waiting
+  #
+  VERSION = '1.0.0'.freeze
 end

data/lib/waiting/waiter.rb

@@ -1,24 +1,97 @@
-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
-    end
-
-    # Mark the waiter as done
-    def done
-      @done = true
-    end
-
-    # Is the waiter done?
-    # @return [Boolean] if the waiter is done
-    def done?
-      @done
-    end
-  end
-end
+require 'waiting/timed_out_error'
+
+class Waiting
+  # The class that patiently waits
+  #
+  class Waiter
+    # The current attempt number
+    #
+    # @return [Integer]
+    #
+    attr_reader :attempts
+
+    # The exp base
+    #
+    # @return [Numeric]
+    #
+    attr_accessor :exp_base
+
+    # The interval
+    #
+    # @return [Numeric]
+    #
+    attr_accessor :interval
+
+    # The max attempts
+    #
+    # @return [Numeric]
+    #
+    attr_accessor :max_attempts
+
+    # The max interval
+    #
+    # @return [Numeric]
+    #
+    attr_accessor :max_interval
+
+    # @param interval [Numeric] Polling interval in seconds.
+    # @param max_attempts [Numeric] Number of attempts before timing out.
+    # @param exp_base [Numeric] Increases the interval by the power of attempts.
+    # @param max_interval [Numeric] Interval limit for exponential backoff.
+    #
+    # @yield Block to check if the wait is over.
+    # @yieldparam waiter [Waiting::Waiter] call +#done+ if the wait is over
+    #
+    def initialize(exp_base: Waiting.default_exp_base,
+                   interval: Waiting.interval,
+                   max_attempts: Waiting.max_attempts,
+                   max_interval: Waiting.max_interval)
+
+      @exp_base = exp_base
+      @interval = interval
+      @max_attempts = max_attempts
+      @max_interval = max_interval
+
+      @done = false
+      @attempts = 0
+    end
+
+    # Mark the waiter as done
+    #
+    def done
+      @done = true
+    end
+
+    # Is the waiter done?
+    #
+    # @return [Boolean] if the waiter is done
+    #
+    def done?
+      @done
+    end
+
+    # Waits for +#done+ to be called
+    #
+    # @raise [Waiting::TimedOutError] if +#done+ is not called in time
+    #
+    def wait
+      loop do
+        if @attempts >= max_attempts
+          raise Waiting::TimedOutError,
+                "Timed out after #{interval * max_attempts}s"
+        end
+
+        yield(self)
+        break if done?
+        wait_once
+      end
+    end
+
+    private
+
+    def wait_once
+      sleep [exp_base**attempts * interval, max_interval].compact.min
+      @attempts += 1
+    end
+  end
+end

data/waiting.gemspec

@@ -14,12 +14,15 @@ Gem::Specification.new do |spec|
   spec.description   = "Waits so you don't have to!"
   spec.homepage      = 'https://github.com/meringu/waiting'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.13.0'
+  spec.add_development_dependency 'yard', '~> 0.9.8'
 end

metadata

@@ -1,57 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: waiting
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Henry Muru Paenga
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2016-06-08 00:00:00.000000000 Z
+date: 2017-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.8
 description: Waits so you don't have to!
 email:
 - meringu@gmail.com
@@ -59,10 +101,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
@@ -81,17 +125,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Waits so you don't have to!