group_delegator 0.1.1

data/lib/group_delegator/group_delegator_klasses.rb

@@ -0,0 +1,62 @@
+class GroupDelegatorKlasses
+  include SourceHelper
+  #unload these methods so the proxy object will handle them
+  [:to_s,:inspect,:=~,:!~,:===].each do |m|
+    undef_method m
+  end
+  
+  #source_classes is the container the holds the classes that will be proxied
+  class << self
+    #unload these methods so the proxy class will handle them
+    [:to_s,:inspect,:=~,:!~,:===].each do |m|
+      undef_method m
+    end
+    
+    attr_accessor :__class_source_group , :__all_class_methods, :__concurrency_model
+    
+    #sets the classes that will be proxied
+    def __set_source_classes(classes_to_proxy, concurrency_model = :iterative)
+      @__concurrency_model = concurrency_model
+      sources_data = SourceHelper.set_sources_data(classes_to_proxy)
+      @source_obj_methods = sources_data[:source_methods]
+      @sources = sources_data[:source_objs]
+      @__all_class_methods = @source_obj_methods.keys
+      @__class_source_group = SourceGroup.new(@sources, concurrency_model) if @sources.size > 0
+    end
+    
+    def __source_classes
+      @sources
+    end
+    
+  end #class<<self
+  
+  #initializing class instance variables
+  self.__set_source_classes([])
+  
+  def self.method_missing(m, *args, &block)
+    if self.__all_class_methods.include? m
+      resp = self.__class_source_group.forward(m, *args, &block)
+      else
+      raise NoMethodError, "#{self.class} can't find the class method #{m} in any of its sources"
+    end
+  end
+  
+  def initialize(*args)
+    #changed self to self.class
+    concurrency_model = self.class.__concurrency_model
+    raise "No Source Classes set" unless self.class.__source_classes.size > 0
+    proxied_objs = self.class.__source_classes.map {|klass| klass.new(*args) }
+    sources_data = SourceHelper.set_sources_data(proxied_objs)
+    @source_obj_methods = sources_data[:source_methods]
+    @source_objects = sources_data[:source_objs]
+    @instance_source_group = SourceGroup.new(@source_objects, concurrency_model)
+  end
+
+  def method_missing(m, *args, &block)
+    if @source_obj_methods.include? m
+      resp = @instance_source_group.forward(m, *args, &block)
+    else
+      raise NoMethodError, "#{self.class} object can't find the method #{m} in any of its sources"
+    end
+  end
+end 

data/lib/group_delegator/source_group.rb

