cascading_configuration 1.0.0

data/lib/cascading_configuration/core/module.rb

@@ -0,0 +1,284 @@
+
+class ::CascadingConfiguration::Core::Module < ::Module
+  
+  DefaultEncapsulationName = :default
+  DefaultEncapsulation = ::CascadingConfiguration::Core::Encapsulation.new( DefaultEncapsulationName )
+  
+  include ::CascadingConfiguration::Core::EnableModuleSupport
+
+  ################
+  #  initialize  #
+  ################
+  
+  def initialize( ccm_name, 
+                  default_encapsulation_or_name = ::CascadingConfiguration::Core::Module::DefaultEncapsulation, 
+                  *ccm_aliases )
+    
+    super()
+    
+    encapsulation = ::CascadingConfiguration::Core::Encapsulation.encapsulation( default_encapsulation_or_name )
+    
+    @default_encapsulation = encapsulation
+    
+    @ccm_name = ccm_name
+    @ccm_aliases = ccm_aliases
+        
+    define_definition_methods( @ccm_name, *@ccm_aliases )
+        
+  end
+
+  ###########################
+  #  default_encapsulation  #
+  ###########################
+  
+  attr_reader :default_encapsulation
+
+  ##############
+  #  ccm_name  #
+  ##############
+  
+  attr_reader :ccm_name
+
+  #################
+  #  ccm_aliases  #
+  #################
+  
+  attr_reader :ccm_aliases
+  
+  ###############################
+  #  define_definition_methods  #
+  ###############################
+  
+  def define_definition_methods( ccm_name, *ccm_aliases )
+    
+    define_cascading_definition_method( ccm_name, *ccm_aliases )
+    define_module_definition_method( ccm_name, *ccm_aliases )
+    define_instance_definition_method( ccm_name, *ccm_aliases )
+    define_object_definition_method( ccm_name, *ccm_aliases )
+    define_local_instance_definition_method( ccm_name, *ccm_aliases )
+    
+  end
+  
+  ########################################
+  #  define_cascading_definition_method  #
+  ########################################
+  
+  def define_cascading_definition_method( ccm_name, *ccm_aliases )
+
+    ccm_method_name = cascading_method_name( ccm_name )
+    ccm_alias_names = ccm_aliases.collect { |this_alias| cascading_method_name( this_alias ) }
+
+    return define_method_with_extension_modules( ccm_method_name, ccm_alias_names, :all )
+
+  end
+
+  #####################################
+  #  define_module_definition_method  #
+  #####################################
+
+  def define_module_definition_method( ccm_name, *ccm_aliases )
+    
+    ccm_method_name = module_method_name( ccm_name )
+    ccm_alias_names = [ class_method_name( ccm_name ) ]
+    ccm_alias_names.concat( ccm_aliases.collect { |this_alias| module_method_name( this_alias ) } )
+    ccm_alias_names.concat( ccm_aliases.collect { |this_alias| class_method_name( this_alias ) } )
+    
+    return define_method_with_extension_modules( ccm_method_name, ccm_alias_names, :module )
+    
+  end
+
+  #######################################
+  #  define_instance_definition_method  #
+  #######################################
+
+  def define_instance_definition_method( ccm_name, *ccm_aliases )
+    
+    ccm_method_name = instance_method_name( ccm_name )
+    ccm_alias_names = ccm_aliases.collect { |this_alias| instance_method_name( this_alias ) }
+    
+    return define_method_with_extension_modules( ccm_method_name, ccm_alias_names, :instance )
+    
+  end
+
+  #############################################
+  #  define_local_instance_definition_method  #
+  #############################################
+
+  def define_local_instance_definition_method( ccm_name, *ccm_aliases )
+    
+    ccm_method_name = local_instance_method_name( ccm_name )
+    ccm_alias_names = ccm_aliases.collect { |this_alias| local_instance_method_name( this_alias ) }
+    
+    return define_method_with_extension_modules( ccm_method_name, ccm_alias_names, :local_instance )
+    
+  end
+
+  #####################################
+  #  define_object_definition_method  #
+  #####################################
+
+  def define_object_definition_method( ccm_name, *ccm_aliases )
+
+    ccm_method_name = object_method_name( ccm_name )
+    ccm_alias_names = ccm_aliases.collect { |this_alias| object_method_name( this_alias ) }
+
+    return define_method_with_extension_modules( ccm_method_name, ccm_alias_names, :object )
+    
+  end
+   
+  ##########################
+  #  create_configuration  #
+  ##########################
+
+  def create_configuration( encapsulation, instance, name )
+
+    encapsulation.register_configuration( instance, name, self )
+    
+    return self
+    
+  end
+
+  ##############################
+  #  initialize_configuration  #
+  ##############################
+  
+  def initialize_configuration( encapsulation, instance, name )
+    
+    # Nothing here - for subclasses to define.
+    
+  end
+
+  ###########################
+  #  define_configurations  #
+  ###########################
+  
+  def define_configurations( instance_controller, encapsulation, method_types, *names, & definer_block )
+
+    accessors = instance_controller.define_configuration_methods( self, encapsulation, method_types, names, & definer_block )
+    
+    instance = instance_controller.instance
+    
+    accessors.each do |this_accessor, this_write_accessor|
+      create_configuration( encapsulation, instance, this_accessor )
+    end
+    
+  end
+
+  ##################################################################################################
+      private ######################################################################################
+  ##################################################################################################
+
+  ###########################
+  #  cascading_method_name  #
+  ###########################
+  
+  def cascading_method_name( base_name )
+    
+    return 'attr_' << base_name.to_s
+    
+  end
+
+  ########################
+  #  module_method_name  #
+  ########################
+
+  def module_method_name( base_name )
+
+    return 'attr_module_' << base_name.to_s
+
+  end
+
+  #######################
+  #  class_method_name  #
+  #######################
+
+  def class_method_name( base_name )
+
+    return 'attr_class_' << base_name.to_s
+
+  end
+
+  ##########################
+  #  instance_method_name  #
+  ##########################
+
+  def instance_method_name( base_name )
+
+    return 'attr_instance_' << base_name.to_s
+
+  end
+
+  ################################
+  #  local_instance_method_name  #
+  ################################
+
+  def local_instance_method_name( base_name )
+
+    return 'attr_local_' << base_name.to_s
+
+  end
+
+  ########################
+  #  object_method_name  #
+  ########################
+
+  def object_method_name( base_name )
+
+    return 'attr_object_' << base_name.to_s
+
+  end
+
+  ##########################################
+  #  define_method_with_extension_modules  #
+  ##########################################
+
+  def define_method_with_extension_modules( ccm_method_name, ccm_aliases, *method_types )
+        
+    # Methods that define configurations that optionally take modules as parameters as well as a
+    # block that will be used to dynamically define an extension module for the instances created
+    # by the configurations. 
+    # 
+    # This defines attr_... :configuration_name, ModuleInstance, ... { ... }
+    
+    ccm = self
+     
+    #======================#
+    #  ccm_method_name_in  #
+    #======================#
+     
+    ccm_encapsulation_method_name = ccm_method_name.to_s + '_in'
+
+    define_method( ccm_encapsulation_method_name ) do |encapsulation_or_name, *args, & definer_block|
+      
+      encapsulation = ::CascadingConfiguration::Core::Encapsulation.encapsulation( encapsulation_or_name, true )
+
+      instance_controller = ::CascadingConfiguration::Core::InstanceController.instance_controller( self, true )
+
+      ccm.define_configurations( instance_controller, encapsulation, method_types, *args, & definer_block )                  
+      
+      return self
+      
+    end
+
+    #===================#
+    #  ccm_method_name  #
+    #===================#
+    
+    default_encapsulation = @default_encapsulation_name
+
+    define_method( ccm_method_name ) do |*args, & definer_block|
+      
+      return __send__( ccm_encapsulation_method_name, default_encapsulation, *args, & definer_block )
+      
+    end
+    
+    ccm_aliases.each do |this_alias|
+      alias_method( this_alias.to_s + '_in', ccm_encapsulation_method_name )
+      alias_method( this_alias, ccm_method_name )
+    end
+    
+    return self
+    
+  end
+   
+end

