appconfig 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,12 @@
+.DS_Store
+**/.DS_Store
+pkg
+doc
+rdoc
+coverage
+*.swp
+*.tmproj
+tmtags
+*~
+\#*
+.\#*

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+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.md

@@ -0,0 +1,93 @@
+AppConfig
+=========
+
+
+	 ______                  ____                     ___                 
+	/\  _  \                /\  _`\                 /'___\ __             
+	\ \ \L\ \  _____   _____\ \ \/\_\   ___    ___ /\ \__//\_\     __     
+	 \ \  __ \/\ '__`\/\ '__`\ \ \/_/_ / __`\/' _ `\ \ ,__\/\ \  /'_ `\   
+	  \ \ \/\ \ \ \L\ \ \ \L\ \ \ \L\ \\ \L\ \\ \/\ \ \ \_/\ \ \/\ \L\ \  
+	   \ \_\ \_\ \ ,__/\ \ ,__/\ \____/ \____/ \_\ \_\ \_\  \ \_\ \____ \ 
+	    \/_/\/_/\ \ \/  \ \ \/  \/___/ \/___/ \/_/\/_/\/_/   \/_/\/___L\ \
+	             \ \_\   \ \_\                                     /\____/
+	              \/_/    \/_/                                     \_/__/
+
+
+*AppConfig* does pretty much what [all](http://github.com/cjbottaro/app_config) [the](http://github.com/stephencelis/app) [other](http://github.com/merbjedi/app_config) [great](http://github.com/oshuma/app_config) application configuration plugins do, but requires even less configuration (I know, how meta). It reads your config from YAML files, supports nested options, and automatically reloads your changes in `development` mode. 
+
+It also has a README with cool ASCII art in it.
+
+Install
+=======
+
+Rails 2.x
+-------
+
+Put this in your `environment.rb`:
+
+	config.gem 'appconfig'
+	
+That's it.
+
+Rails 3
+-------
+
+Add this to your `Gemfile`:
+
+	gem 'appconfig', :require => 'app_config'
+
+That's it.
+
+Usage
+=======
+
+By default AppConfig will try to read config options from `config/appconfig.defaults.yml` and `*.appconfig.yml`.
+
+	# sample appconfig.defaults.yml
+	
+	admins:
+
+	  tisho: 
+	    full_name: Tisho Georgiev
+	    email: tihomir.georgiev@gmail.com
+
+	  josh:
+	    full_name: Joshua Krall
+	    email: josh@transfs.com
+
+Inside your Rails app, you can access your configuration options using the `AppConfig` object.
+
+	@admin_name = AppConfig.admins.tisho.full_name
+
+Since *AppConfig's* storage mechanism is something like the lovechild of `HashWithIndifferentAccess` and `OpenStruct`, you can access your configuration in a bunch of different ways.
+
+	AppConfig.admins.tisho
+	AppConfig[:admins].tisho
+	AppConfig[:admins][:tisho]
+	AppConfig['admins']['tisho']
+	AppConfig['admins'][:tisho]
+
+You get the idea.
+
+If you're prefer the `OpenStruct` methodized syntax for accessing configuration options, you can optionally provide a fallback value for an option that may not exist.
+
+	AppConfig.option_that_doesnt_exist('fallback') 	#=> 'fallback'
+
+Reloading
+-------
+
+When running your app in your `development` environment, *AppConfig* reloads on every request. It does that by using Rails's `ActionController::Dispatcher.to_prepare` hook.
+
+If you need to reload your configuration manually, you can run:
+
+	AppConfig.reload!
+
+Found a bug?
+=======
+
+By all means, drop us a line. Or better yet, fork the project, fix the bug and send us a pull request. We'll thank you for it.
+
+License
+=======
+
+Copyright (c) 2010 Joshua Krall & Tisho Georgiev, released under the MIT license

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+require File.dirname(__FILE__) + "/lib/app_config/version.rb"
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "appconfig"
+    gem.version = AppConfig::VERSION::STRING
+    gem.summary = %Q{Provides an OpenStruct/Hash-like syntax for accessing your app's configuration options, loaded from a YAML file.}
+    gem.description = %Q{Provides an OpenStruct/Hash-like syntax for accessing your app's configuration options, loaded from a YAML file. Supports multiple configuration files, nested configuration groups and fallback options.}
+    gem.email = "tihomir.georgiev@gmail.com"
+    gem.homepage = "http://github.com/tisho/appconfig"
+    gem.authors = ["Tisho Georgiev", "Joshua Krall"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "rails", ">= 2.3"
+    # 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: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "appconfig #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/appconfig.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{appconfig}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tisho Georgiev", "Joshua Krall"]
+  s.date = %q{2010-03-25}
+  s.description = %q{Provides an OpenStruct/Hash-like syntax for accessing your app's configuration options, loaded from a YAML file. Supports multiple configuration files, nested configuration groups and fallback options.}
+  s.email = %q{tihomir.georgiev@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "appconfig.gemspec",
+     "init.rb",
+     "lib/app_config.rb",
+     "lib/app_config/accessor_proxy.rb",
+     "lib/app_config/base.rb",
+     "lib/app_config/railtie.rb",
+     "lib/app_config/version.rb",
+     "rails/init.rb",
+     "spec/app_config_spec.rb",
+     "spec/fixtures/appconfig.defaults.yml",
+     "spec/fixtures/overrides.appconfig.yml",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/tisho/appconfig}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Provides an OpenStruct/Hash-like syntax for accessing your app's configuration options, loaded from a YAML file.}
+  s.test_files = [
+    "spec/app_config_spec.rb",
+     "spec/spec_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
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<rails>, [">= 2.3"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<rails>, [">= 2.3"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<rails>, [">= 2.3"])
+  end
+end
+

data/init.rb

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

data/lib/app_config.rb

@@ -0,0 +1,4 @@
+require 'app_config/version'
+require 'app_config/accessor_proxy'
+require 'app_config/base'
+require 'app_config/railtie' if defined?(Rails) && Rails::VERSION::MAJOR >= 3

data/lib/app_config/accessor_proxy.rb

@@ -0,0 +1,36 @@
+require 'active_support'
+require 'active_support/core_ext/hash'
+
+module AppConfig
+  # Support nested hash accessors, so you could do AppConfig.stylesheet_expansions.standard
+  class AccessorProxy < HashWithIndifferentAccess
+    def method_missing(method, *args, &block)
+      if self[method]
+        return AccessorProxy.new(self[method]) if self[method].is_a?(Hash)
+        self[method]
+      else
+        begin
+          super
+        rescue NoMethodError => e
+          # return default "value if nil" if one is provided
+          if args.size == 1
+            args.first
+          else
+            raise e
+          end
+        end
+      end
+    end
+    
+    def convert_value(value)
+      case value
+      when Hash
+        AccessorProxy.new(value.with_indifferent_access)
+      when Array
+        value.collect { |e| e.is_a?(Hash) ? AccessorProxy.new(e.with_indifferent_access) : e }
+      else
+        value
+      end
+    end    
+  end
+end

data/lib/app_config/base.rb

@@ -0,0 +1,44 @@
+require 'yaml'
+require 'erb'
+
+module AppConfig
+  mattr_accessor :config_files_path, :default_config_file_path
+  
+  class << self
+    def reload!
+      set_default_paths if config_files_path.nil?
+    	@@config = AccessorProxy.new(load_config_file(default_config_file_path))
+
+      config_files.each do |config_file|
+    	  @@config.merge!(load_config_file(config_file))
+      end
+    end
+    
+    def [](key)
+      return @@config[key]
+    end
+    
+    def config_files
+      Dir[config_files_path.join('*appconfig.yml').to_s]
+    end
+    
+    def get(key)
+      return AppConfig[key]
+    end
+    
+    def load_config_file(file_path)
+      YAML::load(ERB.new((IO.read(file_path))).result).symbolize_keys
+    rescue Errno::ENOENT
+      {}
+    end
+    
+    def set_default_paths
+      self.config_files_path = ::Rails.root.join('config')
+      self.default_config_file_path = self.config_files_path.join('appconfig.defaults.yml')
+    end
+    
+    def method_missing(method, *args, &block)
+      @@config.send method, *args, &block
+    end
+  end
+end

data/lib/app_config/railtie.rb

@@ -0,0 +1,10 @@
+module AppConfig
+  class Railtie < Rails::Railtie
+    railtie_name :app_config
+    
+    initializer :load_app_config, :before => :load_application_initializers do |app|
+    end
+    
+    config.to_prepare { ::AppConfig.reload! }
+  end
+end

data/lib/app_config/version.rb

@@ -0,0 +1,9 @@
+module AppConfig
+  module VERSION
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/rails/init.rb

@@ -0,0 +1,9 @@
+# I know using rails/init.rb is deprecated, but it seems to be the only way to 
+# get Rails 2.x to actually treat the gem as a plugin and not a lazy-loadable library.
+# The checks are there just in case Rails 3 ever decides to pick it up.
+
+require 'app_config'
+if defined?(Rails) && Rails::VERSION::MAJOR == 2
+  ::AppConfig.reload!
+  ::ActionController::Dispatcher.to_prepare { ::AppConfig.reload! }
+end

data/spec/app_config_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe AppConfig do
+  before(:all) do
+    silence_warnings do
+      AppConfig.config_files_path = Pathname.new(File.join(File.dirname(__FILE__), 'fixtures'))
+      AppConfig.default_config_file_path = AppConfig.config_files_path.join('appconfig.defaults.yml')
+    end
+  end
+  
+  before(:each) do
+    AppConfig.reload!
+  end
+  
+  it 'should always load default config file first' do
+    # assume there are no other config files
+    AppConfig.stub!(:config_files).and_return([])
+    AppConfig.reload!
+    
+    {
+      %{AppConfig.domain} => 'unknown.com',
+      %{AppConfig.admin.name} => 'John Smith',
+      %{AppConfig.admin.email} => 'john.smith@unknown.com'
+    }.each_pair do |property, expected_value|
+      eval(property).should == expected_value
+    end
+  end
+  
+  it 'should override the default config with whatever is in *.appconfig.yml' do
+    AppConfig.domain.should == 'stillunknown.com'
+  end
+  
+  context 'when accessing first-level config keys' do
+    it 'should allow struct-like access to config keys' do
+      AppConfig.search_engines.should == %w{google.com yahoo.com bing.com}
+    end
+    
+    it 'should allow hash-like access to config keys' do
+      AppConfig[:search_engines].should == %w{google.com yahoo.com bing.com}
+      AppConfig['search_engines'].should == %w{google.com yahoo.com bing.com}
+    end
+  end
+  
+  context 'when accessing deeply nested config keys' do
+    it 'should allow struct-like access to config keys' do
+      AppConfig.admin.name.should == 'John Smith'
+    end
+    
+    it 'should allow hash-like access to config keys' do
+      AppConfig[:admin][:name].should == 'John Smith'
+      AppConfig['admin']['name'].should == 'John Smith'
+    end
+    
+    it 'should allow you to mix hash-like and struct-like syntax when accessing deeply nested config keys' do
+      AppConfig[:admin].name.should == 'John Smith'
+      AppConfig['admin'].name.should == 'John Smith'
+      AppConfig.admin[:name].should == 'John Smith'
+      AppConfig.admin['name'].should == 'John Smith'
+    end
+  end
+
+  it 'should behave like a hash' do
+    AppConfig.keys.should include(*%w{admin search_engines domain})
+  end
+  
+  it 'should allow you to pass an optional "value if key not found" parameter when using struct-like syntax' do
+    AppConfig.nonexistant_key('fallback').should == 'fallback'
+  end
+end

data/spec/fixtures/appconfig.defaults.yml

@@ -0,0 +1,10 @@
+admin:
+  name: John Smith
+  email: john.smith@unknown.com
+
+domain: unknown.com
+
+search_engines:
+  - google.com
+  - yahoo.com
+  - bing.com

data/spec/fixtures/overrides.appconfig.yml

@@ -0,0 +1 @@
+domain: stillunknown.com

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'active_support'
+require 'active_support/core_ext/kernel/reporting'
+
+require 'app_config'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: appconfig
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tisho Georgiev
+- Joshua Krall
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-25 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        version: "2.3"
+  type: :development
+  version_requirements: *id002
+description: Provides an OpenStruct/Hash-like syntax for accessing your app's configuration options, loaded from a YAML file. Supports multiple configuration files, nested configuration groups and fallback options.
+email: tihomir.georgiev@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- appconfig.gemspec
+- init.rb
+- lib/app_config.rb
+- lib/app_config/accessor_proxy.rb
+- lib/app_config/base.rb
+- lib/app_config/railtie.rb
+- lib/app_config/version.rb
+- rails/init.rb
+- spec/app_config_spec.rb
+- spec/fixtures/appconfig.defaults.yml
+- spec/fixtures/overrides.appconfig.yml
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/tisho/appconfig
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Provides an OpenStruct/Hash-like syntax for accessing your app's configuration options, loaded from a YAML file.
+test_files: 
+- spec/app_config_spec.rb
+- spec/spec_helper.rb