uber_config 0.0.6 → 1.0.0

data/README.md

@@ -1,28 +1,27 @@
 UberConfig is a config loader that will load config files from various locations.
 
+# New in 1.0
+
+- Will look for both yml AND json files
+- Added :ext option to choose config extension
+- Indifferent access so you can use either symbols or strings for keys
+
+# Usage
+
 Just run:
 
     config = UberConfig.load
 
-Looks for `config.yml` file or name passed in via :file param.
+It will look `config.yml` or `config.json` by default. You can change what it will look for and
+where with the different load() options.
 
 Here is the order of where it looks:
 
 - $abt_config global variable (for https://github.com/iron-io/abt)
 - directory of file that calls UberConfig.load
 - working directory
-- TODO: look at ~/configs directory
+- TODO: look at ~/configs/#{working_directory_name} directory
 - ~/Dropbox/configs/#{working_directory_name}
 
 :dir can be used to change working_directory_name.
 
-## Helper methods
-
-### Symbolize Keys
-
-When it loads up config files, the hash keys will be strings by default because they are
-strings in the files. You can convert them to keys by running `UberConfig.symbolize_keys!`, for example:
-
-    config = UberConfig.load
-    config = UberConfig.symbolize_keys!(config)
-

data/lib/uber_config/uber_hash.rb

@@ -0,0 +1,12 @@
+class UberHash < Hash
+
+  def [](key)
+    r = super[key]
+    return r if r
+    if r.is_a?(Symbol)
+      return super[key.to_s]
+    end
+    r
+  end
+
+end

data/lib/uber_config/version.rb

@@ -1,3 +1,3 @@
 module UberConfig
-  VERSION = "0.0.6"
+  VERSION = "1.0.0"
 end

data/lib/uber_config.rb

@@ -3,9 +3,13 @@ require "uber_config/version"
 module UberConfig
 
   # Load a config file from various system locations
+  # Options:
+  #   :file => filename, default is 'config' which means it will look for both config.yml and config.json. You can use the full filename like 'config.json'
+  #   :dir => directory to look for in the default locations
+  #   :ext => extension, either yml or json. Default will check both.
   def self.load(options={})
 
-    # First check for abt config
+    # First check for abt config: https://github.com/iron-io/abt
     if defined? $abt_config
       puts "$abt_config found."
       @config = $abt_config
@@ -19,13 +23,20 @@ module UberConfig
         dir = [dir]
       end
     end
-    file = "config.yml"
-    if options[:file]
-      file = options[:file]
-    end
 
-    working_directory = Dir.pwd
-    #puts "working_dir: " + working_directory
+    file = options[:file] || "config"
+    ext = options[:ext]
+    filenames = []
+    if file.include?(".") # then has extension
+      filenames << file
+    else
+      if ext
+        filenames << "#{file}.#{ext}"
+      else
+        filenames << "#{file}.yml"
+        filenames << "#{file}.json"
+      end
+    end
 
     #p Kernel.caller
     caller_file = caller[0][0...(caller[0].index(":in"))]
@@ -44,33 +55,36 @@ module UberConfig
     end
 
     # Now check near caller file
-    dir_and_file = dir.nil? ? [] : dir.dup
-    dir_and_file << file
-    p dir_and_file
-    location = File.join(dir_and_file)
-    p location
-    cf = File.expand_path(location, caller_dir)
-    @config = load_from(cf)
-    return @config if @config
-
-    # and working directory
-    cf = File.expand_path(location)
-    @config = load_from(cf)
-    return @config if @config
-
-    puts "auto_dir_name: #{auto_dir_name}"
+    filenames.each do |file|
+      dir_and_file = dir.nil? ? [] : dir.dup
+      dir_and_file << file
+      #p dir_and_file
+      location = File.join(dir_and_file)
+      #p location
+      cf = File.expand_path(location, caller_dir)
+      @config = load_from(cf)
+      return @config if @config
+
+      # and working directory
+      cf = File.expand_path(location)
+      @config = load_from(cf)
+      return @config if @config
+
+    end
 
     # Now check in Dropbox
-    dropbox_folders = ["~", "Dropbox", "configs"]
-    if dir
-      dropbox_folders = dropbox_folders + dir
-    else
-      dropbox_folders = dropbox_folders << auto_dir_name
+    filenames.each do |file|
+      dropbox_folders = ["~", "Dropbox", "configs"]
+      if dir
+        dropbox_folders = dropbox_folders + dir
+      else
+        dropbox_folders = dropbox_folders << auto_dir_name
+      end
+      dropbox_folders << file
+      cf = File.expand_path(File.join(dropbox_folders))
+      @config = load_from(cf)
+      return @config if @config
     end
-    dropbox_folders << file
-    cf = File.expand_path(File.join(dropbox_folders))
-    @config = load_from(cf)
-    return @config if @config
 
     # couldn't find it
     raise "UberConfig could not find config file!"
@@ -82,17 +96,31 @@ module UberConfig
     if File.exist?(cf)
       config = YAML::load_file(cf)
       # the following makes it indifferent access, but doesn't seem to for inner hashes
-      #config.default_proc = proc do |h, k|
-      #  case k
-      #    when String then sym = k.to_sym; h[sym] if h.key?(sym)
-      #    when Symbol then str = k.to_s; h[str] if h.key?(str)
-      #  end
-      #end
+      set_default_proc(config)
       return config
     end
     nil
   end
 
+  def self.set_default_proc(hash)
+    puts 'setting default proc'
+    p hash
+    hash.default_proc = proc do |h, k|
+      case k
+        when String
+          sym = k.to_sym; h[sym] if h.key?(sym)
+        when Symbol
+          str = k.to_s; h[str] if h.key?(str)
+      end
+    end
+    hash.each_pair do |k, v|
+      if v.is_a?(Hash)
+        set_default_proc(v)
+      end
+    end
+
+  end
+
   # Destructively convert all keys to symbols, as long as they respond to to_sym.
   # inspired by activesupport
   def self.symbolize_keys!(hash)
@@ -124,8 +152,10 @@ module UberConfig
   def self.make_indifferent(hash)
     hash.default_proc = proc do |h, k|
       case k
-        when String then sym = k.to_sym; h[sym] if h.key?(sym)
-        when Symbol then str = k.to_s; h[str] if h.key?(str)
+        when String then
+          sym = k.to_sym; h[sym] if h.key?(sym)
+        when Symbol then
+          str = k.to_s; h[str] if h.key?(str)
       end
     end
   end

data/test/config.json

@@ -0,0 +1,3 @@
+{
+    "jsonx": "value"
+}

data/test/config.yml

@@ -0,0 +1,4 @@
+ymlx: value
+
+outer:
+  inner: inside

data/test/config2.json

@@ -0,0 +1,3 @@
+{
+    "jsonx": "value2"
+}

data/test/test_uber_config.rb

@@ -7,6 +7,23 @@ class TestUberConfig < Test::Unit::TestCase
   def test_loading
     @config = UberConfig.load
     p @config
+
+    assert_equal "value", @config['ymlx']
+    assert_equal "value", @config[:ymlx]
+    p @config[:outer]
+    assert_equal "inside", @config[:outer][:inner]
+
+    @config = UberConfig.load(:ext=>'json')
+    p @config
+    assert_equal "value", @config['jsonx']
+    assert_equal "value", @config[:jsonx]
+
+    @config = UberConfig.load(:file=>"config2")
+    p @config
+    assert_equal "value2", @config['jsonx']
+    assert_equal "value2", @config[:jsonx]
+
+
   end
 
   def test_symbolize

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uber_config
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-20 00:00:00.000000000 Z
+date: 2012-09-25 00:00:00.000000000 Z
 dependencies: []
 description: Loads configs from common locations.
 email:
@@ -23,7 +23,11 @@ files:
 - README.md
 - Rakefile
 - lib/uber_config.rb
+- lib/uber_config/uber_hash.rb
 - lib/uber_config/version.rb
+- test/config.json
+- test/config.yml
+- test/config2.json
 - test/test_uber_config.rb
 - uber_config.gemspec
 homepage: ''