settingslogic 2.0.5 → 2.0.6

data/VERSION.yml

@@ -2,4 +2,4 @@
 :major: 2
 :minor: 0
 :build: 
-:patch: 5
+:patch: 6

data/lib/settingslogic.rb

@@ -4,12 +4,22 @@ require "erb"
 # A simple settings solution using a YAML file. See README for more information.
 class Settingslogic < Hash
   class MissingSetting < StandardError; end
-  
+
   class << self
     def name # :nodoc:
       instance.key?("name") ? instance.name : super
     end
-    
+
+    # Enables Settings.get('nested.key.name') for dynamic access
+    def get(key)
+      parts = key.split('.')
+      curs = self
+      while p = parts.shift
+        curs = curs.send(p)
+      end
+      curs
+    end
+
     def source(value = nil)
       if value.nil?
         @source
@@ -27,15 +37,16 @@ class Settingslogic < Hash
     end
     
     def [](key)
-      # Setting.key.value or Setting[:key][:value] or Setting['key']['value']
-      fetch(key.to_s,nil)
+      instance.fetch(key.to_s, nil)
     end
 
-    def []=(key,val)
-      # Setting[:key] = 'value' for dynamic settings
-      store(key.to_s,val)
+    def []=(key, val)
+      # Setting[:key][:key2] = 'value' for dynamic settings
+      val = new(val, source) if val.is_a? Hash
+      instance.store(key.to_s, val)
+      instance.create_accessor_for(key, val)
     end
-    
+
     def load!
       instance
       true
@@ -48,12 +59,29 @@ class Settingslogic < Hash
     
     private
       def instance
-        @instance ||= new
+        return @instance if @instance
+        @instance = new
+        create_accessors!
+        @instance
       end
       
       def method_missing(name, *args, &block)
         instance.send(name, *args, &block)
       end
+
+      # It would be great to DRY this up somehow, someday, but it's difficult because
+      # of the singleton pattern.  Basically this proxies Setting.foo to Setting.instance.foo
+      def create_accessors!
+        instance.each do |key,val|
+          create_accessor_for(key)
+        end
+      end
+
+      def create_accessor_for(key)
+        return unless key.to_s =~ /^\w+$/  # could have "some-setting:" which blows up eval
+        instance_eval "def #{key}; instance.send(:#{key}); end"
+      end
+
   end
 
   # Initializes a new settings object. You can initialize an object in any of the following ways:
@@ -67,7 +95,10 @@ class Settingslogic < Hash
   # if you are using this in rails. If you pass a string it should be an absolute path to your settings file.
   # Then you can pass a hash, and it just allows you to access the hash via methods.
   def initialize(hash_or_file = self.class.source, section = nil)
+    #puts "new! #{hash_or_file}"
     case hash_or_file
+    when nil
+      raise Errno::ENOENT, "No file specified as Settingslogic source"
     when Hash
       self.replace hash_or_file
     else
@@ -75,39 +106,54 @@ class Settingslogic < Hash
       hash = hash[self.class.namespace] if self.class.namespace
       self.replace hash
     end
-    @section = section || hash_or_file  # so end of error says "in application.yml"
+    @section = section || self.class.source  # so end of error says "in application.yml"
     create_accessors!
   end
 
   # Called for dynamically-defined keys, and also the first key deferenced at the top-level, if load! is not used.
   # Otherwise, create_accessors! (called by new) will have created actual methods for each key.
-  def method_missing(key, *args, &block)
-    begin
-      value = fetch(key.to_s)
-    rescue IndexError
-      raise MissingSetting, "Missing setting '#{key}' in #{@section}"
-    end
+  def method_missing(name, *args, &block)
+    key = name.to_s
+    raise MissingSetting, "Missing setting '#{key}' in #{@section}" unless has_key? key
+    value = fetch(key)
+    create_accessor_for(key)
     value.is_a?(Hash) ? self.class.new(value, "'#{key}' section in #{@section}") : value
   end
 
-  private
-    # This handles naming collisions with Sinatra/Vlad/Capistrano. Since these use a set()
-    # helper that defines methods in Object, ANY method_missing ANYWHERE picks up the Vlad/Sinatra
-    # settings!  So settings.deploy_to title actually calls Object.deploy_to (from set :deploy_to, "host"),
-    # rather than the app_yml['deploy_to'] hash.  Jeezus.
-    def create_accessors!
-      self.each do |key,val|
-        # Use instance_eval/class_eval because they're actually more efficient than define_method{}
-        # http://stackoverflow.com/questions/185947/ruby-definemethod-vs-def
-        # http://bmorearty.wordpress.com/2009/01/09/fun-with-rubys-instance_eval-and-class_eval/
-        self.class.class_eval <<-EndEval
-          def #{key}
-            return @#{key} if @#{key}  # cache (performance)
-            value = fetch('#{key}')
-            @#{key} = value.is_a?(Hash) ? self.class.new(value, "'#{key}' section in #{@section}") : value
-          end
-        EndEval
-      end
+  def [](key)
+    fetch(key.to_s, nil)
+  end
+
+  def []=(key,val)
+    # Setting[:key][:key2] = 'value' for dynamic settings
+    val = self.class.new(val, @section) if val.is_a? Hash
+    store(key.to_s, val)
+    create_accessor_for(key, val)
+  end
+
+  # This handles naming collisions with Sinatra/Vlad/Capistrano. Since these use a set()
+  # helper that defines methods in Object, ANY method_missing ANYWHERE picks up the Vlad/Sinatra
+  # settings!  So settings.deploy_to title actually calls Object.deploy_to (from set :deploy_to, "host"),
+  # rather than the app_yml['deploy_to'] hash.  Jeezus.
+  def create_accessors!
+    self.each do |key,val|
+      create_accessor_for(key)
     end
+  end
 
+  # Use instance_eval/class_eval because they're actually more efficient than define_method{}
+  # http://stackoverflow.com/questions/185947/ruby-definemethod-vs-def
+  # http://bmorearty.wordpress.com/2009/01/09/fun-with-rubys-instance_eval-and-class_eval/
+  def create_accessor_for(key, val=nil)
+    return unless key.to_s =~ /^\w+$/  # could have "some-setting:" which blows up eval
+    instance_variable_set("@#{key}", val) if val
+    self.class.class_eval <<-EndEval
+      def #{key}
+        return @#{key} if @#{key}
+        raise MissingSetting, "Missing setting '#{key}' in #{@section}" unless has_key? '#{key}'
+        value = fetch('#{key}')
+        @#{key} = value.is_a?(Hash) ? self.class.new(value, "'#{key}' section in #{@section}") : value
+      end
+    EndEval
+  end
 end

data/settingslogic.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{settingslogic}
-  s.version = "2.0.5"
+  s.version = "2.0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ben Johnson of Binary Logic"]
-  s.date = %q{2010-02-01}
+  s.date = %q{2010-02-12}
   s.email = %q{bjohnson@binarylogic.com}
   s.extra_rdoc_files = [
     "LICENSE",

data/spec/settings.rb

@@ -1,3 +1,6 @@
 class Settings < Settingslogic
   source "#{File.dirname(__FILE__)}/settings.yml"
+end
+
+class SettingsInst < Settingslogic
 end

data/spec/settings.yml

@@ -16,4 +16,7 @@ language:
     paradigm: object oriented 
 
 collides:
-  does: not
+  does: not
+nested:
+  collides:
+    does: not either

data/spec/settingslogic_spec.rb

@@ -20,7 +20,7 @@ describe "Settingslogic" do
   it "should enable erb" do
     Settings.setting3.should == 25
   end
-  
+
   it "should namespace settings" do
     Settings2.setting1_child.should == "saweet"
     Settings2.deep.another.should == "my value"
@@ -37,9 +37,13 @@ describe "Settingslogic" do
   end
   
   it "should not collide with global methods" do
+    Settings3.nested.collides.does.should == 'not either'
+    Settings3[:nested] = 'fooey'
+    Settings3[:nested].should == 'fooey'
+    Settings3.nested.should == 'fooey'
     Settings3.collides.does.should == 'not'
   end
-  
+
   it "should raise a helpful error message" do
     e = nil
     begin
@@ -49,7 +53,7 @@ describe "Settingslogic" do
     end
     e.should_not be_nil
     e.message.should =~ /Missing setting 'missing' in/
-    
+
     e = nil
     begin
       Settings.language.missing
@@ -71,14 +75,62 @@ describe "Settingslogic" do
     e.message.should =~ /Missing setting 'erlang' in 'language' section/
     
     Settings.language['erlang'].should be_nil
-    Settings.language['erlang'] ||= 5
+    Settings.language['erlang'] = 5
     Settings.language['erlang'].should == 5
 
     Settings.language['erlang'] = {'paradigm' => 'functional'}
     Settings.language.erlang.paradigm.should == 'functional'
+    Settings.respond_to?('erlang').should be_false
 
     Settings.reload!
     Settings.language['erlang'].should be_nil
+
+    Settings.language[:erlang] ||= 5
+    Settings.language[:erlang].should == 5
+
+    Settings.language[:erlang] = {}
+    Settings.language[:erlang][:paradigm] = 'functional'
+    Settings.language.erlang.paradigm.should == 'functional'
+
+    Settings[:toplevel] = '42'
+    Settings.toplevel.should == '42'
+  end
+
+  it "should raise an error on a nil source argument" do
+    class NoSource < Settingslogic; end
+    e = nil
+    begin
+      NoSource.foo.bar
+    rescue => e
+      e.should be_kind_of Errno::ENOENT
+    end
+    e.should_not be_nil
+  end
+
+  # This one edge case currently does not pass, because it requires very
+  # esoteric code in order to make it pass.  It was judged not worth fixing,
+  # as it introduces significant complexity for minor gain.
+  # it "should handle reloading top-level settings"
+  #   Settings[:inspect] = 'yeah baby'
+  #   Settings.inspect.should == 'yeah baby'
+  #   Settings.reload!
+  #   Settings.inspect.should == 'Settings'
+  # end
+
+  it "should handle oddly-named settings" do
+    Settings.language['some-dash-setting#'] = 'dashtastic'
+    Settings.language['some-dash-setting#'].should == 'dashtastic'
+  end
+
+  it "should support instance usage as well" do
+    settings = SettingsInst.new(Settings.source)
+    settings.setting1.setting1_child.should == "saweet"
+  end
+
+  it "should be able to get() a key with dot.notation" do
+    Settings.get('setting1.setting1_child').should == "saweet"
+    Settings.get('setting1.deep.another').should == "my value"
+    Settings.get('setting1.deep.child.value').should == 2
   end
 
   # Put this test last or else call to .instance will load @instance,

data/spec/spec_helper.rb

@@ -10,7 +10,7 @@ require 'settings2'
 require 'settings3'
 
 # Needed to test Settings3
-def collides
+Object.send :define_method, 'collides' do
   'collision'
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: settingslogic
 version: !ruby/object:Gem::Version 
-  version: 2.0.5
+  version: 2.0.6
 platform: ruby
 authors: 
 - Ben Johnson of Binary Logic
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-01 00:00:00 -05:00
+date: 2010-02-12 00:00:00 -05:00
 default_executable: 
 dependencies: []