@@ -0,0 +1,161 @@
+require 'thread'
+
+#This class is the container for the objects that will receive common method calls
+# It also manages the concurrency model to be used when performing the method calls
+class SourceGroup
+  attr_accessor :concurrency_model #:sources, :valid_response_trace, :invalid_response_list
+  
+  #Built-in concurrency models for delegating methods
+  ##execute forwarding in an iterative fashion
+  IterativeBlock = lambda{ |sources, m, *args, &block|
+    all_resps = {}
+    sources.each do |source|
+      this_resp = {}
+      begin
+        #collect valid responses
+        all_resps[:valid] ||= {}
+        all_resps[:valid][source] = source.__send__(m, *args, &block)
+      rescue NoMethodError
+        #oops we have some invalid responses, collect those too
+        all_resps[:invalid] ||= []
+        all_resps[:invalid] << source 
+      end
+    end
+    all_resps
+  }
+  
+  ##If we like speed (with a dash of danger) we can thread the requests rather than iterate
+  ThreadedBlock= lambda{ |sources, m, *args, &block|
+    all_resps = {}
+    threads = []
+    sources.each do |source|
+      threads << Thread.new(source) do |src|
+        Thread.current[:src] = src
+        begin
+          Thread.current[:resp] = src.__send__(m, *args, &block)
+        rescue
+          Thread.current[:err] =  src
+        end
+      end
+    end
+    
+    threads.each do |t|
+      t.join
+      src = t[:src]  #proxied object
+      if t[:resp]
+        #valid response
+        all_resps[:valid] ||= {}
+        all_resps[:valid][src] = t[:resp]
+      elsif t[:err]
+        #oops error
+        all_resps[:invalid] ||= []
+        all_resps[:invalid] << t[:err]
+      else
+        raise "source returned an invalid responseto its thread."\
+             "Response thread: #{t} source: #{source.inspect}"
+      end
+    end
+    all_resps
+  }
+  
+   ##More speed (with more danger) we can use the first valid response (note the change in t.join)
+   ##How to react to the first response, maybe fibers?
+  ThreadedFirstResponseBlock= lambda{ |sources, m, *args, &block|
+    t0 = Time.now
+    first_resp = {}
+    source_threads = []
+    queue = Queue.new
+    sources.each do |source|
+      source_threads << Thread.new do
+        begin
+          queue << { source => source.__send__(m, *args, &block)}
+        rescue
+          Thread.current[:err] =  source #these errored out before a valid entry in queue
+        end
+      end
+    end
+
+    valid_response = nil
+    #limit the time for responses
+    check_queue = Thread.new do
+      until valid_response do
+        sleep 0.01 #don't consume all available resources on a silly event loop
+        valid_response = queue.shift   #shift not pop in case more than one response in queue
+      end
+      Thread.current[:q_response] = valid_response
+    end
+  
+    #Continue if all source_threads finish,  but if check_queue finishes first, continue regardless of source_threads status
+    any_thread_running = true
+    while any_thread_running do
+      sleep 0.01
+      any_src_thr_alive = source_threads.inject(false) {|alive, thr| alive || thr.status}
+      any_thread_running = check_queue.status && any_src_thr_alive
+    end
+    
+    t1 = Time.now
+    
+    if (t1-t0) < 0.1
+      sleep 0.05  #give time fot things to stabilize
+    end
+    #puts "Response from queue: #{check_queue[:q_response].inspect}"
+    
+
+    invalid_resps = []
+    source_threads.each do |t|
+      invalid_resps << t[:err] if t[:err]
+    end
+    #returning source_threads so that the caller can join them if needed (i.e. ending in a know state)
+    #invalid_responses only contains responsed from threads that completed prior to the first valid response
+    first_resp = { :valid => valid_response, :invalid => invalid_resps, :threads => source_threads }
+  }
+  
+  #  
+  def initialize(sources, concurrency_model = :iterative)
+    @sources = sources
+    @concurrency_model = concurrency_model
+  end
+  
+  def forward(m, *args, &block)
+    forward_custom(@concurrency_model, m, *args, &block)
+  end
+  
+  def forward_custom(forward_method, m, *args, &block)
+    forward_block = case forward_method
+      when :iterative
+        IterativeBlock
+      when :threaded
+        ThreadedBlock
+      when :first_response
+        ThreadedFirstResponseBlock
+      when Proc
+        forward_method
+      else
+        raise "Invalid parameter: #{forward_method.inspect}"
+      end
+      
+    @valid_response_trace = {}
+    @invalid_response_list = []
+    sources = @sources
+    if sources.size > 0
+      resp = forward_block.call(sources, m, *args, &block)
+      @valid_response_trace = resp[:valid]
+    else
+      raise "No sources assigned"
+    end
+    @valid_response_trace
+  end
+
+  #just some sugar
+  def forward_iterative(m, *args, &block)
+    forward_custom(:iterative, m, *args, & block)
+  end
+
+  def forward_threaded(m, *args, &block)
+    forward_custom(:threaded, m, *args, & block)
+  end
+
+  def forward_first_resp(m, *args, &block)
+    forward_custom(:first_response, m, *args, &block)
+  end
+end

data/lib/group_delegator/source_helper.rb

@@ -0,0 +1,17 @@
+module SourceHelper
+  def self.set_sources_data(proxied_objs)
+    source_obj_methods = {} #map of all methods to the objects that use them
+    proxied_objs.each do |proxied_obj|
+      proxied_obj.methods.each do |proxy_method|
+        source_obj_methods[proxy_method] ||= [proxied_obj]
+        source_obj_methods[proxy_method] << proxied_obj
+      end
+    end
+    {:source_methods => source_obj_methods, :source_objs => proxied_objs}
+  end
+  
+  def __set_sources_data(proxied_objs)
+    raise "No source instances set" unless proxied_objs.size > 0
+    SourceHelper.set_sources_data(proxied_objs)
+  end
+end

