module-cluster 1.3.7 → 1.4.0

data/lib/module-cluster/_private_/ModuleCluster/CascadeFeatures.rb

@@ -0,0 +1,54 @@
+
+module ModuleCluster::CascadeFeatures
+  
+  extend ModuleCluster::CascadeFeatures::PerformCascades
+  
+  #####################
+  #  append_features  #
+  #####################
+
+  def append_features( hooked_instance )
+
+    ModuleCluster::CascadeFeatures.cascade_features( self, hooked_instance, cluster_stack.prepending_include_hooks )
+    
+    super
+    
+  end
+  
+  ##############
+  #  included  #
+  ##############
+
+  def included( hooked_instance )
+
+    super
+
+    ModuleCluster::CascadeFeatures.cascade_features( self, hooked_instance, cluster_stack.include_hooks )
+    
+  end
+  
+  ###################
+  #  extend_object  #
+  ###################
+
+  def extend_object( hooked_instance )
+
+    ModuleCluster::CascadeFeatures.cascade_features( self, hooked_instance, cluster_stack.prepending_extend_hooks )
+    
+    super
+    
+  end
+  
+  ##############
+  #  extended  #
+  ##############
+
+  def extended( hooked_instance )
+
+    super
+
+    ModuleCluster::CascadeFeatures.cascade_features( self, hooked_instance, cluster_stack.extend_hooks )
+
+  end
+  
+end

data/lib/module-cluster/_private_/ModuleCluster/CascadeFeatures/ClusterStack.rb

@@ -0,0 +1,44 @@
+
+module ModuleCluster::CascadeFeatures::ClusterStack
+
+  #########################
+  #  self.cluster_stacks  #
+  #########################
+
+  def self.cluster_stacks
+    
+    return @cluster_stacks ||= Hash.new
+    
+  end
+
+  ########################
+  #  self.cluster_stack  #
+  ########################
+
+  def self.cluster_stack( class_or_module )
+    
+    cluster_stack_for_class_or_module = nil
+    
+    unless cluster_stack_for_class_or_module = cluster_stacks[ class_or_module ]
+      
+      cluster_stack_for_class_or_module = ModuleCluster::ClusterStack.new
+      
+      cluster_stacks[ class_or_module ] = cluster_stack_for_class_or_module
+      
+    end
+
+    return cluster_stack_for_class_or_module
+     
+  end
+
+  ###################
+  #  cluster_stack  #
+  ###################
+
+  def cluster_stack
+    
+    return ModuleCluster::CascadeFeatures::ClusterStack.cluster_stack( self )
+     
+  end
+
+end

data/lib/module-cluster/_private_/ModuleCluster/CascadeFeatures/PerformCascades.rb

