viva-app_config 1.2.0

data/CHANGELOG

@@ -0,0 +1,14 @@
+10/03/2008
+* recursively merge the configuration hashes
+
+07/01/2009
+* Packaged as a gem (but still works as a Rails plugin).
+* The app config object is now an instance of ApplicationConfiguration.
+* NoMethodError raised if you try to access a config element that doesn't exist.
+* ApplicationConfiguration#reload! to reread the config files and rebuild the app config object.
+
+08/27/2009
+* Updated the ClosedStruct class.
+
+08/28/2009
+* Added support for "environments" in the YAML files.

data/README.rdoc

@@ -0,0 +1,89 @@
+== Summary
+Application level configuration.
+
+== Features
+
+ * simple YAML config files
+ * config files support ERB
+ * config files support inheritance
+ * access config information via convenient object member notation
+
+=== Basic Usage
+
+You simply write a configuration file in YAML.  Notice you can use ERB.
+
+<em>config.yml</em>
+  aws:
+    access_key: 123ABC
+    secret_key: ABC123
+  now: <%= Time.now %>
+  servers: [ {name: example1.com}, {name: example2.com} ]
+
+Then somewhere in your code, you create a global constant from the config file.  Then access the config data via object member notation.
+
+_code_
+  ::AppConfig = ApplicationConfiguration.new("config.yml")
+  AppConfig.aws.access_key  # => "123ABC"
+  AppConfig.aws.secret_key  # => "ABC123"
+  AppConfig.now             # => Tue May 05 21:55:15 -0500 2009
+  AppConfig.servers[0].name # => "example1.com"
+
+=== Inheritance
+
+You can have a second config file that is recursively merged with the first config file.
+
+<em>base.yml</em>
+  app_name:  MyCoolApp
+  domain:  dev.mycoolapp.com
+
+<em>production.yml</em>
+  domain:  www.mycoolapp.com
+
+_code_
+  ::AppConfig = ApplicationConfiguration.new("base.yml", "production.yml")
+  AppConfig.app_name # => "MyCoolApp"
+  AppConfig.domain   # => "www.mycoolapp.com"
+
+=== Using in a Rails app
+
+You just need to create an initializer that looks something like this.
+
+ require 'app_config'
+ ::AppConfig = ApplicationConfiguration.new(RAILS_ROOT+"/config/app_config.yml",
+                                            RAILS_ROOT+"/config/environments/#{RAILS_ENV}.yml")
+
+If you installed this as a Rails plugin instead of a gem, that code is already run for you in
+the plugin's init.rb.
+
+=== Environments
+
+Alternatively to splitting out your environments into separate files, you can just have a single file which defines
+the application configuration for all environments (much like how databases.yml works).  Note if you do this, nested
+configurations will not be recursively merged.  See example below.
+
+<em>app_config.yml</em>
+  defaults: &defaults
+    one: won
+    two: too
+    nested:
+      foo: foo
+      bar: bar
+  
+  development:
+    <<: *defaults
+    two: new
+    nested:
+      foo: bar
+
+_code_
+  RAILS_ENV # => "development"
+  ::AppConfig = ApplicationConfiguration.new("app_config.yml")
+  AppConfig.use_environment!(RAILS_ENV)
+  AppConfig.one # => "won"
+  AppConfig.two # => "new"
+  AppConfig.nested.foo # => "bar"
+  AppConfig.nested.bar # raises NoMethodError because nested configurations are not recursively merged
+
+
+== Author
+Christopher J. Bottaro

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "app_config"
+    gem.summary = %Q{Application level configuration.}
+    gem.description = %Q{Application level configuration that supports YAML config file, inheritance, ERB, and object member notation.}
+    gem.email = "cjbottaro@alumni.cs.utexas.edu"
+    gem.homepage = "http://github.com/cjbottaro/app_config"
+    gem.authors = ["Christopher J Bottaro"]
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the app_config plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the app_config plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AppConfig'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 0
+:major: 1
+:minor: 2

data/app_config.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{viva-app_config}
+  s.version = "1.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Christopher J Bottaro"]
+  s.date = %q{2009-09-08}
+  s.description = %q{Application level configuration that supports YAML config file, inheritance, ERB, and object member notation.}
+  s.email = %q{cjbottaro@alumni.cs.utexas.edu}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    "CHANGELOG",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "app_config.gemspec",
+     "init.rb",
+     "install.rb",
+     "lib/app_config.rb",
+     "lib/closed_struct.rb",
+     "tasks/app_config_tasks.rake",
+     "test/app_config.yml",
+     "test/app_config_test.rb",
+     "test/closed_struct_test.rb",
+     "test/development.yml",
+     "test/empty1.yml",
+     "test/empty2.yml",
+     "test/environments.yml",
+     "test/override_with.yml",
+     "uninstall.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/cjbottaro/app_config}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.2}
+  s.summary = %q{Application level configuration.}
+  s.test_files = [
+    "test/app_config_test.rb",
+     "test/closed_struct_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/init.rb

@@ -0,0 +1,4 @@
+require 'app_config'
+
+::AppConfig = ApplicationConfiguration.new(RAILS_ROOT+"/config/app_config.yml",
+                                           RAILS_ROOT+"/config/environments/#{RAILS_ENV}.yml")

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/app_config.rb

@@ -0,0 +1,64 @@
+require 'closed_struct'
+require 'yaml'
+require 'erb'
+
+class ApplicationConfiguration
+  
+  # Create a new ApplicationConfiguration object.  <tt>conf_path_1</tt> is the path to your YAML configuration file.
+  # If <tt>conf_path_2</tt> is given, the contents are recursively merged with the contents of <tt>conf_path_1</tt>.
+  # This allows you to have a "base" configuration with settings that are overrided by "environment specific"
+  # (developement, test, production, etc) settings.
+  #
+  # Ex:
+  #  ApplicationConfiguration.new(RAILS_ROOT+"/config/base.yml", RAILS_ROOT+"/environments/#{RAILS_ENV}_config.yml")
+  def initialize(conf_path_1, conf_path_2 = nil)
+    @conf_path_1, @conf_path_2 = conf_path_1, conf_path_2
+    reload!
+  end
+  
+  # Rereads your configuration files and rebuilds your ApplicationConfiguration object.  This is useful
+  # for when you edit your config files, but don't want to restart your web server.
+  def reload!
+    conf1 = load_conf_file(@conf_path_1)
+    conf2 = load_conf_file(@conf_path_2)
+    @config_hash  = recursive_merge(conf1, conf2)
+    @config = ClosedStruct.r_new(@config_hash)
+  end
+  
+  def use_environment!(environment, options = {})
+    raise ArgumentError, "environment doesn't exist in app config: #{environment}" \
+      unless @config_hash.has_key?(environment.to_s)
+    
+    @config_hash = @config_hash[environment.to_s]
+    @config = @config.send(environment)
+    
+    if options[:override_with] and File.exist?(options[:override_with])
+      overriding_config = load_conf_file(options[:override_with])
+      @config_hash = recursive_merge(@config_hash, overriding_config)
+      @config = ClosedStruct.r_new(@config_hash)
+    end
+  end
+  
+private
+  
+  def method_missing(name, *args)
+    if @config.respond_to?(name)
+      @config.send(name, *args)
+    else
+      super
+    end
+  end
+  
+  def load_conf_file(conf_path)
+    return {} if !conf_path or conf_path.empty?
+    File.open(conf_path, "r") do |file|
+      YAML.load(ERB.new(file.read).result) || {}
+    end
+  end
+  
+  # Recursively merges hashes.  h2 will overwrite h1.
+  def recursive_merge(h1, h2) #:nodoc:
+    h1.merge(h2){ |k, v1, v2| v2.kind_of?(Hash) ? recursive_merge(v1, v2) : v2 }
+  end
+  
+end

data/lib/closed_struct.rb

@@ -0,0 +1,60 @@
+require 'ostruct'
+
+# Like OpenStruct, but raises an exception if you try to access a member that wasn't specified in the initializer.
+class ClosedStruct < OpenStruct
+  
+  def self.r_new(hash)
+    closed_struct = ClosedStruct.new(hash)
+    closed_struct.send(:recursive_initialize)
+    closed_struct
+  end
+  
+  def initialize(*args)
+    if args.length == 1 and args.first.kind_of?(Hash)
+      super(args.first)
+    elsif args.length > 1 and args.all?{ |arg| [Symbol, String].include?(arg.class) }
+      args = args.inject({}){ |memo, arg| memo[arg.to_sym] = nil; memo }
+      super(args)
+    else
+      raise ArgumentError, "invalid arguments: #{args.inspect}"
+    end
+    @closed = true
+  end
+  
+  def new_ostruct_member(name)
+    if @closed
+      raise RuntimeError, "cannot add members to closed struct"
+    else
+      super
+    end
+  end
+  
+  def method_missing(name, *args)
+    raise NoMethodError, "undefined method '#{name}' for #{self}"
+  end
+  
+  def id
+    if @table.has_key?(:id)
+      @table[:id]
+    else
+      method_missing(:id)
+    end
+  end
+  
+  def to_h
+    @table.dup
+  end
+  
+private
+  
+  def recursive_initialize
+    @table.each do |k, v|
+      if v.kind_of?(Hash)
+        @table[k] = ClosedStruct.r_new(v)
+      elsif v.kind_of?(Array)
+        @table[k] = v.collect{ |e| e.kind_of?(Hash) ? ClosedStruct.r_new(e) : e }
+      end
+    end
+  end
+  
+end

data/tasks/app_config_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :app_config do
+#   # Task goes here
+# end

data/test/app_config.yml

@@ -0,0 +1,5 @@
+size: 1
+server: google.com
+emails:
+  support: support@domain.com
+  webmaster: web@domain.com

data/test/app_config_test.rb

@@ -0,0 +1,105 @@
+require 'test/unit'
+require 'app_config'
+
+class AppConfigTest < Test::Unit::TestCase
+  
+  def test_missing_files
+    assert_raise(Errno::ENOENT){ ApplicationConfiguration.new('not_here1', 'not_here2') }
+  end
+  
+  def test_empty_files
+    config = ApplicationConfiguration.new('test/empty1.yml', 'test/empty2.yml')
+    assert_equal OpenStruct.new, config.instance_variable_get("@config")
+  end
+  
+  def test_common
+    config = ApplicationConfiguration.new('test/app_config.yml')
+    assert_equal 1, config.size
+    assert_equal 'google.com', config.server
+  end
+  
+  def test_override
+    config = ApplicationConfiguration.new('test/app_config.yml', 'test/development.yml')
+    assert_equal 2, config.size
+    assert_equal 'google.com', config.server
+  end
+  
+  def test_nested
+    config = ApplicationConfiguration.new('test/development.yml')
+    assert_equal 3, config.section.size
+  end
+  
+  def test_array
+    config = ApplicationConfiguration.new('test/development.yml')
+    assert_equal 'yahoo.com', config.section.servers[0].name
+    assert_equal 'amazon.com', config.section.servers[1].name
+  end
+  
+  def test_erb
+    config = ApplicationConfiguration.new('test/development.yml')
+    assert_equal 6, config.computed
+  end
+  
+  def test_recursive_merge
+    config = ApplicationConfiguration.new('test/app_config.yml', 'test/development.yml')
+    assert_equal 'support@domain.com', config.emails.support
+    assert_equal 'webmaster@domain.com', config.emails.webmaster
+    assert_equal 'feedback@domain.com', config.emails.feedback
+  end
+  
+  def test_exception_on_non_existant_values
+    config = ApplicationConfiguration.new('test/app_config.yml')
+    assert_raise(NoMethodError){ config.not_here1 = "blah" }
+    assert_raise(NoMethodError){ config.not_here2 }
+  end
+  
+  def test_reload
+    config = ApplicationConfiguration.new('test/app_config.yml')
+    config.size = 2
+    assert_equal 2, config.size
+    config.reload!
+    assert_equal 1, config.size
+  end
+  
+  def test_environments
+    config = ApplicationConfiguration.new('test/environments.yml')
+    config.use_environment!("development")
+    assert_equal 2, config.size
+    assert_equal "google.com", config.server
+    assert_equal 6, config.computed
+    assert_equal 3, config.section.size
+    assert_equal "yahoo.com", config.section.servers[0].name
+    assert_equal "amazon.com", config.section.servers[1].name
+    assert_equal "webmaster@domain.com", config.emails.webmaster
+    assert_equal "feedback@domain.com", config.emails.feedback
+    assert_raise(NoMethodError){ config.emails.support }
+  end
+  
+  def test_use_environment_override_with
+    config = ApplicationConfiguration.new('test/environments.yml')
+    config.use_environment!("development", :override_with => "test/override_with.yml")
+    assert_equal 10, config.size
+    assert_equal "over.com", config.section.servers[0].name
+    assert_equal "ride.com", config.section.servers[1].name
+    assert_equal "google.com", config.server
+    assert_equal 6, config.computed
+    assert_equal "webmaster@domain.com", config.emails.webmaster
+    assert_equal "feedback@domain.com", config.emails.feedback
+    assert_raise(NoMethodError){ config.emails.support }
+  end
+  
+  def test_use_environment_override_with_no_file
+    config = ApplicationConfiguration.new('test/environments.yml')
+    config.use_environment!("development", :override_with => "test/non_existant.yml")
+    assert_equal 2, config.size
+    assert_equal "google.com", config.server
+    assert_equal 6, config.computed
+    assert_equal 3, config.section.size
+    assert_equal "yahoo.com", config.section.servers[0].name
+    assert_equal "amazon.com", config.section.servers[1].name
+    assert_equal "webmaster@domain.com", config.emails.webmaster
+    assert_equal "feedback@domain.com", config.emails.feedback
+    assert_raise(NoMethodError){ config.emails.support }
+  end
+  
+end

data/test/closed_struct_test.rb

@@ -0,0 +1,33 @@
+require 'test/unit'
+require 'app_config'
+
+class ClosedStructTest < Test::Unit::TestCase
+
+  def test_from_hash
+    s = ClosedStruct.new :a => "a", "b" => "b", :c => 123
+    assert_equal "a", s.a
+    assert_equal "b", s.b
+    assert_equal 123, s.c
+    assert_raise(NoMethodError){ s.d }
+  end
+  
+  def test_from_array
+    s = ClosedStruct.new :a, :b, :c
+    s.b = "b"
+    assert_nil s.a
+    assert_equal "b", s.b
+    assert_nil s.c
+    assert_raise(NoMethodError){ s.d }
+  end
+  
+  def test_nested_hash
+    s = ClosedStruct.r_new :a => :a, :b => { :c => :c }, :d => :d
+    assert_equal :c, s.b.c
+  end
+  
+  def test_nested_hashes_in_array
+    s = ClosedStruct.r_new :a => :a, :b => [ {:c => :c }, { :d => :d } ], :e => :e
+    assert_equal :c, s.b[0].c
+  end
+
+end

data/test/development.yml

@@ -0,0 +1,8 @@
+size: 2
+computed: <%= 1 + 2 + 3 %>
+section:
+  size: 3
+  servers: [ {name: yahoo.com}, {name: amazon.com} ]
+emails:
+  webmaster: webmaster@domain.com
+  feedback: feedback@domain.com

data/test/environments.yml

@@ -0,0 +1,17 @@
+defaults: &defaults
+  size: 1
+  server: google.com
+  emails:
+    support: support@domain.com
+    webmaster: web@domain.com
+
+development:
+  <<: *defaults
+  size: 2
+  computed: <%= 1 + 2 + 3 %>
+  section:
+    size: 3
+    servers: [ {name: yahoo.com}, {name: amazon.com} ]
+  emails:
+    webmaster: webmaster@domain.com
+    feedback: feedback@domain.com

data/test/override_with.yml

@@ -0,0 +1,3 @@
+size: 10
+section:
+  servers: [ {name: over.com}, {name: ride.com} ]

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: viva-app_config
+version: !ruby/object:Gem::Version 
+  version: 1.2.0
+platform: ruby
+authors: 
+- Christopher J Bottaro
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-08 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Application level configuration that supports YAML config file, inheritance, ERB, and object member notation.
+email: cjbottaro@alumni.cs.utexas.edu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- CHANGELOG
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- app_config.gemspec
+- init.rb
+- install.rb
+- lib/app_config.rb
+- lib/closed_struct.rb
+- tasks/app_config_tasks.rake
+- test/app_config.yml
+- test/app_config_test.rb
+- test/closed_struct_test.rb
+- test/development.yml
+- test/empty1.yml
+- test/empty2.yml
+- test/environments.yml
+- test/override_with.yml
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/cjbottaro/app_config
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: Application level configuration.
+test_files: 
+- test/app_config_test.rb
+- test/closed_struct_test.rb