cascading-configuration-setting 1.0.0

data/README.rdoc

@@ -0,0 +1,141 @@
+== Cascading Configuration
+
+http://rubygems.org/gems/cascading-configuration-setting
+
+== DESCRIPTION:
+
+Adds methods for cascading configuration settings. Support package for cascading-configuration.
+
+== SUMMARY:
+  
+  * :attr_configuration
+
+== INSTALL:
+
+  * sudo gem install cascading-configuration-setting
+
+== EXAMPLE:
+
+  #############################################################################
+  ########################### attr_configuration ##############################
+  #############################################################################
+
+  ##################
+  #  first module  #
+  ##################
+
+  module CascadingConfiguration::MockModule
+    include CascadingConfiguration
+    attr_configuration :some_configuration
+    self.some_configuration = :some_value
+    # => some_configuration.should == :some_value
+  end
+
+  ########################
+  #  including module 1  #
+  ########################
+
+  module CascadingConfiguration::MockModule2
+    include CascadingConfiguration::MockModule
+    # => some_configuration.should == :some_value
+    self.some_configuration = :module_value
+    # => some_configuration.should == :module_value
+  end
+
+  ########################
+  #  including module 2  #
+  ########################
+
+  module CascadingConfiguration::MockModule3
+    include CascadingConfiguration::MockModule2
+  end
+
+  ###############
+  #  top class  #
+  ###############
+
+  class CascadingConfiguration::MockClass
+    include CascadingConfiguration::MockModule3
+    # => some_configuration.should == :module_value
+    self.some_configuration = :another_value
+    # => some_configuration.should == :another_value
+  end
+
+  ###########################
+  #  instance of top class  #
+  ###########################
+
+  object_instance_one = CascadingConfiguration::MockClass.new
+  # => object_instance_one.some_configuration.should == :another_value
+  object_instance_one.some_configuration = :yet_another_value
+  # => object_instance_one.some_configuration.should == :yet_another_value
+  # => CascadingConfiguration::MockClass.some_configuration.should == :another_value
+  # => CascadingConfiguration::MockModule.some_configuration.should == :some_value
+
+  ############################
+  #  first inheriting class  #
+  ############################
+
+  class CascadingConfiguration::MockClassSub1 < CascadingConfiguration::MockClass
+    # => some_configuration.should == :another_value
+    self.some_configuration = :a_value_not_yet_used
+    # => some_configuration.should == :a_value_not_yet_used
+    # => CascadingConfiguration::MockClass.some_configuration.should == :another_value
+    # => CascadingConfiguration::MockModule.some_configuration.should == :some_value
+  end
+
+  ########################################
+  #  instance of first inheriting class  #
+  ########################################
+
+  object_instance_two = CascadingConfiguration::MockClassSub1.new
+  # => object_instance_two.some_configuration.should == :a_value_not_yet_used
+  # => object_instance_one.some_configuration.should == :yet_another_value
+  # => CascadingConfiguration::MockClass.some_configuration.should == :another_value
+  # => CascadingConfiguration::MockModule.some_configuration.should == :some_value
+
+  #############################
+  #  second inheriting class  #
+  #############################
+
+  class CascadingConfiguration::MockClassSub2 < CascadingConfiguration::MockClassSub1
+    # => some_configuration.should == :a_value_not_yet_used
+    self.some_configuration = :another_value_not_yet_used
+    # => some_configuration.should == :another_value_not_yet_used
+  end
+
+  #########################################
+  #  instance of second inheriting class  #
+  #########################################
+
+  object_instance_three = CascadingConfiguration::MockClassSub2.new
+  # => object_instance_three.some_configuration.should == :another_value_not_yet_used
+  object_instance_three.some_configuration = :one_more_unused_value
+  # => object_instance_three.some_configuration.should == :one_more_unused_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/lib/cascading-configuration-setting.rb

@@ -0,0 +1,21 @@
+
+require 'cascading-configuration-variable'
+#require_relative '../../variable/lib/cascading-configuration-variable.rb'
+
+module CascadingConfiguration
+  module ConfigurationSetting
+    module Accessors
+    end
+    module ClassInstance
+    end
+    module ObjectInstance
+    end
+    module ModuleInstance
+    end
+  end
+end
+
+require_relative 'cascading-configuration-setting/CascadingConfiguration/ConfigurationSetting.rb'
+require_relative 'cascading-configuration-setting/CascadingConfiguration/ConfigurationSetting/Accessors.rb'
+require_relative 'cascading-configuration-setting/CascadingConfiguration/ConfigurationSetting/ClassInstance.rb'
+require_relative 'cascading-configuration-setting/CascadingConfiguration/ConfigurationSetting/ModuleInstance.rb'

