exponential-backoff 0.0.1 → 0.0.2

data/.travis.yml

@@ -1,5 +1,4 @@
 language: ruby
-script: ruby -Ilib -Itest test/exponential_backoff_test.rb
 rvm:
   - 1.9.3
   - 1.9.2

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+0.0.2
+
+  - Initialize backoff with Array or Range as a convenience.
+  - Check if given iteration is one of intervals when running in a loop.
+
+0.0.1
+
+  - Initial version.

data/README.md

@@ -38,6 +38,13 @@ maximal_elapsed_time = 60.0
 backoff = ExponentialBackoff.new(minimal_interval, maximal_elapsed_time)
 ```
 
+Arrays and ranges work for your convenience too:
+
+```ruby
+backoff = ExponentialBackoff.new(minimal_interval..maximal_elapsed_time)
+backoff = ExponentialBackoff.new([minimal_interval, maximal_elapsed_time])
+```
+
 You can get intervals for specified range:
 
 ```ruby
@@ -94,6 +101,15 @@ You can peek what is the current interval:
 backoff.current_interval # 3.764
 ```
 
+You can check if given iteration is one of intervals or maximum interval multiple:
+
+```ruby
+backoff = ExponentialBackoff.new(1, 10)
+backoff.iteration_active?(4) # true
+backoff.iteration_active?(20) # true
+backoff.iteration_active?(3) # false
+```
+
 There is also sugar for executing block of code until successful with increasing intervals:
 
 ```ruby
@@ -111,7 +127,7 @@ end
 Running tests
 -------------
 
-    ruby -Ilib -Itest test/exponential_backoff_test.rb
+    bundle exec rake test
 
 
 Supported rubies

data/Rakefile

@@ -1,2 +1,10 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/*_test.rb"
+end
+
+desc "Run tests"
+task :default => :test

data/exponential-backoff.gemspec

@@ -13,4 +13,6 @@ Gem::Specification.new do |gem|
   gem.name          = "exponential-backoff"
   gem.require_paths = ["lib"]
   gem.version       = ExponentialBackoff::VERSION
+  
+  gem.add_development_dependency 'rake'
 end

data/lib/exponential_backoff.rb

@@ -4,9 +4,14 @@ class ExponentialBackoff
   attr_accessor :multiplier, :randomize_factor
   attr_reader   :current_interval
 
-  def initialize(minimal_interval, maximum_elapsed_time)
-    @maximum_elapsed_time = maximum_elapsed_time
-    @minimal_interval = minimal_interval
+  def initialize(interval, maximum_elapsed_time = nil)
+    if interval.respond_to?(:first)
+      @minimal_interval, @maximum_elapsed_time = interval.first, interval.last
+    else
+      @minimal_interval, @maximum_elapsed_time = interval, maximum_elapsed_time
+    end
+    raise ArgumentError, "Invalid range specified" if [@minimal_interval, @maximum_elapsed_time].any? { |i| !i.is_a?(Numeric) }
+
     @randomize_factor = 0
     @multiplier = 2.0
     clear
@@ -20,6 +25,16 @@ class ExponentialBackoff
     @current_interval = @enumerator.next
   end
 
+  def iteration_active?(iteration)
+    index = 0
+    current_interval = interval_at(index)
+    while current_interval < iteration && current_interval < @maximum_elapsed_time
+      index += 1
+      current_interval = interval_at(index)
+    end
+    current_interval == iteration || iteration % @maximum_elapsed_time == 0
+  end
+
   def intervals_for(range)
     range.to_a.map { |iteration| interval_at(iteration) }
   end

data/lib/exponential_backoff/version.rb

@@ -1,3 +1,3 @@
 class ExponentialBackoff
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/exponential_backoff_test.rb

@@ -2,6 +2,22 @@ require 'test/unit'
 require 'exponential_backoff'
 
 class ExponentialBackoffTest < Test::Unit::TestCase
+  def test_range_initializer
+    backoff = ExponentialBackoff.new(1..5)
+    assert_equal [1, 2, 4, 5], backoff.intervals_for(0..3)
+  end
+
+  def test_array_initializer
+    backoff = ExponentialBackoff.new([1, 5])
+    assert_equal [1, 2, 4, 5], backoff.intervals_for(0..3)
+  end
+
+  def test_no_maximal_time
+    assert_raise ArgumentError do
+      backoff = ExponentialBackoff.new(2)
+    end
+  end
+
   def test_multiplier_default
     min, max = 1, 2
     backoff = ExponentialBackoff.new(min, max)
@@ -154,5 +170,20 @@ class ExponentialBackoffTest < Test::Unit::TestCase
     elapsed = Time.now.to_f - time
     assert elapsed >= 0.3
   end
+
+  def test_iteration_active_for_one_from_list
+    backoff = ExponentialBackoff.new(1, 10)
+    assert backoff.iteration_active?(4)
+  end
+
+  def test_iteration_active_for_maximum_interval_multiple
+    backoff = ExponentialBackoff.new(1, 10)
+    assert backoff.iteration_active?(20)
+  end
+
+  def test_iteration_active_for_not_from_list_and_not_multiple
+    backoff = ExponentialBackoff.new(1, 10)
+    refute backoff.iteration_active?(6)
+  end
 end
 

metadata

@@ -1,16 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: exponential-backoff
 version: !ruby/object:Gem::Version
-  version: 0.0.1
   prerelease: 
+  version: 0.0.2
 platform: ruby
 authors:
 - Paweł Pacana
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-26 00:00:00.000000000 Z
-dependencies: []
+date: 2013-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :development
 description: 
 email:
 - pawel.pacana@gmail.com
@@ -20,6 +36,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -35,23 +52,28 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+      segments:
+      - 0
+      hash: 4010949273159976482
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 4010949273159976482
+  none: false
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Exponential backoff algorithm for better reconnect intervals.
 test_files:
 - test/exponential_backoff_test.rb
-has_rdoc: