jcnetdev-app_config 1.0

data/README

@@ -0,0 +1 @@
+README.rdoc

data/README.rdoc

@@ -0,0 +1,56 @@
+== Summary
+Application level configuration.
+
+== Author
+Christopher J. Bottaro
+
+=== Accessing the AppConfig object
+After installing this plugin, the AppConfig object will be global available.  Entries are accessed via object member notation:
+ AppConfig.my_config_entry
+Nested entries are supported:
+ AppConfig.my_section.some_entry
+
+=== Common config file
+Config entries defined in
+ RAILS_ROOT/config/app_config.yml
+will be available to all environments.
+
+=== Environment specific config files
+You can have environment specific config files.  Environment specific config entries take precedence over common config entries.
+
+Example development environment config file:
+ RAILS_ROOT/config/environments/development.yml
+ 
+Example production environment config file:
+ RAILS_ROOT/config/environments/production.yml
+
+=== Embedded Ruby (ERB)
+ Embedded Ruby is allowed in the configuration files.  See examples below.
+
+=== Examples
+Consider the two following config files.
+
+RAILS_ROOT/config/app_config.yml:
+ size: 1
+ server: google.com
+
+RAILS_ROOT/config/environments/development.yml:
+ size: 2
+ computed: <%= 1 + 2 + 3 %>
+ section:
+   size: 3
+   servers: [ {name: yahoo.com}, {name: amazon.com} ]
+
+Notice that the environment specific config entries overwrite the common entries.
+ AppConfig.size -> 2
+ AppConfig.server -> google.com
+
+Notice the embedded Ruby.
+ AppConfig.computed -> 6
+
+Notice that object member notation is maintained even in nested entries.
+ AppConfig.section.size -> 3
+
+Notice array notation and object member notation is maintained.
+ AppConfig.section.servers[0].name -> yahoo.com
+ AppConfig.section.servers[1].name -> amazon.com

data/app_config.gemspec

@@ -0,0 +1,32 @@
+Gem::Specification.new do |s|
+  s.name = 'app_config'
+  s.version = '1.0'
+  s.date = '2008-07-04'
+  
+  s.summary = "Application level configuration"
+  s.description = "Allow application wide configuration settings via YML files"
+  
+  s.authors = ['RailsJedi', 'Christopher J. Bottaro']
+  s.email = 'railsjedi@gmail.com'
+  s.homepage = 'http://github.com/jcnetdev/app_config'
+  
+  s.has_rdoc = true
+  s.rdoc_options = ["--main", "README"]
+  s.extra_rdoc_files = ["README"]
+
+  s.add_dependency 'rails', ['>= 2.1']
+  
+  s.files = ["README",
+             "README.rdoc",
+             "app_config.gemspec",
+             "init.rb",
+             "lib/app_config.rb",
+             "rails/init.rb"]
+  
+  s.test_files = ["test/app_config.yml",
+                  "test/app_config_test.rb",
+                  "test/development.yml",
+                  "test/empty1.yml",
+                  "test/empty2.yml"]
+
+end

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init"

data/lib/app_config.rb

@@ -0,0 +1,41 @@
+require 'ostruct'
+require 'yaml'
+require 'erb'
+
+# == Summary
+# This is API documentation, NOT documentation on how to use this plugin.  For that, see the README.
+module ApplicationConfig
+  
+  # Create a config object (OpenStruct) from a yaml file.  If a second yaml file is given, then the sections of that file will overwrite the sections
+  # if the first file if they exist in the first file.
+  def self.load_files(conf_path_1, conf_path_2 = nil)
+  
+    conf1 = YAML.load(ERB.new(IO.read(conf_path_1)).result) if conf_path_1 and File.exists?(conf_path_1)
+    conf1 = {} if !conf1 or conf1.empty?
+    
+    conf2 = YAML.load(ERB.new(IO.read(conf_path_2)).result) if conf_path_2 and File.exists?(conf_path_2)
+    conf2 = {} if !conf2 or conf2.empty?
+    
+    conf = conf1.merge(conf2)
+    (!conf or conf.empty?) ? OpenStruct.new : convert(conf)
+    
+  end
+  
+  # Recursively converts Hashes to OpenStructs (including Hashes inside Arrays)
+  def self.convert(h) #:nodoc:
+    s = OpenStruct.new
+    h.each do |k, v|
+      s.new_ostruct_member(k)
+      if v.instance_of?(Hash)
+        s.send( (k+'=').to_sym, convert(v))
+      elsif v.instance_of?(Array)
+        converted_array = v.collect { |e| e.instance_of?(Hash) ? convert(e) : e }
+        s.send( (k+'=').to_sym, converted_array)
+      else
+        s.send( (k+'=').to_sym, v)
+      end
+    end
+    s
+  end
+
+end

data/rails/init.rb

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

data/test/app_config.yml

@@ -0,0 +1,2 @@
+size: 1
+server: google.com

data/test/app_config_test.rb

@@ -0,0 +1,44 @@
+require 'test/unit'
+require 'app_config'
+
+class AppConfigTest < Test::Unit::TestCase
+  
+  def test_missing_files
+    config = ApplicationConfig.load_files('not_here1', 'not_here2')
+    assert_equal OpenStruct.new, config
+  end
+  
+  def test_empty_files
+    config = ApplicationConfig.load_files('test/empty1.yml', 'test/empty2.yml')
+    assert_equal OpenStruct.new, config
+  end
+  
+  def test_common
+    config = ApplicationConfig.load_files('test/app_config.yml')
+    assert_equal 1, config.size
+    assert_equal 'google.com', config.server
+  end
+  
+  def test_environment_override
+    config = ApplicationConfig.load_files('test/app_config.yml', 'test/development.yml')
+    assert_equal 2, config.size
+    assert_equal 'google.com', config.server
+  end
+  
+  def test_nested
+    config = ApplicationConfig.load_files('test/development.yml')
+    assert_equal 3, config.section.size
+  end
+  
+  def test_array
+    config = ApplicationConfig.load_files('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 = ApplicationConfig.load_files('test/development.yml')
+    assert_equal 6, config.computed
+  end
+  
+end

data/test/development.yml

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

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: jcnetdev-app_config
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+platform: ruby
+authors: 
+- RailsJedi
+- Christopher J. Bottaro
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-07-04 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "2.1"
+    version: 
+description: Allow application wide configuration settings via YML files
+email: railsjedi@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- README
+- README.rdoc
+- app_config.gemspec
+- init.rb
+- lib/app_config.rb
+- rails/init.rb
+has_rdoc: true
+homepage: http://github.com/jcnetdev/app_config
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Application level configuration
+test_files: 
+- test/app_config.yml
+- test/app_config_test.rb
+- test/development.yml
+- test/empty1.yml
+- test/empty2.yml