hopsoft-fig 0.8.4 → 0.8.5

data/README.rdoc

@@ -2,12 +2,14 @@
 
 ===DRY up those magic numbers and hard coded strings into something more managable.  Fig is the smart way to manage stuff that really belongs in a config file instead of scattered throughout your code.
 
+Here are the Rdocs[http://hopsoft.github.com/fig/README.rdoc.html]
+Video tutorial coming soon...
+
 ==Why
 
-I know that Ruby is a dynamic language and that hard coded values aren't as big a deal, but...
-it's still good practice to have a centralized place to hold certain settings.
+Even though Ruby is a dynamic language and hard coded values aren't as big a deal, it's still good practice to have a centralized place to hold certain settings.
 
-I used to create a globally available Hash to store this stuff, but have always wanted something more powerful and elegant.
+In the past I would use a globally available Hash to store this stuff, but have always wanted something more powerful and elegant.
 
 
 ==What
@@ -48,28 +50,29 @@ Second, install the Gem.
 ===Usage
 Create a YAML file that will serve as one of the configuration files you plan to use.  In a Rails application, I usually create the file config/app.yml, but you can name the file anything you like and can save it to any location within your appliation or library.
 
-Require Fig either explicitly or implicitly.  In a Rails application, I generally do this in environment.rb.
+Require Fig either explicitly or implicitly.  In a Rails application, I generally do this in environment.rb. Note: this step isn't required if you installed as a Rails plugin.
   # implicit
   require 'hopsoft/fig'
   # explicit
   gem 'hopsoft-fig'
 
 Instantiate a Fig object that is globally available to your application.  In a Rails application, I generally do this in environment.rb.
-  APP_CONFIG = Fig.new(RAILS_ROOT + '/config/app.yml')
+  APP_CONFIG = Hopsoft::Fig.new(RAILS_ROOT + '/config/app.yml')
 
 Start using your settings.
   puts APP_CONFIG.settings.message
   puts APP_CONFIG.yaml['message']
   puts APP_CONFIG.get_setting('message')
+
   # returns nil instead of an error when the setting doesn't exist
   puts APP_CONFIG.get_setting('some.nested.setting.that.may.not.exist')
   
 Reuse settings in your YAML file (This is a great way to apply the DRY principle to your configuration settings):
   name: Nathan Hopkins
-  message: {fig:name} says hello.
+  message: Hello from {fig:name}.
  
   puts APP_CONFIG.get_setting('message')
-  # outputs -> Nathan Hopkins says hello.
+  # outputs -> Hello from Nathan Hopkins.
 
 Update the YAML file and load the changes without restarting your application.
   APP_CONFIG.load

data/Rakefile

@@ -1,6 +1,6 @@
 require 'echoe'
 
-Echoe.new('fig', '0.8.4') do |p|
+Echoe.new('fig', '0.8.5') 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.4"
+  s.version = "0.8.5"
 
   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-16}
+  s.date = %q{2009-03-18}
   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/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.extra_rdoc_files = ["lib/hopsoft/fig.rb", "lib/string.rb", "README.rdoc", "tasks/fig_tasks.rake"]
+  s.files = ["fig.gemspec", "init.rb", "install.rb", "lib/hopsoft/fig.rb", "lib/string.rb", "Manifest", "MIT-LICENSE", "Rakefile", "README.rdoc", "tasks/fig_tasks.rake", "test/fig_test.rb", "test/string_test.rb", "test/test.yml", "test/test2.yml", "uninstall.rb"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/hopsoft/fig}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Fig", "--main", "README.rdoc"]
@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.rubyforge_project = %q{fig}
   s.rubygems_version = %q{1.3.1}
   s.summary = %q{The smart way to manage configuration settings for your Ruby applications.}