data/lib/cascading_configuration/core.rb

@@ -0,0 +1,23 @@
+
+# @private
+module ::CascadingConfiguration::Core
+  
+  #################
+  #  self.enable  #
+  #################
+  
+  # @private
+  def self.enable( instance, ccm )
+    
+    instance.const_set( :ClassInstance, ccm )
+
+    # Enable module instance so that when included it creates instance support
+    instance.extend( ::CascadingConfiguration::Core::EnableInstanceSupport )
+
+    instance.extend( ::ModuleCluster )
+
+    instance.include_or_extend_also_extends( instance::ClassInstance )
+    
+  end
+  
+end

data/lib/cascading_configuration/hash.rb

@@ -0,0 +1,103 @@
+
+###
+#  CascadingConfiguration::Hash allows definition of hash attributes that will composite downward through
+#  the ancestor chain.
+# 
+module ::CascadingConfiguration::Hash
+
+  ###
+  # Cascading hash attribute methods, which will affect instances according to include/extend pattern used.
+  #
+  # @method attr_hash
+  #
+  # @overload attr_hash( *names )
+  #   
+  #   @scope 
+  #
+  #   @param [Symbol,String,Hash{Symbol,String=>Symbol,String},Module] name The name to be used 
+  #    for the declared attribute. If a hash is passed, each key will be used as the setting 
+  #    name and accessor and each value will be used as the corresponding write accessor.
+  #
+  #   @yield [ ] Creates a new Module of type CascadingConfiguration::Core::InstanceController::ExtensionModule
+  #    and runs module_eval( & block ) on instance with provided block.
+  #
+  #   @return self
+  #
+
+  ###
+  # Cascading hash attribute module/class methods, which will affect all module singletons 
+  #   according to include/extend pattern used.
+  #
+  # @method attr_module_hash
+  #
+  # @overload attr_module_hash( *names )
+  #
+  #   @param [Symbol,String,Hash{Symbol,String=>Symbol,String}] name The name to be used 
+  #    for the declared attribute. If a hash is passed, each key will be used as the setting 
+  #    name and accessor and each value will be used as the corresponding write accessor.
+  #
+  #   @yield [ ] Creates a new Module of type CascadingConfiguration::Core::InstanceController::ExtensionModule
+  #    and runs module_eval( & block ) on instance with provided block.
+  #
+  #   @return self
+  #
+
+  ###
+  # Cascading hash instance methods, which will affect instances of including modules according to 
+  #   include/extend pattern used.
+  #
+  # @method attr_instance_hash
+  #
+  # @overload attr_instance_hash( *names )
+  #
+  #   @param [Symbol,String,Hash{Symbol,String=>Symbol,String}] name The name to be used 
+  #    for the declared attribute. If a hash is passed, each key will be used as the setting 
+  #    name and accessor and each value will be used as the corresponding write accessor.
+  #
+  #   @yield [ ] Creates a new Module of type CascadingConfiguration::Core::InstanceController::ExtensionModule
+  #    and runs module_eval( & block ) on instance with provided block.
+  #
+  #   @return self
+  #
+
+  ###
+  # Non-cascading hash methods that will affect the instance declared on as well as instances of that instance, 
+  #   if applicable.
+  #
+  # @method attr_local_hash
+  #
+  # @overload attr_local_hash( *names )
+  #
+  #   @param [Symbol,String,Hash{Symbol,String=>Symbol,String}] name The name to be used 
+  #    for the declared attribute. If a hash is passed, each key will be used as the setting 
+  #    name and accessor and each value will be used as the corresponding write accessor.
+  #
+  #   @yield [ ] Creates a new Module of type CascadingConfiguration::Core::InstanceController::ExtensionModule
+  #    and runs module_eval( & block ) on instance with provided block.
+  #
+  #   @return self
+  #
+
+  ###
+  # Non-cascading hash methods that will affect only the instance declared on.
+  #
+  # @method attr_object_hash
+  #
+  # @overload attr_object_hash( *names )
+  #
+  #   @param [Symbol,String,Hash{Symbol,String=>Symbol,String}] name The name to be used 
+  #    for the declared attribute. If a hash is passed, each key will be used as the setting 
+  #    name and accessor and each value will be used as the corresponding write accessor.
+  #
+  #   @yield [ ] Creates a new Module of type CascadingConfiguration::Core::InstanceController::ExtensionModule
+  #    and runs module_eval( & block ) on instance with provided block.
+  #
+  #   @return self
+  #
+
+  hash_module = ::CascadingConfiguration::Core::Module::ExtendedConfigurations::
+                  CompositingObjects.new( :hash, ::CompositingHash, :default, :configuration_hash )
+  
+  ::CascadingConfiguration::Core.enable( self, hash_module )
+
+end

