cjbottaro-app_config 1.0.0 → 1.0.1

data/CHANGELOG

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

data/VERSION.yml

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

data/app_config.gemspec

@@ -0,0 +1,56 @@
+# 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{app_config}
+  s.version = "1.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Christopher J Bottaro"]
+  s.date = %q{2009-08-27}
+  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",
+     "uninstall.rb"
+  ]
+  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.3}
+  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

@@ -22,7 +22,7 @@ class ApplicationConfiguration
     conf1 = load_conf_file(@conf_path_1)
     conf2 = load_conf_file(@conf_path_2)
     conf  = recursive_merge(conf1, conf2)
-    @config = convert(conf)
+    @config = ClosedStruct.r_new(conf)
   end
   
 private
@@ -42,22 +42,6 @@ private
     end
   end
   
-  # Recursively converts Hashes to ClosedStructs (including Hashes inside Arrays)
-  def convert(h) #:nodoc:
-    s = ClosedStruct.new(h.keys)
-    h.each do |k, v|
-      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
-  
   # 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 }

data/lib/closed_struct.rb

@@ -1,13 +1,22 @@
 require 'ostruct'
 
-class ClosedStruct < OpenStruct # :nodoc:
+# 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
+    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
-      h = args.inject({}){ |memo, k| memo[k] = nil; memo }
-      super(h)
+      raise ArgumentError, "invalid arguments: #{args.inspect}"
     end
     @closed = true
   end
@@ -36,4 +45,16 @@ class ClosedStruct < OpenStruct # :nodoc:
     @table.dup
   end
   
-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/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/uninstall.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cjbottaro-app_config
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Christopher J Bottaro
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-01 00:00:00 -07:00
+date: 2009-08-27 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -22,19 +22,25 @@ 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
-has_rdoc: true
+- uninstall.rb
+has_rdoc: false
 homepage: http://github.com/cjbottaro/app_config
-licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -55,9 +61,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 3
 summary: Application level configuration.
 test_files: 
 - test/app_config_test.rb
+- test/closed_struct_test.rb