ambience 0.1.0

data/README.rdoc

@@ -0,0 +1,78 @@
+= Ambience
+
+Ruby on Rails configuration with JVM Parameter spicing.
+
+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:
+
+  $ 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
+
+  test:
+    <<: *defaults
+
+  production:
+    <<: *defaults
+
+== Loading the configuration
+
+Place this at the bottom of your config/environment.rb file:
+
+  AppConfig = Ambience.new
+
+== Running your application on MRI
+
+The configuration Hash equals the default configuration file:
+
+  "auth" => {
+    "user" => "client",
+    "password => "secret",
+    "service" => "http://test.example.com"
+  }
+
+== Running the application on JRuby
+
+Expecting these default JVM properties:
+
+  jruby.home = "/usr/local/lib/jruby"
+  java.runtime.name = "Java(TM) SE Runtime Environment"
+  java.runtime.version = "1.6.0_14-b08"
+
+And the following custom property:
+
+  auth.service = "http://live.example.com"
+
+The default configuration will be extended by JVM properties:
+
+  "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

@@ -0,0 +1,42 @@
+require "rubygems"
+require "rake"
+require "rake/testtask"
+require "rake/rdoctask"
+
+task :default => :test
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = 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"]
+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
+
+    spec.files = FileList["[A-Z]*", "init.rb", "{lib,test}/**/*.{rb,yml}"]
+
+    spec.rdoc_options += [
+      "--title", "Ambience",
+      "--line-numbers",
+      "--inline-source"
+    ]
+  end
+rescue LoadError
+  puts "Jeweler missing. Install with: gem install jeweler"
+end

data/VERSION

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

data/init.rb

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

data/lib/ambience.rb

@@ -0,0 +1,88 @@
+require "rubygems"
+require "yaml" unless defined? YAML
+require "erb" unless defined? ERB
+
+class Ambience
+  class << self
+
+    # 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

data/test/ambience_test.rb

@@ -0,0 +1,48 @@
+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

@@ -0,0 +1,23 @@
+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

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

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+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

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: ambience
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Daniel Harrington
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-13 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: JVM-Parameters for your JRuby app
+email: me@rubiii.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- lib/ambience.rb
+- test/ambience_test.rb
+- test/fixtures/fixtures.rb
+- test/fixtures/some_config.yml
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/rubiii/ambience
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+- --title
+- Ambience
+- --line-numbers
+- --inline-source
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: JVM-Parameters for your JRuby app
+test_files: 
+- test/ambience_test.rb
+- test/fixtures/fixtures.rb
+- test/test_helper.rb