@@ -0,0 +1,209 @@
+
+module ModuleCluster::CascadeFeatures::PerformCascades
+
+  ######################
+  #  cascade_features  #
+  ######################
+  
+  def cascade_features( module_self, hooked_instance, set_stack )
+    
+    # This method is called when a ModuleCluster module is included or extended.
+    # It determines what modules should be included/extended and which should cascade.
+    
+    # for each set:
+    set_stack.each do |this_set|
+
+      # Block sets simply run a block at a hook. They do not include or extend returns from the block.
+      # The hooked module will not be extended by ModuleCluster.
+      if this_set.is_a?( ModuleCluster::ClusterStack::Block::Set )
+
+        if this_set.dependency_module.should_run_block?( hooked_instance )
+
+          case this_set.runtime_block.arity
+            when 0
+              module_self.instance_eval( & this_set.runtime_block )
+            else
+              module_self.instance_exec( hooked_instance, & this_set.runtime_block )
+          end
+
+        end
+        
+      # Other sets take parameters and an optional block. The optional block returns are included
+      # or extended like the parameters provided.
+      else
+        
+        # dependency modules can cause instances to be included/extended and/or cascade
+        should_include = this_set.dependency_module.should_include_or_extend?( hooked_instance )
+        should_cascade = this_set.dependency_module.should_cascade?( hooked_instance )
+
+        # cascade parameter modules as appropriate
+        cascade_modules_into_hooked_instance( module_self, hooked_instance, this_set, this_set.modules ) if should_cascade
+
+        # include/extend parameter modules as appropriate
+        include_extend_modules( module_self, hooked_instance, this_set, this_set.modules ) if should_include        
+        
+        # process runtime block if present
+        if this_set.runtime_includes_or_extends_block
+          
+          # if we have a runtime block, run block and collect returns as appropriate
+          if runtime_modules = collect_block_runtime_result_modules( module_self, hooked_instance, this_set )
+        
+            # cascade return modules if appropriate
+            cascade_modules_into_hooked_instance( module_self, hooked_instance, this_set, runtime_modules ) if should_cascade
+          
+            # include/extend return modules if appropriate
+            include_extend_modules( module_self, hooked_instance, this_set, runtime_modules ) if should_include
+          
+          end
+          
+        end
+        
+      end
+      
+    end
+            
+  end
+
+  ############################
+  #  include_extend_modules  #
+  ############################
+
+  def include_extend_modules( module_self, hooked_instance, set, modules )
+
+    # Collect include/extend modules from this set into our eventual include/extend order.
+    case set.include_or_extend
+      when :include_and_extend
+        include_or_extend_hooked_instance( hooked_instance, set, true, true, modules )
+      when :include
+        include_or_extend_hooked_instance( hooked_instance, set, true, false, modules )
+      when :extend
+        include_or_extend_hooked_instance( hooked_instance, set, false, true, modules )
+    end
+    
+  end
+
+  ##########################################
+  #  cascade_modules_into_hooked_instance  #
+  ##########################################
+
+  def cascade_modules_into_hooked_instance( module_self, hooked_instance, set, modules )
+
+    # if we are supposed to cascade we need to extend with the ModuleCluster dependency module
+    hooked_instance.extend( set.dependency_module )
+
+    # and we call the set's definition method to cascade
+    hooked_instance.__send__( set.method, *modules )
+
+  end
+  
+  #######################################
+  #  include_or_extend_hooked_instance  #
+  ######################################
+  
+  def include_or_extend_hooked_instance( hooked_instance, set, should_include, should_extend, modules )
+    
+    # We have collected includes, extends, transparent cascades.
+    # Now we want to actually include/extend/cascade as appropriate.
+    
+    # If we have a module (a class is a module):
+    module_self = self
+    if hooked_instance.is_a?( Module )
+
+      hooked_instance.module_eval do
+        
+        if should_include                                                                                      and 
+           module_self.should_include_or_extend_instance?( set.module_class_instance_or_all, hooked_instance ) and 
+           ! modules.empty?
+           
+          include( *modules.reverse )
+          
+        end
+        
+        if should_extend                                                                                       and 
+           module_self.should_include_or_extend_instance?( set.module_class_instance_or_all, hooked_instance ) and
+           ! modules.empty?
+           
+          extend( *modules.reverse )
+
+        end
+
+      end
+      
+    # Otherwise we have an instance:
+    else
+      
+      if should_extend                                                                                       and 
+         module_self.should_include_or_extend_instance?( set.module_class_instance_or_all, hooked_instance ) and 
+         ! modules.empty?
+
+        hooked_instance.extend( *modules.reverse )
+
+      end
+      
+    end
+    
+  end
+
+  ########################################
+  #  should_include_or_extend_instance?  #
+  ########################################
+
+  def should_include_or_extend_instance?( module_class_instance_or_all, into_instance )
+
+    # The set stack already corresponds to include or extend or both, we are testing all_module_class_or_instance for:
+    #
+    # * any include/extend
+    # * module include/extend
+    # * class include/extend
+    # * instance extend
+  
+    should_include_or_extend_instance = false
+    
+    if module_class_instance_or_all == :all                                                                               or
+       module_class_instance_or_all == :module   && ( into_instance.is_a?( Module ) && ! into_instance.is_a?( Class ) )   or
+       module_class_instance_or_all == :class    && into_instance.is_a?( Class )                                          or
+       module_class_instance_or_all == :instance && ! into_instance.is_a?( Module )
+       
+      should_include_or_extend_instance = true
+    
+    end
+    
+    return should_include_or_extend_instance
+    
+  end
+
+  ##########################################
+  #  collect_block_runtime_result_modules  #
+  ##########################################
+
+  def collect_block_runtime_result_modules( module_self, hooked_instance, set )
+
+    runtime_block_result_modules = nil
+
+    case set.runtime_includes_or_extends_block.arity
+      when 0
+        runtime_block_result_modules = module_self.instance_eval( & set.runtime_includes_or_extends_block )
+      else
+        runtime_block_result_modules = module_self.instance_exec( hooked_instance, & set.runtime_includes_or_extends_block )
+    end
+    
+    if runtime_block_result_modules
+
+      # make sure we have an array as a result
+      runtime_block_result_modules = [ runtime_block_result_modules ] unless runtime_block_result_modules.is_a?( Array )
+
+      # make sure members of our result array are modules
+      runtime_block_result_modules.delete_if do |this_result_instance|
+        ! this_result_instance.is_a?( Module )
+      end
+      
+      
+      runtime_block_result_modules = nil if runtime_block_result_modules.empty?
+      
+    end
+    
+    return runtime_block_result_modules
+    
+  end
+  
+end

