fun_with_configurations 0.0.1 → 0.0.2

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/fun_with/configurations/config.rb

@@ -3,8 +3,34 @@ module FunWith
     class KeyError < Exception
     end
     
-    class Config < Hash
-      def initialize( &block )
+    class ChainError < Exception
+    end
+    
+    module ConfigOverriddenMethods
+      def self.override_method( sym )
+        eval <<-EOS
+          def #{sym}( *args, &block )
+            self.method_missing(:sym, *args, &block)
+          end
+          
+          def #{sym}=( *args, &block )
+            self.method_missing( :#{sym}, *args, &block )
+          end
+        EOS
+      end
+      
+      for sym in [:test]
+        override_method( sym )
+      end
+    end
+    
+    class Config
+      include ConfigOverriddenMethods
+      
+      def initialize( key_to_self = nil, parent = nil, &block )
+        @key_to_self = key_to_self
+        @parent      = parent
+        @config_vars = {}
         self.instance_exec( &block ) if block_given?
       end
     
@@ -12,10 +38,12 @@ module FunWith
         method = method.to_s.gsub( /=$/, '' ).to_sym
         
         if block_given?
-          self[method] = Config.new unless self[method].is_a?(Config)
+          self[method] = Config.new(method, self) unless self[method].is_a?(Config)
           self[method].instance_exec( &block )
-        elsif args.length > 0
+        elsif args.length == 1
           self[method] = args.first
+        elsif args.length > 1
+          self[method] = args
         else
           self[method]   
         end
@@ -24,20 +52,72 @@ module FunWith
       def []( sym )
         sym = sym.to_sym if sym.is_a?(String)
         self.class.key_check( sym )
-        super( sym )
+        @config_vars[ sym ]
       end
       
       def []=( sym, val )
         sym = sym.to_sym if sym.is_a?(String)
         self.class.key_check( sym )
-        super( sym, val )
+        @config_vars[ sym ] = val
+      end
+      
+      # Say you had a configuration that had multiple entries, and you wanted to select from
+      # among them at runtime.  Example:
+      # config:
+      #   important_folder:
+      #     development: "/this/directory",
+      #     test:        "/that/directory",
+      #     production:  "~/another/directory"
+      #
+      # You could do config.important_folder[environment] every time you want to access that setting.
+      # Or you can do config.important_folder.promote_configuration(:development) and have the 
+      # development subconfiguration replace the important_folder: configuration
+      # 
+      # You can promote a sub-sub-sub-config by sending an array of symbols.  But I hope it
+      # never comes to that.
+      def promote_configuration( *keys )
+        replace_with = self.try.config_method_chain_result( keys )
+        if replace_with.success?
+          @parent[@key_to_self] = replace_with.config
+        else
+          raise ChainError.new( "config failed to promote_configuration #{keys.inspect}" )
+        end
       end
       
       def self.key_check( sym )
-        @reserved_symbols ||= Hash.instance_methods
+        @reserved_symbols ||= Config.instance_methods - self.fwc_overridden_methods
+        
         raise KeyError.new("#{sym} is not a symbol") unless sym.is_a?(Symbol)
         raise KeyError.new("#{sym} is reserved for use by Hash") if @reserved_symbols.include?( sym )
       end
+      
+      def try( *keys )
+        t = TryObject.new( self )
+        
+        for key in keys
+          t[key]
+        end
+        
+        t
+      end
+
+      def self.from_hash( hash )
+        config = self.new 
+
+        for k, v in hash
+          config.send( k, v.is_a?( Hash ) ? self.from_hash( v ) : v )
+        end
+        
+        config
+      end
+      
+      def self.fwc_overridden_methods
+        ConfigOverriddenMethods.instance_methods.grep( /[^=]$/ )
+      end
+      
+      def fwc_overridden_methods
+        self.class.fwc_overridden_methods
+      end
     end
   end
 end

data/lib/fun_with/configurations/object.rb

@@ -1,11 +1,19 @@
 class Object
   def install_fwc_config( config = nil, &block )
     extend FunWith::Configurations::Configurable
-    self.config = config || FunWith::Configurations::Config.new( &block )
+    self.config = config || FunWith::Configurations::Config.new( nil, &block )
     self.config
   end
   
   def install_fwc_config_from_file( filename )
     install_fwc_config( eval( File.read( filename ) ) )  # TODO: Has to be a better way than eval().  Dangerous.
   end
+  
+  def install_fwc_config_from_hash( hash )
+    install_fwc_config( FunWith::Configurations::Config.from_hash( hash ) )
+  end
+
+  def install_fwc_config_from_yaml( yaml_string )
+    install_fwc_config_from_hash( YAML.load( yaml_string ) )
+  end
 end

data/lib/fun_with/configurations/try_object.rb

@@ -0,0 +1,65 @@
+module FunWith
+  module Configurations
+    class TryResult
+      attr_accessor :config
+      def initialize( config, success )
+        @config = config
+        @success = success
+      end
+      
+      def success?
+        @success
+      end
+    end
+    
+    class TryObject
+      # takes a Config object
+      def initialize( config )
+        @config  = config
+        @success = true
+        @leaf    = false
+      end
+      
+      def method_missing( method, *args )
+        follow_config_method_chain( method )
+      end
+
+      def [] method_key
+        follow_config_method_chain( method_key.to_sym )
+      end
+      
+      def follow_config_method_chain( method )
+        if @success == true
+          if @config.is_a?(Config) && @config.has_key?(method)
+            @config = @config[method]
+            unless @config.is_a?(Config)
+              @leaf = true
+            end
+          elsif @leaf
+            @leaf = false   # declare unsuccessful on next call.
+          else
+            @success = false
+          end
+        end
+        
+        self
+      end
+      
+      def config_method_chain_result( *keys )
+        keys = keys.flatten
+        
+        if success?
+          keys.each do |k|
+            follow_config_method_chain(k)
+          end
+        end
+        
+        TryResult.new( @config, success? )
+      end
+      
+      def success?
+        @success
+      end
+    end
+  end
+end

data/lib/fun_with_configurations.rb

@@ -1,5 +1,13 @@
 require 'fun_with_files'
+module FunWith
+  module Configurations
+  end
+end
+
+FunWith::Files::RootPath.rootify( FunWith::Configurations, __FILE__.fwf_filepath.dirname.up )
+
 require_relative File.join( "fun_with", "configurations", "config" )
 require_relative File.join( "fun_with", "configurations", "configurations" )
 require_relative File.join( "fun_with", "configurations", "object" )
+require_relative File.join( "fun_with", "configurations", "try_object" )
 

data/test/data/config.yml

@@ -0,0 +1,12 @@
+servers: 
+  puppymonster:
+    commands:
+    - flippy
+    - snorty
+    - shorty
+  
+    services:
+      mysql:       yep
+      memcached:   sure
+      oauth:       definitely
+      twitter:     no

data/test/test_fun_with_configurations.rb

@@ -25,6 +25,16 @@ class TestFunWithConfigurations < Test::Unit::TestCase
           e :f
           f :g
         end
+        
+        s do
+          t do
+            u do
+              v do
+                w :x
+              end
+            end
+          end
+        end
       end
     end
     
@@ -66,29 +76,118 @@ class TestFunWithConfigurations < Test::Unit::TestCase
       assert_equal nil, @obj.config[:c=]
     end
     
-    should "gripe when given a string" do
+    should "gripe when given a hash" do
       assert defined?( FunWith::Configurations::KeyError )
       assert_raises FunWith::Configurations::KeyError do |err|
-        @obj.config["c"]
+        @obj.config[{c: "hey"}]
       end
     end
     
     should "gripe when given a reserved method as a key" do
       assert defined?( FunWith::Configurations::KeyError )
       assert_raises FunWith::Configurations::KeyError do |err|
-        @obj.config[:keys] = ["22461", "80129"]
+        @obj.config[:clone] = ["22461", "80129"]
+      end  
+      
+      assert_raises FunWith::Configurations::KeyError do |err|
+        @obj.config.clone = ["22461", "80129"]
       end
     end
+    
+    should "pass tests for try() function" do
+      assert_equal true,  @obj.config.try.a.success?
+      assert_equal true,  @obj.config.try.a.b.success?
+      assert_equal false,  @obj.config.try.a.b.c.success?
+      assert_equal false, @obj.config.try.a.b.c.d.e.f.g.h.success?
+      assert_equal true,  @obj.config.try.c.d.success?
+      assert_equal true,  @obj.config.try[:c]["d"].success?     # alternate traversal mechanism
+    end
+    
+    should "have parents" do
+      assert_kind_of FunWith::Configurations::Config, @obj.config.c.instance_variable_get(:@parent)
+      assert_kind_of FunWith::Configurations::Config, @obj.config.s.t.u.instance_variable_get(:@parent).instance_variable_get(:@parent)
+    end
+    
+    should "promote subconfiguration" do
+      assert_equal :x, @obj.config.s.t.u.v.w
+      @obj.config.s.t.u.v.promote_configuration(:w)
+      assert_equal :x, @obj.config.s.t.u.v
+    end
+
+    should "promote sub-subconfiguration" do
+      assert_equal :x, @obj.config.s.t.u.v.w
+      @obj.config.s.t.u.promote_configuration(:v,:w)
+      assert_equal :x, @obj.config.s.t.u
+    end
   end
   
   should "successfully create configuration manually" do
     @obj = Object.new
     @obj.extend( FunWith::Configurations::Configurable )
-    @obj.config = FunWith::Configurations::Config.new do
+    @obj.config = FunWith::Configurations::Config.new( nil ) do
       betelgeuse "red"
       rigel "blue-white"
     end
     
     assert_equal "blue-white", @obj.config.rigel
   end
+  
+  context "testing overridden methods|" do
+    setup do
+      @obj = Object.new
+      @obj.install_fwc_config do
+        malaprop :sym
+        blocky do
+          fish :guts
+          test :has_caused_problems
+        end
+      end
+    end
+    
+    should "override test" do
+      assert @obj.config.blocky.respond_to?(:test)
+      assert_equal :has_caused_problems, @obj.config.blocky.test 
+    end
+  end
+  
+  should "hold multiple arguments as arrays" do
+    @obj = Object.new
+    @obj.install_fwc_config do
+      my_array 1,2,3,nil,5
+      my_array2 [1,2,3,nil,5]
+    end
+    
+    assert_equal @obj.config.my_array, @obj.config.my_array2
+  end
+  
+  context "testing from_hash" do
+    setup do
+      @obj = Object.new
+      @obj.install_fwc_config_from_hash({
+        :calista => "Flockhart",
+        :jude    => "Law"
+      })
+    
+      @obj2 = Object.new
+      @obj2.install_fwc_config_from_hash({
+        :a => {
+          :b => {
+            :c => {
+              :d => "e"
+            }
+          }
+        }
+      })
+      
+      @obj3 = Object.new
+      yaml = FunWith::Configurations.root("test", "data", "config.yml").read
+      @obj3.install_fwc_config_from_yaml( yaml )
+    end
+    
+    should "have successfully created configs" do
+      assert_equal "Law", @obj.config.jude
+      assert_equal "e", @obj2.config.a.b.c.d
+      assert_equal "definitely", @obj3.config.servers.puppymonster.services.oauth
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fun_with_configurations
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-30 00:00:00.000000000 Z
+date: 2013-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fun_with_files
@@ -119,7 +119,9 @@ files:
 - ./lib/fun_with/configurations/config.rb
 - ./lib/fun_with/configurations/configurations.rb
 - ./lib/fun_with/configurations/object.rb
+- ./lib/fun_with/configurations/try_object.rb
 - ./lib/fun_with_configurations.rb
+- ./test/data/config.yml
 - ./test/helper.rb
 - ./test/test_fun_with_configurations.rb
 - Gemfile
@@ -142,7 +144,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2567250153676636570
+      hash: 4158279720265668030
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: