hopsoft-fig 0.8.3 → 0.8.4

data/Rakefile

@@ -1,6 +1,6 @@
 require 'echoe'
 
-Echoe.new('fig', '0.8.3') do |p|
+Echoe.new('fig', '0.8.4') do |p|
   p.description = "The smart way to manage configuration settings for your Ruby applications."
   p.url = "http://github.com/hopsoft/fig"
   p.author = "Nathan Hopkins, Hopsoft LLC"

data/fig.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{fig}
-  s.version = "0.8.3"
+  s.version = "0.8.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nathan Hopkins, Hopsoft LLC"]
-  s.date = %q{2009-03-15}
+  s.date = %q{2009-03-16}
   s.description = %q{The smart way to manage configuration settings for your Ruby applications.}
   s.email = %q{natehop@gmail.com}
-  s.extra_rdoc_files = ["README.rdoc", "lib/fig.rb", "lib/string.rb", "tasks/fig_tasks.rake"]
-  s.files = ["README.rdoc", "install.rb", "MIT-LICENSE", "test/test.yml", "test/test2.yml", "test/string_test.rb", "test/fig_test.rb", "Manifest", "uninstall.rb", "Rakefile", "init.rb", "lib/fig.rb", "lib/string.rb", "tasks/fig_tasks.rake", "fig.gemspec"]
+  s.extra_rdoc_files = ["README.rdoc", "lib/hopsoft/fig.rb", "lib/string.rb", "tasks/fig_tasks.rake"]
+  s.files = ["README.rdoc", "install.rb", "MIT-LICENSE", "test/test.yml", "test/test2.yml", "test/string_test.rb", "test/fig_test.rb", "Manifest", "uninstall.rb", "Rakefile", "init.rb", "lib/hopsoft/fig.rb", "lib/string.rb", "tasks/fig_tasks.rake", "fig.gemspec"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/hopsoft/fig}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Fig", "--main", "README.rdoc"]

data/lib/hopsoft/fig.rb

@@ -0,0 +1,134 @@
+require 'yaml'
+require 'ostruct'
+require 'thread'
+require File.dirname(__FILE__) + '/../string'
+
+module Hopsoft
+  class Fig
+ 
+    # Constructor...
+    #
+    # ===Params
+    # * *file_path* - Path to the config file that should be loaded.
+    def initialize(file_path)
+      @lock = Mutex.new
+      @file_path = file_path
+      load
+    end
+
+    # Returns the config file file as a YAML Hash.
+    def yaml
+      copy = {}
+      @lock.synchronize do
+        copy.merge!(@yaml)
+      end
+      copy
+    end
+
+
+    # Returns an OpenStruct object representation of the config file.
+    # This allows you to access config settings with dot notation.
+    def settings
+      copy = OpenStruct.new
+      @lock.synchronize do
+        copy.marshal_load(@settings.marshal_dump)
+      end
+      copy
+    end
+
+    # The safest way to get a config setting.
+    # Requesting a non-exsisting key, will simply return a nil value instead of raising an error.
+    #
+    # Examples:
+    # Fig.get_setting('some.nested.setting')
+    #
+    # ===Params
+    # * *key* - A case insensivie config key
+    #
+    # *Returns* The value of the config setting requested.
+    #   This may be the value itself or an OpenStruct containing child args
+    def get_setting(key)
+      setting = nil
+
+      @lock.synchronize do
+        setting = @settings
+        keys = key.to_s.downcase.split(/\./)
+
+        keys.each do |k|
+          item = eval("setting.#{k}")
+          return nil unless item
+          setting = item
+        end
+      end
+
+      setting
+    end
+
+    # Loads the config file and builds the internal Fig objects.
+    # Can be used to reload the file when changes have been made.
+    def load
+      yaml = YAML.load_file(@file_path)
+      yaml.each {|k, v| interpolate_setting(yaml, v)}
+      settings = OpenStruct.new
+      add_hash(settings, yaml)
+
+      @lock.synchronize do
+        @yaml = yaml
+        @settings = settings
+      end
+    rescue
+      puts "Failed to load file: #{@file_path}\n#{$!}"
+    end
+
+    private
+
+    # Invoked recursively to implicitly interpolate all settings for the passed value.
+    # Config values that contain the pattern /{fig:/ are implicitly interpolated,
+    # replacing the "fig" placeholder with the actual value from elsewhere in the config file.
+    #
+    # Example:
+    #   name: Nathan Hopkins
+    #   message: "This is a test! Hello #{fig:example.name}"
+    #
+    # ===Params
+    # * *value* [_Object_] The value to interpolate.
+    def interpolate_setting(yaml, value)
+      if value.is_a?(Hash)
+        value.each {|k,v| interpolate_setting(yaml, v) }
+      elsif value.is_a?(String)
+        pattern = /\{fig:/i
+        start = value.index(pattern, 0)
+        replace = {}
+      
+        while start
+          finish = value.index(/\}/, start)
+          key = value[(start + 1)..(finish - 1)]
+          replace[key] = eval("yaml['#{key.sub(/^fig:/i, "").gsub(/\./, "']['")}'].to_s")
+          start = value.index(pattern, finish)
+        end
+      
+        value.interpolate(replace, true)
+      end
+    end
+  
+    # Recursively adds a hash to an OpenStruct object, ultimately creating a complete OpenStruct object with attributes
+    # for all key/value pairs in the Hash.
+    #
+    # ===Params
+    # * *obj* - The OpenStruct object to add Hash args to.
+    # * *hash* - The Hash to pull args from.
+    def add_hash(obj, hash)
+      return unless hash
+
+      hash.each do |key, value|
+        if value.class == Hash
+          eval "obj.#{key} = OpenStruct.new"
+          add_hash(eval("obj.#{key}"), value)
+        else
+          eval "obj.#{key.downcase} = value"
+        end
+      end
+    end
+   
+  end
+end

