runcoderun-configatron 2.2.1.2 → 2.2.2.1

data/lib/configatron/blank_slate.rb

@@ -0,0 +1,61 @@
+#--
+# Copyright 2004, 2006 by Jim Weirich (jim@weirichhouse.org).
+# All rights reserved.
+
+# Permission is granted for use, copying, modification, distribution,
+# and distribution of modified versions of this work as long as the
+# above copyright notice is included.
+#++
+
+# This version of BlankSlate was taken from Builder and modified by Rob Sanheim
+# to remove hooks into the various built-in callbacks (ie method_added).
+# Not sure if we need that complexity (yet) in configatron's use case.
+#
+######################################################################
+# BlankSlate provides an abstract base class with no predefined
+# methods (except for <tt>\_\_send__</tt> and <tt>\_\_id__</tt>).
+# BlankSlate is useful as a base class when writing classes that
+# depend upon <tt>method_missing</tt> (e.g. dynamic proxies).
+#
+class Configatron
+  class BlankSlate
+    # These methods are used by configatron internals, so we have to whitelist them.
+    # We could probably do some alias magic to get them to be proper __foo style methods
+    #, but this is okay for now.
+    CONFIGATRON_WHITELIST = %w[instance_eval methods instance_variable_get is_a? class]
+    
+    class << self
+      
+      # Hide the method named +name+ in the BlankSlate class.  Don't
+      # hide methods in +CONFIGATRON_WHITELIST+ or any method beginning with "__".
+      def hide(name)
+        if instance_methods.include?(name.to_s) and
+          name !~ /^(__|#{CONFIGATRON_WHITELIST.join("|")})/
+          @hidden_methods ||= {}
+          @hidden_methods[name.to_sym] = instance_method(name)
+          undef_method name
+        end
+      end
+
+      def find_hidden_method(name)
+        @hidden_methods ||= {}
+        @hidden_methods[name] || superclass.find_hidden_method(name)
+      end
+
+      # Redefine a previously hidden method so that it may be called on a blank
+      # slate object.
+      def reveal(name)
+        bound_method = nil
+        unbound_method = find_hidden_method(name)
+        fail "Don't know how to reveal method '#{name}'" unless unbound_method
+        define_method(name) do |*args|
+          bound_method ||= unbound_method.bind(self)
+          bound_method.call(*args)
+        end
+      end
+    end
+
+    instance_methods.each { |m| hide(m) }
+    
+  end
+end

data/lib/configatron/configatron.rb

@@ -12,7 +12,7 @@ class Configatron
   
   # Forwards the method call onto the 'namespaced' Configatron::Store
   def method_missing(sym, *args)
-    @_store[@_namespace.last].send(sym, *args)
+    @_store[@_namespace.last].__send__(sym, *args)
   end
   
   # Removes ALL configuration parameters

data/lib/configatron/core_ext/class.rb

@@ -0,0 +1,26 @@
+class Class
+  
+  # Returns access to configuration parameters named after the class.
+  # 
+  # Examples:
+  #   configatron.foo.bar = :bar
+  #   configatron.a.b.c.d = 'D'
+  #   
+  #   class Foo
+  #   end
+  #   
+  #   module A
+  #     module B
+  #       class C
+  #       end
+  #     end
+  #   end
+  # 
+  #   Foo.to_configatron.bar # => :bar
+  #   A::B::C.to_configatron.d # => 'D'
+  def to_configatron
+    name_spaces = self.name.split("::").collect{|s| s.methodize}
+    configatron.send_with_chain(name_spaces)
+  end
+  
+end

data/lib/configatron/core_ext/object.rb

@@ -0,0 +1,9 @@
+class Object # :nodoc:
+  
+  def send_with_chain(methods, *args) # :nodoc:
+    obj = self
+    [methods].flatten.each {|m| obj = obj.__send__(m, *args)}
+    obj
+  end
+  
+end

data/lib/configatron/core_ext/string.rb

@@ -0,0 +1,84 @@
+class String # :nodoc:
+  
+  def underscore # :nodoc:
+    self.to_s.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+  end
+  
+  def methodize # :nodoc:
+    x = self
+    
+    # if we get down to a nil or an empty string raise an exception! 
+    raise NameError.new("#{self} cannot be converted to a valid method name!") if x.nil? || x == ''
+    
+    # get rid of the big stuff in the front/back
+    x.strip!
+    
+    # if we get down to a nil or an empty string raise an exception! 
+    raise NameError.new("#{self} cannot be converted to a valid method name!") if x.nil? || x == ''
+    
+    x = x.underscore
+    
+    # get rid of spaces and make the _
+    x.gsub!(' ', '_')
+    # get rid of everything that isn't 'safe' a-z, 0-9, ?, !, =, _
+    x.gsub!(/([^ a-zA-Z0-9\_\?\!\=]+)/n, '_')
+    
+    # if we get down to a nil or an empty string raise an exception! 
+    raise NameError.new("#{self} cannot be converted to a valid method name!") if x.nil? || x == ''
+    
+    # condense multiple 'safe' non a-z chars to just one.
+    # ie. ___ becomes _ !!!! becomes ! etc...
+    [' ', '_', '?', '!', "="].each do |c|
+      x.squeeze!(c)
+    end
+    
+    # if we get down to a nil or an empty string raise an exception! 
+    raise NameError.new("#{self} cannot be converted to a valid method name!") if x.nil? || x == ''
+    
+    #down case the whole thing
+    x.downcase!
+    
+    # get rid of any characters at the beginning that aren't a-z
+    while !x.match(/^[a-z]/)
+      x.slice!(0)
+      
+      # if we get down to a nil or an empty string raise an exception! 
+      raise NameError.new("#{self} cannot be converted to a valid method name!") if x.nil? || x == ''
+    end
+    
+    # let's trim this bad boy down a bit now that we've cleaned it up, somewhat.
+    # we should do this before cleaning up the end character, because it's possible to end up with a 
+    # bad char at the end if you trim too late.
+    x = x[0..100] if x.length > 100
+    
+    # get rid of any characters at the end that aren't safe
+    while !x.match(/[a-z0-9\?\!\=]$/)
+      x.slice!(x.length - 1)
+      # if we get down to a nil or an empty string raise an exception! 
+      raise NameError.new("#{self} cannot be converted to a valid method name!") if x.nil? || x == ''
+    end
+    
+    # if we get down to a nil or an empty string raise an exception! 
+    raise NameError.new("#{self} cannot be converted to a valid method name!") if x.nil? || x == ''
+    
+    # let's get rid of characters that don't belong in the 'middle' of the method.
+    orig_middle = x[1..(x.length - 2)]
+    n_middle = orig_middle.dup
+    
+    ['?', '!', "="].each do |c|
+      n_middle.gsub!(c, "_")
+    end
+    
+    # the previous gsub can leave us with multiple underscores that need cleaning up.
+    n_middle.squeeze!("_")
+    
+    x.gsub!(orig_middle, n_middle)
+    x.gsub!("_=", "=")
+    x
+  end
+  
+end

data/lib/configatron/errors.rb

@@ -1,13 +1,13 @@
 class Configatron
-  class ProtectedParameter < StandardError
-    def intialize(name)
-      super("Can not modify protected parameter: '#{name}'")
+  class ProtectedParameter < RuntimeError
+    def initialize(_name)
+      super("Can not modify protected parameter: '#{_name}'")
     end
   end
 
-  class LockedNamespace < StandardError
-    def initialize(name)
-      super("Cannot add new parameters to locked namespace: #{name.inspect}")
+  class LockedNamespace < RuntimeError
+    def initialize(_name)
+      super("Cannot add new parameters to locked namespace: #{_name.inspect}")
     end
   end
 end

data/lib/configatron/store.rb

@@ -1,6 +1,6 @@
 class Configatron
-  class Store
-    alias_method :send!, :send
+  class Store < BlankSlate
+    # alias_method :__send!, :__send__
     
     # Takes an optional Hash of parameters
     def initialize(options = {}, name = nil, parent = nil)
@@ -94,8 +94,8 @@ class Configatron
     def method_missing(sym, *args) # :nodoc:
       if sym.to_s.match(/(.+)=$/)
         name = sym.to_s.gsub("=", '').to_sym
-        raise Configatron::ProtectedParameter.new(name) if @_protected.include?(name) || methods_include?(name)
-        raise Configatron::LockedNamespace.new(@_name) if @_locked && !@_store.has_key?(name)
+        raise Configatron::ProtectedParameter.new(name.to_s) if @_protected.include?(name) || methods_include?(name)
+        raise Configatron::LockedNamespace.new(@_name.to_s) if @_locked && !@_store.has_key?(name)
         @_store[name] = parse_options(*args)
       elsif @_store.has_key?(sym)
         return @_store[sym]
@@ -120,7 +120,7 @@ class Configatron
     def protect_all!
       @_protected.clear
       @_store.keys.each do |k|
-        val = self.send(k)
+        val = self.__send__(k)
         val.protect_all! if val.class == Configatron::Store
         @_protected << k
       end
@@ -134,7 +134,7 @@ class Configatron
     def unprotect_all!
       @_protected.clear
       @_store.keys.each do |k|
-        val = self.send(k)
+        val = self.__send__(k)
         val.unprotect_all! if val.class == Configatron::Store
       end
     end

data/lib/configatron.rb

@@ -1,7 +1,11 @@
 base = File.join(File.dirname(__FILE__), 'configatron')
 require 'yaml'
 require 'erb'
-require File.join(base, 'kernel')
+require File.join(base, 'blank_slate')
 require File.join(base, 'configatron')
 require File.join(base, 'store')
-require File.join(base, 'errors')
+require File.join(base, 'errors')
+require File.join(base, 'core_ext', 'kernel')
+require File.join(base, 'core_ext', 'object')
+require File.join(base, 'core_ext', 'string')
+require File.join(base, 'core_ext', 'class')

data/spec/lib/blank_slate_spec.rb

@@ -0,0 +1,25 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe Configatron::BlankSlate do
+
+  before(:each) do
+    configatron.reset!
+  end
+  
+  it "should respond to __id__ and __send__ built in methods" do
+    lambda {
+      Configatron::BlankSlate.new.__id__
+      Configatron::BlankSlate.new.__send__
+    }.should_not raise_error(NoMethodError)
+  end
+  
+  it "should have methods on the CONFIGATRON_WHITELIST" do
+    blank_slate = Configatron::BlankSlate.new
+    Configatron::BlankSlate::CONFIGATRON_WHITELIST.each do |meth|
+      lambda {
+        blank_slate__send__
+      }.should_not raise_error(NoMethodError)
+    end
+  end
+  
+end

data/spec/lib/class_spec.rb

@@ -0,0 +1,28 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+configatron.foo.bar = :bar
+configatron.a.b.c.d = 'D'
+
+class Foo
+end
+
+module A
+  module B
+    class C
+    end
+  end
+end
+
+describe Class do
+  
+  describe 'to_configatron' do
+    
+    it 'should return a Configatron::Store object based on the name of the class' do
+      Foo.to_configatron.should be_kind_of(Configatron::Store)
+      Foo.to_configatron.bar.should == :bar
+      A::B::C.to_configatron.d.should == 'D'
+    end
+    
+  end
+  
+end

data/spec/lib/configatron_spec.rb

@@ -5,17 +5,28 @@ describe "configatron" do
   before(:each) do
     configatron.reset!
   end
+
+  describe "can use built in method names on nested stores" do
+    configatron.email.send = "joe@example.com"
+    configatron.email.send.should == "joe@example.com"
+    
+    configatron.email.object_id.should == "another"
+    configatron.email.object_id "another"
+  end
   
   describe 'protect' do
     
     it 'should protect a parameter and prevent it from being set' do
       configatron.one = 1
       configatron.protect(:one)
-      lambda{configatron.one = 'one'}.should raise_error(Configatron::ProtectedParameter)
+      lambda { 
+        configatron.one = 'one' 
+      }.should raise_error(Configatron::ProtectedParameter)
       configatron.one.should == 1
     end
     
     it 'should protect basic methods' do
+      pending("Not sure if this really applies any more...there is no reason to _not_ let users set a key called 'object_id' now")
       lambda{configatron.object_id = 123456}.should raise_error(Configatron::ProtectedParameter)
       lambda{configatron.foo.object_id = 123456}.should raise_error(Configatron::ProtectedParameter)
     end
@@ -49,9 +60,11 @@ describe "configatron" do
       configatron.letters.a = 'A'
       configatron.letters.b = 'B'
       configatron.protect_all!
-      [:a,:b].each do |l|
-        lambda{configatron.configure_from_hash(:letters => {l => l.to_s})}.should raise_error(Configatron::ProtectedParameter)
-        configatron.letters.send(l).should == l.to_s.upcase
+      [:a,:b].each do |lowercase_letter|
+        lambda {
+          configatron.configure_from_hash(:letters => { lowercase_letter => lowercase_letter.to_s})
+        }.should raise_error(Configatron::ProtectedParameter)
+        configatron.letters.__send__(lowercase_letter).should == lowercase_letter.to_s.upcase
       end
       lambda{configatron.letters.configure_from_hash(:a => 'a')}.should raise_error(Configatron::ProtectedParameter)
       lambda{configatron.configure_from_hash(:letters => 'letters')}.should raise_error(Configatron::ProtectedParameter)

data/spec/lib/errors_spec.rb

@@ -0,0 +1,9 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe "errors" do
+  
+  it "should have descriptive message" do
+    Configatron::ProtectedParameter.new("name").message.should == "Can not modify protected parameter: 'name'"
+  end
+  
+end

data/spec/lib/store_spec.rb

@@ -0,0 +1,10 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe Configatron::Store do
+
+  before(:each) do
+    configatron.reset!
+  end
+  
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: runcoderun-configatron
 version: !ruby/object:Gem::Version 
-  version: 2.2.1.2
+  version: 2.2.2.1
 platform: ruby
 authors: 
 - markbates
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-14 00:00:00 -08:00
+date: 2009-01-20 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -22,16 +22,24 @@ extensions: []
 extra_rdoc_files: 
 - README
 files: 
+- lib/configatron/blank_slate.rb
 - lib/configatron/configatron.rb
+- lib/configatron/core_ext/class.rb
+- lib/configatron/core_ext/kernel.rb
+- lib/configatron/core_ext/object.rb
+- lib/configatron/core_ext/string.rb
 - lib/configatron/errors.rb
-- lib/configatron/kernel.rb
 - lib/configatron/store.rb
 - lib/configatron.rb
 - README
 - spec/lib
+- spec/lib/blank_slate_spec.rb
+- spec/lib/class_spec.rb
 - spec/lib/configatron_spec.rb
+- spec/lib/errors_spec.rb
 - spec/lib/futurama.yml
 - spec/lib/lost.yml
+- spec/lib/store_spec.rb
 - spec/lib/the_wire.yml
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -64,9 +72,13 @@ specification_version: 2
 summary: A powerful Ruby configuration system.
 test_files: 
 - spec/lib
+- spec/lib/blank_slate_spec.rb
+- spec/lib/class_spec.rb
 - spec/lib/configatron_spec.rb
+- spec/lib/errors_spec.rb
 - spec/lib/futurama.yml
 - spec/lib/lost.yml
+- spec/lib/store_spec.rb
 - spec/lib/the_wire.yml
 - spec/spec.opts
 - spec/spec_helper.rb