module-cluster 1.4.8 → 2.0.0

data/lib/module/cluster/instance_controller/instance_controller_interface.rb

@@ -0,0 +1,269 @@
+
+###
+# @private
+#
+# Interface implementation for {::Module::Cluster::InstanceController Module::Cluster::InstanceController}. 
+#   Implementation provided separately for ease of overloading.
+#
+module ::Module::Cluster::InstanceController::InstanceControllerInterface
+
+  ################
+  #  initialize  #
+  ################
+  
+  ###
+  #
+  # @param instance Object instance for which Instance Controller is to operate.
+  #
+  def initialize( instance )
+    
+    @instance = instance
+    
+  end
+
+  #########################
+  #  subclass_controller  #
+  #########################
+  
+  ###
+  # Returns subclass hook controller.
+  #
+  # @return [Module::Cluster::InstanceController::HookController] Subclass hook controller.
+  #
+  def subclass_controller
+
+    return @subclass_controller ||= self.class::HookController.new( :subclass, self )
+
+  end
+  
+  ###############################
+  #  before_include_controller  #
+  ###############################
+  
+  ###
+  # Returns before-include hook controller.
+  #
+  # @return [Module::Cluster::InstanceController::HookController] Before-include hook controller.
+  #
+  def before_include_controller
+
+    return @before_include_controller ||= self.class::HookController.new( :before_include, self )
+
+  end
+
+  ##############################
+  #  before_extend_controller  #
+  ##############################
+
+  ###
+  # Returns before-extend hook controller.
+  #
+  # @return [Module::Cluster::InstanceController::HookController] Before-extend hook controller.
+  #
+  def before_extend_controller
+
+    return @before_extend_controller ||= self.class::HookController.new( :before_extend, self )
+
+  end
+
+  #################################
+  #  before_include_extend_proxy  #
+  #################################
+  
+  ###
+  # Returns a multi-controller proxy for before-include and before-extend hook controllers.
+  #
+  # @return [Module::Cluster::InstanceController::MultipleHookControllerProxy] 
+  #           Before-include-extend hook controller proxy.
+  #
+  def before_include_extend_proxy
+
+    return @before_include_extend_proxy ||= self.class::MultipleHookControllerProxy.new( :before_include_extend,
+                                                                                         before_include_controller,
+                                                                                         before_extend_controller )
+
+  end
+
+  ###################################
+  #  before_include_subclass_proxy  #
+  ###################################
+  
+  ###
+  # Returns a multi-controller proxy for before-include and subclass hook controllers.
+  #
+  # @return [Module::Cluster::InstanceController::MultipleHookControllerProxy] 
+  #           Before-include-subclass hook controller proxy.
+  #
+  def before_include_subclass_proxy
+
+    return @before_include_subclass_proxy ||= self.class::MultipleHookControllerProxy.new( :before_include_subclass,
+                                                                                           before_include_controller,
+                                                                                           subclass_controller )
+
+  end
+
+  ##################################
+  #  before_extend_subclass_proxy  #
+  ##################################
+  
+  ###
+  # Returns a multi-controller proxy for before-extend and subclass hook controllers.
+  #
+  # @return [Module::Cluster::InstanceController::MultipleHookControllerProxy] 
+  #           Before-extend-subclass hook controller proxy.
+  #
+  def before_extend_subclass_proxy
+
+    return @before_extend_subclass_proxy ||= self.class::MultipleHookControllerProxy.new( :before_extend_subclass,
+                                                                                          before_include_controller,
+                                                                                          subclass_controller )
+
+  end
+
+  ##########################################
+  #  before_include_extend_subclass_proxy  #
+  ##########################################
+  
+  ###
+  # Returns a multi-controller proxy for before-include, before-extend, and subclass hook controllers.
+  #
+  # @return [Module::Cluster::InstanceController::MultipleHookControllerProxy] 
+  #           Before-include-extend-subclass hook controller proxy.
+  #
+  def before_include_extend_subclass_proxy
+
+    @before_include_extend_subclass_proxy ||= self.class::
+                                              MultipleHookControllerProxy.new( :before_include_extend_subclass,
+                                                                               before_include_controller,
+                                                                               before_extend_controller,
+                                                                               subclass_controller )
+    return @before_include_extend_subclass_proxy
+
+  end
+  
+  ##############################
+  #  after_include_controller  #
+  ##############################
+  
+  ###
+  # Returns after-include hook controller.
+  #
+  # @return [Module::Cluster::InstanceController::HookController] After-include hook controller.
+  #
+  def after_include_controller
+
+    return @after_include_controller ||= self.class::HookController.new( :after_include, self )
+
+  end
+
+  #############################
+  #  after_extend_controller  #
+  #############################
+
+  ###
+  # Returns after-extend hook controller.
+  #
+  # @return [Module::Cluster::InstanceController::HookController] After-extend hook controller.
+  #
+  def after_extend_controller
+
+    return @after_extend_controller ||= self.class::HookController.new( :after_extend, self )
+
+  end
+
+  ################################
+  #  after_include_extend_proxy  #
+  ################################
+  
+  ###
+  # Returns a multi-controller proxy for after-include and after-extend hook controllers.
+  #
+  # @return [Module::Cluster::InstanceController::MultipleHookControllerProxy] 
+  #           After-include-extend hook controller proxy.
+  #
+  def after_include_extend_proxy
+
+    return @after_include_extend_proxy ||= self.class::MultipleHookControllerProxy.new( :after_include_extend,
+                                                                                        after_include_controller,
+                                                                                        after_extend_controller )
+
+  end
+
+  ##################################
+  #  after_include_subclass_proxy  #
+  ##################################
+  
+  ###
+  # Returns a multi-controller proxy for after-include and subclass hook controllers.
+  #
+  # @return [Module::Cluster::InstanceController::MultipleHookControllerProxy] 
+  #           After-include-subclass hook controller proxy.
+  #
+  def after_include_subclass_proxy
+
+    return @after_include_subclass_proxy ||= self.class::MultipleHookControllerProxy.new( :after_include_subclass,
+                                                                                          after_include_controller,
+                                                                                          subclass_controller )
+
+  end
+
+  #################################
+  #  after_extend_subclass_proxy  #
+  #################################
+  
+  ###
+  # Returns a multi-controller proxy for after-extend and subclass hook controllers.
+  #
+  # @return [Module::Cluster::InstanceController::MultipleHookControllerProxy] 
+  #           After-extend-subclass hook controller proxy.
+  #
+  def after_extend_subclass_proxy
+
+    return @after_extend_subclass_proxy ||= self.class::MultipleHookControllerProxy.new( :after_extend_subclass,
+                                                                                         after_extend_controller,
+                                                                                         subclass_controller )
+
+  end
+
+  #########################################
+  #  after_include_extend_subclass_proxy  #
+  #########################################
+  
+  ###
+  # Returns a multi-controller proxy for after-include, after-extend, and subclass hook controllers.
+  #
+  # @return [Module::Cluster::InstanceController::MultipleHookControllerProxy] 
+  #           After-include-extend-subclass hook controller proxy.
+  #
+  def after_include_extend_subclass_proxy
+
+    @after_include_extend_subclass_proxy ||= self.class::
+                                             MultipleHookControllerProxy.new( :after_include_extend_subclass,
+                                                                              after_include_controller,
+                                                                              after_extend_controller,
+                                                                              subclass_controller )
+    return @after_include_extend_subclass_proxy
+
+  end
+
+  ######################################################################################################################
+  #   private ##########################################################################################################
+  ######################################################################################################################
+
+  ###
+  # These methods are not actually in private space but are internal methods for inter-object
+  # communications. They aren't intended for public interfacing.
+  #
+
+  ##############
+  #  instance  #
+  ##############
+  
+  ###
+  # Get reference to object instance for which Instance Controller (self) is operative.
+  #
+  # @!attribute [reader] Object instance for which this Instance Controller operates.
+  #
+  attr_reader :instance
+  
+end

