ambience 0.1.0 → 0.2.0

data/CHANGELOG

@@ -0,0 +1,8 @@
+== 0.2.0 (2010-03-06)
+  * Complete rewrite. Removed Rails-specific defaults and returning the Ambience config
+    as a Hashie::Mash (http://github.com/intridea/hashie). Take a look at the new Readme
+    and Specs for examples.
+
+== 0.1.0 (2009-12-12)
+  * Initial release.
+

data/README.rdoc

@@ -1,78 +1,45 @@
 = Ambience
 
-Ruby on Rails configuration with JVM Parameter spicing.
+App configuration feat. YAML and JVM properties. Lets you specify a default configuration in a YAML file and overwrite details via JVM properties for production.
 
-Loads the content from a default configuration file. Merges these defaults
-with the available JVM properties when running the application on JRuby.
-
-== Install
-
-As a gem:
+== Installation
 
   $ gem install ambience
 
-As a Rails plugin:
-
-  $ script/plugin install git://github.com/rubiii/ambience.git
-
-== Default configuration
-
-Default configuration at config/ambience.yml
-
-  defaults: &defaults
-    auth:
-      user: "client"
-      password: "secret"
-      service: "http://test.example.com"
-
-  development:
-    <<: *defaults
+== How it works
 
-  test:
-    <<: *defaults
+Given you created a YAML config like this one:
 
-  production:
-    <<: *defaults
+  auth:
+    address: http://example.com
+    username: ferris
+    password: test
 
-== Loading the configuration
+You create an Ambience config by passing in the path to your config file:
 
-Place this at the bottom of your config/environment.rb file:
+  AppConfig = Ambience.new File.join(Rails.root, "config", "ambience.yml")
 
-  AppConfig = Ambience.new
+Ambience will load and convert your config into a Hash:
 
-== Running your application on MRI
+  { "auth" => { "address" => "http://example.com", "username" => "ferris", "password" => "test" } }
 
-The configuration Hash equals the default configuration file:
+Then it looks for any JVM properties (if your running JRuby)
 
-  "auth" => {
-    "user" => "client",
-    "password => "secret",
-    "service" => "http://test.example.com"
-  }
+  auth.address = "http://live.example.com"
+  auth.password = "topsecret"
 
-== Running the application on JRuby
+and deep merge them with your Hash:
 
-Expecting these default JVM properties:
+  { "auth" => { "address" => "http://live.example.com", "username" => "ferris", "password" => "topsecret" } }
 
-  jruby.home = "/usr/local/lib/jruby"
-  java.runtime.name = "Java(TM) SE Runtime Environment"
-  java.runtime.version = "1.6.0_14-b08"
+Finally, it returns the Hash as a {Hashie::Mash}[http://github.com/intridea/hashie] so you can access values by specifying keys as Symbols or Strings or using method-like accessors:
 
-And the following custom property:
+  AppConfig[:auth][:address]
+  # => "http://live.example.com"
 
-  auth.service = "http://live.example.com"
+  AppConfig["auth"]["username"]
+  # => "http://live.example.com"
 
-The default configuration will be extended by JVM properties:
+  AppConfig.auth.password
+  # => "topsecret"
 
-  "auth" => {
-    "user" => "client",
-    "password => "secret",
-    "service" => "http://live.example.com"
-  },
-  "java" => {
-    "runtime" => {
-      "name" => "Java(TM) SE Runtime Environment",
-      "version" => "1.6.0_14-b08"
-    }
-  },
-  "jruby" => { "home" => "/usr/local/lib/jruby" }

data/Rakefile

@@ -1,42 +1,31 @@
-require "rubygems"
 require "rake"
-require "rake/testtask"
-require "rake/rdoctask"
+require "spec/rake/spectask"
+require "spec/rake/verify_rcov"
 
-task :default => :test
+task :default => :spec
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << "lib"
-  t.libs << "test"
-  t.pattern = "test/**/*_test.rb"
-  t.verbose = true
+Spec::Rake::SpecTask.new do |spec|
+  spec.spec_files = FileList["spec/**/*_spec.rb"]
+  spec.spec_opts << "--color"
+  spec.libs += ["lib", "spec"]
+  spec.rcov = true
 end
 
-Rake::RDocTask.new do |rdoc|
-  rdoc.title = "Ambience"
-  rdoc.rdoc_dir = "rdoc"
-  rdoc.rdoc_files.include("lib/**/*.rb")
-  rdoc.options = ["--line-numbers", "--inline-source"]
+RCov::VerifyTask.new(:spec_verify => :spec) do |verify|
+  verify.threshold = 100.0
+  verify.index_html = "rcov/index.html"
 end
 
 begin
-  require "jeweler"
-  Jeweler::Tasks.new do |spec|
-    spec.name = "ambience"
-    spec.author = "Daniel Harrington"
-    spec.email = "me@rubiii.com"
-    spec.homepage = "http://github.com/rubiii/ambience"
-    spec.summary = "JVM-Parameters for your JRuby app"
-    spec.description = spec.summary
+  require "hanna/rdoctask"
 
-    spec.files = FileList["[A-Z]*", "init.rb", "{lib,test}/**/*.{rb,yml}"]
-
-    spec.rdoc_options += [
-      "--title", "Ambience",
-      "--line-numbers",
-      "--inline-source"
-    ]
+  Rake::RDocTask.new do |rdoc|
+    rdoc.title = "Ambience - App configuration feat. YAML and JVM properties"
+    rdoc.rdoc_dir = "doc"
+    rdoc.rdoc_files.include("**/*.rdoc").include("lib/**/*.rb")
+    rdoc.options << "--line-numbers"
+    rdoc.options << "--webcvs=http://github.com/rubiii/ambience/tree/master/"
   end
 rescue LoadError
-  puts "Jeweler missing. Install with: gem install jeweler"
-end
+  puts "'gem install hanna' for documentation"
+end

data/lib/ambience.rb

@@ -1,88 +1,7 @@
-require "rubygems"
 require "yaml" unless defined? YAML
 require "erb" unless defined? ERB
 
-class Ambience
-  class << self
+require "hashie"
 
-    # Returns a new config Hash for a given Rails +environment+ from a given
-    # +config_file+. Adds the current JVM properties to the config Hash in case
-    # the application is running on JRuby.
-    def new(environment = RAILS_ENV, config_file = nil)
-      hash = setup_config environment, load_config_file(config_file)
-      hash = setup_jvm hash
-    end
-
-    # Returns if the application's running on JRuby.
-    def jruby?
-      RUBY_PLATFORM =~ /java/
-    end
-
-  private
-
-    # Loads the given +config_file+. Tries to load "ambience.yml" from the
-    # application's config folder in case no +config_file+ was given. Returns
-    # the content from the config file or nil in case no config file was found.
-    def load_config_file(config_file)
-      config_file ||= File.join(RAILS_ROOT, "config", "ambience.yml")
-      config = File.expand_path(config_file)
-      file = File.read(config) if File.exist? config
-      file ||= nil
-    end
-
-    # Returns the ERB-interpreted content at the given +env+ from a given Yaml
-    # +config+ String and returns a Hash containing the evaluated content.
-    # Defaults to returning an empty Hash in case +config+ is nil.
-    def setup_config(env, config)
-      hash = YAML.load(ERB.new(config).result)[env] unless config.nil?
-      hash ||= {}
-    end
-
-    # Expects the current config +hash+, iterates through the JVM properties,
-    # adds them to the given +hash+ and returns the merged result.
-    def setup_jvm(hash)
-      if jruby?
-        jvm_properties.each do |key, value|
-          param = hash_from_property key, value
-          hash = deep_merge(hash, param) unless hash.nil?
-        end
-      end
-      hash
-    end
-
-    # Merges a given +hash+ with a +target+ Hash and returns the merged result.
-    def deep_merge(hash, target)
-      target.keys.each do |key|
-        if target[key].is_a? Hash and hash[key].is_a? Hash
-          hash[key] = deep_merge(hash[key], target[key])
-          next
-        end
-        hash[key] = target[key]
-      end
-      hash
-    end
-
-    # Expects +key+ and +value+ from a JVM property and returns a Hash that
-    # complies to the YAML format.
-    def hash_from_property(key, value)
-      hash, split = {}, key.split(".")
-      (split.size-1).downto(0) do |i|
-        v = i == (split.size-1) ? value : hash
-        hash = { split[i] => v }
-      end
-      hash
-    end
-
-    # Returns the JVM properties.
-    def jvm_properties
-      JavaLang::System.get_properties
-    end
-
-  end
-end
-
-if Ambience.jruby?
-  module JavaLang
-    include_package "java.lang"
-  end
-end
+require "ambience/core_ext"
+require "ambience/ambience"

data/lib/ambience/ambience.rb

@@ -0,0 +1,104 @@
+# = Ambience
+#
+# App configuration feat. YAML and JVM properties. Lets you specify a default configuration
+# in a YAML file and overwrite details via JVM properties for production.
+#
+# == How it works
+#
+# Given you created a YAML config like this one:
+#
+#   auth:
+#     address: http://example.com
+#     username: ferris
+#     password: test
+#
+# You create an Ambience config by passing in the path to your config file:
+#
+#   AppConfig = Ambience.new File.join(Rails.root, "config", "ambience.yml")
+#
+# Ambience will load and convert your config into a Hash:
+#
+#   { "auth" => { "address" => "http://example.com", "username" => "ferris", "password" => "test" } }
+#
+# Then it looks for any JVM properties (if your running JRuby)
+#
+#   auth.address = "http://live.example.com"
+#   auth.password = "topsecret"
+#
+# and deep merge them with your Hash:
+#
+#   { "auth" => { "address" => "http://live.example.com", "username" => "ferris", "password" => "topsecret" } }
+#
+# Finally, it returns the Hash as a {Hashie::Mash}[http://github.com/intridea/hashie] so you can
+# access values by specifying keys as Symbols or Strings or using method-like accessors:
+#
+#   AppConfig[:auth][:address]
+#   # => "http://live.example.com"
+#
+#   AppConfig["auth"]["username"]
+#   # => "http://live.example.com"
+#
+#   AppConfig.auth.password
+#   # => "topsecret"
+class Ambience
+  class << self
+
+    # Returns a new Ambience config from a given YAML +config_file+ for an optional +env+.
+    # Overwrites properties with any JVM properties (in case the application is running on JRuby).
+    def new(config_file, env = nil)
+      config_hash = parse_config load_config(config_file)
+      config_hash = config_hash[env.to_s] || config_hash[env.to_sym] if env
+      config_hash.deep_merge! jvm_property_hash
+      Hashie::Mash.new config_hash
+    end
+
+    # Returns whether the current Ruby platfrom is JRuby.
+    def jruby?
+      RUBY_PLATFORM =~ /java/
+    end
+
+  private
+
+    # Loads a given +config_file+. Raises an ArgumentError in case the config could not be found.
+    def load_config(config_file)
+      raise ArgumentError, "Missing config: #{config_file}" unless File.exist? config_file
+      File.read config_file
+    end
+
+    # Returns the ERB-interpreted content from a given YAML +config+ String and returns a Hash
+    # containing the evaluated content. Defaults to returning an empty Hash.
+    def parse_config(config)
+      YAML.load ERB.new(config).result || {}
+    end
+
+    # Returns a Hash containing any JVM properties.
+    def jvm_property_hash
+      jvm_properties.inject({}) do |hash, (key, value)|
+        hash.deep_merge hash_from_property(key, value)
+      end
+    end
+
+    # Returns a Hash generated from a JVM +property+ and its +value+.
+    #
+    # ==== Example:
+    #
+    #   hash_from_property "webservice.auth.address", "http://auth.example.com"
+    #   # => { "webservice" => { "auth" => { "address" => "http://auth.example.com" } } }
+    def hash_from_property(property, value)
+      property.split(".").reverse.inject(value) { |value, item| { item => value } }
+    end
+
+    # Returns the JVM properties.
+    def jvm_properties
+      jruby? ? JavaLang::System.get_properties : {}
+    end
+
+  end
+
+  if jruby?
+    module JavaLang
+      include_package "java.lang"
+    end
+  end
+
+end

data/lib/ambience/core_ext.rb

@@ -0,0 +1,19 @@
+class Hash
+
+  # Returns a new Hash with self and +other_hash+ merged recursively.
+  # Implementation from ActiveSupport::CoreExtensions::Hash::DeepMerge.
+  def deep_merge(other_hash)
+    merge(other_hash) do |key, oldval, newval|
+      oldval = oldval.to_hash if oldval.respond_to? :to_hash
+      newval = newval.to_hash if newval.respond_to? :to_hash
+      oldval.class.to_s == "Hash" && newval.class.to_s == "Hash" ? oldval.deep_merge(newval) : newval
+    end
+  end
+
+  # Returns a new Hash with self and +other_hash+ merged recursively. Modifies the receiver in place.
+  # Implementation from ActiveSupport::CoreExtensions::Hash::DeepMerge.
+  def deep_merge!(other_hash)
+    replace deep_merge(other_hash)
+  end
+
+end

data/spec/ambience/ambience_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+describe Ambience do
+  include SpecHelper
+
+  it "should return the content of a given config file as a Hashie::Mash" do
+    config = Ambience.new config_file(:basic)
+
+    config.should be_a(Hashie::Mash)
+    config.auth.username.should == "ferris"
+    config[:auth][:address].should == "http://example.com"
+    config["auth"]["password"].should == "test"
+  end
+
+  it "should return the config for an optional environment as a Hashie::Mash" do
+    config = Ambience.new config_file(:environments), :production
+
+    config.should be_a(Hashie::Mash)
+    config.auth.username.should == "ferris"
+    config[:auth]["password"].should == "topsecret"
+  end
+
+  it "should return the config specified as Symbols as a Hashie::Mash" do
+    config = Ambience.new config_file(:symbols), "production"
+
+    config.should be_a(Hashie::Mash)
+    config.auth.username.should == "ferris"
+    config[:auth]["password"].should == "test"
+  end
+
+  it "should merge the config with any JVM properties when using JRuby" do
+    Ambience.stubs(:jruby?).returns(true)
+    Ambience.stubs(:jvm_properties).returns(
+      "auth.address" => "http://live.example.com",
+      "auth.password" => "topsecret"
+    )
+    config = Ambience.new config_file(:basic)
+
+    config.should be_a(Hashie::Mash)
+    config.auth.username.should == "ferris"
+    config[:auth][:address].should == "http://live.example.com"
+    config["auth"]["password"].should == "topsecret"
+  end
+
+  it "should raise an ArgumentError in case the given config file could not be found" do
+    lambda { Ambience.new "missing_config.yml" }.should raise_error(ArgumentError)
+  end
+
+end

data/spec/fixtures/basic.yml

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

data/spec/fixtures/environments.yml

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

data/spec/fixtures/symbols.yml

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

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require "spec"
+require "mocha"
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end
+
+require "ambience"
+
+module SpecHelper
+
+  def config_file(name)
+    File.join File.dirname(__FILE__), "fixtures", "#{name}.yml"
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ambience
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Daniel Harrington
@@ -9,11 +9,40 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-13 00:00:00 +01:00
+date: 2010-03-06 00:00:00 +01:00
 default_executable: 
-dependencies: []
-
-description: JVM-Parameters for your JRuby app
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.8
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.7
+    version: 
+description: 
 email: me@rubiii.com
 executables: []
 
@@ -22,15 +51,17 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 files: 
-- README.rdoc
+- CHANGELOG
 - Rakefile
-- VERSION
-- init.rb
+- README.rdoc
+- lib/ambience/ambience.rb
+- lib/ambience/core_ext.rb
 - lib/ambience.rb
-- test/ambience_test.rb
-- test/fixtures/fixtures.rb
-- test/fixtures/some_config.yml
-- test/test_helper.rb
+- spec/ambience/ambience_spec.rb
+- spec/spec_helper.rb
+- spec/fixtures/basic.yml
+- spec/fixtures/environments.yml
+- spec/fixtures/symbols.yml
 has_rdoc: true
 homepage: http://github.com/rubiii/ambience
 licenses: []
@@ -38,10 +69,10 @@ licenses: []
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
-- --title
-- Ambience
 - --line-numbers
 - --inline-source
+- --title
+- Ambience - App configuration feat. YAML and JVM properties
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -62,8 +93,7 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: JVM-Parameters for your JRuby app
+summary: App configuration feat. YAML and JVM properties
 test_files: 
-- test/ambience_test.rb
-- test/fixtures/fixtures.rb
-- test/test_helper.rb
+- spec/ambience/ambience_spec.rb
+- spec/spec_helper.rb

data/VERSION

@@ -1 +0,0 @@
-0.1.0

data/init.rb

@@ -1 +0,0 @@
-require "ambience"

data/test/ambience_test.rb

@@ -1,48 +0,0 @@
-require File.join(File.dirname(__FILE__), "test_helper")
-
-class AmbienceTest < Test::Unit::TestCase
-
-  include Fixtures
-
-  context "Ambience using anything else than JRuby" do
-    setup do
-      Ambience.stubs(:jruby?).returns(false)
-    end
-
-    context "with config file set up" do
-      should "return a Hash containing the config file content" do
-        result = Ambience.new "test", some_config_file
-        assert_equal some_config_hash, result
-      end
-    end
-
-    context "with no config file available" do
-      should "return an empty Hash" do
-        result = Ambience.new "test", "nofile"
-        assert_equal Hash.new, result
-      end
-    end
-  end
-
-  context "Ambience using JRuby" do
-    setup do
-      Ambience.stubs(:jruby?).returns(true)
-      Ambience.stubs(:jvm_properties).returns(some_jvm_properties)
-    end
-
-    context "with config file set up" do
-      should "return a Hash containing the config file and JVM properties" do
-        result = Ambience.new "test", some_config_file
-        assert_equal some_jvm_updated_config_hash, result
-      end
-    end
-
-    context "with no config file available" do
-      should "return a Hash containing the JVM properties" do
-        result = Ambience.new "test", "nofile"
-        assert_equal some_converted_jvm_properties, result
-      end
-    end
-  end
-
-end

data/test/fixtures/fixtures.rb

@@ -1,23 +0,0 @@
-module Fixtures
-
-  def some_config_file
-    File.join(File.dirname(__FILE__), "some_config.yml")
-  end
-
-  def some_config_hash
-    { "auth" => { "user" => "test", "password" => "test" } }
-  end
-
-  def some_jvm_properties
-    { "auth.user" => "jvm" }
-  end
-
-  def some_converted_jvm_properties
-    { "auth" => { "user" => "jvm" } }
-  end
-
-  def some_jvm_updated_config_hash
-    { "auth" => { "user" => "jvm", "password" => "test" } }
-  end
-
-end

data/test/fixtures/some_config.yml

@@ -1,13 +0,0 @@
-defaults: &defaults
-  auth:
-    user: "test"
-    password: "test"
-
-development:
-  <<: *defaults
-
-test:
-  <<: *defaults
-
-production:
-  <<: *defaults

data/test/test_helper.rb

@@ -1,7 +0,0 @@
-require 'rubygems'
-require 'test/unit'
-require "mocha"
-require "shoulda"
-
-require File.join(File.dirname(__FILE__), "fixtures", "fixtures")
-require File.join(File.dirname(__FILE__), "..", "lib", "ambience") unless defined? Ambience