configliere 0.4.6 → 0.4.7

data/CHANGELOG.textile

@@ -1,3 +1,14 @@
+h2. Version 0.4.7
+
+* can now load JSON
+* updated specs to run on Windows
+* Only accepts things that are to_sym'bolizable as keys
+* pings rdoc.info on commit
+
+h2. Version 0.4.6
+
+Unwittingly moved DeepHash's alias_method(:merge,:update) *above* the redefinition of update, and so made merge be quietly broken. Fixed, and many more specs added.
+
 h2. Version 0.4.5
 
 * can now ask for @has_definition?(:my_param)@ or @has_definition?(:my_param, :description)@.

data/Gemfile

@@ -1,5 +1,7 @@
 source "http://rubygems.org"
 
+gem 'json'
+
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do

data/Gemfile.lock

@@ -9,6 +9,7 @@ GEM
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
+    json (1.5.1)
     rake (0.8.7)
     rcov (0.9.9)
     reek (1.2.8)
@@ -43,6 +44,7 @@ DEPENDENCIES
   bundler (~> 1.0.12)
   highline (>= 1.5.2)
   jeweler (~> 1.5.2)
+  json
   rcov (>= 0.9.9)
   reek
   roodi

data/README.textile

@@ -180,7 +180,7 @@ h2. Command-line parameters
 
 <pre>
     # Head back
-    time_machine --delorean.power_source='1.21 gigawatt lightning strike' --dest_time=11-05-1985
+    time_machine --delorean.power_source='1.21 jiggawatt lightning strike' --dest_time=11-05-1985
     # (in the time_machine script:)
     Settings.use(:commandline)
     Settings.resolve!

data/VERSION

@@ -1 +1 @@
-0.4.6
+0.4.7