data/spec/group_delegator_instances_spec.rb

@@ -0,0 +1,150 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'benchmark'
+
+#classes for testing
+class A
+  def common_method
+    :a
+  end
+  def some_method
+    :aa
+  end
+  def a_method
+    :aaa
+  end
+end
+
+class B
+  def common_method
+    :b
+  end
+end
+
+class C
+  def common_method
+    :c
+  end
+  def some_method
+    :cc
+  end
+end
+
+shared_examples_for "instance delegator - entire collection" do
+  it "passes methods to the underlying instances of the group" do
+    group_obj.common_method.should == {@a_obj => :a, @b_obj => :b, @c_obj => :c}
+  end
+end
+
+shared_examples_for "instance delegator - first response" do
+  it "passes methods to the first responing instance" do
+        expected_result_set = {@a_obj=>:a, @b_obj=>:b, @c_obj=>:c}
+        result = group_obj.common_method
+        result_key = result.keys.first
+        expected_result_set.keys.should include result_key
+        result_value = result.values.first
+        expected_result_set.values.should include result_value
+  end
+end
+
+describe "delegating to a group of instance objects" do
+  before(:each) do
+    @a_obj = A.new; @b_obj = B.new; @c_obj = C.new
+  end
+
+  describe "default concurrency model (iterative)" do
+    it_should_behave_like  "instance delegator - entire collection" do
+      let(:group_obj) { GroupDelegatorInstances.new([@a_obj, @b_obj, @c_obj]) }
+     end
+  end
+
+  describe "iterative concurrency model" do
+    it_should_behave_like  "instance delegator - entire collection" do
+      let(:group_obj) { GroupDelegatorInstances.new([@a_obj, @b_obj, @c_obj], :iterative) }
+     end
+  end
+
+  describe "threaded concurrency model" do
+    it_should_behave_like  "instance delegator - entire collection" do
+      let(:group_obj) { GroupDelegatorInstances.new([@a_obj, @b_obj, @c_obj], :threaded) }
+     end
+  end
+
+  describe "first response concurrency model" do
+    it_should_behave_like "instance delegator - first response" do
+      let(:group_obj) { GroupDelegatorInstances.new([@a_obj, @b_obj, @c_obj], :first_response) }
+    end
+  end
+end
+
+
+
+class BenchA
+  def common_method
+    sleep 0.3
+    :a
+  end
+end
+
+class BenchB
+  def common_method
+    sleep 0.2
+    :b
+  end
+end
+
+class BenchC
+  def common_method
+    sleep 0.1
+    :c
+  end
+end
+
+describe "benchmarks" do
+  before(:all) do
+    @execution_times = {}
+  end
+
+  after(:all) do
+    p @execution_times
+  end
+
+  describe "iterative" do
+    before(:each) do
+      @a_obj = BenchA.new; @b_obj = BenchB.new; @c_obj = BenchC.new
+      @group_obj = GroupDelegatorInstances.new([@a_obj, @b_obj, @c_obj], :iterative)
+    end
+
+    it "executes" do
+      @execution_times[:iterative] = Benchmark.realtime { @group_obj.common_method }
+    end
+  end
+
+  describe "threaded" do
+    before(:each) do
+      @a_obj = BenchA.new; @b_obj = BenchB.new; @c_obj = BenchC.new
+      @group_obj = GroupDelegatorInstances.new([@a_obj, @b_obj, @c_obj], :threaded)
+    end
+
+    it "executes" do
+      @execution_times[:threaded] = Benchmark.realtime { @group_obj.common_method }
+    end
+  end
+
+  describe "first response" do
+    before(:each) do
+      @a_obj = BenchA.new; @b_obj = BenchB.new; @c_obj = BenchC.new
+      @group_obj = GroupDelegatorInstances.new([@a_obj, @b_obj, @c_obj], :first_response)
+    end
+
+    it "executes" do
+      @execution_times[:first_response] = Benchmark.realtime { @group_obj.common_method }
+    end
+  end
+
+  describe "results" do
+    it "checks the order of results" do
+      @execution_times[:first_response].should < @execution_times[:threaded]
+      @execution_times[:threaded].should < @execution_times[:iterative]
+    end
+  end
+end

