simple_app_config 0.1.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,22 @@
+MIT license
+
+Copyright (c) 2009 Patrick Huesler
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,65 @@
+= simple app config
+
+Generates a configuration object:
+
+* Pass in a YAML file
+* Pass in an environment as a filter
+* Use YAML defaults
+* Use ERB
+* Returns an OpenStruct so top level attributes can be accessed via method
+
+Here is how a configuration file could look like:
+
+  application: RailsConfig
+  version: <%= 'version'.upcase %>
+
+  defaults: &defaults
+    payment:
+      key: payment_key
+
+  development:
+    <<: *defaults
+    payment:
+      key: development_payment_key
+
+  production:
+    <<: *defaults
+
+== Installation
+
+=== Via github
+  gem install phuesler-simple_app_config
+  
+=== Via gem cutter (http://www.gemcutter.org)
+  gem install gemcutter
+  gem tumble
+  gem install simple_app_config
+
+== Usage
+  
+ require 'simple_app_config'
+ Config = AppConfig.create("config/application.yml", :environment => 'development')
+ 
+ puts Config.application
+ puts Config.payment['key']
+
+When used in a Rails project, create an initializer and add something like this:
+
+ require 'simple_app_config'
+ Config = AppConfig.create("#{Rails.root}/config/application.yml", :environment => Rails.env)
+
+
+== 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) 2009 Patrick Huesler. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "simple_app_config"
+    gem.summary = %Q{A little helper to define and access the app configuration}
+    gem.description = %Q{Use yml and erb and speficiy environments and scopes}
+    gem.email = "patrick.huesler@gmail.com"
+    gem.homepage = "http://github.com/phuesler/simple_app_config"
+    gem.authors = ["Patrick Huesler"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "simple_app_config #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/lib/app_config.rb

@@ -0,0 +1,11 @@
+require 'ostruct'
+require 'erb'
+class AppConfig
+  def self.create(yaml_file, options = {})
+    yaml_data = YAML::load(ERB.new(IO.read(yaml_file)).result)
+    data = {}
+    data = yaml_data.delete(options[:environment]) if options[:environment]
+    data.merge!(yaml_data)
+    OpenStruct.new(data)
+  end
+end

data/simple_app_config.gemspec

@@ -0,0 +1,51 @@
+# 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{simple_app_config}
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Patrick Huesler"]
+  s.date = %q{2009-10-04}
+  s.description = %q{Use yml and erb and speficiy environments and scopes}
+  s.email = %q{patrick.huesler@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/app_config.rb",
+     "simple_app_config.gemspec",
+     "test/app_config_test.rb",
+     "test/fixtures/application.yml",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/phuesler/simple_app_config}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A little helper to define and access the app configuration}
+  s.test_files = [
+    "test/app_config_test.rb",
+     "test/test_helper.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/test/app_config_test.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+class AppConfigTest < Test::Unit::TestCase
+  TEST_FILE = File.join(File.dirname(__FILE__),"fixtures","application.yml")
+
+  def test_method_accessor_for_top_level_attributes
+    config = AppConfig.create(TEST_FILE)
+    assert_equal "RailsConfig", config.application
+  end
+
+  def test_read_a_scoped_attribute
+    config = AppConfig.create(TEST_FILE, :environment => 'development')
+    assert_equal "development_payment_key", config.payment['key']
+  end
+  
+  def test_attributes_are_inherited
+    config = AppConfig.create(TEST_FILE, :environment => 'production')
+    assert_equal "payment_key", config.payment['key']
+  end
+  
+  def test_erb_rendering
+    config = AppConfig.create(TEST_FILE)
+    assert_equal 'VERSION', config.version
+  end
+end

data/test/fixtures/application.yml

@@ -0,0 +1,14 @@
+application: RailsConfig
+version: <%= 'version'.upcase %>
+
+defaults: &defaults
+  payment:
+    key: payment_key
+
+development:
+  <<: *defaults
+  payment:
+    key: development_payment_key
+
+production:
+  <<: *defaults

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'app_config'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: simple_app_config
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Patrick Huesler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-04 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Use yml and erb and speficiy environments and scopes
+email: patrick.huesler@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/app_config.rb
+- simple_app_config.gemspec
+- test/app_config_test.rb
+- test/fixtures/application.yml
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/phuesler/simple_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: A little helper to define and access the app configuration
+test_files: 
+- test/app_config_test.rb
+- test/test_helper.rb