data/configliere.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{configliere}
-  s.version = "0.4.6"
+  s.version = "0.4.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["infochimps", "mrflip"]
-  s.date = %q{2011-05-21}
+  s.date = %q{2011-06-28}
   s.description = %q{ You've got a script. It's got some settings. Some settings are for this module, some are for that module. Most of them don't change. Except on your laptop, where the paths are different.  Or when you're in production mode. Or when you're testing from the command line.
 
    "" So, Consigliere of mine, I think you should tell your Don what everyone knows. "" -- Don Corleone
@@ -108,6 +108,7 @@ Configliere manage settings from many sources: static constants, simple config f
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<json>, [">= 0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.12"])
       s.add_development_dependency(%q<yard>, ["~> 0.6.7"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
@@ -116,6 +117,7 @@ Configliere manage settings from many sources: static constants, simple config f
       s.add_development_dependency(%q<RedCloth>, [">= 0"])
       s.add_development_dependency(%q<highline>, [">= 1.5.2"])
     else
+      s.add_dependency(%q<json>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.12"])
       s.add_dependency(%q<yard>, ["~> 0.6.7"])
       s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
@@ -125,6 +127,7 @@ Configliere manage settings from many sources: static constants, simple config f
       s.add_dependency(%q<highline>, [">= 1.5.2"])
     end
   else
+    s.add_dependency(%q<json>, [">= 0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.12"])
     s.add_dependency(%q<yard>, ["~> 0.6.7"])
     s.add_dependency(%q<jeweler>, ["~> 1.5.2"])

data/lib/configliere/commands.rb

@@ -29,7 +29,7 @@ module Configliere
     end
 
     def command_info
-      commands[command_name]
+      commands[command_name] if command_name
     end
 
     def resolve!

data/lib/configliere/config_file.rb

@@ -30,7 +30,11 @@ module Configliere
       if filename.is_a?(Symbol) then raise Configliere::DeprecatedError, "Loading from a default config file is no longer provided" ; end
       filename = expand_filename(filename)
       begin
-        read_yaml(File.open(filename), options)
+        case filetype(filename)
+        when 'json' then read_json(File.open(filename), options)
+        when 'yaml' then read_yaml(File.open(filename), options)
+        else            read_yaml(File.open(filename), options)
+        end
       rescue Errno::ENOENT => e
         warn "Loading empty configliere settings file #{filename}"
       end
@@ -38,6 +42,7 @@ module Configliere
     end
 
     def read_yaml yaml_str, options={}
+      require 'yaml'
       new_data = YAML.load(yaml_str) || {}
       # Extract the :env (production/development/etc)
       if options[:env]
@@ -47,6 +52,19 @@ module Configliere
       self
     end
 
+    #
+    # we depend on you to require some sort of JSON
+    #
+    def read_json json_str, options={}
+      new_data = JSON.load(json_str) || {}
+      # Extract the :env (production/development/etc)
+      if options[:env]
+        new_data = new_data[options[:env]] || {}
+      end
+      deep_merge! new_data
+      self
+    end
+
     # save to disk.
     # * file is in YAML format, as a hash of handle => param_hash pairs
     # * filename defaults to Configliere::DEFAULT_CONFIG_FILE (~/.configliere, probably)
@@ -59,6 +77,11 @@ module Configliere
 
   protected
 
+    def filetype filename
+      filename =~ /\.([^\.]+)$/ ;
+      $1
+    end
+
     def expand_filename filename
       if filename.to_s.include?('/')
         File.expand_path(filename)

data/lib/configliere/deep_hash.rb

@@ -265,21 +265,21 @@ class DeepHash < Hash
   # Merge hashes recursively.
   # Nothing special happens to array values
   #
-  #     x = { :subhash => { 1 => :val_from_x, 222 => :only_in_x, 333 => :only_in_x }, :scalar => :scalar_from_x}
-  #     y = { :subhash => { 1 => :val_from_y, 999 => :only_in_y },                    :scalar => :scalar_from_y }
+  #     x = { :subhash => { :a => :val_from_x, :b => :only_in_x, :c => :only_in_x }, :scalar => :scalar_from_x}
+  #     y = { :subhash => { :a => :val_from_y, :d => :only_in_y },                   :scalar => :scalar_from_y }
   #     x.deep_merge y
-  #     => {:subhash=>{1=>:val_from_y, 222=>:only_in_x, 333=>:only_in_x, 999=>:only_in_y}, :scalar=>:scalar_from_y}
+  #     => {:subhash=>{:a=>:val_from_y, :b=>:only_in_x, :c=>:only_in_x, :d=>:only_in_y}, :scalar=>:scalar_from_y}
   #     y.deep_merge x
-  #     => {:subhash=>{1=>:val_from_x, 222=>:only_in_x, 333=>:only_in_x, 999=>:only_in_y}, :scalar=>:scalar_from_x}
+  #     => {:subhash=>{:a=>:val_from_x, :b=>:only_in_x, :c=>:only_in_x, :d=>:only_in_y}, :scalar=>:scalar_from_x}
   #
   # Nil values always lose.
   #
-  #     x = {:subhash=>{:nil_in_x=>nil, 1=>:val1,}, :nil_in_x=>nil}
+  #     x = {:subhash=>{:nil_in_x=>nil, a=>:val_a}, :nil_in_x=>nil}
   #     y = {:subhash=>{:nil_in_x=>5},              :nil_in_x=>5}
   #     y.deep_merge x
-  #     => {:subhash=>{1=>:val1, :nil_in_x=>5}, :nil_in_x=>5}
+  #     => {:subhash=>{:a=>:val_a, :nil_in_x=>5}, :nil_in_x=>5}
   #     x.deep_merge y
-  #     => {:subhash=>{1=>:val1, :nil_in_x=>5}, :nil_in_x=>5}
+  #     => {:subhash=>{:a=>:val_a, :nil_in_x=>5}, :nil_in_x=>5}
   #
   def deep_merge hsh2
     merge hsh2, &DeepHash::DEEP_MERGER
@@ -293,11 +293,11 @@ class DeepHash < Hash
   #
   # Treat hash as tree of hashes:
   #
-  #     x = { 1 => :val, :subhash => { 1 => :val1 } }
+  #     x = { :a => :val, :subhash => { :b => :val_b } }
   #     x.deep_set(:subhash, :cat, :hat)
-  #     # => { 1 => :val, :subhash => { 1 => :val1,   :cat => :hat } }
-  #     x.deep_set(:subhash, 1, :newval)
-  #     # => { 1 => :val, :subhash => { 1 => :newval, :cat => :hat } }
+  #     # => { :a => :val, :subhash => { :b => :val_b,   :cat => :hat } }
+  #     x.deep_set(:subhash, :b, :newval)
+  #     # => { :a => :val, :subhash => { :b => :newval, :cat => :hat } }
   #
   #
   def deep_set *args
@@ -316,14 +316,14 @@ class DeepHash < Hash
   #
   # Treat hash as tree of hashes:
   #
-  #     x = { 1 => :val, :subhash => { 1 => :val1 } }
-  #     x.deep_get(:subhash, 1)
-  #     # => :val
-  #     x.deep_get(:subhash, 2)
+  #     x = { :a => :val_a, :subhash => { :b => :val_b } }
+  #     x.deep_get(:a)
+  #     # => :val_a
+  #     x.deep_get(:subhash, :c)
   #     # => nil
-  #     x.deep_get(:subhash, 2, 3)
+  #     x.deep_get(:subhash, :c, :f)
   #     # => nil
-  #     x.deep_get(:subhash, 2)
+  #     x.deep_get(:subhash, :b)
   #     # => nil
   #
   def deep_get *args
@@ -337,15 +337,15 @@ class DeepHash < Hash
   #
   # Treat hash as tree of hashes:
   #
-  #     x = { 1 => :val, :subhash => { 1 => :val1, 2 => :val2 } }
-  #     x.deep_delete(:subhash, 1)
+  #     x = { :a => :val, :subhash => { :a => :val1, :b => :val2 } }
+  #     x.deep_delete(:subhash, :a)
   #     #=> :val
   #     x
-  #     #=> { 1 => :val, :subhash => { 2 => :val2 } }
+  #     #=> { :a => :val, :subhash => { :b => :val2 } }
   #
   def deep_delete *args
-    last_key  = args.pop
-    last_hsh  = args.empty? ? self : (deep_get(*args)||{})
+    last_key  = args.pop                                   # key to delete
+    last_hsh  = args.empty? ? self : (deep_get(*args)||{}) # hsh containing that key
     last_hsh.delete(last_key)
   end
 
@@ -359,9 +359,9 @@ protected
   # @private
   def convert_key(attr)
     case
-    when attr.to_s.include?('.') then attr.to_s.split(".").map{|sub_attr| sub_attr.to_sym }
-    when attr.is_a?(String)      then attr.to_sym
-    else                              attr
+    when attr.to_s.include?('.')   then attr.to_s.split(".").map{|sub_attr| sub_attr.to_sym }
+    when attr.is_a?(Array)         then attr.map{|sub_attr| sub_attr.to_sym }
+    else                                attr.to_sym
     end
   end
 

data/spec/configliere/config_file_spec.rb

@@ -10,7 +10,7 @@ describe Configliere::ConfigFile do
     @config.should respond_to(:read)
   end
 
-  describe 'loading a config file' do
+  describe 'loading a yaml config file' do
     before do
       @fake_file = '{ :my_param: val_from_file }'
     end
@@ -47,6 +47,44 @@ describe Configliere::ConfigFile do
     end
   end
 
+  describe 'loading a json config file' do
+    before do
+      require 'json'
+      @fake_file = '{"my_param":"val_from_file"}'
+    end
+
+    describe 'successfully' do
+      it 'with an absolute pathname uses it directly' do
+        File.should_receive(:open).with(%r{/fake/path.json}).and_return(@fake_file)
+        @config.read '/fake/path.json'
+      end
+      it 'with a simple filename, references it to the default config dir' do
+        File.should_receive(:open).with(File.join(Configliere::DEFAULT_CONFIG_DIR, 'file.json')).and_return(@fake_file)
+        @config.read 'file.json'
+      end
+      it 'returns the config object for chaining' do
+        File.should_receive(:open).with(File.join(Configliere::DEFAULT_CONFIG_DIR, 'file.json')).and_return(@fake_file)
+        @config.defaults :also_a_param => true
+        @config.read('file.json').should == { :my_param => 'val_from_file', :also_a_param => true }
+      end
+      after do
+        @config[:my_param].should == 'val_from_file'
+      end
+    end
+
+    it 'no longer provides a default config file' do
+      lambda{ @config.read(:my_settings) }.should raise_error(Configliere::DeprecatedError)
+      defined?(Configliere::DEFAULT_CONFIG_FILE).should_not be_true
+    end
+
+    it 'warns but does not fail if the file is missing' do
+      @config = Configliere::Param.new
+      File.stub(:open).and_raise(Errno::ENOENT)
+      @config.should_receive(:warn).with("Loading empty configliere settings file #{Configliere::DEFAULT_CONFIG_DIR}/nonexistent_file.json")
+      @config.read('nonexistent_file.json').should == {}
+    end
+  end
+
   describe '#read_yaml' do
     before do
       @config.merge! :reload => :whatever
@@ -107,7 +145,7 @@ describe Configliere::ConfigFile do
     it 'and ensures the directory exists' do
       fake_file = StringIO.new('', 'w')
       File.stub!(:open).with(%r{/fake/path.yaml}, 'w').and_yield(fake_file)
-      FileUtils.should_receive(:mkdir_p).with('/fake')
+      FileUtils.should_receive(:mkdir_p).with(%r{/fake})
       @config.save! '/fake/path.yaml'
     end
   end

data/spec/configliere/deep_hash_spec.rb

@@ -81,6 +81,13 @@ describe DeepHash do
       deep_hash[:hash] = { :sym_key => "is buggy in Ruby 1.8.6" }
       deep_hash[:hash].should be_an_instance_of(DeepHash)
     end
+
+    it "only accepts #to_sym'bolizable things as keys" do
+      lambda{ @deep_hash[1] = 'hi'            }.should raise_error(NoMethodError, /undefined method `to_sym'/)
+      lambda{ @deep_hash[{ :a => :b }] = 'hi' }.should raise_error(NoMethodError, /undefined method `to_sym'/)
+      lambda{ @deep_hash[Object.new] = 'hi'   }.should raise_error(NoMethodError, /undefined method `to_sym'/)
+      lambda{ @deep_hash[:a] = 'hi'           }.should_not raise_error
+    end
   end
 
   describe '#[]' do
@@ -96,6 +103,12 @@ describe DeepHash do
       else                            lambda{ @deep_hash['hat.cat'] }.should raise_error(NoMethodError, 'undefined method `[]\' for :cat:Symbol') end
       @deep_hash.should == hsh # shouldn't change from reading (specifically, shouldn't autovivify)
     end
+
+    it "only accepts #to_sym'bolizable things as keys" do
+      lambda{ @deep_hash[1]            }.should raise_error(NoMethodError, /undefined method `to_sym'/)
+      lambda{ @deep_hash[{ :a => :b }] }.should raise_error(NoMethodError, /undefined method `to_sym'/)
+      lambda{ @deep_hash[Object.new]   }.should raise_error(NoMethodError, /undefined method `to_sym'/)
+    end
   end
 
   def arrays_should_be_equal arr1, arr2
@@ -122,25 +135,25 @@ describe DeepHash do
 
   describe '#compact' do
     it 'removes nils but not empties or falsehoods' do
-      DeepHash.new({ 1 => nil }).compact.should == {}
-      DeepHash.new({ 1 => nil, 2 => false, 3 => {}, 4 => "", :remains => true }).compact!.should == { 2 => false, 3 => {}, 4 => "", :remains => true }
+      DeepHash.new({ :a => nil }).compact.should == {}
+      DeepHash.new({ :a => nil, :b => false, :c => {}, :d => "", :remains => true }).compact.should == { :b => false, :c => {}, :d => "", :remains => true }
     end
 
     it 'leaves original alone' do
-      deep_hash = DeepHash.new({ 1 => nil, :remains => true })
+      deep_hash = DeepHash.new({ :a => nil, :remains => true })
       deep_hash.compact.should == { :remains => true }
-      deep_hash.should == { 1 => nil, :remains => true }
+      deep_hash.should == { :a => nil, :remains => true }
     end
   end
 
   describe '#compact!' do
     it 'removes nils but not empties or falsehoods' do
-      DeepHash.new({ 1 => nil}).compact!.should == {}
-      DeepHash.new({ 1 => nil, 2 => false, 3 => {}, 4 => "", :remains => true }).compact!.should == { 2 => false, 3 => {}, 4 => "", :remains => true }
+      DeepHash.new({ :a => nil}).compact!.should == {}
+      DeepHash.new({ :a => nil, :b => false, :c => {}, :d => "", :remains => true }).compact!.should == { :b => false, :c => {}, :d => "", :remains => true }
     end
 
     it 'modifies in-place' do
-      deep_hash = DeepHash.new({ 1 => nil, :remains => true })
+      deep_hash = DeepHash.new({ :a => nil, :remains => true })
       deep_hash.compact!.should == { :remains => true }
       deep_hash.should == { :remains => true }
     end

metadata

@@ -2,7 +2,7 @@
 name: configliere
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.4.6
+  version: 0.4.7
 platform: ruby
 authors: 
 - infochimps
@@ -11,12 +11,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-21 00:00:00 -05:00
+date: 2011-06-28 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: bundler
+  name: json
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -24,10 +35,10 @@ dependencies:
         version: 1.0.12
   type: :development
   prerelease: false
-  version_requirements: *id001
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: yard
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -35,10 +46,10 @@ dependencies:
         version: 0.6.7
   type: :development
   prerelease: false
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: jeweler
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -46,10 +57,10 @@ dependencies:
         version: 1.5.2
   type: :development
   prerelease: false
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -57,10 +68,10 @@ dependencies:
         version: 2.5.0
   type: :development
   prerelease: false
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: spork
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -68,10 +79,10 @@ dependencies:
         version: 0.9.0.rc5
   type: :development
   prerelease: false
-  version_requirements: *id005
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: RedCloth
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -79,10 +90,10 @@ dependencies:
         version: "0"
   type: :development
   prerelease: false
-  version_requirements: *id006
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: highline
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -90,7 +101,7 @@ dependencies:
         version: 1.5.2
   type: :development
   prerelease: false
-  version_requirements: *id007
+  version_requirements: *id008
 description: " You've got a script. It's got some settings. Some settings are for this module, some are for that module. Most of them don't change. Except on your laptop, where the paths are different.  Or when you're in production mode. Or when you're testing from the command line.\n\n   \"\" So, Consigliere of mine, I think you should tell your Don what everyone knows. \"\" -- Don Corleone\n\n\
   Configliere manage settings from many sources: static constants, simple config files, environment variables, commandline options, straight ruby. You don't have to predefine anything, but you can ask configliere to type-convert, require, document or password-obscure any of its fields. Modules can define config settings independently of each other and the main program.\n"
 email: coders@infochimps.org
@@ -174,7 +185,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 213250075244557737
+      hash: -3025764887803996140
       segments: 
       - 0
       version: "0"