figly 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca71726e5c151db9b95fbaac7d18642457640496
-  data.tar.gz: 8d4950a3615f85f555e7191def270af19dd03b58
+  metadata.gz: 92096fbb361ef15bd69d38780f8a5d1c4b2d1093
+  data.tar.gz: 54be27cfa55e83e7b4a12eea18f6e0f38d53e13e
 SHA512:
-  metadata.gz: bd31fed56870c2e2ee55291f99841ad8503847471d6c8488f5302dd46b827f2fc8cf3a9dac627b56647ba991f5b7943444f089d4626ce7c953d569f144aa73d3
-  data.tar.gz: 4d3e715cfc2c92d05b99fe92540222a010bc056838c74ee8a30ce49a66bff32d3f60699eacc0f242a50b7d54f4b7dcb7b16e8b562e261e37eaeea1b426af267d
+  metadata.gz: 9ecce235ec39a27f398de581105cfaa69f4beafc83838a73c4a61ee7e815b5b960786c93126c7ac46b6244d6cc34745925a9d48b2cfd224079f72ec4ee6ef285
+  data.tar.gz: 32b0cdc33f3691a5f006fdc9f13ca09fd4b3bdb5ec9de9aa2a99e9ed77f605e800e4a1893b7fda8764386f19ad560510cfffef3f638d297fa86b37141798fd75

data/README.md

@@ -18,9 +18,11 @@ Or install it yourself as:
 
 ## Usage
 
-The only setup that's required is to set the path of you're configuration file that must be in YAML. Just throw the following code into an initializer:
+The only setup that's required is to set the path of you're configuration file that must be in YAML. Just throw the following code into an initializer.:
 
-    Figly.setup "path/to/config.yml"
+    Figly.load_file "path/to/config.yml"
+
+**NOTE: You can load multiple config files of different types and they will be deep merged together in your settings**
 
 If you're config looks like this:
 
@@ -33,27 +35,33 @@ You can do the following:
 
     Figly::Settings.some_key
     #=> 234
-    
+
     Figly::Settings.nest1
     #=> {"nest2" => {"nest3" => "Yay"}}
-    
+
     Figly::Settings.nest1.nest2.nest3
     #=> "Yay"
 
+Figly currently supports the following file extensions, and will infer the parser based on the extension:
+
+- .yml => YAML
+- .toml => TOML
+- .json => JSON
+
 ## Testing    
 
-If you want to contribute start by making sure the tests work. Also if you want to isolate the bundled gems to the sandbox (the path below is already in the .gitignore), run:
+If you want to contribute start by making sure the tests work:
 
-    bundle install --path vendor/bundle
+    bundle install
 
-To access a REPL environment that loads the libraries as well as does the initial setup with the `spec/support/config.yml` set as the path:
+To access a REPL environment that loads the libraries:
 
     ./bin/console
-    
+
 To run tests:
 
     rspec spec
-    
+
 ## Contributing
 
 1. Fork it ( https://github.com/onetwopunch/figly/fork )

data/lib/figly.rb

@@ -3,10 +3,11 @@ require "figly/settings"
 
 module Figly
   class ParserError < StandardError; end
-  class UnsupportedError < StandardError; end
+  class UnsupportedFormatError < StandardError; end
+  class ConfigNotFoundError < StandardError; end
 
   def self.load_file(path)
-    raise "File does not exist: #{path}" unless File.exists?(path)
+    raise ConfigNotFoundError, "File does not exist: #{path}" unless File.exists?(path)
     ext = File.extname(path)
     data = case ext
     when '.toml'
@@ -17,13 +18,15 @@ module Figly
         # that the value doesn't match an error
         old_stdout = $stdout
         $stdout = StringIO.new('','w')
-        d = TOML.load_file(path)
-        cap = $stdout.string
-        raise ParserError, cap if cap =~ /^Failed to match/
-        $stdout = old_stdout
-        d
+        TOML.load_file(path).tap do |d|
+          cap = $stdout.string
+          raise ParserError, cap if cap =~ /^Failed to match/
+        end
       rescue Exception => e
         raise ParserError, e.message
+      ensure
+        # Make sure to reset the old stdout even if an exception is thrown
+        $stdout = old_stdout
       end
     when '.yml'
       begin
@@ -40,7 +43,7 @@ module Figly
         raise ParserError, e.message
       end
     else
-      raise UnsupportedError, "Unsupported file extension (#{ext})"
+      raise UnsupportedFormatError, "Unsupported file extension (#{ext})"
     end
 
     # Here we merge config files if there are multiple load calls

data/lib/figly/version.rb

@@ -1,3 +1,3 @@
 module Figly
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

data/spec/figly_spec.rb

@@ -57,4 +57,29 @@ describe Figly do
       expect(Figly::Settings.a.b.c).to eq({"d"=>"test"})
     end
   end
+
+  context 'errors' do
+    context 'ParserError' do
+      it 'should error on bad.yml' do
+        expect{Figly.load_file('spec/support/bad.yml')}.to raise_error(Figly::ParserError)
+      end
+      it 'should error on bad.json' do
+        expect{Figly.load_file('spec/support/bad.json')}.to raise_error(Figly::ParserError)
+      end
+      it 'should error on bad.toml' do
+        expect{Figly.load_file('spec/support/bad.toml')}.to raise_error(Figly::ParserError)
+      end
+      it 'should reset $stdout to the default even on an error' do
+        expect{ Figly.load_file('spec/support/bad.toml') rescue nil }.not_to change { $stdout }
+      end
+    end
+
+    it 'should raise an error if the config file is not found' do
+      expect{ Figly.load_file('spec/support/nonexistent.json') }.to raise_error(Figly::ConfigNotFoundError)
+    end
+
+    it 'should raise an error on an unsupported config file format' do
+      expect{ Figly.load_file("spec/support/config.ini") }.to raise_error(Figly::UnsupportedFormatError)
+    end
+  end
 end

data/spec/support/bad.json

@@ -0,0 +1,3 @@
+{
+  "hello": 'world'
+}

data/spec/support/bad.toml

@@ -0,0 +1,2 @@
+[section]
+key = 'value'

data/spec/support/bad.yml

@@ -0,0 +1,2 @@
+x
+language:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: figly
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Ryan Canty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-25 00:00:00.000000000 Z
+date: 2016-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: toml
@@ -102,6 +102,10 @@ files:
 - lib/figly/version.rb
 - spec/figly_spec.rb
 - spec/spec_helper.rb
+- spec/support/bad.json
+- spec/support/bad.toml
+- spec/support/bad.yml
+- spec/support/config.ini
 - spec/support/config.json
 - spec/support/config.toml
 - spec/support/config.yml
@@ -134,6 +138,10 @@ summary: A tiny gem that allows you to access config settings from YAML, TOML, o
 test_files:
 - spec/figly_spec.rb
 - spec/spec_helper.rb
+- spec/support/bad.json
+- spec/support/bad.toml
+- spec/support/bad.yml
+- spec/support/config.ini
 - spec/support/config.json
 - spec/support/config.toml
 - spec/support/config.yml