data/lib/cascading-configuration-setting/CascadingConfiguration/ConfigurationSetting.rb

@@ -0,0 +1,47 @@
+
+module CascadingConfiguration::ConfigurationSetting
+
+  ###########################################################################################################
+  ######################################  Singleton Implementation  #########################################
+  ###########################################################################################################
+
+  ###################
+  #  self.included  #
+  ###################
+
+  def self.included( class_or_module )
+    class_or_module.instance_eval do
+      include CascadingConfiguration::ConfigurationVariable
+      extend  CascadingConfiguration::ConfigurationSetting
+      include CascadingConfiguration::ConfigurationSetting::ObjectInstance
+      extend  CascadingConfiguration::ConfigurationSetting::ClassInstance
+      extend  CascadingConfiguration::ConfigurationSetting::Accessors
+      unless is_a?( Class )
+        extend CascadingConfiguration::ConfigurationSetting::ModuleInstance
+      end
+    end
+  end
+
+  ########################################
+  #  get_configuration_searching_upward  #
+  ########################################
+
+  def get_configuration_searching_upward( configuration_name )
+
+    configuration = nil
+
+    configuration_variable = cascading_variable_name( configuration_name )
+
+    ancestors_to_Object.each do |this_ancestor|
+      if this_ancestor.instance_variable_defined?( configuration_variable )
+        # if our instance defines this configuration, use its setting
+        configuration = this_ancestor.instance_variable_get( configuration_variable )
+        break
+      end
+    end
+
+    return configuration
+
+  end
+
+end

data/lib/cascading-configuration-setting/CascadingConfiguration/ConfigurationSetting/Accessors.rb

@@ -0,0 +1,37 @@
+
+module CascadingConfiguration::ConfigurationSetting::Accessors
+
+  #################################
+  #  define_configuration_setter  #
+  #################################
+  
+  def define_configuration_setter( configuration_name )
+    configuration_setter_name = ( configuration_name.to_s + '=' ).to_s
+    [ self, eigenclass ].each do |klass_or_eigenclass|
+      klass_or_eigenclass.class_eval do
+        define_method( configuration_setter_name ) do |value|
+          # configuration setter returns setting variable (variable from self), which is now the ID of value
+          return instance_variable_set( cascading_variable_name( configuration_name ), value )
+        end
+      end
+    end
+  end
+
+  #################################
+  #  define_configuration_getter  #
+  #################################
+  
+  def define_configuration_getter( configuration_name )
+    configuration_getter_name = configuration_name
+    [ self, eigenclass ].each do |klass_or_eigenclass|
+      klass_or_eigenclass.class_eval do
+        define_method( configuration_getter_name ) do
+          # configuration getter returns current setting value (taken from first superclass with setting)
+          # that means first variable that has been set
+          return get_configuration_searching_upward( configuration_name )
+        end
+      end
+    end
+  end
+
+end

data/lib/cascading-configuration-setting/CascadingConfiguration/ConfigurationSetting/ClassInstance.rb

@@ -0,0 +1,17 @@
+
+module CascadingConfiguration::ConfigurationSetting::ClassInstance
+
+  ########################
+  #  attr_configuration  #
+  ########################
+
+  def attr_configuration( *property_names )
+    property_names.each do |this_property_name|
+      # define configuration setter
+      define_configuration_setter( this_property_name )
+      # define configuration getter
+      define_configuration_getter( this_property_name )
+    end
+  end
+
+end

data/lib/cascading-configuration-setting/CascadingConfiguration/ConfigurationSetting/ModuleInstance.rb

@@ -0,0 +1,20 @@
+
+module CascadingConfiguration::ConfigurationSetting::ModuleInstance
+  
+  ##############
+  #  included  #
+  ##############
+  
+  def included( class_or_module )
+    self_module = self
+    class_or_module.instance_eval do
+      include CascadingConfiguration::ConfigurationSetting
+      # when we extend a module (which has happened if we got here)
+      # then we need to make sure when the module we are extending is included
+      # * CascadingConfiguration is included
+      # * the module we extended is used to extend the class/module that included
+      extend  self_module
+    end
+  end
+  
+end

data/spec/CascadingConfiguration/ConfigurationSetting/Accessors_spec.rb