-  s.test_files = ["test/string_test.rb", "test/fig_test.rb"]
+  s.test_files = ["test/fig_test.rb", "test/string_test.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/init.rb

@@ -1,2 +1,2 @@
 require 'string'
-require 'fig'
+require 'hopsoft/fig'

data/lib/hopsoft/fig.rb

@@ -8,8 +8,8 @@ module Hopsoft
  
     # Constructor...
     #
-    # ===Params
-    # * *file_path* - Path to the config file that should be loaded.
+    # ====Params
+    # * +file_path+ - Path to the config file that should be loaded.
     def initialize(file_path)
       @lock = Mutex.new
       @file_path = file_path
@@ -27,7 +27,7 @@ module Hopsoft
 
 
     # Returns an OpenStruct object representation of the config file.
-    # This allows you to access config settings with dot notation.
+    # This allows access to config settings via dot notation.
     def settings
       copy = OpenStruct.new
       @lock.synchronize do
@@ -39,14 +39,12 @@ module Hopsoft
     # 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')
+    #   Fig.get_setting('some.nested.setting')
     #
-    # ===Params
-    # * *key* - A case insensivie config key
+    # ====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
+    # 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
 
@@ -55,7 +53,7 @@ module Hopsoft
         keys = key.to_s.downcase.split(/\./)
 
         keys.each do |k|
-          item = eval("setting.#{k}")
+          item = eval("setting.#{k}") if setting.is_a?(OpenStruct)
           return nil unless item
           setting = item
         end
@@ -82,16 +80,16 @@ module Hopsoft
 
     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.
+    # Interpolates all settings for the passed value.
+    # Config values that contain the pattern /{fig:/ are 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}"
+    #   message: "This is a test! Hello #{fig:example.name}."
     #
-    # ===Params
-    # * *value* [_Object_] The value to interpolate.
+    # ====Params
+    # * +value+ - The value to interpolate.
     def interpolate_setting(yaml, value)
       if value.is_a?(Hash)
         value.each {|k,v| interpolate_setting(yaml, v) }
@@ -114,9 +112,9 @@ module Hopsoft
     # 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.
+    # ====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
 
@@ -131,4 +129,4 @@ module Hopsoft
     end
    
   end
-end
+end

data/lib/string.rb

@@ -1,21 +1,22 @@
 class String
 
   # Allows various forms of string interpolation.
-  # Addd to make it easier to dynamically replace YAML config values;
-  # howerver, this will likely come in handy elsewhere.
-  #
-  # Examples:
+  # Originally designed to reuse YAML config values; howerver,
+  # this will likely come in handy elsewhere.
+  # 
+  # 
   #   "Hello! My name is ?".interpolate("Nathan Hopkins")
   #   "Hello! My first name is ? and my last name is ?".interpolate(["Nathan", "Hopkins"])
-  #   'Hello! My first name is {first_name} and my last name is {last_name}'.interpolate(:first_name => "Nathan", :last_name => "Hopkins")
+  #   'Hello! My first name is {first_name} and my last name is {last_name}'.interpolate(:first_name => "Nathan",
+  #     :last_name => "Hopkins")
+  # 
   #
-  # ===Params
-  # * *args* [Symbol, String, Array, Hash] The value(s) used to replace segments of the string.
-  # * *in_place* [Boolean] Indicates if the value should edited in place.
-  #   Be careful when doing this, you may end up with unexpected results!
+  # ====Params
+  # * +args+ - The value(s) used to replace segments of the string.
+  # * +in_place+ - Indicates if the value should edited in place.  Be careful when doing this, you may end up with unexpected results!
+  # 
   #
-  # ===Returns
-  # The new string after interpolation.
+  # Returns the new string after interpolation.
   def interpolate(args, in_place=false)
     args = [args] unless args.is_a?(Array) || args.is_a?(Hash)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hopsoft-fig
 version: !ruby/object:Gem::Version 
-  version: 0.8.4
+  version: 0.8.5
 platform: ruby
 authors: 
 - Nathan Hopkins, Hopsoft LLC
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-16 00:00:00 -07:00
+date: 2009-03-18 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -20,26 +20,26 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README.rdoc
 - lib/hopsoft/fig.rb
 - lib/string.rb
+- README.rdoc
 - tasks/fig_tasks.rake
 files: 
-- README.rdoc
+- fig.gemspec
+- init.rb
 - install.rb
+- lib/hopsoft/fig.rb
+- lib/string.rb
+- Manifest
 - MIT-LICENSE
+- Rakefile
+- README.rdoc
+- tasks/fig_tasks.rake
+- test/fig_test.rb
+- test/string_test.rb
 - 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
 has_rdoc: true
 homepage: http://github.com/hopsoft/fig
 post_install_message: 
@@ -72,5 +72,5 @@ signing_key:
 specification_version: 2
 summary: The smart way to manage configuration settings for your Ruby applications.
 test_files: 
-- test/string_test.rb
 - test/fig_test.rb
+- test/string_test.rb