figgy 0.9.1 → 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YzlmMTc5ZjUyYzI2MTc5YjJiNDFhZTRkMDljYjc0MzhmNTc5MGNmZA==
+  data.tar.gz: !binary |-
+    ODJmMGFhZjNhNjA3NmU5YmY5ZWZlMjZjZTdhMjMyOTdmMDFlM2E4Mg==
+SHA512:
+  metadata.gz: !binary |-
+    YWVlNDkwNDdlMTJjNTMyZmJiOTZmNmRlN2Q0Y2E3NzM4NTg1NGUwYmExMjk1
+    MmU1NTg3ODYxNWExOTJmMmY1MjJlODZjOWJiYTMwMzI2N2YwYzRlN2IxMDNj
+    Y2Y4Yjg4MGFlM2Y4NmQ5NDk2MGFiODY3MDcyYzJmZmI3Njk0YTQ=
+  data.tar.gz: !binary |-
+    ZmJiYjZlYmUzYTkzYzM1ODUxZWFmMGU0YjY4YjlkMmJhNDJiZTFmNmVlOGQx
+    ZTIwYThlNTE4ZWE1NGI0YjBjYWU3MmQwNGExYWY2YjNiZTc3MzI0M2I3Y2Nl
+    NWI5NDQwZWRiYzA4ZGRjYzFmNzgxZmQ3MTU1MmZmNTlhZDEwYjc=

data/.travis.yml

@@ -2,3 +2,5 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kyle Hargraves
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -14,46 +14,67 @@ any other arbitrary thing you happen to come up with.
 
 Just like everything else these days. In your Gemfile:
 
-    gem 'figgy'
+~~~ruby
+gem 'figgy'
+~~~
 
 ## Overview
 
 Set it up (say, in a Rails initializer):
 
-    AppConfig = Figgy.build do |config|
-      config.root = Rails.root.join('etc')
+~~~ruby
+AppConfig = Figgy.build do |config|
+  config.root = Rails.root.join('etc')
 
-      # config.foo is read from etc/foo.yml
-      config.define_overlay :default, nil
+  # config.foo is read from etc/foo.yml
+  config.define_overlay :default, nil
 
-      # config.foo is then updated with values from etc/production/foo.yml
-      config.define_overlay(:environment) { Rails.env }
+  # config.foo is then updated with values from etc/production/foo.yml
+  config.define_overlay(:environment) { Rails.env }
 
-      # Maybe you need to load XML files?
-      config.define_handler 'xml' do |contents|
-        Hash.from_xml(contents)
-      end
-    end
+  # Maybe you need to load XML files?
+  config.define_handler 'xml' do |contents|
+    Hash.from_xml(contents)
+  end
+end
+~~~
 
 Access it as a dottable, indifferent-access hash:
 
-    AppConfig.foo.some_key
-    AppConfig["foo"]["some_key"]
-    AppConfig[:foo].some_key
+~~~ruby
+AppConfig.foo.some_key
+AppConfig["foo"]["some_key"]
+AppConfig[:foo].some_key
+~~~
 
 Multiple root directories may be specified, so that configuration files live in
 more than one place (say, in gems):
 
-    AppConfig = Figgy.build do |config|
-      config.root = Rails.root.join('etc')
-      config.add_root Rails.root.join('vendor/etc')
-    end
+~~~ruby
+AppConfig = Figgy.build do |config|
+  config.root = Rails.root.join('etc')
+  config.add_root Rails.root.join('vendor/etc')
+end
+~~~
 
 Precedence of root directories is in reverse order of definition, such that the
 root directory added first (typically the one immediately within the application)
 has highest precedence. In this way, defaults can be inherited from libraries,
 but then overridden when necessary within the application.
 
+## Caveats
+
+Because the objects exposed by figgy are often hashes, all of the instance methods
+of Hash (and, of course, Enumerable) are available along the chain. But note that
+this means you can not use key names such as `size` or `each` with the dottable
+access style:
+
+~~~ruby
+AppConfig.price.bulk   #=> 100.00
+AppConfig.price.each   #=> attempts to invoke Hash#each
+AppConfig.price[:each] #=> 50.00
+~~~
+
 ## Thanks
 
