asir 1.2.8 → 1.2.9

data/ChangeLog

@@ -1,3 +1,10 @@
+2012-06-19  Kurt A. Stephens  <ks.github@kurtstephens.com>
+
+	* v1.2.9: New Version: Fixes, New Functionality.
+	* ASIR::Error::Unforwardable.unforwardable is deprecated; use .modules.
+	* ASIR::AdaptiveValue: refactor ASIR::RetryBehavior sleep values.
+	* BUG: Transport#after_receive_message.call takes a Message::State.
+
 2012-03-14  Kurt A. Stephens  <ks.github@kurtstephens.com>
 
 	* v1.2.8: New Version: Additional functionality.

data/lib/asir/adaptive_value.rb

@@ -0,0 +1,81 @@
+module ASIR
+  # Adaptive Value.
+  # Return a Numeric #value which adapts.
+  # Useful for controlling adaptive retry sleep amounts or other
+  # values that must be stochastic.
+  #
+  # #init must be specified.
+  # #rand_factor should be a Float.
+  #
+  class AdaptiveValue
+    attr_accessor :init, :min, :max, :add, :mult, :rand_factor
+
+    def initialize opts = nil
+      if opts
+        opts.each do | k, v |
+          send(:"#{k}=", v)
+        end
+      end
+    end
+
+    # Returns a new value limited by #min and #max after applying the addition of #rand_factor.
+    def value
+      v = @value || init_or_error
+      v += v * rand(@rand_factor) if @rand_factor
+      v = @min if @min && v < @min
+      v = @max if @max && v > @max
+      v
+    end
+    def value= x
+      @value = x
+    end
+
+    # Returns a cached #value until #reset! or #new_value!.
+    def value!
+      @value_ ||= value
+    end
+
+    # Returns a new cached #value.
+    def new_value!
+      @value_ = nil
+      value!
+    end
+
+    # Resets #value to #init.
+    def reset!
+      @value_ = @value = nil
+      self
+    end
+
+    def to_i
+      x = value.to_i
+      adapt!
+      x
+    end
+
+    def to_f
+      x = value.to_f
+      adapt!
+      x
+    end
+
+    # Increments value by #add, if #add is set.
+    # Multiplies value by #mult, if #mult is set.
+    # Limits value by #min and #max.
+    def adapt!
+      @value ||= init_or_error
+      @value += @add if @add
+      @value *= @mult if @mult
+      @value = @min if @min && @value < @min
+      @value = @max if @max && @value > @max
+      self
+    end
+
+    private
+    def init_or_error
+      @init or raise ArgumentError, "init: not set"
+    end
+
+  end
+end
+

data/lib/asir/error.rb

@@ -39,9 +39,9 @@ module ASIR
         super(msg)
         self.set_backtrace original && original.backtrace
       end