@@ -0,0 +1,28 @@
+
+require_relative '../../../lib/cascading-configuration-setting.rb'
+
+describe CascadingConfiguration::ConfigurationSetting::Accessors do
+
+  #################################
+  #  define_configuration_setter  #
+  #  define_configuration_getter  #
+  #################################
+
+  it 'can define a method to get and set configuration value' do
+    class CascadingConfiguration::ConfigurationSetting::Mock
+      include CascadingConfiguration::ConfigurationSetting
+    end
+    # setter
+    setter_method_name = ( :some_configuration.to_s + '=' ).to_sym
+    CascadingConfiguration::ConfigurationSetting::Mock.define_configuration_setter( :some_configuration )
+    CascadingConfiguration::ConfigurationSetting::Mock.methods.include?( setter_method_name ).should == true
+    CascadingConfiguration::ConfigurationSetting::Mock.instance_methods.include?( setter_method_name ).should == true
+    CascadingConfiguration::ConfigurationSetting::Mock.some_configuration = :a_setting_not_yet_used
+    # getter
+    CascadingConfiguration::ConfigurationSetting::Mock.define_configuration_getter( :some_configuration )
+    CascadingConfiguration::ConfigurationSetting::Mock.methods.include?( :some_configuration ).should == true
+    CascadingConfiguration::ConfigurationSetting::Mock.instance_methods.include?( :some_configuration ).should == true
+    CascadingConfiguration::ConfigurationSetting::Mock.some_configuration.should == :a_setting_not_yet_used
+  end
+
+end

data/spec/CascadingConfiguration/ConfigurationSetting_spec.rb

@@ -0,0 +1,43 @@
+
+require_relative '../../lib/cascading-configuration-setting.rb'
+
+describe CascadingConfiguration::ConfigurationSetting do
+ 
+  ################################
+  #  attr_configuration  #
+  ################################
+  
+  it 'can define a configuration setting, which is the primary interface' do
+    module CascadingConfiguration::ConfigurationSetting::MockModule
+      include CascadingConfiguration::ConfigurationSetting
+      attr_configuration :some_other_configuration
+      self.some_other_configuration = :our_setting_value
+      some_other_configuration.should == :our_setting_value
+    end
+    module CascadingConfiguration::ConfigurationSetting::MockModule2
+      include CascadingConfiguration::ConfigurationSetting::MockModule
+      self.some_other_configuration = :another_value
+      some_other_configuration.should == :another_value
+    end
+    module CascadingConfiguration::ConfigurationSetting::MockModule3
+      include CascadingConfiguration::ConfigurationSetting::MockModule2
+      some_other_configuration.should == :another_value
+    end
+    class CascadingConfiguration::ConfigurationSetting::MockClass
+      include CascadingConfiguration::ConfigurationSetting::MockModule3
+      some_other_configuration.should == :another_value
+      self.some_other_configuration = :our_setting_value
+    end
+    class CascadingConfiguration::ConfigurationSetting::MockClassSub1 < CascadingConfiguration::ConfigurationSetting::MockClass
+      some_other_configuration.should == :our_setting_value
+      self.some_other_configuration = :our_other_setting_value
+      some_other_configuration.should == :our_other_setting_value
+    end
+    class CascadingConfiguration::ConfigurationSetting::MockClassSub2 < CascadingConfiguration::ConfigurationSetting::MockClassSub1
+      some_other_configuration.should == :our_other_setting_value
+      self.some_other_configuration = :a_third_setting_value
+      some_other_configuration.should == :a_third_setting_value
+    end
+  end
+    
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: cascading-configuration-setting
+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-13 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: cascading-configuration-variable
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Provides :attr_configuration.
+email: asher@ridiculouspower.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/cascading-configuration-setting/CascadingConfiguration/ConfigurationSetting/Accessors.rb
+- lib/cascading-configuration-setting/CascadingConfiguration/ConfigurationSetting/ClassInstance.rb
+- lib/cascading-configuration-setting/CascadingConfiguration/ConfigurationSetting/ModuleInstance.rb
+- lib/cascading-configuration-setting/CascadingConfiguration/ConfigurationSetting.rb
+- lib/cascading-configuration-setting.rb
+- spec/CascadingConfiguration/ConfigurationSetting/Accessors_spec.rb
+- spec/CascadingConfiguration/ConfigurationSetting_spec.rb
+- README.rdoc
+has_rdoc: true
+homepage: http://rubygems.org/gems/cascading-configuration-setting
+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: cascading-configuration-setting
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Support package for cascading-configuration.
+test_files: []
+