cascading-configuration-hash 1.0.0 → 1.1.0

data/README.md

@@ -0,0 +1,365 @@
+# Cascading Configuration #
+
+http://rubygems.org/gems/cascading-configuration-hash
+
+# Description #
+
+Adds methods for cascading configuration hashes. Support package for cascading-configuration.
+
+# Summary #
+
+## :attr_configuration_hash ##
+
+:attr_configuration_hash provides inheritable configuration that cascades downward. 
+
+Configuration inheritance can cascade through modules, classes, and instances.
+
+:attr_configuration_hash defines a single attribute accessor that composes the set of configuration values appropriate to the ancestor level being queried (merging downward from most distant ancestor to self). An internal cache is kept, and any configuration updates that occur to higher-level ancestors cascade immediately downward.
+
+# Install #
+
+* sudo gem install cascading-configuration-hash
+
+# Usage #
+
+## First Module ##
+
+1. Define initial configuration in a module.
+
+A class works just as well, but we can't use a module in the same chain if we start with a class.
+
+* Include module to enable attr_configuration_hash.
+
+```ruby
+
+  module CascadingConfiguration::MockModule
+	include CascadingConfiguration::Hash
+  end
+
+```
+
+* Declare attr_configuration_hash.
+
+```ruby
+
+  module CascadingConfiguration::MockModule
+    attr_configuration_hash :some_hash_configuration
+  end
+
+```
+
+* Set initial value.
+
+```ruby
+
+  module CascadingConfiguration::MockModule
+    self.some_hash_configuration = { :some_value => :some_value }
+  end
+
+```
+
+* Verify initial configuration value
+
+```ruby
+
+  module CascadingConfiguration::MockModule
+    # => some_hash_configuration.should == { :some_value => :some_value }
+  end
+
+```
+
+## Including Module 1 ##
+
+2. Include initial module in another module.
+
+Including the module that has included a CascadingConfiguration module is the same as including a CascadingConfiguration module.
+
+```ruby
+
+  module CascadingConfiguration::MockModule2
+    include CascadingConfiguration::MockModule
+  end
+
+```
+
+* Verify inherited value
+
+```ruby
+
+  module CascadingConfiguration::MockModule2
+    # => some_hash_configuration.should == { :some_value => :some_value }
+  end
+
+```
+
+* Override inherited value
+
+```ruby
+
+  module CascadingConfiguration::MockModule2
+    self.some_hash_configuration = { :module_value => :some_value }
+  end
+
+```
+
+* Verify local override value
+
+```ruby
+
+  module CascadingConfiguration::MockModule2
+    # => some_hash_configuration.should == { :module_value => :some_value }
+  end
+
+```
+
+## Including Module 2 ##
+
+3. Include second module in another module.
+
+```ruby
+
+  module CascadingConfiguration::MockModule3
+    include CascadingConfiguration::MockModule2
+  end
+
+```
+
+* Verify inherited value
+
+```ruby
+
+  module CascadingConfiguration::MockModule3
+    # => some_array_configuration.should == { :module_value => :some_value }
+  end
+
+```
+
+## Top Class ##
+
+4. Include third module in a class.
+
+```ruby
+
+  class CascadingConfiguration::MockClass
+    include CascadingConfiguration::MockModule3
+  end
+
+```
+
+* Verify inherited value
+
+```ruby
+
+  class CascadingConfiguration::MockClass
+    # => some_hash_configuration.should == { :module_value => :some_value }
+  end
+
+```
+
+* Override inherited value
+
+```ruby
+
+  class CascadingConfiguration::MockClass
+    self.some_hash_configuration = { :another_value => :some_value }
+  end
+
+```
+
+* Verify local override value
+
+```ruby
+
+  class CascadingConfiguration::MockClass
+    # => some_hash_configuration.should == { :another_value => :some_value }
+  end
+
+```
+
+## Instance of Top Class ##
+
+5. Instantiate class.
+
+```ruby
+
+  object_instance_one = CascadingConfiguration::MockClass.new
+
+```
+
+* Verify inherited value
+
+```ruby
+
+  # => object_instance_one.some_hash_configuration.should == { :another_value => :some_value }
+
+```
+
+* Override inherited value
+
+```ruby
+
+  object_instance_one.some_hash_configuration = { :yet_another_value => :some_value }
+
+```
+
+* Verify local override value
+
+```ruby
+
+  # => object_instance_one.some_hash_configuration.should == { :yet_another_value => :some_value }
+  # => CascadingConfiguration::MockClass.some_hash_configuration.should == { :another_value => :some_value }
+  # => CascadingConfiguration::MockModule.some_hash_configuration.should == { :some_value => :some_value }
+
+```
+
+# First Inheriting Class #
+
+6. Inheriting class.
+
+Inheriting class should not get any settings from instance of superclass.
+
+* Verify inherited value
+
+```ruby
+
+  class CascadingConfiguration::MockClassSub1 < CascadingConfiguration::MockClass
+    # => some_hash_configuration.should == { :another_value => :some_value }
+  end
+
+```
+
+* Override inherited value
+
+```ruby
+
+  class CascadingConfiguration::MockClassSub1 < CascadingConfiguration::MockClass
+    self.some_hash_configuration = { :a_value_not_yet_used => :some_value }
+  end
+
+```
+
+* Verify local override value
+
+```ruby
+
+  class CascadingConfiguration::MockClassSub1 < CascadingConfiguration::MockClass
+    # => some_hash_configuration.should == { :a_value_not_yet_used => :some_value }
+    # => CascadingConfiguration::MockClass.some_hash_configuration.should == { :another_value => :some_value }
+    # => CascadingConfiguration::MockModule.some_hash_configuration.should == { :some_value => :some_value }
+  end
+
+```
+
+## Instance of First Inheriting Class ##
+
+7. Instantiate first inheriting class.
+
+```ruby
+
+  object_instance_two = CascadingConfiguration::MockClassSub1.new
+
+```
+
+* Verify inherited value
+
+```ruby
+
+  # => object_instance_two.some_hash_configuration.should == { :a_value_not_yet_used => :some_value }
+  # => object_instance_one.some_hash_configuration.should == { :yet_another_value => :some_value }
+  # => CascadingConfiguration::MockClass.some_hash_configuration.should == { :another_value => :some_value }
+  # => CascadingConfiguration::MockModule.some_hash_configuration.should == { :some_value => :some_value }
+
+```
+
+## Second Inheriting Class ##
+
+8. Second inheriting class.
+
+* Verify inherited value
+
+```ruby
+
+  class CascadingConfiguration::MockClassSub2 < CascadingConfiguration::MockClassSub1
+    # => some_hash_configuration.should == { :a_value_not_yet_used => :some_value }
+  end
+
+```
+
+* Override inherited value
+
+```ruby
+
+  class CascadingConfiguration::MockClassSub2 < CascadingConfiguration::MockClassSub1
+    self.some_hash_configuration = { :another_value_not_yet_used => :some_value }
+  end
+
+```
+
+* Verify local override value
+
+```ruby
+
+  class CascadingConfiguration::MockClassSub2 < CascadingConfiguration::MockClassSub1
+    # => some_hash_configuration.should == { :another_value_not_yet_used => :some_value }
+  end
+
+```
+
+## Instance of Second Inheriting Class ##
+
+9. Instantiate Second Inheriting Class.
+
+```ruby
+
+  object_instance_three = CascadingConfiguration::MockClassSub2.new
+
+```
+
+* Verify inherited value
+
+```ruby
+
+  # => object_instance_three.some_hash_configuration.should == { :another_value_not_yet_used => :some_value }
+
+```
+
+* Override inherited value
+
+```ruby
+
+  object_instance_three.some_hash_configuration = { :one_more_unused_value => :some_value }
+
+```
+
+* Verify local override value
+
+```ruby
+
+  # => object_instance_three.some_hash_configuration.should == { :one_more_unused_value => :some_value }
+
+```
+
+# 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/README.rdoc

