ambience 1.0.0 → 2.0.0

data/.travis.yml

@@ -1,8 +1,9 @@
-script: "rake"
 rvm:
   - 1.8.7
   - 1.9.2
+  - ruby-head
   - ree
   - rbx
+  - rbx-2.0
   - jruby
 

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+== 2.0.0 (2011-11-04)
+
+  * Replaced the automatic loading of a user-local ambience.yml with an option to
+    load an app-specific config by providing a path to the additonal config via
+    an AMBIENCE_CONFIG environment variable.
+
 == 1.0.0 (2011-06-15)
 
   * Cleaned up the project's setup.

data/README.md

@@ -1,8 +1,8 @@
 Ambience [![Build Status](http://travis-ci.org/rubiii/ambience.png)](http://travis-ci.org/rubiii/ambience)
 ========
 
-App configuration feat. YAML and JVM properties. Lets you specify a default configuration in a YAML file
-and overwrite details via local settings and JVM properties for production.
+App configuration feat. YAML and JVM properties. Lets you specify a default configuration in a YAML  
+file and overwrite details via local settings and JVM properties for production.
 
 
 Installation
@@ -18,7 +18,7 @@ $ gem install ambience
 Getting started
 ---------------
 
-Given you created a YAML config like this:
+Ambience expects your configuration to live inside a YAML file:
 
 ``` yml
 auth:
@@ -27,20 +27,21 @@ auth:
   password: test
 ```
 
-You can instantiate an Ambience config by passing in the path to your config file:
+You can create a new Ambience config by passing in the path to your config file:
 
 ``` ruby
 AppConfig = Ambience.create Rails.root.join("config", "ambience.yml")
 ```
 
-Ambience will load and convert your config into a Hash:
+Ambience loads your config and converts it into a Hash:
 
 ``` ruby
 { "auth" => { "address" => "http://example.com", "username" => "ferris", "password" => "test" } }
 ```
 
-Afterwards it tries to merge these settings with local ones specified in an Ambience.local_config file.
-Finally it looks for any JVM properties (if your running JRuby) and merge these properties with your config:
+Afterwards it tries to merge these settings with app-specific setting stored in a file which path is
+provided through the AMBIENCE_CONFIG environment variable. Also, if you're using JRuby, Ambience will
+merge all JVM properties with the config Hash:
 
 ``` ruby
 auth.address = "http://live.example.com"
@@ -53,7 +54,7 @@ The result would be something like this:
 { "auth" => { "address" => "http://live.example.com", "username" => "ferris", "password" => "topsecret" } }
 ```
 
-In the end you can decide whether you want to return the config as a Hash:
+You can get the final config as a Hash:
 
 ``` ruby
 AppConfig = Ambience.create(Rails.root.join("config", "ambience.yml")).to_hash
@@ -69,6 +70,6 @@ AppConfig = Ambience.create(Rails.root.join("config", "ambience.yml")).to_mash
 Railtie
 -------
 
-Ambience comes with a Railtie which looks for `config/ambience.yml` inside your Rails project.
-If the file exists, Ambience loads the config and stores it in an `AppConfig` constant.
+Ambience comes with a Railtie which looks for `config/ambience.yml` inside your Rails project.  
+If the file exists, Ambience loads the config and stores it in an `AppConfig` constant.  
 All this happens before Rails evaluates your environment config.

data/ambience.gemspec

@@ -14,8 +14,9 @@ Gem::Specification.new do |s|
 
   s.add_dependency "hashie", ">= 0.2.0"
 
-  s.add_development_dependency "rspec", "~> 2.6.0"
-  s.add_development_dependency "mocha", "~> 0.9.12"
+  s.add_development_dependency "rake",     "0.8.7"
+  s.add_development_dependency "rspec",    "~> 2.6.0"
+  s.add_development_dependency "mocha",    "~> 0.9.12"
   s.add_development_dependency "autotest"
 
   s.files         = `git ls-files`.split("\n")

data/lib/ambience/config.rb

@@ -17,26 +17,28 @@ module Ambience
   # in a YAML file and overwrite details via local settings and JVM properties for production.
   class Config
 
-    # Sets the path to a local ambience config file.
-    def self.local_config=(local_config)
-      @@local_config = local_config
-    end
+    class << self
+
+      def env_config
+        @env_config ||= "AMBIENCE_CONFIG"
+      end
+
+      attr_writer :env_config
 
-    # Returns the path to a local ambience config file for specifying user-specific
-    # settings that don't belong into the application config file.
-    def self.local_config
-      @@local_config ||= File.join ENV["HOME"].to_s, ".ambience", "ambience.yml"
     end
 
-    def initialize(config_file, env = nil)
-      @config_file, @env = config_file, env
+    def initialize(base_config, env = nil)
+      self.base_config = base_config
+      self.env = env
     end
 
+    attr_accessor :base_config, :env
+
     # Returns the Ambience config as a Hash.
     def to_hash
-      config = load_config @config_file
-      config = config.deep_merge local_config
-      config.deep_merge jvm_config
+      config = load_base_config
+      config = config.deep_merge(load_env_config)
+      config.deep_merge(load_jvm_config)
     end
 
     # Returns the Ambience config as a Hashie::Mash.
@@ -46,28 +48,30 @@ module Ambience
 
   private
 
+    def load_base_config
+      load_config base_config
+    end
+
+    def load_env_config
+      config = ENV[self.class.env_config]
+      config ? load_config(config) : {}
+    end
+
     def load_config(config_file)
-      raise ArgumentError, "Missing config: #{config_file}" unless File.exist? config_file
+      raise ArgumentError, "Missing config file: #{config_file}" unless File.exist?(config_file)
 
       config = File.read config_file
       config = YAML.load ERB.new(config).result || {}
-      config = config[@env.to_s] || config[@env.to_sym] if @env
+      config = config[env.to_s] || config[env.to_sym] if env
       config
     end
 
-    # Returns a Hash containing any local settings from the +@@local_config+.
-    def local_config
-      File.exist?(self.class.local_config) ? load_config(self.class.local_config) : {}
-    end
-
-    ## Returns a Hash containing any JVM properties.
-    def jvm_config
+    def load_jvm_config
       jvm_properties.inject({}) do |hash, (key, value)|
         hash.deep_merge hash_from_property(key, value)
       end
     end
 
-    # Returns the JVM properties.
     def jvm_properties
       Ambience.jruby? ? java.lang.System.get_properties : {}
     end

data/lib/ambience/version.rb

@@ -1,5 +1,5 @@
 module Ambience
 
-  VERSION = "1.0.0"
+  VERSION = "2.0.0"
 
 end

data/spec/ambience/ambience_spec.rb

@@ -36,11 +36,12 @@ describe Ambience do
   end
 
   it "raises an ArgumentError when the given config file could not be found" do
-    lambda { Ambience.create("missing_config.yml").to_hash }.should raise_error(ArgumentError)
+    expect { Ambience.create("missing_config.yml").to_hash }.to raise_error(ArgumentError)
   end
 
   context "when using JRuby" do
     before do
+      Ambience.stubs(:jruby?).returns(true)
       Ambience::Config.send(:define_method, :java) { JavaMock }
     end
 
@@ -49,11 +50,6 @@ describe Ambience do
     end
 
     it "merges the config with any JVM properties" do
-      Ambience.stubs(:jruby?).returns(true)
-      Ambience::Config.any_instance.stubs(:jvm_properties).returns(
-        "auth.address" => "http://live.example.com",
-        "auth.password" => "topsecret"
-      )
       config = Ambience.create(config_file(:basic)).to_mash
 
       config.should be_a(Hashie::Mash)
@@ -63,6 +59,15 @@ describe Ambience do
     end
   end
 
+  context "with an env config file" do
+    it "merges the config with the env config" do
+      ENV["AMBIENCE_CONFIG"] = config_file(:env_config)
+      config = Ambience.create(config_file(:basic)).to_mash
+
+      config.auth.address.should == "http://live.example.com"
+    end
+  end
+
   def config_file(name)
     File.expand_path("../../fixtures/#{name}.yml", __FILE__)
   end

data/spec/fixtures/basic.yml

@@ -1,5 +1,5 @@
 auth:
-  address: http://example.com
-  username: ferris
-  password: test
+  address: "http://example.com"
+  username: "ferris"
+  password: "test"
 

data/spec/fixtures/env_config.yml

@@ -0,0 +1,4 @@
+auth:
+  address: "http://live.example.com"
+  username: "ferris"
+  password: "test"

data/spec/fixtures/environments.yml

@@ -1,14 +1,13 @@
 development: &development
   auth:
     username: "ferris"
-    password: test
+    password: "test"
 
 test:
   <<: *development
 
 production:
-  <<: *development
   auth:
     username: "ferris"
-    password: topsecret
+    password: "topsecret"
 

data/spec/fixtures/symbols.yml

@@ -1,7 +1,7 @@
 :development: &development
   :auth:
     :username: "ferris"
-    :password: test
+    :password: "test"
 
 :test:
   <<: *development

data/spec/spec_helper.rb

@@ -1,4 +1,8 @@
 require "bundler"
 Bundler.require :default, :development
 
+RSpec.configure do |config|
+  config.mock_with :mocha
+end
+
 require "support/java_mock"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ambience
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 15
   prerelease: 
   segments: 
-  - 1
+  - 2
   - 0
   - 0
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors: 
 - Daniel Harrington
@@ -15,13 +15,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-15 00:00:00 +02:00
-default_executable: 
+date: 2011-11-04 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: hashie
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -32,12 +29,28 @@ dependencies:
         - 2
         - 0
         version: 0.2.0
+  name: hashie
   type: :runtime
-  version_requirements: *id001
+  prerelease: false
+  requirement: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  name: rake
+  type: :development
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -48,12 +61,12 @@ dependencies:
         - 6
         - 0
         version: 2.6.0
+  name: rspec
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: mocha
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -64,12 +77,12 @@ dependencies:
         - 9
         - 12
         version: 0.9.12
+  name: mocha
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: autotest
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -78,8 +91,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  name: autotest
   type: :development
-  version_requirements: *id004
+  prerelease: false
+  requirement: *id005
 description: App configuration feat. YAML and JVM properties
 email: me@rubiii.com
 executables: []
@@ -105,11 +120,11 @@ files:
 - lib/ambience/version.rb
 - spec/ambience/ambience_spec.rb
 - spec/fixtures/basic.yml
+- spec/fixtures/env_config.yml
 - spec/fixtures/environments.yml
 - spec/fixtures/symbols.yml
 - spec/spec_helper.rb
 - spec/support/java_mock.rb
-has_rdoc: true
 homepage: http://github.com/rubiii/ambience
 licenses: []
 
@@ -139,13 +154,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: ambience
-rubygems_version: 1.4.1
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: App configuration feat. YAML and JVM properties
 test_files: 
 - spec/ambience/ambience_spec.rb
 - spec/fixtures/basic.yml
+- spec/fixtures/env_config.yml
 - spec/fixtures/environments.yml
 - spec/fixtures/symbols.yml
 - spec/spec_helper.rb