module-cluster 1.0.0

data/README.md

@@ -0,0 +1,112 @@
+# Module Cluster #
+
+http://rubygems.org/gems/module-cluster
+
+# Description #
+
+Adds methods for defining module clusters using #included and #extended.
+
+# Summary #
+
+Provides :define_module_inclusion, :define_module_extension, and :define_module_cluster.
+
+# Install #
+
+* sudo gem install module-cluster
+
+# Usage #
+
+Simply:
+
+```ruby
+module SomeModule
+  include ModuleCluster
+end
+```
+
+To cause modules to be included when this module is included:
+
+```ruby
+module SomeModule
+  define_module_inclusion do |includes, extends|
+    includes.concat [ SomeOtherModule ]
+  end
+end
+```
+
+or extended when this module is included:
+
+```ruby
+module SomeModule
+  define_module_inclusion do |includes, extends|
+    extends.concat [ SomeOtherModule ]
+  end
+end
+```
+
+or when this module is extended
+
+```ruby
+module SomeModule
+  define_module_extension do |includes, extends|
+    includes.concat [ SomeOtherModule ]
+  end
+end
+```
+
+or
+
+```ruby
+module SomeModule
+  define_module_extension do |includes, extends|
+    extends.concat [ SomeOtherModule ]
+  end
+end
+```
+
+or when this module is either included or extended:
+
+```ruby
+module SomeModule
+  define_module_cluster do |includes, extends|
+    includes.concat [ SomeOtherModule ]
+  end
+end
+```
+
+or
+
+```ruby
+module SomeModule
+  define_module_cluster do |includes, extends|
+    extends.concat [ SomeOtherModule ]
+  end
+end
+```
+
+If the block returns [ includes, extends ] as arrays, those values will be used; otherwise, the contents of the includes and extends parameters passed to the block will be used.
+
+# License #
+
+  (The MIT License)
+
+  Copyright (c) 2011 Asher
+
+  Permission is hereby granted, free of charge, to any person obtaining
+  a copy of this software and associated documentation files (the
+  'Software'), to deal in the Software without restriction, including
+  without limitation the rights to use, copy, modify, merge, publish,
+  distribute, sublicense, and/or sell copies of the Software, and to
+  permit persons to whom the Software is furnished to do so, subject to
+  the following conditions:
+
+  The above copyright notice and this permission notice shall be
+  included in all copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+  CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/module-cluster.rb

@@ -0,0 +1,13 @@
+
+module ModuleCluster
+	module IncludeSupport
+	end
+	module ExtendSupport
+	end
+end
+
+require_relative 'module-cluster/ModuleCluster.rb'
+require_relative 'module-cluster/_private_/ModuleCluster.rb'
+require_relative 'module-cluster/ModuleCluster/IncludeExtendSupport.rb'
+require_relative 'module-cluster/ModuleCluster/IncludeSupport.rb'
+require_relative 'module-cluster/ModuleCluster/ExtendSupport.rb'

data/lib/module-cluster/ModuleCluster.rb

@@ -0,0 +1,38 @@
+
+module ModuleCluster
+
+	#############################
+	#  define_module_inclusion  #
+	#############################
+
+	def define_module_inclusion( & block )
+		inclusion_array, extension_array = yield_for_includes_extends( block )
+		ModuleCluster::IncludeSupport.set_includes_for_class_or_module( self, inclusion_array )
+		ModuleCluster::IncludeSupport.set_extends_for_class_or_module( self, extension_array )
+		extend ModuleCluster::IncludeSupport
+		return self
+	end
+
+	#############################
+	#  define_module_extension  #
+	#############################
+	
+	def define_module_extension( & block )
+		inclusion_array, extension_array = yield_for_includes_extends( block )
+		ModuleCluster::ExtendSupport.set_includes_for_class_or_module( self, inclusion_array )
+		ModuleCluster::ExtendSupport.set_extends_for_class_or_module( self, extension_array )
+		extend ModuleCluster::ExtendSupport
+		return self
+	end
+	
+	###########################
+	#  define_module_cluster  #
+	###########################
+
+	def define_module_cluster( & include_extend_block )
+		define_module_inclusion( & include_extend_block )
+		define_module_extension( & include_extend_block )
+		return self
+	end
+
+end

data/lib/module-cluster/ModuleCluster/ExtendSupport.rb