data/lib/module/cluster/instance_controller/multiple_hook_controller_proxy.rb

@@ -0,0 +1,359 @@
+
+###
+# Proxies before include or extend definitions to both include and extend controllers.
+#
+class ::Module::Cluster::InstanceController::MultipleHookControllerProxy
+      
+  ################
+  #  initialize  #
+  ################
+  
+  ###
+  # @private
+  # 
+  # @param name Name of this Multiple Hook Controller Proxy.
+  #
+  # @param hook_controllers Hook Controllers for which this Proxy is operative.
+  #
+  def initialize( name, *hook_controllers )
+    
+    @name = name
+    
+    @hook_controllers = hook_controllers
+        
+  end
+  
+  #############
+  #  include  #
+  #############
+
+  ###
+  # Declare that modules should be included at event hook.
+  #
+  # @overload include( module, ..., & block )
+  #
+  #   @param module Module to include at event hook.
+  #
+  #   @yield [hooked_instance] Block for event hook action.
+  #   @yieldparam hooked_instance Instance for which event hook is occurring. 
+  #     Equivalent to parameter for #included and #extended.
+  # 
+  # @return [Module::Cluster::InstanceController::HookController] self
+  #
+  def include( *modules )
+    
+    @hook_controllers.each do |this_hook_controller|
+      this_hook_controller.include( *modules )
+    end
+
+    return self
+    
+  end
+
+  ############
+  #  extend  #
+  ############
+
+  ###
+  # Declare that modules should be extended at event hook.
+  #
+  # @overload extend( module, ..., & block )
+  #
+  #   @param module Module to extend at event hook.
+  #
+  #   @yield [hooked_instance] Block for event hook action.
+  #   @yieldparam hooked_instance Instance for which event hook is occurring. 
+  #     Equivalent to parameter for #included and #extended.
+  # 
+  # @return [Module::Cluster::InstanceController::HookController] self
+  #
+  def extend( *modules )
+
+    @hook_controllers.each do |this_hook_controller|
+      this_hook_controller.extend( *modules )
+    end
+
+    return self
+    
+  end
+
+  ########################
+  #  include_and_extend  #
+  ########################
+
+  ###
+  # Declare that modules should be included and extended at event hook. See also #extend_and_include.
+  #
+  # @overload include_and_extend( module, ..., & block )
+  #
+  #   @param module Module to include and extend at event hook.
+  #
+  #   @yield [hooked_instance] Block for event hook action.
+  #   @yieldparam hooked_instance Instance for which event hook is occurring. 
+  #     Equivalent to parameter for #included and #extended.
+  # 
+  # @return [Module::Cluster::InstanceController::HookController] self
+  #
+  def include_and_extend( *modules )
+    
+    @hook_controllers.each do |this_hook_controller|
+      this_hook_controller.include_and_extend( *modules )
+    end
+
+    return self
+    
+  end
+
+  ########################
+  #  extend_and_include  #
+  ########################
+
+  ###
+  # Declare that modules should be extended and included at event hook. Order is reversed from #include_and_extend.
+  #
+  # @overload extend_and_include( module, ..., & block )
+  #
+  #   @param module Module to extend and include at event hook.
+  #
+  #   @yield [hooked_instance] Block for event hook action.
+  #   @yieldparam hooked_instance Instance for which event hook is occurring. 
+  #     Equivalent to parameter for #included and #extended.
+  # 
+  # @return [Module::Cluster::InstanceController::HookController] self
+  #
+  def extend_and_include( *modules )
+    
+    @hook_controllers.each do |this_hook_controller|
+      this_hook_controller.extend_and_include( *modules )
+    end
+
+    return self
+    
+  end
+
+  ############
+  #  action  #
+  ############
+  
+  ###
+  # Declare that action should be performed at event hook.
+  #
+  # @yield [hooked_instance] Block for event hook action.
+  # @yieldparam hooked_instance Instance for which event hook is occurring. 
+  #   Equivalent to parameter for #included and #extended.
+  # 
+  # @return [Module::Cluster::InstanceController::HookController] self
+  #
+  def action( & block )
+    
+    @hook_controllers.each do |this_hook_controller|
+      this_hook_controller.action( & block )
+    end
+
+    return self
+    
+  end
+
+  ###################
+  #  before_extend  #
+  ###################
+  
+  ###
+  # Declare that chained actions should be inserted into the event stack prior to the location 
+  #   in the same event stack where provided module(s) are specified to be extended.
+  #
+  # @overload before_extend( module, ..., & block )
+  #
+  #   @param module Module that insert should be prior to.
+  #
+  #   @yield [hooked_instance] Block for event hook action.
+  #   @yieldparam hooked_instance Instance for which event hook is occurring. 
+  #     Equivalent to parameter for #included and #extended.
+  #
+  # @return [Module::Cluster::InstanceController::HookController::ChainProxy] Chain Proxy for chained declarations.
+  #
+  def before_extend( *modules )
+    
+    return chain_proxy.before_extend( *modules )
+    
+  end
+
+  ####################
+  #  before_include  #
+  ####################
+  
+  ###
+  # Declare that chained actions should be inserted into the event stack prior to the location 
+  #   in the same event stack where provided module(s) are specified to be included.
+  #
+  # @overload before_include( module, ..., & block )
+  #
+  #   @param module Module that insert should be prior to.
+  #
+  #   @yield [hooked_instance] Block for event hook action.
+  #   @yieldparam hooked_instance Instance for which event hook is occurring. 
+  #     Equivalent to parameter for #included and #extended.
+  #
+  # @return [Module::Cluster::InstanceController::HookController::ChainProxy] Chain Proxy for chained declarations.
+  #
+  def before_include( *modules )
+    
+    return chain_proxy.before_include( *modules )
+    
+  end
+
+  ##############################
+  #  before_include_or_extend  #
+  #  before_extend_or_include  #
+  ##############################
+  
+  ###
+  # Declare that chained actions should be inserted into the event stack prior to the location 
+  #   in the same event stack where provided module(s) are specified to be included or extended.
+  #
+  # @overload before_include_or_extend( module, ..., & block )
+  #
+  #   @param module Module that insert should be prior to.
+  #
+  #   @yield [hooked_instance] Block for event hook action.
+  #   @yieldparam hooked_instance Instance for which event hook is occurring. 
+  #     Equivalent to parameter for #included and #extended.
+  #
+  # @return [Module::Cluster::InstanceController::HookController::ChainProxy] Chain Proxy for chained declarations.
+  #
+  def before_include_or_extend( *modules )
+
+    return chain_proxy.before_include_or_extend( *modules )
+    
+  end
+  
+  alias_method :before_extend_or_include, :before_include_or_extend
+  
+  ###################
+  #  after_include  #
+  ###################
+  
+  ###
+  # Declare that chained actions should be inserted into the event stack after the location 
+  #   in the same event stack where provided module(s) are specified to be included.
+  #
+  # @overload before_include( module, ..., & block )
+  #
+  #   @param module Module that insert should be after.
+  #
+  #   @yield [hooked_instance] Block for event hook action.
+  #   @yieldparam hooked_instance Instance for which event hook is occurring. 
+  #     Equivalent to parameter for #included and #extended.
+  #
+  # @return [Module::Cluster::InstanceController::HookController::ChainProxy] Chain Proxy for chained declarations.
+  #
+  def after_include( *modules )
+
+    return chain_proxy.after_include( *modules )
+    
+  end
+
+  ##################
+  #  after_extend  #
+  ##################
+  
+  ###
+  # Declare that chained actions should be inserted into the event stack after the location 
+  #   in the same event stack where provided module(s) are specified to be extended.
+  #
+  # @overload before_extend( module, ..., & block )
+  #
+  #   @param module Module that insert should be after.
+  #
+  #   @yield [hooked_instance] Block for event hook action.
+  #   @yieldparam hooked_instance Instance for which event hook is occurring. 
+  #     Equivalent to parameter for #included and #extended.
+  #
+  # @return [Module::Cluster::InstanceController::HookController::ChainProxy] Chain Proxy for chained declarations.
+  #
+  def after_extend( *modules )
+
+    return chain_proxy.after_extend( *modules )
+    
+  end
+
+  #############################
+  #  after_include_or_extend  #
+  #  after_extend_or_include  #
+  #############################
+  
+  ###
+  # Declare that chained actions should be inserted into the event stack after the location 
+  #   in the same event stack where provided module(s) are specified to be included or extended.
+  #
+  # @overload before_include_or_extend( module, ..., & block )
+  #
+  #   @param module Module that insert should be after.
+  #
+  #   @yield [hooked_instance] Block for event hook action.
+  #   @yieldparam hooked_instance Instance for which event hook is occurring. 
+  #     Equivalent to parameter for #included and #extended.
+  #
+  # @return [Module::Cluster::InstanceController::HookController::ChainProxy] Chain Proxy for chained declarations.
+  #
+  def after_include_or_extend( *modules )
+    
+    return chain_proxy.after_include_or_extend( *modules )
+    
+  end
+
+  alias_method :after_extend_or_include, :after_include_or_extend
+  
+  ######################################################################################################################
+  #   private ##########################################################################################################
+  ######################################################################################################################
+
+  ###
+  # These methods are not actually in private space but are internal methods for inter-object
+  # communications. They aren't intended for public interfacing.
+  #
+
+  #################
+  #  chain_proxy  #
+  #################
+  
+  ###
+  # @private
+  #
+  # Get Chain Proxy instance used by this Multiple Hook Controller Proxy.
+  #
+  # @return [Module::Cluster::InstanceController::MultipleHookControllerProxy::ChainProxy] Chain Proxy instance.
+  #
+  def chain_proxy
+
+    return @chain_proxy ||= self.class::ChainProxy.new( self )
+    
+  end
+
+  ##########
+  #  name  #
+  ##########
+  
+  ###
+  # @private
+  #
+  # Name of hook controller.
+  #
+  # @return [Symbol,String] Name.
+  #
+  attr_reader :name
+
+  ######################
+  #  hook_controllers  #
+  ######################
+  
+  ###
+  # @private
+  #
+  # @!attribute [reader] Hook Controllers this Proxy proxies.
+  #
+  # @return [Array<Module::Cluster::InstanceController::HookController>] Hook Controllers this Proxy proxies.
+  #
+  attr_reader :hook_controllers
+    
+end