data/lib/cascading_configuration/setting.rb

@@ -0,0 +1,87 @@
+
+###
+#  CascadingConfiguration::Setting allows definition of setting attributes that will retrieve
+#  the first value defined in an instance looking up the ancestor chain.
+# 
+module ::CascadingConfiguration::Setting
+  
+  ###
+  # Cascading setting attribute methods, which will affect instances according to include/extend pattern used.
+  #
+  # @method attr_setting
+  #
+  # @overload attr_setting( *names )
+  #   
+  #   @scope 
+  #
+  #   @param [Symbol,String,Hash{Symbol,String=>Symbol,String}] name The name to be used 
+  #    for the declared attribute. If a hash is passed, each key will be used as the setting 
+  #    name and accessor and each value will be used as the corresponding write accessor.
+  #
+  #   @return self
+  #
+
+  ###
+  # Cascading setting attribute module/class methods, which will affect all module singletons 
+  #   according to include/extend pattern used.
+  #
+  # @method attr_module_setting
+  #
+  # @overload attr_module_setting( *names )
+  #
+  #   @param [Symbol,String,Hash{Symbol,String=>Symbol,String}] name The name to be used 
+  #    for the declared attribute. If a hash is passed, each key will be used as the setting 
+  #    name and accessor and each value will be used as the corresponding write accessor.
+  #
+  #   @return self
+  #
+
+  ###
+  # Cascading setting instance methods, which will affect instances of including modules according to 
+  #   include/extend pattern used.
+  #
+  # @method attr_instance_setting
+  #
+  # @overload attr_instance_setting( *names )
+  #
+  #   @param [Symbol,String,Hash{Symbol,String=>Symbol,String}] name The name to be used 
+  #    for the declared attribute. If a hash is passed, each key will be used as the setting 
+  #    name and accessor and each value will be used as the corresponding write accessor.
+  #
+  #   @return self
+  #
+
+  ###
+  # Non-cascading setting methods that will affect the instance declared on as well as instances of that instance, 
+  #   if applicable.
+  #
+  # @method attr_local_setting
+  #
+  # @overload attr_local_setting( *names )
+  #
+  #   @param [Symbol,String,Hash{Symbol,String=>Symbol,String}] name The name to be used 
+  #    for the declared attribute. If a hash is passed, each key will be used as the setting 
+  #    name and accessor and each value will be used as the corresponding write accessor.
+  #
+  #   @return self
+  #
+
+  ###
+  # Non-cascading setting methods that will affect only the instance declared on.
+  #
+  # @method attr_object_setting
+  #
+  # @overload attr_object_setting( *names )
+  #
+  #   @param [Symbol,String,Hash{Symbol,String=>Symbol,String}] name The name to be used 
+  #    for the declared attribute. If a hash is passed, each key will be used as the setting 
+  #    name and accessor and each value will be used as the corresponding write accessor.
+  #
+  #   @return self
+  #
+  
+  setting_module = ::CascadingConfiguration::Core::Module::InheritingValues.new( :setting, :default, :configuration )
+  
+  ::CascadingConfiguration::Core.enable( self, setting_module )
+
+end