data/test/fig_test.rb

@@ -1,9 +1,9 @@
 require 'test/unit'
 require 'fileutils'
-require File.dirname(__FILE__) + '/../lib/fig'
+require File.dirname(__FILE__) + '/../lib/hopsoft/fig'
 
 class FigTest < Test::Unit::TestCase
-  @@fig = Fig.new(File.dirname(__FILE__) + '/test.yml')
+  @@fig = Hopsoft::Fig.new(File.dirname(__FILE__) + '/test.yml')
   
   def test_yaml_values
     assert @@fig.yaml

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hopsoft-fig
 version: !ruby/object:Gem::Version 
-  version: 0.8.3
+  version: 0.8.4
 platform: ruby
 authors: 
 - Nathan Hopkins, Hopsoft LLC
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-15 00:00:00 -07:00
+date: 2009-03-16 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -21,7 +21,7 @@ extensions: []
 
 extra_rdoc_files: 
 - README.rdoc
-- lib/fig.rb
+- lib/hopsoft/fig.rb
 - lib/string.rb
 - tasks/fig_tasks.rake
 files: 
@@ -36,7 +36,7 @@ files:
 - uninstall.rb
 - Rakefile
 - init.rb
-- lib/fig.rb
+- lib/hopsoft/fig.rb
 - lib/string.rb
 - tasks/fig_tasks.rake
 - fig.gemspec

data/lib/fig.rb

@@ -1,132 +0,0 @@
-require 'yaml'
-require 'ostruct'
-require 'thread'
-require File.dirname(__FILE__) + '/string'
-
-class Fig
- 
-  # Constructor...
-  #
-  # ===Params
-  # * *file_path* - Path to the config file that should be loaded.
-  def initialize(file_path)
-    @lock = Mutex.new
-    @file_path = file_path
-    load
-  end
-
-  # Returns the config file file as a YAML Hash.
-  def yaml
-    copy = {}
-    @lock.synchronize do
-      copy.merge!(@yaml)
-    end
-    copy
-  end
-
-
-  # Returns an OpenStruct object representation of the config file.
-  # This allows you to access config settings with dot notation.
-  def settings
-    copy = OpenStruct.new
-    @lock.synchronize do 
-      copy.marshal_load(@settings.marshal_dump)
-    end
-    copy
-  end
-
-  # The safest way to get a config setting.
-  # Requesting a non-exsisting key, will simply return a nil value instead of raising an error.
-  #
-  # Examples:
-  # Fig.get_setting('some.nested.setting')
-  #
-  # ===Params
-  # * *key* - A case insensivie config key
-  #
-  # *Returns* The value of the config setting requested.
-  #   This may be the value itself or an OpenStruct containing child args
-  def get_setting(key)
-    setting = nil
-
-    @lock.synchronize do
-      setting = @settings
-      keys = key.to_s.downcase.split(/\./)
-
-      keys.each do |k|
-        item = eval("setting.#{k}")
-        return nil unless item
-        setting = item
-      end
-    end
-
-    setting
-  end
-
-  # Loads the config file and builds the internal Fig objects.
-  # Can be used to reload the file when changes have been made.
-  def load
-    yaml = YAML.load_file(@file_path)
-    yaml.each {|k, v| interpolate_setting(yaml, v)}
-    settings = OpenStruct.new
-    add_hash(settings, yaml)
-
-    @lock.synchronize do  
-      @yaml = yaml
-      @settings = settings
-    end
-  rescue
-    puts "Failed to load file: #{@file_path}\n#{$!}"
-  end
-
-private
-
-  # Invoked recursively to implicitly interpolate all settings for the passed value.
-  # Config values that contain the pattern /{fig:/ are implicitly interpolated,
-  # replacing the "fig" placeholder with the actual value from elsewhere in the config file.  
-  #  
-  # Example:
-  #   name: Nathan Hopkins
-  #   message: "This is a test! Hello #{fig:example.name}"
-  #
-  # ===Params
-  # * *value* [_Object_] The value to interpolate.
-  def interpolate_setting(yaml, value)
-    if value.is_a?(Hash)
-      value.each {|k,v| interpolate_setting(yaml, v) }
-    elsif value.is_a?(String)
-      pattern = /\{fig:/i
-      start = value.index(pattern, 0)
-      replace = {}
-      
-      while start
-        finish = value.index(/\}/, start)
-        key = value[(start + 1)..(finish - 1)]
-        replace[key] = eval("yaml['#{key.sub(/^fig:/i, "").gsub(/\./, "']['")}'].to_s")  
-        start = value.index(pattern, finish)
-      end
-      
-      value.interpolate(replace, true)
-    end
-  end
-  
-  # Recursively adds a hash to an OpenStruct object, ultimately creating a complete OpenStruct object with attributes
-  # for all key/value pairs in the Hash.
-  # 
-  # ===Params
-  # * *obj* - The OpenStruct object to add Hash args to.
-  # * *hash* - The Hash to pull args from.
-  def add_hash(obj, hash)
-    return unless hash
-
-    hash.each do |key, value|
-      if value.class == Hash
-        eval "obj.#{key} = OpenStruct.new"
-        add_hash(eval("obj.#{key}"), value)
-      else
-        eval "obj.#{key.downcase} = value"  
-      end
-    end
-  end
-   
-end