-This was written on [Enova Financial's](http://www.enovafinancial.com) dime/time.
+This was written on [Enova's](http://www.enova.com) dime/time.

data/figgy.gemspec

@@ -10,6 +10,7 @@ Gem::Specification.new do |s|
   s.homepage    = "http://github.com/pd/figgy"
   s.summary     = %q{Configuration file reading}
   s.description = %q{Access YAML, JSON (and ...) configuration files with ease}
+  s.license     = 'MIT'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -18,7 +19,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency "json"
   s.add_development_dependency "rake"
-  s.add_development_dependency "rspec"
+  s.add_development_dependency "rspec", '~> 2.14.0'
   s.add_development_dependency "simplecov"
   s.add_development_dependency "aruba"
   s.add_development_dependency "heredoc_unindent"

data/lib/figgy/finder.rb

@@ -17,7 +17,12 @@ class Figgy
     # @return Whatever was in the config file loaded
     # @raise [Figgy::FileNotFound] if no config file could be found for +name+
     def load(name)
-      result = files_for(name).reduce(nil) do |result, file|
+      files = files_for(name)
+      if files.empty?
+        raise(Figgy::FileNotFound, "Can't find config files for key: #{name.inspect}")
+      end
+
+      result = files.reduce(nil) do |result, file|
         object = @config.handler_for(file).call(File.read(file))
         if result && result.respond_to?(:merge)
           deep_merge(result, object)
@@ -26,7 +31,6 @@ class Figgy
         end
       end
 
-      raise(Figgy::FileNotFound, "Can't find config files for key: #{name.inspect}") unless result
       deep_freeze(to_figgy_hash(result))
     end
 

data/lib/figgy/version.rb

@@ -1,3 +1,3 @@
 class Figgy
-  VERSION = "0.9.1"
+  VERSION = "1.0.0"
 end

data/lib/figgy.rb

@@ -42,6 +42,10 @@ class Figgy
     end
   end
 
+  def [](key)
+    @store.get(key)
+  end
+
   def method_missing(m, *args, &block)
     @store.get(m)
   end

data/spec/figgy_spec.rb

@@ -112,6 +112,62 @@ describe Figgy do
       config.values.number = 4
       config.values.number.should == 4
     end
+
+    it "supports indifferent hash notation on the top-level config object" do
+      write_config 'values', "number: 1"
+      config = test_config
+      config['values'].should == config.values
+      config[:values].should  == config.values
+    end
+
+    context "performing basic hash operations" do
+      let(:config) do
+        write_config 'values', <<-YML
+        with:
+          one: 1
+          two: 2
+        without:
+          two: 2
+        another:
+          three: 3
+        altogether:
+          one: 1
+          two: 2
+          three: 3
+        YML
+        test_config
+      end
+
+      it "can delete a key" do
+        config.values.with.delete(:one).should == 1
+        config.values.with.should == config.values.without
+      end
+
+      it "can look up values for a list of keys" do
+        config.values.with.values_at(:one,:two).should == [1,2]
+      end
+
+      it "can merge with another hash" do
+        config.values.with.merge(config.values.another).should == config.values.altogether
+      end
+    end
+  end
+
+  context 'oddities' do
+    it "returns false for empty files (cf. YAML.load(''))" do
+      write_config 'empty', ''
+      test_config.empty.should == false
+    end
+
+    it "returns false for files containing a literal false" do
+      write_config 'maybe', 'false'
+      test_config.maybe.should == false
+    end
+
+    it "returns nil when explicitly set to that value in the YAML file" do
+      write_config 'reason_to_do_this', nil.to_yaml
+      test_config.reason_to_do_this.should == nil
+    end
   end
 
   context "multiple roots" do
@@ -343,12 +399,12 @@ describe Figgy do
 
   context "freezing" do
     it "leaves results unfrozen by default" do
-      write_config 'values', 'foo: 1'
+      write_config 'values', "foo: '1'"
       test_config.values.foo.should_not be_frozen
     end
 
     it "freezes the results when config.freeze = true" do
-      write_config 'values', 'foo: 1'
+      write_config 'values', "foo: '1'"
       config = test_config do |config|
         config.freeze = true
       end
@@ -382,11 +438,3 @@ describe Figgy do
     end
   end
 end
-
-describe Figgy do
-  describe 'CnuConfig drop-in compatibility' do
-    it "should maybe support path_formatter = some_proc.call(config_name, overlays)"
-    it "should support preload's all_key_names when using path_formatter"
-    it "should support preload's all_key_names when using path_formatter"
-  end
-end

metadata

@@ -1,82 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: figgy
 version: !ruby/object:Gem::Version
-  version: 0.9.1
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Kyle Hargraves
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-21 00:00:00.000000000 Z
+date: 2014-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70290730298440 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70290730298440
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70290730294020 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70290730294020
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &70290726201420 !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
   type: :development
   prerelease: false
-  version_requirements: *70290726201420
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70290726201000 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70290726201000
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: aruba
-  requirement: &70290726200580 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70290726200580
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: heredoc_unindent
-  requirement: &70290726200160 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70290726200160
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Access YAML, JSON (and ...) configuration files with ease
 email:
 - pd@krh.me
@@ -85,9 +102,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .rvmrc
 - .travis.yml
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - figgy.gemspec
@@ -100,29 +117,30 @@ files:
 - spec/figgy_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/pd/figgy
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Configuration file reading
 test_files:
 - spec/figgy_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/.rvmrc

@@ -1 +0,0 @@
-rvm use ruby-1.9.3-p0@figgy --create