data/lib/module-cluster/{ModuleCluster → _private_/ModuleCluster}/ClusterStack.rb

@@ -1,8 +1,6 @@
 
 class ModuleCluster::ClusterStack
 
-  Set = Struct.new( :dependency_module, :method, :include_or_extend, :modules, :runtime_includes_or_extends_block )
-
   include ModuleCluster::ClusterStack::Block
   include ModuleCluster::ClusterStack::Includes
   include ModuleCluster::ClusterStack::Extends

data/lib/module-cluster/{ModuleCluster → _private_/ModuleCluster}/ClusterStack/Block.rb

@@ -1,9 +1,8 @@
 
 module ModuleCluster::ClusterStack::Block
   
-  Set = Struct.new( :runtime_block )
-  
   include ModuleCluster::ClusterStack::Block::Class
   include ModuleCluster::ClusterStack::Block::Module
+  include ModuleCluster::ClusterStack::Block::Instance
 
 end

data/lib/module-cluster/_private_/ModuleCluster/ClusterStack/Block/Class.rb

@@ -0,0 +1,36 @@
+
+module ModuleCluster::ClusterStack::Block::Class
+  
+  ###################
+  #  class_include  #
+  ###################
+
+  def class_include( dependency_module, runtime_block )
+    include_hooks.push( ModuleCluster::ClusterStack::Block::Set.new( dependency_module, runtime_block ) )
+  end
+
+  ##################
+  #  class_extend  #
+  ##################
+
+  def class_extend( dependency_module, runtime_block )
+    extend_hooks.push( ModuleCluster::ClusterStack::Block::Set.new( dependency_module, runtime_block ) )
+  end
+
+  ###########################
+  #  prepend_class_include  #
+  ###########################
+
+  def prepend_class_include( dependency_module, runtime_block )
+    prepending_include_hooks.push( ModuleCluster::ClusterStack::Block::Set.new( dependency_module, runtime_block ) )
+  end
+
+  ##########################
+  #  prepend_class_extend  #
+  ##########################
+
+  def prepend_class_extend( dependency_module, runtime_block )
+    prepending_extend_hooks.push( ModuleCluster::ClusterStack::Block::Set.new( dependency_module, runtime_block ) )
+  end
+
+end

data/lib/module-cluster/_private_/ModuleCluster/ClusterStack/Block/Instance.rb

@@ -0,0 +1,20 @@
+
+module ModuleCluster::ClusterStack::Block::Instance
+
+  #####################
+  #  instance_extend  #
+  #####################
+
+  def instance_extend( dependency_module, runtime_block )
+    extend_hooks.push( ModuleCluster::ClusterStack::Block::Set.new( dependency_module, runtime_block ) )
+  end
+
+  #############################
+  #  prepend_instance_extend  #
+  #############################
+
+  def prepend_instance_extend( dependency_module, runtime_block )
+    prepending_extend_hooks.push( ModuleCluster::ClusterStack::Block::Set.new( dependency_module, runtime_block ) )
+  end
+
+end

data/lib/module-cluster/_private_/ModuleCluster/ClusterStack/Block/Module.rb

@@ -0,0 +1,36 @@
+
+module ModuleCluster::ClusterStack::Block::Module
+
+  ####################
+  #  module_include  #
+  ####################
+
+  def module_include( dependency_module, runtime_block )
+    include_hooks.push( ModuleCluster::ClusterStack::Block::Set.new( dependency_module, runtime_block ) )
+  end
+
+  ###################
+  #  module_extend  #
+  ###################
+
+  def module_extend( dependency_module, runtime_block )
+    extend_hooks.push( ModuleCluster::ClusterStack::Block::Set.new( dependency_module, runtime_block ) )
+  end
+
+  ############################
+  #  prepend_module_include  #
+  ############################
+
+  def prepend_module_include( dependency_module, runtime_block )
+    prepending_include_hooks.push( ModuleCluster::ClusterStack::Block::Set.new( dependency_module, runtime_block ) )
+  end
+
+  ###########################
+  #  prepend_module_extend  #
+  ###########################
+
+  def prepend_module_extend( dependency_module, runtime_block )
+    prepending_extend_hooks.push( ModuleCluster::ClusterStack::Block::Set.new( dependency_module, runtime_block ) )
+  end
+
+end

data/lib/module-cluster/_private_/ModuleCluster/ClusterStack/Block/Set.rb