-      def self.unforwardable;    @@unforwardable; end
-      def self.unforwardable= x; @@unforwardable = x; end
-      @@unforwardable ||= [
+      def self.modules;    @@modules; end
+      def self.modules= x; @@modules = x; end
+      @@modules ||= [
         ::SystemExit,
         ::SystemStackError,
         ::NoMemoryError,

data/lib/asir/main.rb

@@ -377,7 +377,7 @@ END
     transport.after_receive_message = lambda do | transport, state |
       message = state.message
       $0 = "#{old_arg0} #{transport.message_count} #{message.identifier}"
-      after_receive_message.call(transport, message)
+      after_receive_message.call(transport, state)
     end
     transport.run_server!
     self

data/lib/asir/message.rb

@@ -18,7 +18,7 @@ module ASIR
 
     def invoke!
       @result = Result.new(self, @receiver.__send__(@selector, *@arguments))
-    rescue *Error::Unforwardable.unforwardable => exc
+    rescue *Error::Unforwardable.modules => exc
       @result = Result.new(self, nil, Error::Unforwardable.new(exc))
     rescue ::Exception => exc
       @result = Result.new(self, nil, exc)

data/lib/asir/retry_behavior.rb

@@ -1,3 +1,6 @@
+require 'asir/error'
+require 'asir/adaptive_value'
+
 module ASIR
   # !SLIDE
   # Generic retry behavior
@@ -12,13 +15,15 @@ module ASIR
     attr_accessor :try_sleep_max
 
     # Yields:
-    #   :try, n_try
-    #   :rescue, exc
-    #   :retry, exc
-    #   :failed, nil
+    #   :try, n_try - for each attempt.
+    #   :rescue, exc - for any rescued exception.
+    #   :retry, exc - before each retry.
+    #   :failed, last_exc - when too many retrys occurred.
     def with_retry
       n_try = 0
-      sleep_secs = try_sleep
+      @try_sleep_value ||= ::ASIR::AdaptiveValue.new
+      @try_sleep_value.init = try_sleep
+      @try_sleep_value.reset!
       result = done = last_exception = nil
       begin
         n_try += 1
@@ -26,24 +31,27 @@ module ASIR
         done = true
       rescue *Error::Unrecoverable.modules
         raise
-      rescue *Error::Unforwardable.unforwardable
+      rescue *Error::Unforwardable.modules
         raise
       rescue ::Exception => exc
-        last_exception = exc
+        last_exc = exc
         yield :rescue, exc
         if ! try_max || try_max > n_try
           yield :retry, exc
-          if sleep_secs
+          if try_sleep
+            sleep_secs = @try_sleep_value.value
             sleep sleep_secs if sleep_secs > 0
-            sleep_secs += try_sleep_increment if try_sleep_increment
-            sleep_secs = try_sleep_max if try_sleep_max && sleep_secs > try_sleep_max
+            @try_sleep_value.init = try_sleep
+            @try_sleep_value.add  = try_sleep_increment
+            @try_sleep_value.max  = try_sleep_max
+            @try_sleep_value.adapt!
           end
           retry
         end
       end
       unless done
-        unless yield :failed, last_exception
-          exc = last_exception
+        unless yield :failed, last_exc
+          exc = last_exc
           raise RetryError, "Retry failed: #{exc.inspect}", exc.backtrace
         end
       end

data/lib/asir/transport.rb

@@ -165,7 +165,7 @@ module ASIR
         if message_ok
           if exception && ! result_ok
             case exception
-            when *Error::Unforwardable.unforwardable
+            when *Error::Unforwardable.modules
               unforwardable_exception = exception = Error::Unforwardable.new(exception)
             end
             state.result = Result.new(state.message, nil, exception)

data/lib/asir/version.rb

@@ -1,3 +1,3 @@
 module ASIR
-  VERSION = "1.2.8"
+  VERSION = "1.2.9"
 end

data/spec/adaptive_value_spec.rb

@@ -0,0 +1,103 @@
+require 'asir/adaptive_value'
+
+describe ASIR::AdaptiveValue do
+  it "should have a #value of #init." do
+    av = ASIR::AdaptiveValue.new(:init => 5)
+    av.value.should == 5
+    av.value.should == 5
+    av.value!.should == 5
+  end
+
+  it "should have a #value limited by #min." do
+    av = ASIR::AdaptiveValue.new(:init => 5, :min => 10)
+    av.value.should == 10
+    av.value.should == 10
+    av.value!.should == 10
+  end
+
+  it "should have a #value not limited by #min." do
+    av = ASIR::AdaptiveValue.new(:init => 15, :min => 10)
+    av.value.should == 15
+    av.value.should == 15
+    av.value!.should == 15
+  end
+
+  it "should have a #value limited by #max." do
+    av = ASIR::AdaptiveValue.new(:init => 5, :max => 10)
+    av.value.should == 5
+    av.value.should == 5
+    av.value!.should == 5
+  end
+
+  it "should have a #value not limited by #max." do
+    av = ASIR::AdaptiveValue.new(:init => 15, :max => 10)
+    av.value.should == 10
+    av.value.should == 10
+    av.value!.should == 10
+  end
+
+  it "should have a #value adjusted by #add." do
+    av = ASIR::AdaptiveValue.new(:init => 1, :add => 2)
+    av.value.should == 1
+    av.value.should == 1
+    av.adapt!
+    av.value.should == 3
+    av.value.should == 3
+    av.value!.should == 3
+    av.adapt!
+    av.value.should == 5
+    av.value.should == 5
+    av.value!.should == 3
+  end
+
+  it "should have a #value adjusted by #mult." do
+    av = ASIR::AdaptiveValue.new(:init => 10, :mult => 1.2)
+    av.value.should == 10
+    av.value.should == 10
+    av.adapt!
+    av.value.to_i.should == 12
+    av.value.to_i.should == 12
+    av.value!.to_i.should == 12
+    av.adapt!
+    av.value.to_i.should == 14
+    av.value.to_i.should == 14
+    av.value!.to_i.should == 12
+  end
+
+  it "should have an adapting #to_i and #to_f value." do
+    av = ASIR::AdaptiveValue.new(:init => 10, :mult => 1.2)
+    av.to_i.should == 10
+    av.to_f.should be_within(0.1).of(12.0)
+    av.to_f.should be_within(0.1).of(14.4)
+    av.to_f.should be_within(0.01).of(17.28)
+    av.to_i.should == 20
+  end
+
+  it "should have a #value adjusted by #rand_factor." do
+    av = ASIR::AdaptiveValue.new(:init => 10, :rand_factor => 0.5)
+    def av._ri
+      @_ri ||= -1
+      @_ri += 1
+    end
+    def av._rv
+      @_rv ||= (0...10).to_a
+    end
+    def av.rand scale
+      (_rv[_ri % _rv.size] / 10.0) * scale
+    end
+
+    av.value.should == 10
+    av.value.should == 10.5
+    av.value!.should == 11.0
+    av.value.should == 11.5
+    av.value.should == 12.0
+    av.value!.should == 11.0
+  end
+
+  it "should raise error if #init is not set." do
+    av = ASIR::AdaptiveValue.new(:rand_factor => 0.5)
+    lambda do
+      av.value
+    end.should raise_error(ArgumentError, /init: not set/)
+  end
+end

data/spec/message_spec.rb

@@ -47,7 +47,7 @@ describe "ASIR::Message" do
   end
 
   it 'should capture Unforwardable exceptions.' do
-    cls = ::ASIR::Error::Unforwardable.unforwardable.first
+    cls = ::ASIR::Error::Unforwardable.modules.first
     cls.should_not == nil
     msg = "This message".freeze
     message.selector = :raise_exception!

data/spec/retry_behavior_spec.rb

@@ -0,0 +1,56 @@
+require 'asir/retry_behavior'
+
+describe ASIR::RetryBehavior do
+  let(:cls) do
+    Class.new do
+      include ASIR::RetryBehavior
+      attr_accessor :sleeps
+      def sleeps; @sleeps ||= [ ]; end
+      def sleep x; sleeps << x; end
+      def yields; @yields ||= [ ]; end
+      def yielder &blk
+        Proc.new do | kind, value |
+          yields << [ kind, value ]
+          blk.call kind, value
+        end
+      end
+    end
+  end
+  subject { cls.new }
+
+  it 'should retry only try_max times, then raise RetryError' do
+    blk = subject.yielder do | kind, value |
+      raise "Fail" if kind == :try
+    end
+    subject.try_max = 10
+    lambda do
+      subject.with_retry(&blk)
+    end.should raise_error(ASIR::RetryBehavior::RetryError)
+    subject.sleeps.should == [ ]
+    subject.yields.select{|x| x[0] == :try}.map{|x| x[1]}.should == [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
+    subject.yields.select{|x| x[0] == :rescue}.map{|x| x[1]}.size.should == 10
+    subject.yields.select{|x| x[0] == :retry}.map{|x| x[1]}.size.should == 9
+    subject.yields.select{|x| x[0] == :failed}.map{|x| x[1]}.size.should == 1
+  end
+
+  it 'should sleep for increasing amounts' do
+    blk = subject.yielder do | kind, value |
+      raise "Fail" if kind == :try
+    end
+    subject.try_max = 10
+    subject.try_sleep = 10
+    subject.try_sleep_increment = 2
+    lambda do
+      subject.with_retry(&blk)
+    end.should raise_error(ASIR::RetryBehavior::RetryError)
+    subject.sleeps.should == [10, 12, 14, 16, 18, 20, 22, 24, 26]
+
+    subject.sleeps.clear
+    subject.yields.clear
+    lambda do
+      subject.with_retry(&blk)
+    end.should raise_error(ASIR::RetryBehavior::RetryError)
+    subject.sleeps.should == [10, 12, 14, 16, 18, 20, 22, 24, 26]
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asir
 version: !ruby/object:Gem::Version
-  version: 1.2.8
+  version: 1.2.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-15 00:00:00.000000000 Z
+date: 2013-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuid
@@ -178,6 +178,7 @@ files:
 - lab/phony_proc.rb
 - lab/spoon_test.rb
 - lib/asir.rb
+- lib/asir/adaptive_value.rb
 - lib/asir/additional_data.rb
 - lib/asir/application.rb
 - lib/asir/channel.rb
@@ -242,12 +243,14 @@ files:
 - lib/asir/uri_config.rb
 - lib/asir/uuid.rb
 - lib/asir/version.rb
+- spec/adaptive_value_spec.rb
 - spec/client_spec.rb
 - spec/debug_helper.rb
 - spec/demux_spec.rb
 - spec/example_spec.rb
 - spec/message_spec.rb
 - spec/performance_spec.rb
+- spec/retry_behavior_spec.rb
 - spec/spec_helper.rb
 - spec/thread_pool_spec.rb
 - spec/thread_variable_spec.rb
@@ -270,7 +273,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2378832726393842164
+      hash: -2116348420781161108
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -279,7 +282,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2378832726393842164
+      hash: -2116348420781161108
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -287,12 +290,14 @@ signing_key:
 specification_version: 3
 summary: Abstracting Services in Ruby
 test_files:
+- spec/adaptive_value_spec.rb
 - spec/client_spec.rb
 - spec/debug_helper.rb
 - spec/demux_spec.rb
 - spec/example_spec.rb
 - spec/message_spec.rb
 - spec/performance_spec.rb
+- spec/retry_behavior_spec.rb
 - spec/spec_helper.rb
 - spec/thread_pool_spec.rb
 - spec/thread_variable_spec.rb