@@ -1,118 +1,32 @@
 == Cascading Configuration
 
-http://rubygems.org/gems/cascading-configuration-hash
+http://rubygems.org/gems/cascading-configuration
 
-== DESCRIPTION:
-
-Adds methods for cascading configuration hashes. Support package for cascading-configuration.
+== Description
 
-== SUMMARY:
-  
-  * :attr_configuration_hash
+Adds methods for cascading configurations.
 
-== INSTALL:
+== Summary
 
-  * sudo gem install cascading-configuration-hash
+Cascading configuration methods for single settings, arrays, hashes.
 
-== EXAMPLE:
+== :attr_configuration_hash
 
-  #############################################################################
-  ######################### attr_configuration_hash ###########################
-  #############################################################################
+:attr_configuration_hash provides inheritable configuration that cascades downward. 
 
-  ##################
-  #  first module  #
-  ##################
+Configuration inheritance can cascade through modules, classes, and instances.
 
-  module CascadingConfiguration::MockModule
-    attr_configuration_hash :some_hash_configuration
-    self.some_hash_configuration = { :some_value => :some_value }
-    # => some_hash_configuration.should == { :some_value => :some_value }
-  end
+:attr_configuration_hash defines a single attribute accessor that composes the set of configuration values appropriate to the ancestor level being queried (merging downward from most distant ancestor to self). An internal cache is kept, and any configuration updates that occur to higher-level ancestors cascade immediately downward.
 