data/spec/group_delegator_klasses_spec.rb

@@ -0,0 +1,270 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'benchmark'
+
+#classes for testing
+class A
+  attr_accessor :iv
+  def self.klass_method
+    :A
+  end
+  def self.a_klass_method
+    :AAA
+  end
+  def initialize(params)
+    @iv = params
+  end
+  def common_method
+    :a
+  end
+  def a_method
+    :aaa
+  end
+end
+
+class B
+  attr_accessor :iv
+  def self.klass_method
+    :B
+  end
+  def initialize(params)
+    @iv = params
+  end
+  def common_method
+    :b
+  end
+end
+
+class C
+  attr_accessor :iv
+  def self.klass_method
+    :C
+  end
+  def initialize(params)
+    @iv = params
+  end
+  def common_method
+    :c
+  end
+end
+
+
+shared_examples_for "class delegator - entire collection" do
+  it "passes methods to the source classes in the group" do
+    group_klass.klass_method.should == {A=>:A, B=>:B, C=>:C}
+  end
+end
+
+shared_examples_for "class delegator - first response" do
+  it "passes methods to the source classes in the group" do
+        expected_result_set = {A=>:A, B=>:B, C=>:C} 
+        result = group_klass.klass_method
+        result_key = result.keys.first
+        expected_result_set.keys.should include result_key
+        result_value = result.values.first
+        expected_result_set.values.should include result_value
+  end
+end
+
+shared_examples_for "class delegator - initializing objects" do
+  it "should initialize a group of objects based on the group of classes" do
+    source_classes = [ A, B, C ]
+    objs_iv = group_obj.iv
+    objs_iv.each_with_index do |obj_inst_var, i|
+      obj = obj_inst_var[0]
+      inst_var = obj_inst_var[1]
+      obj.class.should == source_classes[i]
+      inst_var.should == :some_init_params
+    end
+  end
+end
+
+shared_examples_for "instance delegator - entire collection" do
+  it "passes methods to the underlying instances of the group" do
+    group_obj.common_method.values == [:a, :b, :c]
+  end
+end
+
+shared_examples_for "instance delegator - first response" do
+  it "passes methods to the first responing instance" do
+        expected_result_set = [:a, :b, :c]
+        result = group_obj.common_method
+        result_value = result.values.first
+        expected_result_set.should include result_value
+  end
+end
+
+describe "delegating to a group of classes" do
+  before(:each) do
+    
+  end
+
+  describe "default concurrency model (iterative)" do
+    it_should_behave_like "class delegator - entire collection" do
+      #One line inheritance to prevent clobbering GroupDelegatorKlasses class inst var
+      DefaultGDK = Class.new(GroupDelegatorKlasses)
+      DefaultGDK.__set_source_classes( [A, B, C] )
+      let(:group_klass) { DefaultGDK }
+    end
+  end
+
+  describe "iterative concurrency model" do
+    it_should_behave_like "class delegator - entire collection" do
+      IterGDK = Class.new(GroupDelegatorKlasses)
+      IterGDK.__set_source_classes( [A, B, C], :iterative )
+      let(:group_klass) { IterGDK }
+    end
+  end
+
+  describe "threaded concurrency model" do
+    it_should_behave_like "class delegator - entire collection" do
+      ThreadGDK = Class.new(GroupDelegatorKlasses)
+      ThreadGDK.__set_source_classes( [A, B, C], :threaded )
+      let(:group_klass) { ThreadGDK }
+    end
+  end
+
+  describe "first response concurrency model" do
+    it_should_behave_like "class delegator - first response" do
+      FirstRespGDK = Class.new(GroupDelegatorKlasses)
+      FirstRespGDK.__set_source_classes( [A, B, C], :first_response )
+      let(:group_klass) { FirstRespGDK }
+    end
+  end
+
+  describe "default group initialization" do
+    it_should_behave_like "class delegator - initializing objects" do
+      DefObjGDK = Class.new(GroupDelegatorKlasses)
+      DefObjGDK.__set_source_classes( [A, B, C] )
+      let(:group_obj) { DefObjGDK.new(:some_init_params) }
+    end
+  end
+
+  describe "group initialization, iterative" do
+    it_should_behave_like "class delegator - initializing objects" do
+      IterObjGDK = Class.new(GroupDelegatorKlasses)
+      IterObjGDK.__set_source_classes( [A, B, C], :iterative )
+      let(:group_obj) { IterObjGDK.new(:some_init_params) }
+    end
+  end
+
+  describe "group initialization, threaded" do
+    it_should_behave_like "class delegator - initializing objects" do
+      ThreadObjGDK = Class.new(GroupDelegatorKlasses)
+      ThreadObjGDK.__set_source_classes( [A, B, C], :iterative )
+      let(:group_obj) { ThreadObjGDK.new(:some_init_params) }
+    end
+  end
+
+  describe "group initialization, first response" do
+    it_should_behave_like "instance delegator - first response" do
+      FirstRespObjGDK = Class.new(GroupDelegatorKlasses)
+      FirstRespObjGDK.__set_source_classes( [A, B, C], :first_response )
+      let(:group_obj) { FirstRespObjGDK.new(:some_init_params) }
+    end
+  end
+end
+
+describe "newly created instances should behave as grouped delegates" do
+  describe "default concurrency model (iterative)" do
+    it_should_behave_like  "instance delegator - entire collection" do
+      let(:group_obj) { DefObjGDK.new(:some_other_params) }
+     end
+  end
+
+  describe "iterative concurrency model" do
+    it_should_behave_like  "instance delegator - entire collection" do
+      let(:group_obj) { IterObjGDK.new(:some_other_params) }
+     end
+  end
+
+  describe "threaded concurrency model" do
+    it_should_behave_like  "instance delegator - entire collection" do
+      let(:group_obj) { ThreadObjGDK.new(:some_other_params) }
+     end
+  end
+
+  describe "first response concurrency model" do
+    it_should_behave_like  "instance delegator - first response" do
+      let(:group_obj) { FirstRespObjGDK.new(:some_other_params) }
+     end
+  end
+
+end
+
+class BenchA
+  def common_method
+    sleep 0.3
+    :a
+  end
+end
+
+class BenchB
+  def common_method
+    sleep 0.2
+    :b
+  end
+end
+
+class BenchC
+  def common_method
+    sleep 0.1
+    :c
+  end
+end
+
+describe "benchmarks" do
+  before(:all) do
+    @execution_times = {}
+  end
+
+  after(:all) do
+    p @execution_times
+  end
+
+  describe "iterative" do
+    before(:each) do
+      #@a_obj = BenchA.new; @b_obj = BenchB.new; @c_obj = BenchC.new
+      BenchObjGDK = Class.new(GroupDelegatorKlasses)
+      BenchObjGDK.__set_source_classes( [BenchA, BenchB, BenchC], :iterative )
+      @bench_obj = BenchObjGDK.new
+    end
+
+    it "executes" do
+      @execution_times[:iterative] = Benchmark.realtime { @bench_obj.common_method }
+    end
+  end
+
+  describe "threaded" do
+    before(:each) do
+      #@a_obj = BenchA.new; @b_obj = BenchB.new; @c_obj = BenchC.new
+      BenchObjGDK = Class.new(GroupDelegatorKlasses)
+      BenchObjGDK.__set_source_classes( [BenchA, BenchB, BenchC], :threaded )
+      @bench_obj = BenchObjGDK.new
+    end
+
+    it "executes" do
+      @execution_times[:threaded] = Benchmark.realtime { @bench_obj.common_method }
+    end
+  end
+
+  describe "first response" do
+    before(:each) do
+      #@a_obj = BenchA.new; @b_obj = BenchB.new; @c_obj = BenchC.new
+      BenchObjGDK = Class.new(GroupDelegatorKlasses)
+      BenchObjGDK.__set_source_classes( [BenchA, BenchB, BenchC], :first_response )
+      @bench_obj = BenchObjGDK.new
+    end
+
+    it "executes" do
+      @execution_times[:first_response] = Benchmark.realtime { @bench_obj.common_method }
+    end
+  end
+
+
+  describe "results" do
+    it "checks the order of results" do
+      @execution_times[:first_response].should < @execution_times[:threaded]
+      @execution_times[:threaded].should < @execution_times[:iterative]
+    end
+  end
+end