yaml2env 0.1.1 → 0.1.2

data/.travis.yml

@@ -1,7 +1,10 @@
 rvm:
   - 1.8.7
   - 1.9.2
+  - ree
+  - ruby-head
   - rbx
+  - rbx-2.0
   - jruby
-  - ree
-  - ruby-head
+notifications:
+  disabled: true

data/Gemfile

@@ -2,3 +2,10 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in yaml2env.gemspec
 gemspec
+
+group :test do
+  group :darwin do
+    gem 'rb-fsevent'
+  end
+end
+

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jonas Grimfelt, Merchii. http://merchii.com
+
+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.textile

@@ -25,7 +25,10 @@ h2. Usage
 To give this some context; this is how we use @Yaml2Env@ to initialize "Hoptoad":http://hoptoadapp.com:
 
 <pre>
-  Yaml2Env.load 'config/hoptoad.yml', {'HOPTOAD_API_KEY' => 'api_key'}
+  Yaml2Env.load! 'config/hoptoad.yml', {'HOPTOAD_API_KEY' => 'api_key'}
+
+  # ...or if a warning note in the logs is enough:
+  #   Yaml2Env.load 'config/hoptoad.yml', {'HOPTOAD_API_KEY' => 'api_key'}
 
   if defined?(HoptoadNotifier)
     HoptoadNotifier.configure do |config|
@@ -53,22 +56,37 @@ To give this some context; this is how we use @Yaml2Env@ to initialize "Hoptoad"
 ...which will yield:
 
 <pre>
-  Rails.env = 'development'
+  # Rails.env => 'development'
   ENV['HOPTOAD_API_KEY'] => 'NONE'
 
-  Rails.env = 'staging'
+  # Rails.env => 'staging'
   ENV['HOPTOAD_API_KEY'] => '123abc'
 
-  Rails.env = 'production'
+  # Rails.env => 'production'
   ENV['HOPTOAD_API_KEY'] => 'abc123'
 
-  Rails.env = 'test'
+  # Rails.env => 'test'
   ENV['HOPTOAD_API_KEY'] => 'NONE'
 
-  Rails.env = 'other'
+  # Rails.env => 'other'
   => "Failed to load required config for environment 'other': /Users/grimen/development/example.com/config/hoptoad.yml"
 </pre>
 
+h2. Helpers
+
+A few convenient helpers:
+
+<pre>
+  Yaml2Env.loaded? 'HOPTOAD_API_KEY'
+  => true
+
+  Yaml2Env.loaded? 'BAZOOKA'
+  => false
+
+  Yaml2Env.loaded? 'HOPTOAD_API_KEY', 'BAZOOKA'
+  => false
+</pre>
+
 h2. Notes
 
 This gem was developed for our own requirements at *"Merchii":http://github.com/merchii*, so feel free to send pull-requests with enhancements of any kind (features, bug-fixes, documentation, tests, etc.) to make it better or useful for you as well.
@@ -76,5 +94,5 @@ This gem was developed for our own requirements at *"Merchii":http://github.com/
 h2. License
 
 Released under the MIT license.
-Copyright (c) "Merchii":http://github.com/merchii, "Jonas Grimfelt":http://github.com/grimen
+Copyright (c) "Jonas Grimfelt":http://github.com/grimen, "Merchii":http://github.com/merchii
 

data/lib/yaml2env/version.rb

@@ -1,3 +1,3 @@
 module Yaml2env
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/yaml2env.rb

@@ -55,7 +55,7 @@ module Yaml2env
       yield self
     end
 
-    def load(config_path, required_keys = {}, optional_keys = {})
+    def load!(config_path, required_keys = {}, optional_keys = {})
       self.detect_root!
       self.detect_env!
 
@@ -84,6 +84,21 @@ module Yaml2env
       end
     end
 
+    def load(config_path, required_keys = {}, optional_keys = {})
+      begin
+        self.load!(config_path, required_keys, optional_keys)
+      rescue Error => e
+        if self.logger?
+          ::Yaml2env.logger.warn("[Yaml2env]: #{e} -- called from: #{__FILE__})")
+        end
+      end
+      true
+    end
+
+    def loaded?(*constant_names)
+      constant_names.all? { |cn| ::Yaml2env::LOADED_ENV.key?(cn.to_s) }
+    end
+
     def detect_root!
       self.root ||= if ::ENV.key?('RACK_ROOT')
         ::ENV['RACK_ROOT']
@@ -92,7 +107,7 @@ module Yaml2env
       elsif defined?(::Sinatra::Application)
         ::Sinatra::Application.root
       else
-        raise DetectionFailedError, "Failed to auto-detect Yaml.env (config environment). Specify environment before loading any configs/initializers using Yaml2env, e.g Yaml2env.env = 'development'."
+        raise DetectionFailedError, "Failed to auto-detect Yaml.root (config root). Specify root before loading any configs/initializers using Yaml2env, e.g. Yaml2env.root = '~/projects/my_app'."
       end
     end
 
@@ -104,7 +119,7 @@ module Yaml2env
       elsif defined?(::Sinatra::Application)
         ::Sinatra::Application.environment
       else
-        raise DetectionFailedError, "Failed to auto-detect Yaml2env.root (config root). Specify environment before loading any configs/initializers using Yaml2env, e.g Yaml2env.env = 'development'."
+        raise DetectionFailedError, "Failed to auto-detect Yaml2env.root (config root). Specify environment before loading any configs/initializers using Yaml2env, e.g. Yaml2env.env = 'development'."
       end
     end
 

data/spec/yaml2env_spec.rb

@@ -260,7 +260,7 @@ describe Yaml2env do
     end
   end
 
-  describe ".load" do
+  describe ".load!" do
     before do
       Yaml2env.env = 'production'
       Yaml2env.root = File.dirname(__FILE__)
@@ -268,26 +268,60 @@ describe Yaml2env do
     end
 
     it 'should be defined' do
-      Yaml2env.must_respond_to :load
+      Yaml2env.must_respond_to :load!
     end
 
     it 'should throw error if specified config file that do not exist' do
       assert_raises Yaml2env::ConfigLoadingError do
-        Yaml2env.load 'null.yml'
+        Yaml2env.load! 'null.yml'
       end
     end
 
     it 'should not throw error if specified config file do exist' do
-      assert Yaml2env.load('fixtures/example.yml')
+      assert Yaml2env.load!('fixtures/example.yml')
     end
 
     it 'should throw error if a specified constant-key do not exist in the config file' do
       assert_raises Yaml2env::MissingConfigKeyError do
-        Yaml2env.load 'fixtures/example.yml', {:API_KEY => 'bla'}
+        Yaml2env.load! 'fixtures/example.yml', {:API_KEY => 'bla'}
       end
     end
 
     it 'should not throw error if a specified constant-key do in fact exist in the config file' do
+      assert Yaml2env.load! 'fixtures/example.yml', {:API_KEY => 'api_key', :API_SECRET => 'api_secret'}
+    end
+
+    it 'should set - with Yaml2env - loaded ENV-values' do
+      Yaml2env::LOADED_ENV.clear unless Yaml2env::LOADED_ENV.empty?
+      Yaml2env.load! 'fixtures/example.yml', {:API_KEY => 'api_key', :API_SECRET => 'api_secret'}
+      Yaml2env::LOADED_ENV.must_equal({"API_SECRET" => "PRODUCTION_SECRET", "API_KEY" => "PRODUCTION_KEY"})
+    end
+  end
+
+  describe ".load" do
+    before do
+      Yaml2env.env = 'production'
+      Yaml2env.root = File.dirname(__FILE__)
+      Yaml2env.logger = nil
+    end
+
+    it 'should be defined' do
+      Yaml2env.must_respond_to :load
+    end
+
+    it 'should at maximum log warning if specified config file that do not exist' do
+      assert Yaml2env.load('null.yml')
+    end
+
+    it 'should not log warning or raise error if specified config file do exist' do
+      assert Yaml2env.load('fixtures/example.yml')
+    end
+
+    it 'should at maximum log warning if a specified constant-key do not exist in the config file' do
+      assert Yaml2env.load 'fixtures/example.yml', {:API_KEY => 'bla'}
+    end
+
+    it 'should not log warning or raise error if a specified constant-key do in fact exist in the config file' do
       assert Yaml2env.load 'fixtures/example.yml', {:API_KEY => 'api_key', :API_SECRET => 'api_secret'}
     end
 
@@ -298,6 +332,43 @@ describe Yaml2env do
     end
   end
 
+  describe ".loaded?" do
+    before do
+      Yaml2env::LOADED_ENV.clear unless Yaml2env::LOADED_ENV.empty?
+    end
+
+    it 'should be defined' do
+      Yaml2env.must_respond_to :loaded?
+    end
+
+    describe "one argument" do
+      it 'should return false if specified constant is not loaded into ENV' do
+        Yaml2env.loaded?('API_KEY').must_equal false
+      end
+
+      it 'should return true if specified constant is loaded into ENV' do
+        Yaml2env.load 'fixtures/example.yml', {:API_KEY => 'api_key', :API_SECRET => 'api_secret'}
+        Yaml2env.loaded?('API_KEY').must_equal true
+      end
+    end
+
+    describe "multiple arguments" do
+      it 'should return false if none of the specified constants are not loaded into ENV' do
+        Yaml2env.loaded?('API_KEY', 'API_SECRET').must_equal false
+      end
+
+      it 'should return false if any of the specified constants are not loaded into ENV' do
+        Yaml2env.load 'fixtures/example.yml', {:API_KEY => 'api_key'}
+        Yaml2env.loaded?('API_KEY', 'API_SECRET').must_equal false
+      end
+
+      it 'should return true if all specified constants are loaded into ENV' do
+        Yaml2env.load 'fixtures/example.yml', {:API_KEY => 'api_key', :API_SECRET => 'api_secret'}
+        Yaml2env.loaded?('API_KEY', 'API_SECRET').must_equal true
+      end
+    end
+  end
+
   protected
 
     def rack!(loaded)

metadata

@@ -2,7 +2,7 @@
 name: yaml2env
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Merchii
@@ -11,12 +11,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-27 00:00:00 +02:00
-default_executable: 
+date: 2011-08-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
-  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -24,10 +22,10 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
   type: :development
+  prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: bundler
-  prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -35,10 +33,10 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.0.0
   type: :development
+  prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: minitest
-  prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -46,10 +44,10 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
   type: :development
+  prerelease: false
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: guard
-  prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -57,10 +55,10 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
   type: :development
+  prerelease: false
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: guard-bundler
-  prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -68,10 +66,10 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
   type: :development
+  prerelease: false
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: guard-minitest
-  prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -79,6 +77,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
   type: :development
+  prerelease: false
   version_requirements: *id006
 description: Stash environment-specific configs in YAML-files and load them into ENV according to best-practices pattern - and auto-detects on-initialization if something is missing (skipping the "scratching the head"-part).
 email: 
@@ -95,6 +94,7 @@ files:
 - .travis.yml
 - Gemfile
 - Guardfile
+- MIT-LICENSE
 - README.textile
 - Rakefile
 - lib/yaml2env.rb
@@ -103,7 +103,6 @@ files:
 - spec/spec_helper.rb
 - spec/yaml2env_spec.rb
 - yaml2env.gemspec
-has_rdoc: true
 homepage: http://github.com/merchii/yaml2env
 licenses: []
 
@@ -117,6 +116,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: -148891887331939387
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
@@ -127,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: yaml2env
-rubygems_version: 1.6.2
+rubygems_version: 1.8.7
 signing_key: 
 specification_version: 3
 summary: YAML => ENV for environment-specific configs