confit 0.0.5 → 1.0

data/README.md

@@ -1,18 +1,22 @@
+**N.B. Confit 1.0 breaks backwards-compatibility with earlier versions!**
+
 Installation
 ------------
 * sudo gem install confit
 
 Initialization
 --------------
-* require 'confit'
-* confit('path/to/config.yml')
+* `require 'confit'`
+`confit('path/to/file_name.yml')`
 
 Usage
 -----
-* puts confit.some_key # "The value of this key!"
+* `puts confit.file_name.some_key # "The value of this key!"`
 
 Notes
 -----
-* Optional initialization params include environment and strict mode:
-* confit('path/to/config.yml', 'development', true)
-* Strict mode raises a NoMethodError if that key hasn't been loaded from your yaml file.
+* Optional initialization params include environment, strict mode, and force reload of file
+* `confit('path/to/file_name.yml', 'development', true, true) # confit.file_name.key_name -- from the yaml block named "development"`
+* Strict mode raises a `MissingVariableError` if that key hasn't been loaded from your yaml file.
+* Force reload ensures that the file is processed, even if Confit has already seen it before. This is useful for loading multiple 
+environments at different times from within one file. 

data/lib/confit.rb

@@ -1,9 +1,21 @@
 require 'ostruct'
+require 'rubygems'
+
+class InvalidFileNameError < StandardError; end
+class MissingVariableError < StandardError; end
+class MissingFileError < StandardError; end
 
 module Confit
   
   @@app_config = nil
   @@strict = nil
+  @@files = Array.new
+  @@current_file_name = nil
+  @@debug = false
+  
+  def self.debug(msg)
+    puts "\nDebug:\t#{msg}" if @@debug
+  end
   
   def self.strict
     @@strict
@@ -14,31 +26,72 @@ module Confit
   end
   
   def self.confit(file=nil, env=nil, strict=false, force=false)
-
-    @@app_config ? (return @@app_config if not force) : @@app_config = OpenStruct.new
-
+    self.debug("self.confit(file=#{file}, env=#{env}, strict=#{strict}, force=#{force})")
+    
+    @@app_config = OpenStruct.new if not @@app_config
+    
+    if not @@files.include?(file) and not file.nil?
+      self.debug "New file: #{file}"
+      self.prep_config(file)
+    else
+      self.debug "File exists: (#{force}) #{file}"
+      return @@app_config if not force
+      self.debug "Forcing reload of file"
+    end
+    
     @@strict = strict ? true : false
     
+    self.process_file(file, env)
+
+    @@app_config
+  end
+  
+  def self.prep_config(file)
+    file =~ /([^\/]+)\.yml$/i
+    raise InvalidFileNameError, "Filename is not valid: #{file}" if not $1
+    
+    @@current_file_name = $1
+    self.debug "Current file #{@@current_file_name}"
+    @@files << file
+    @@app_config.send("#{@@current_file_name}=", OpenStruct.new)  
+  end
+  
+  def self.process_file(file, env=nil)
     if not file.nil?
       if File.exist?(file)
         yaml = env ? YAML.load_file(file)[env] : YAML.load_file(file)
-        yaml.each do |key, val|
-          @@app_config.send("#{self.prep_key(key)}=", val)
-        end
+        self.parse_hash(yaml, @@app_config.send(@@current_file_name))
       else
-        raise IOError, "File #{file} does not exist!"
+        raise MissingFileError, "File #{file} does not exist!"
       end
     end
-
-    @@app_config
   end
-
+  
+  def self.load_pair(key, val, parent)
+    self.debug "load_pair: #{parent}.send(#{key}=, #{val})"
+    parent.send("#{key}=", val)
+  end
+  
+  def self.parse_hash(zee_hash, parent)
+    zee_hash.each do |key, val|
+      if val.is_a?(Hash)
+        self.debug "is a Hash #{key},#{val}"
+        self.load_pair(key, OpenStruct.new, parent)
+        self.parse_hash(val, parent.send(key))
+      else
+        self.debug "Not a Hash #{key},#{val}"
+        self.load_pair(key, val, parent)
+      end
+      
+    end
+  end
+  
 end
 
 module Kernel
   
   def confit(file=nil, env=nil, strict=false, force=false)
-    Confit::confit(file, env, strict)
+    Confit::confit(file, env, strict, force)
   end
 
 end
@@ -48,7 +101,7 @@ class OpenStruct
   def method_missing(mid, *args)
     mname = mid.id2name
     if mname !~ /=/
-      raise NoMethodError, "Confit variable not defined! confit.#{mname}" if Confit.strict
+      raise MissingVariableError, "Confit variable not defined! #{mname}" if Confit.strict
     else
       len = args.length
       if mname.chomp!('=')

data/test/complex.yml

@@ -0,0 +1,26 @@
+jo_dev:
+  app_name: jo dev
+  api_key: theapikey
+  secret_key: thesecret
+  canvas_page_name: jo_dev_test
+  callback_url: http://urldoesntexist.com
+  page_id: 12345
+  app_id: 56789
+  page_url: http://www.facebook.com/apps/application.php?id=56789
+  page_tab_url: http://www.facebook.com/apps/application.php?id=56789&v=app_56789
+  uid: 100000981545471
+
+poeks_dev:
+  app_name: poeks dev
+  api_key: thepoeksapikey
+  secret_key: thepoekssecretkey
+  canvas_page_name: poeks_dev_test
+  callback_url: http://urldontexist.com
+  page_id: 923048
+  app_id: 685490605
+  page_url: http://www.facebook.com/apps/application.php?id=685490605
+  page_tab_url: http://www.facebook.com/apps/application.php?id=685490605&v=app_685490605
+  uid: 655764281
+  a_hash: 
+    name: the hash
+    value: the value

data/test/confit_test.rb

@@ -1,30 +1,35 @@
 require File.join(File.expand_path(File.join(File.dirname(__FILE__))), '..', 'lib', 'confit')
 
 require 'test/unit'
-require 'rubygems'
 
 class ConfitTest < Test::Unit::TestCase
-  
-  def _init
-    file = File.join(File.expand_path(File.join(File.dirname(__FILE__))), '..', 'test', 'test.yml')
+
+  def test_missing
+    file = File.join(File.expand_path(File.join(File.dirname(__FILE__))), '..', 'test', 'simple.yml')
     confit(file, 'dev', true)
+    puts "Doesn't exist: #{confit.test.your_mom}"
+  rescue MissingVariableError => e
+    assert_equal(e.class.to_s, "MissingVariableError")
   end
   
-  def test_main_methods
-    _init
-    assert_equal("twitterpoeks@gmail.com", confit.email)
+  def test_simple
+    file = File.join(File.expand_path(File.join(File.dirname(__FILE__))), '..', 'test', 'simple.yml')
+    confit(file, 'dev', true)
+    assert_equal("Poeks", confit.simple.author)
   end
 
-  def test_missing
-    _init
-    puts "Doesn't exist: #{confit.your_mom}"
-  rescue NoMethodError => e
-    puts "Rescued NoMethodError for confit.your_mom!"
+  def test_complex
+    file = File.join(File.expand_path(File.join(File.dirname(__FILE__))), '..', 'test', 'complex.yml')
+    confit(file, nil, true)
+    assert_equal("the value", confit.complex.poeks_dev.a_hash.value)
   end
   
-  def test_spacey
-    _init
-    assert_equal(confit.a_key_with_spaces, "Now underscores")
+  def test_force
+    file = File.join(File.expand_path(File.join(File.dirname(__FILE__))), '..', 'test', 'complex.yml')
+    confit(file, 'jo_dev', true, true)
+    assert_equal("jo dev", confit.complex.app_name)
+    confit(file, 'poeks_dev', true, true)
+    assert_equal("poeks dev", confit.complex.app_name)
   end
   
 end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: confit
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 15
   prerelease: false
   segments: 
+  - 1
   - 0
-  - 0
-  - 5
-  version: 0.0.5
+  version: "1.0"
 platform: ruby
 authors: 
 - Jen Oslislo
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-22 00:00:00 -08:00
+date: 2010-11-30 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -30,8 +29,9 @@ extra_rdoc_files: []
 
 files: 
 - lib/confit.rb
+- test/complex.yml
 - test/confit_test.rb
-- test/test.yml
+- test/simple.yml
 - README.md
 has_rdoc: true
 homepage: https://github.com/poeks/confit