config-file-loader 0.1.0 → 0.1.1

data/CHANGELOG

@@ -1,2 +1,4 @@
 0.1.0
-Initial Version
+* Initial Version
+0.1.1
+* Added OStruct support

data/README.markdown

@@ -0,0 +1,75 @@
+# config-file-loader
+
+Inspired/ ripped off from ryan bate's great railscast
+
+[http://railscasts.com/episodes/85-yaml-configuration-file]()
+
+## features
+
+* configuration file is in yaml
+* supports erb in yaml file
+* assumes/adds yml extension
+* assumes file is in RAILS_ROOT/config
+* can override config file location per file (using an absolute or relative path) or globally 
+* allows custom override files, so for local developers or production per machine values
+* different variable values for different "Rails" environments.
+* works in Rails, but also in non rails-projects.
+
+## planned features
+
+* monitoring files and updating upon file changes using fsevents.
+* database based config values
+* memcache config values
+* ui to see and edit variables (will save to db/memcache - probably not file)
+
+## file format
+
+  supports aliases, erb, and any yaml construct.
+
+    defaults: &defaults
+      d1: v1
+      d2: v2
+    development:
+      <<: *defaults
+      attribute1: value1
+      attribute2:
+        attribute2a: value2a
+        attribute2b: value2b
+      attribute3: <%= ENV['USER'] %>
+    test:
+      <<: *defaults
+      attribute1: value1b
+    ...
+
+override file:
+
+    development:
+      attribute2:
+        attribute2a: replaced-value2a
+
+If you are nesting hashes within a file, remember that yaml will replace the whole hash.
+
+But a separate override file will merge in values. So in development, only attribute2a will be replaced.
+
+## usage
+
+    APP_CONFIG = ConfigFileLoader.load(
+      'app_config.yml',
+      'app_config_local.yml',
+      '/opt/local/config/app_config_override.yml'
+    )
+
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 kbrock. See LICENSE for details.

data/Rakefile

@@ -6,7 +6,7 @@ begin
   Jeweler::Tasks.new do |gem|
     gem.name = "config-file-loader"
     gem.summary = %Q{Load config files from disk}
-    gem.description = %Q{simple way to load erb yaml config files}
+    gem.description = %Q{simple way to load erb yaml config files. based upon http://railscasts.com/episodes/85-yaml-configuration-file}
     gem.email = "keenan@thebrocks.net"
     gem.homepage = "http://github.com/kbrock/config-file-loader"
     gem.authors = ["kbrock"]

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/init.rb

@@ -0,0 +1 @@
+require 'config_file_loader'

data/lib/config-file-loader.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/config_file_loader'

data/lib/config_file_loader.rb

@@ -1,5 +1,6 @@
 require 'erb'
 require 'yaml'
+require 'ostruct'
 class ConfigFileLoader
 
   ## base directory for configuration
@@ -36,6 +37,10 @@ class ConfigFileLoader
     load_files(*files)
   end
 
+  def self.load_as_struct(*files)
+    OpenStruct.new(load_files(*files))
+  end
+
   def self.load(*files, &block)    
     block=lambda() { |hash| self.deep_symbolize_keys(hash) } unless block_given?
     load_files(*files,&block)
@@ -55,7 +60,7 @@ class ConfigFileLoader
   def self.fix_name(name)
     return unless name.is_a?(String)
     #if it is not relative ('./file') or absolute ('/a/b/file') - tack on config directory
-    name = "#{self.base}/#{name}" unless ['.','/'].include?(name[0,1])
+    name = "#{self.base}/#{name}" unless ['.','/','~'].include?(name[0,1])
     name+=".yml" unless name.include?('yml') || name.include?('cfg')
     name
   end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'config_file_loader'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: config-file-loader
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - kbrock
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-21 00:00:00 -04:00
+date: 2010-08-18 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -34,7 +34,7 @@ dependencies:
         version: 1.2.9
   type: :development
   version_requirements: *id001
-description: simple way to load erb yaml config files
+description: simple way to load erb yaml config files. based upon http://railscasts.com/episodes/85-yaml-configuration-file
 email: keenan@thebrocks.net
 executables: []
 
@@ -42,16 +42,19 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.markdown
 files: 
 - .document
 - .gitignore
 - CHANGELOG
 - LICENSE
-- README.rdoc
+- README.markdown
 - Rakefile
 - VERSION
+- init.rb
+- lib/config-file-loader.rb
 - lib/config_file_loader.rb
+- rails/init.rb
 - spec/config/a.yml
 - spec/config/b.yml
 - spec/config/dev_prod.yml

data/README.rdoc

@@ -1,41 +0,0 @@
-= config-file-loader
-
-http://railscasts.com/episodes/85-yaml-configuration-file
-
-* assumes yaml files (which can contain erb) with the extension yml
-* assumes yaml file is in config (unless an absolute path is given)
-
-== file format
-
-# development:
-#   attribute1: value1
-#   attribute2:
-#     attribute2a: value2a
-#     attribute2b: value2b
-#   attribute3: <%= ENV['USER'] %>
-# test:
-#   attribute1: value1b
-# ...
-
-== usage
-
-APP_CONFIG = ConfigFileLoader.load(
-  'app_config.yml',
-  'app_config_local.yml',
-  '/opt/local/config/app_config_override.yml'
-)
-
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010 kbrock. See LICENSE for details.