data/lib/cascading_configuration.rb

@@ -0,0 +1,47 @@
+
+# namespaces that have to be declared ahead of time for proper load order
+require_relative './namespaces'
+
+# source file requires
+require_relative './requires.rb'
+
+module ::CascadingConfiguration
+  
+  ConfigurationModules = [ Setting, 
+                           Hash, 
+                           Array,
+                           Array::Unique,
+                           Array::Sorted,
+                           Array::Sorted::Unique ]
+  
+  ###################
+  #  self.included  #
+  ###################
+  
+  def self.included( instance )
+    
+    super if defined?( super )
+    
+    instance.module_eval do
+      ::CascadingConfiguration::ConfigurationModules.each do |this_member|
+        include( this_member )
+      end
+    end
+    
+  end
+
+  ###################
+  #  self.extended  #
+  ###################
+  
+  def self.extended( instance )
+    
+    super if defined?( super )
+    
+    ::CascadingConfiguration::ConfigurationModules.each do |this_member|
+      instance.extend( this_member )
+    end
+    
+  end
+  
+end

data/lib/namespaces.rb

@@ -0,0 +1,9 @@
+
+module ::CascadingConfiguration
+  module Core
+    class InstanceController < ::Module
+      module Methods
+      end
+    end
+  end
+end

data/lib/requires.rb

@@ -0,0 +1,46 @@
+require 'to_camel_case'
+require 'accessor-utilities'
+require 'parallel-ancestry'
+require 'compositing-hash'
+require 'compositing-array-sorted-unique'
+
+#require_relative '../../compositing_objects/compositing-hash/lib/compositing-hash.rb'
+
+basepath = 'cascading_configuration'
+
+files = [
+    
+  'core/enable_module_support',
+  'core/enable_instance_support',
+  
+  'core',
+  
+  'core/encapsulation',
+  
+  'core/module',
+  'core/module/inheriting_values',
+  'core/module/extended_configurations',
+  'core/module/extended_configurations/compositing_objects',
+  'core/module/block_configurations',
+  'core/module/block_configurations/cascading_variables',
+    
+  'core/instance_controller/support_module',
+  'core/instance_controller/support_module/instance_support_module',
+  'core/instance_controller/support_module/singleton_support_module',
+  'core/instance_controller/extension_module',
+  'core/instance_controller',
+  
+  'setting',
+  
+  'hash',
+  
+  'array',
+  'array/unique',
+  'array/sorted',
+  'array/sorted/unique'
+  
+]
+
+files.each do |this_file|
+  require_relative( File.join( basepath, this_file ) + '.rb' )
+end