-  ########################
-  #  including module 1  #
-  ########################
+== Install
 
-  module CascadingConfiguration::MockModule2
-    # => some_hash_configuration.should == { :some_value => :some_value }
-    self.some_hash_configuration = { :module_value => :some_value }
-    # => some_hash_configuration.should == { :module_value => :some_value }
-  end
+* sudo gem install cascading-configuration
 
-  ########################
-  #  including module 2  #
-  ########################
+== Usage
 
-  module CascadingConfiguration::MockModule3
+See supporting package README markdown files (README.md) for examples.
 
-  end
-
-  ###############
-  #  top class  #
-  ###############
-
-  class CascadingConfiguration::MockClass
-    # => some_hash_configuration.should == { :module_value => :some_value }
-    self.some_hash_configuration = { :another_value => :some_value }
-    # => some_hash_configuration.should == { :another_value => :some_value }
-  end
-
-  ###########################
-  #  instance of top class  #
-  ###########################
-
-  object_instance_one = CascadingConfiguration::MockClass.new
-  # => object_instance_one.some_hash_configuration.should == { :another_value => :some_value }
-  object_instance_one.some_hash_configuration = { :yet_another_value => :some_value }
-  # => object_instance_one.some_hash_configuration.should == { :yet_another_value => :some_value }
-  # => CascadingConfiguration::MockClass.some_hash_configuration.should == { :another_value => :some_value }
-  # => CascadingConfiguration::MockModule.some_hash_configuration.should == { :some_value => :some_value }
-
-  ############################
-  #  first inheriting class  #
-  ############################
-
-  class CascadingConfiguration::MockClassSub1 < CascadingConfiguration::MockClass
-    # => some_hash_configuration.should == { :another_value => :some_value }
-    self.some_hash_configuration = { :a_value_not_yet_used => :some_value }
-    # => some_hash_configuration.should == { :a_value_not_yet_used => :some_value }
-    # => CascadingConfiguration::MockClass.some_hash_configuration.should == { :another_value => :some_value }
-    # => CascadingConfiguration::MockModule.some_hash_configuration.should == { :some_value => :some_value }
-  end
-
-  ########################################
-  #  instance of first inheriting class  #
-  ########################################
-
-  object_instance_two = CascadingConfiguration::MockClassSub1.new
-  # => object_instance_two.some_hash_configuration.should == { :a_value_not_yet_used => :some_value }
-  # => object_instance_one.some_hash_configuration.should == { :yet_another_value => :some_value }
-  # => CascadingConfiguration::MockClass.some_hash_configuration.should == { :another_value => :some_value }
-  # => CascadingConfiguration::MockModule.some_hash_configuration.should == { :some_value => :some_value }
-
-  #############################
-  #  second inheriting class  #
-  #############################
-
-  class CascadingConfiguration::MockClassSub2 < CascadingConfiguration::MockClassSub1
-    # => some_hash_configuration.should == { :a_value_not_yet_used => :some_value }
-    self.some_hash_configuration = { :another_value_not_yet_used => :some_value }
-    # => some_hash_configuration.should == { :another_value_not_yet_used => :some_value }
-  end
-
-  #########################################
-  #  instance of second inheriting class  #
-  #########################################
-
-  object_instance_three = CascadingConfiguration::MockClassSub2.new
-  # => object_instance_three.some_hash_configuration.should == { :another_value_not_yet_used => :some_value }
-  object_instance_three.some_hash_configuration = { :one_more_unused_value => :some_value }
-  # => object_instance_three.some_hash_configuration.should == { :one_more_unused_value => :some_value }
-
-  #############################################################################
-
-== LICENSE:
+== License
 
   (The MIT License)