@@ -0,0 +1,2 @@
+
+ModuleCluster::ClusterStack::Block::Set = Struct.new( :dependency_module, :runtime_block )

data/lib/module-cluster/_private_/ModuleCluster/ClusterStack/Extends.rb

@@ -0,0 +1,108 @@
+
+module ModuleCluster::ClusterStack::Extends
+  
+  ##################
+  #  extend_hooks  #
+  ##################
+
+  def extend_hooks
+    return @extend_hooks ||= Array.new
+  end
+
+  #####################
+  #  extend_includes  #
+  #####################
+  
+  def extend_includes( module_instance, method, includes, runtime_includes_block )
+    extend_hooks.push( ModuleCluster::ClusterStack::Set.new( module_instance, method, :all, :include, includes, runtime_includes_block ) )
+  end
+  
+  ####################
+  #  extend_extends  #
+  ####################
+
+  def extend_extends( module_instance, method, extends, runtime_extends_block )
+    extend_hooks.push( ModuleCluster::ClusterStack::Set.new( module_instance, method, :all, :extend, extends, runtime_extends_block ) )
+  end
+
+  #################################
+  #  extend_includes_and_extends  #
+  #################################
+  
+  def extend_includes_and_extends( module_instance, method, includes_and_extends, runtime_includes_and_extends_block )
+    extend_hooks.push( ModuleCluster::ClusterStack::Set.new( module_instance, method, :all, :include_and_extend, includes_and_extends, runtime_includes_and_extends_block ) )
+  end
+
+  ############################
+  #  module_extend_includes  #
+  ############################
+  
+  def module_extend_includes( module_instance, method, includes, runtime_includes_block )
+    extend_hooks.push( ModuleCluster::ClusterStack::Set.new( module_instance, method, :module, :include, includes, runtime_includes_block ) )
+  end
+  
+  ###########################
+  #  module_extend_extends  #
+  ###########################
+
+  def module_extend_extends( module_instance, method, extends, runtime_extends_block )
+    extend_hooks.push( ModuleCluster::ClusterStack::Set.new( module_instance, method, :module, :extend, extends, runtime_extends_block ) )
+  end
+
+  ########################################
+  #  module_extend_includes_and_extends  #
+  ########################################
+  
+  def module_extend_includes_and_extends( module_instance, method, includes_and_extends, runtime_includes_and_extends_block )
+    extend_hooks.push( ModuleCluster::ClusterStack::Set.new( module_instance, method, :module, :include_and_extend, includes_and_extends, runtime_includes_and_extends_block ) )
+  end
+
+  ###########################
+  #  class_extend_includes  #
+  ###########################
+  
+  def class_extend_includes( module_instance, method, includes, runtime_includes_block )
+    extend_hooks.push( ModuleCluster::ClusterStack::Set.new( module_instance, method, :class, :include, includes, runtime_includes_block ) )
+  end
+  
+  ##########################
+  #  class_extend_extends  #
+  ##########################
+
+  def class_extend_extends( module_instance, method, extends, runtime_extends_block )
+    extend_hooks.push( ModuleCluster::ClusterStack::Set.new( module_instance, method, :class, :extend, extends, runtime_extends_block ) )
+  end
+
+  #######################################
+  #  class_extend_includes_and_extends  #
+  #######################################
+  
+  def class_extend_includes_and_extends( module_instance, method, includes_and_extends, runtime_includes_and_extends_block )
+    extend_hooks.push( ModuleCluster::ClusterStack::Set.new( module_instance, method, :class, :include_and_extend, includes_and_extends, runtime_includes_and_extends_block ) )
+  end
+
+  ##############################
+  #  instance_extend_includes  #
+  ##############################
+  
+  def instance_extend_includes( module_instance, method, includes, runtime_includes_block )
+    extend_hooks.push( ModuleCluster::ClusterStack::Set.new( module_instance, method, :instance, :include, includes, runtime_includes_block ) )
+  end
+  
+  #############################
+  #  instance_extend_extends  #
+  #############################
+
+  def instance_extend_extends( module_instance, method, extends, runtime_extends_block )
+    extend_hooks.push( ModuleCluster::ClusterStack::Set.new( module_instance, method, :instance, :extend, extends, runtime_extends_block ) )
+  end
+
+  ##########################################
+  #  instance_extend_includes_and_extends  #
+  ##########################################
+  
+  def instance_extend_includes_and_extends( module_instance, method, includes_and_extends, runtime_includes_and_extends_block )
+    extend_hooks.push( ModuleCluster::ClusterStack::Set.new( module_instance, method, :instance, :include_and_extend, includes_and_extends, runtime_includes_and_extends_block ) )
+  end
+  
+end