@@ -0,0 +1,23 @@
+
+module ModuleCluster::ExtendSupport
+
+	extend ModuleCluster::IncludeExtendSupport
+
+  ##############
+  #  extended  #
+  ##############
+
+	def extended( class_or_module )
+		super if defined?( super )
+		module_self = self
+		class_or_module.instance_eval do
+			ModuleCluster::ExtendSupport.includes_for_class_or_module( module_self ).each do |this_module|
+				include this_module
+			end
+			ModuleCluster::ExtendSupport.extends_for_class_or_module( module_self ).each do |this_module|
+				extend this_module
+			end
+		end
+	end
+
+end

data/lib/module-cluster/ModuleCluster/IncludeExtendSupport.rb

@@ -0,0 +1,38 @@
+
+module ModuleCluster::IncludeExtendSupport
+
+	######################################
+	#  set_includes_for_class_or_module  #
+	######################################
+
+	def set_includes_for_class_or_module( class_or_module, includes )
+		@includes_for_class_or_module ||= Hash.new
+		@includes_for_class_or_module[ class_or_module ] = includes
+	end
+
+	#####################################
+	#  set_extends_for_class_or_module  #
+	#####################################
+	
+	def set_extends_for_class_or_module( class_or_module, extends )
+		@extends_for_class_or_module ||= Hash.new
+		@extends_for_class_or_module[ class_or_module ] = extends
+	end
+
+	############################################
+	#  includes_for_class_or_module_inclusion  #
+	############################################
+
+	def includes_for_class_or_module( class_or_module )
+		return @includes_for_class_or_module[ class_or_module ]	||= Array.new
+	end
+
+	###########################################
+	#  extends_for_class_or_module_extension  #
+	###########################################
+
+	def extends_for_class_or_module( class_or_module )
+		return @extends_for_class_or_module[ class_or_module ] ||= Array.new
+	end
+
+end

data/lib/module-cluster/ModuleCluster/IncludeSupport.rb

@@ -0,0 +1,23 @@
+
+module ModuleCluster::IncludeSupport
+
+	extend ModuleCluster::IncludeExtendSupport
+
+  ##############
+  #  included  #
+  ##############
+
+	def included( class_or_module )
+		super if defined?( super )
+		module_self = self
+		class_or_module.instance_eval do
+			ModuleCluster::IncludeSupport.includes_for_class_or_module( module_self ).each do |this_module|
+				include this_module
+			end
+			ModuleCluster::IncludeSupport.extends_for_class_or_module( module_self ).each do |this_module|
+				extend this_module
+			end
+		end
+	end
+
+end

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

@@ -0,0 +1,22 @@
+
+module ModuleCluster
+
+  ###########################################################################################################
+      private ###############################################################################################
+  ###########################################################################################################
+
+	def yield_for_includes_extends( block )
+		inclusion_array = Array.new
+		extension_array = Array.new
+		returned_includes, returned_extends = block.call( inclusion_array, extension_array )
+		inclusion_array = returned_includes if returned_includes.is_a?( Array )
+		extension_array = returned_extends if returned_extends.is_a?( Array )
+		unless inclusion_array.is_a?( Array ) and extension_array.is_a?( Array )
+			raise 'Expected module inclusion/extension variables to remain Array. Received ' +
+			      inclusion_array.inspect + ' for inclusion array, and ' + extension_array.inspect +
+			      ' for extension array.'
+		end
+		return inclusion_array, extension_array
+	end
+	
+end

data/spec/ModuleCluster/IncludeExtendSupport_spec.rb

@@ -0,0 +1,46 @@
+
+require_relative '../../lib/module-cluster.rb'
+
+describe ModuleCluster::IncludeExtendSupport do
+  
+  ############################################
+	#  set_includes_for_class_or_module        #
+	#  includes_for_class_or_module_inclusion  #
+	############################################
+
+	it 'can set and return includes for a class or module' do
+	  module ModuleCluster::IncludeExtendSupport::Mock01
+	    extend ModuleCluster::IncludeExtendSupport
+      module MockModule1
+      end
+      module MockModule2
+      end
+    end
+	  class ModuleCluster::IncludeExtendSupport::MockClass
+	    includes = [ ModuleCluster::IncludeExtendSupport::Mock01::MockModule1,
+	                 ModuleCluster::IncludeExtendSupport::Mock01::MockModule2 ]
+	    ModuleCluster::IncludeExtendSupport::Mock01.set_includes_for_class_or_module( self, includes )
+    end
+  end
+
+	###########################################
+	#  set_extends_for_class_or_module        #
+	#  extends_for_class_or_module_extension  #
+	###########################################
+	
+	it 'can set and return extends for a class or module' do
+	  module ModuleCluster::IncludeExtendSupport::Mock02
+	    extend ModuleCluster::IncludeExtendSupport
+      module MockModule1
+      end
+      module MockModule2
+      end
+    end
+	  class ModuleCluster::IncludeExtendSupport::MockClass
+	    includes = [ ModuleCluster::IncludeExtendSupport::Mock02::MockModule1,
+	                 ModuleCluster::IncludeExtendSupport::Mock02::MockModule2 ]
+	    ModuleCluster::IncludeExtendSupport::Mock02.set_includes_for_class_or_module( self, includes )
+    end	  
+  end
+  
+end

data/spec/ModuleCluster_spec.rb

@@ -0,0 +1,282 @@
+require_relative '../lib/module-cluster.rb'
+
+describe ModuleCluster do
+
+	#############################
+	#  define_module_inclusion  #
+	#############################
+
+  it 'can define includes and extends for module inclusion' do
+    module ModuleCluster::MockInclusion01
+      extend ModuleCluster
+      module Mock1
+      end
+      module Mock2
+      end
+      module Mock3
+      end
+      define_module_inclusion do |includes, extends|
+        includes.concat [ Mock1, Mock2 ]
+        extends.concat [ Mock3 ]
+      end
+    end
+    module ModuleCluster::MockInclusion01a
+      ancestors.include?( ModuleCluster::MockInclusion01::Mock1 ).should == false
+      ancestors.include?( ModuleCluster::MockInclusion01::Mock2 ).should == false
+      include ModuleCluster::MockInclusion01
+      ancestors.include?( ModuleCluster::MockInclusion01::Mock1 ).should == true
+      ancestors.include?( ModuleCluster::MockInclusion01::Mock2 ).should == true
+      eigenclass = class << self ; self ; end
+      eigenclass.ancestors.include?( ModuleCluster::MockInclusion01::Mock3 ).should == true
+    end
+    module ModuleCluster::MockInclusion02
+      extend ModuleCluster
+      module Mock1
+      end
+      module Mock2
+      end
+      module Mock3
+      end
+      define_module_inclusion do |includes, extends|
+        includes.concat [ Mock1, Mock2 ]
+      end
+    end
+    module ModuleCluster::MockInclusion02a
+      ancestors.include?( ModuleCluster::MockInclusion02::Mock1 ).should == false
+      ancestors.include?( ModuleCluster::MockInclusion02::Mock2 ).should == false
+      include ModuleCluster::MockInclusion02
+      ancestors.include?( ModuleCluster::MockInclusion02::Mock1 ).should == true
+      ancestors.include?( ModuleCluster::MockInclusion02::Mock2 ).should == true
+      eigenclass = class << self ; self ; end
+      eigenclass.ancestors.include?( ModuleCluster::MockInclusion02::Mock3 ).should == false
+    end
+    module ModuleCluster::MockInclusion03
+      extend ModuleCluster
+      module Mock1
+      end
+      module Mock2
+      end
+      module Mock3
+      end
+      define_module_inclusion do |includes, extends|
+        extends.concat [ Mock3 ]
+      end
+    end
+    module ModuleCluster::MockInclusion03a
+      ancestors.include?( ModuleCluster::MockInclusion03::Mock1 ).should == false
+      ancestors.include?( ModuleCluster::MockInclusion03::Mock2 ).should == false
+      include ModuleCluster::MockInclusion03
+      ancestors.include?( ModuleCluster::MockInclusion03::Mock1 ).should == false
+      ancestors.include?( ModuleCluster::MockInclusion03::Mock2 ).should == false
+      eigenclass = class << self ; self ; end
+      eigenclass.ancestors.include?( ModuleCluster::MockInclusion03::Mock3 ).should == true
+    end
+  end
+
+	#############################
+	#  define_module_extension  #
+	#############################
+	
+  it 'can define includes and extends for module extension' do
+    module ModuleCluster::MockExtension01
+      extend ModuleCluster
+      module Mock1
+      end
+      module Mock2
+      end
+      module Mock3
+      end
+      define_module_extension do |includes, extends|
+        includes.concat [ Mock1, Mock2 ]
+        extends.concat [ Mock3 ]
+      end
+    end
+    module ModuleCluster::MockExtension01a
+      ancestors.include?( ModuleCluster::MockExtension01::Mock1 ).should == false
+      ancestors.include?( ModuleCluster::MockExtension01::Mock2 ).should == false
+      extend ModuleCluster::MockExtension01
+      ancestors.include?( ModuleCluster::MockExtension01::Mock1 ).should == true
+      ancestors.include?( ModuleCluster::MockExtension01::Mock2 ).should == true
+      eigenclass = class << self ; self ; end
+      eigenclass.ancestors.include?( ModuleCluster::MockExtension01::Mock3 ).should == true
+    end
+    module ModuleCluster::MockExtension02
+      extend ModuleCluster
+      module Mock1
+      end
+      module Mock2
+      end
+      module Mock3
+      end
+      define_module_extension do |includes, extends|
+        includes.concat [ Mock1, Mock2 ]
+      end
+    end
+    module ModuleCluster::MockExtension02a
+      ancestors.include?( ModuleCluster::MockExtension02::Mock1 ).should == false
+      ancestors.include?( ModuleCluster::MockExtension02::Mock2 ).should == false
+      extend ModuleCluster::MockExtension02
+      ancestors.include?( ModuleCluster::MockExtension02::Mock1 ).should == true
+      ancestors.include?( ModuleCluster::MockExtension02::Mock2 ).should == true
+      eigenclass = class << self ; self ; end
+      eigenclass.ancestors.include?( ModuleCluster::MockExtension02::Mock3 ).should == false
+    end
+    module ModuleCluster::MockExtension03
+      extend ModuleCluster
+      module Mock1
+      end
+      module Mock2
+      end
+      module Mock3
+      end
+      define_module_extension do |includes, extends|
+        extends.concat [ Mock3 ]
+      end
+    end
+    module ModuleCluster::MockExtension03a
+      ancestors.include?( ModuleCluster::MockExtension03::Mock1 ).should == false
+      ancestors.include?( ModuleCluster::MockExtension03::Mock2 ).should == false
+      extend ModuleCluster::MockExtension03
+      ancestors.include?( ModuleCluster::MockExtension03::Mock1 ).should == false
+      ancestors.include?( ModuleCluster::MockExtension03::Mock2 ).should == false
+      eigenclass = class << self ; self ; end
+      eigenclass.ancestors.include?( ModuleCluster::MockExtension03::Mock3 ).should == true
+    end
+  end
+	
+	###########################
+	#  define_module_cluster  #
+	###########################
+	
+  it 'can define includes and extends for module extension and inclusion' do
+    module ModuleCluster::MockClusterInclusion01
+      extend ModuleCluster
+      module Mock1
+      end
+      module Mock2
+      end
+      module Mock3
+      end
+      define_module_cluster do |includes, extends|
+        includes.concat [ Mock1, Mock2 ]
+        extends.concat [ Mock3 ]
+      end
+    end
+    module ModuleCluster::MockClusterInclusion01a
+      ancestors.include?( ModuleCluster::MockClusterInclusion01::Mock1 ).should == false
+      ancestors.include?( ModuleCluster::MockClusterInclusion01::Mock2 ).should == false
+      include ModuleCluster::MockClusterInclusion01
+      ancestors.include?( ModuleCluster::MockClusterInclusion01::Mock1 ).should == true
+      ancestors.include?( ModuleCluster::MockClusterInclusion01::Mock2 ).should == true
+      eigenclass = class << self ; self ; end
+      eigenclass.ancestors.include?( ModuleCluster::MockClusterInclusion01::Mock3 ).should == true
+    end
+    module ModuleCluster::MockClusterInclusion02
+      extend ModuleCluster
+      module Mock1
+      end
+      module Mock2
+      end
+      module Mock3
+      end
+      define_module_cluster do |includes, extends|
+        includes.concat [ Mock1, Mock2 ]
+      end
+    end
+    module ModuleCluster::MockClusterInclusion02a
+      ancestors.include?( ModuleCluster::MockClusterInclusion02::Mock1 ).should == false
+      ancestors.include?( ModuleCluster::MockClusterInclusion02::Mock2 ).should == false
+      include ModuleCluster::MockClusterInclusion02
+      ancestors.include?( ModuleCluster::MockClusterInclusion02::Mock1 ).should == true
+      ancestors.include?( ModuleCluster::MockClusterInclusion02::Mock2 ).should == true
+      eigenclass = class << self ; self ; end
+      eigenclass.ancestors.include?( ModuleCluster::MockClusterInclusion02::Mock3 ).should == false
+    end
+    module ModuleCluster::MockClusterInclusion03
+      extend ModuleCluster
+      module Mock1
+      end
+      module Mock2
+      end
+      module Mock3
+      end
+      define_module_cluster do |includes, extends|
+        extends.concat [ Mock3 ]
+      end
+    end
+    module ModuleCluster::MockClusterInclusion03a
+      ancestors.include?( ModuleCluster::MockClusterInclusion03::Mock1 ).should == false
+      ancestors.include?( ModuleCluster::MockClusterInclusion03::Mock2 ).should == false
+      include ModuleCluster::MockClusterInclusion03
+      ancestors.include?( ModuleCluster::MockClusterInclusion03::Mock1 ).should == false
+      ancestors.include?( ModuleCluster::MockClusterInclusion03::Mock2 ).should == false
+      eigenclass = class << self ; self ; end
+      eigenclass.ancestors.include?( ModuleCluster::MockClusterInclusion03::Mock3 ).should == true
+    end
+    module ModuleCluster::MockClusterExtension01
+      extend ModuleCluster
+      module Mock1
+      end
+      module Mock2
+      end
+      module Mock3
+      end
+      define_module_cluster do |includes, extends|
+        includes.concat [ Mock1, Mock2 ]
+        extends.concat [ Mock3 ]
+      end
+    end
+    module ModuleCluster::MockClusterExtension01a
+      ancestors.include?( ModuleCluster::MockClusterExtension01::Mock1 ).should == false
+      ancestors.include?( ModuleCluster::MockClusterExtension01::Mock2 ).should == false
+      extend ModuleCluster::MockClusterExtension01
+      ancestors.include?( ModuleCluster::MockClusterExtension01::Mock1 ).should == true
+      ancestors.include?( ModuleCluster::MockClusterExtension01::Mock2 ).should == true
+      eigenclass = class << self ; self ; end
+      eigenclass.ancestors.include?( ModuleCluster::MockClusterExtension01::Mock3 ).should == true
+    end
+    module ModuleCluster::MockClusterExtension02
+      extend ModuleCluster
+      module Mock1
+      end
+      module Mock2
+      end
+      module Mock3
+      end
+      define_module_cluster do |includes, extends|
+        includes.concat [ Mock1, Mock2 ]
+      end
+    end
+    module ModuleCluster::MockClusterExtension02a
+      ancestors.include?( ModuleCluster::MockClusterExtension02::Mock1 ).should == false
+      ancestors.include?( ModuleCluster::MockClusterExtension02::Mock2 ).should == false
+      extend ModuleCluster::MockClusterExtension02
+      ancestors.include?( ModuleCluster::MockClusterExtension02::Mock1 ).should == true
+      ancestors.include?( ModuleCluster::MockClusterExtension02::Mock2 ).should == true
+      eigenclass = class << self ; self ; end
+      eigenclass.ancestors.include?( ModuleCluster::MockClusterExtension02::Mock3 ).should == false
+    end
+    module ModuleCluster::MockClusterExtension03
+      extend ModuleCluster
+      module Mock1
+      end
+      module Mock2
+      end
+      module Mock3
+      end
+      define_module_cluster do |includes, extends|
+        extends.concat [ Mock3 ]
+      end
+    end
+    module ModuleCluster::MockClusterExtension03a
+      ancestors.include?( ModuleCluster::MockClusterExtension03::Mock1 ).should == false
+      ancestors.include?( ModuleCluster::MockClusterExtension03::Mock2 ).should == false
+      extend ModuleCluster::MockClusterExtension03
+      ancestors.include?( ModuleCluster::MockClusterExtension03::Mock1 ).should == false
+      ancestors.include?( ModuleCluster::MockClusterExtension03::Mock2 ).should == false
+      eigenclass = class << self ; self ; end
+      eigenclass.ancestors.include?( ModuleCluster::MockClusterExtension03::Mock3 ).should == true
+    end    
+  end
+
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: module-cluster
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Asher
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-21 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Provides :define_module_inclusion, :define_module_extension, and :define_module_cluster.
+email: asher@ridiculouspower.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/module-cluster/_private_/ModuleCluster.rb
+- lib/module-cluster/ModuleCluster/ExtendSupport.rb
+- lib/module-cluster/ModuleCluster/IncludeExtendSupport.rb
+- lib/module-cluster/ModuleCluster/IncludeSupport.rb
+- lib/module-cluster/ModuleCluster.rb
+- lib/module-cluster.rb
+- spec/ModuleCluster/IncludeExtendSupport_spec.rb
+- spec/ModuleCluster_spec.rb
+- README.md
+- README.rdoc
+has_rdoc: true
+homepage: http://rubygems.org/gems/module-cluster
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: module-cluster
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: "Adds methods for defining module clusters using #included and #extended."
+test_files: []
+