yappconfig 0.2.0

data/.document

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+
+# Gems required for this gem
+gem "hashie"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler"
+  gem "jeweler", "~> 1.8.3"
+  gem "simplecov"
+
+  gem "rails"
+end

data/Gemfile.lock

@@ -0,0 +1,111 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.3)
+      actionpack (= 3.2.3)
+      mail (~> 2.4.4)
+    actionpack (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.2)
+    activemodel (3.2.3)
+      activesupport (= 3.2.3)
+      builder (~> 3.0.0)
+    activerecord (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+    activesupport (3.2.3)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    git (1.2.5)
+    hashie (1.2.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    journey (1.0.3)
+    json (1.6.6)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.18)
+    multi_json (1.2.0)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.2.3)
+      actionmailer (= 3.2.3)
+      actionpack (= 3.2.3)
+      activerecord (= 3.2.3)
+      activeresource (= 3.2.3)
+      activesupport (= 3.2.3)
+      bundler (~> 1.0)
+      railties (= 3.2.3)
+    railties (3.2.3)
+      actionpack (= 3.2.3)
+      activesupport (= 3.2.3)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    simplecov (0.6.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    sprockets (2.1.2)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  hashie
+  jeweler (~> 1.8.3)
+  rails
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 David Somers <jalada@gmail.com>
+
+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,102 @@
+# yappconfig
+
+A clean way to use a YAML file for configuration.
+
+## Configuring
+
+In Rails, yappconfig should Just Work™. For everything else you can configure it
+using a `configure` block: 
+
+    AppConfig.configure do |config|
+      config.config_file = "/path/to/config" # Default in Rails app is config/config.yml.
+      config.environment = "production" # Multi-stage config files, default none.
+      config.auto_reload = false # Defaults to true.
+    end
+
+## Accessing configuration settings
+
+Once configured you can use yappconfig throughout your app by accessing your
+configuration through the `AppConfig` constant. For example:
+
+    # config/config.yml
+    twitter:
+      access_token: "MY_TWITTER_TOKEN"
+
+    # In your app
+    AppConfig.twitter.access_token
+    # => "MY_TWITTER_TOKEN"
+
+You can also access it through other constants: `APP_CONFIG`, `YappConfig` and
+`YAPP_CONFIG`. Whichever you prefer :).
+
+## Sample configuration files
+
+yappconfig supports single stage and multi-stage files. In Rails it will expect
+a multi-stage file where the stages correspond with your Rails environment
+variable. It will also expect the configuration file to be in
+`config/config.yml` in the root of your application.
+
+### Single stage example
+
+    simple_config: "is simple"
+    nested_config:
+      is_nested: true
+
+### Multi-stage example
+
+Here, every stage inherits from defaults and then configurations can be
+overriden.
+
+    defaults: &defaults
+    
+      multistage_config: "is clever"
+    
+    development:
+      <<: *defaults
+    
+    production:
+      <<: *defaults
+      
+      multistage_config: "is very clever"
+
+Watch out for this:
+
+    defaults: &defaults
+      
+      server:
+        host: localhost
+        port: 6789
+    
+    production:
+      <<: *defaults
+      
+      server:
+        host: production-box
+        # port is now unset!
+
+That is, by overriding `server` all nested values have been 'deleted' because
+it has been overridden with a new hash. In this example, you would have to
+explicitly set `port` again in production. For this reason, it's probably best
+to avoid too much nesting...
+
+
+## Contributing to yappconfig
+ 
+* Check out the latest master to make sure the feature hasn't been implemented
+  or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it
+  and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to
+  have your own version, or is otherwise necessary, that is fine, but please
+  isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2012 David Somers <jalada@gmail.com>. See LICENSE.txt for further
+details.
+

data/Rakefile

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "yappconfig"
+  gem.homepage = "http://github.com/jalada/yappconfig"
+  gem.license = "MIT"
+  gem.summary = %Q{An application config, best for Rails apps}
+  gem.description = %Q{yappconfig provides your application with a global configuration based on the environment. The configuration is loaded in from YAML. It has sensible defaults for Rails applications}
+  gem.email = "jalada@gmail.com"
+  gem.authors = ["David Somers"]
+
+  gem.files.exclude 'spec/dummy'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "yappconfig #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/app-config/railtie.rb

@@ -0,0 +1,15 @@
+require 'rails'
+
+module AppConfig
+  class Railtie < Rails::Railtie
+
+    initializer "app-config.configure_for_rails" do
+      AppConfig.configure do |config|
+        config.config_file = Rails.root.join("config", "config.yml")
+        config.environment = Rails.env
+        config.auto_reload = true if Rails.env == "development"
+      end
+    end
+  end
+
+end

data/lib/app-config.rb

@@ -0,0 +1,98 @@
+require 'app-config/railtie' if defined?(Rails)
+require 'erb'
+
+# Public: Application Configuration singleton. Config is stored within as 
+# a class
+module AppConfig
+
+  # Private: Standard error.
+  class Error < StandardError; end
+
+  # Private: Actual configuration class. A new one of these is created whenever
+  # AppConfig is configured.
+  class Config
+    require 'hashie'
+
+    # Private: Initialize the class with a filename and environment (optional).
+    # Takes a hash of options.
+    #
+    # filename - configuration filename. Must exist.
+    # environment - optional, environment to pick in the configuration file.
+    #
+    # Returns the new config.
+    def initialize(options)
+      @options = options
+      yaml = YAML.load(ERB.new(IO.read @options.config_file).result)
+      yaml = yaml[@options.environment] if @options.environment
+      @config = Hashie::Mash.new yaml
+      @last_mtime = File.mtime @options.config_file
+      @config
+    end
+
+    # Private: Override method_missing to access the config object. If the file
+    # has been modified and auto_reload is set to true, re-run initialize.
+    #
+    # Returns the result of applying the method to the config object.
+    def method_missing(method, *args, &block)
+      if @options.auto_reload and @last_mtime != File.mtime(@options.config_file)
+        initialize @options
+      end
+      @config.__send__(method, *args, &block)
+    end
+
+  end
+
+  # Create a configuration attribute
+  class << self
+    attr_accessor :configuration
+  end
+
+  # Public: Configure AppConfig. Note that repeated calls to configure will
+  # reset all configuration and clear the existing config class. Therefore you 
+  # need to configure AppConfig all in one go, or alternatively access
+  # configuration parameters directly e.g. AppConfig.configuration.config_file
+  #
+  # Yields to the provided block, then sets defaults on top.
+  def self.configure(&block)
+    self.configuration = Configuration.new
+    @klass = nil
+    yield(configuration)
+    self.configuration.defaults
+  end
+
+  # Private: Holds the configuration.
+  class Configuration
+    attr_accessor :environment
+    attr_accessor :config_file
+    attr_accessor :auto_reload
+
+    # Private: Set default configuration values that haven't been set by
+    # the user
+    def defaults
+      @auto_reload ||= @environment == "production" ? false : true
+    end
+
+    def config_file=(filename)
+      raise Error, "File does not exist or is not a file: #{filename}" unless File.file? filename
+      @config_file = filename
+    end
+  end
+
+  def self.method_missing(method, *args, &block)
+    if @klass || self.configuration.config_file
+      @klass ||= Config.new(self.configuration)
+      @klass.__send__(method, *args, &block)
+    else
+      raise Error, "Please set a config_file with AppConfig.configure first"
+    end
+  end
+
+  # Default configuration
+  configure {}
+
+end
+
+# Alias for old applications
+APP_CONFIG = AppConfig
+# Alias for people who like to yap.
+YappConfig = YAPP_CONFIG = AppConfig

data/lib/yappconfig.rb

@@ -0,0 +1 @@
+require 'app-config'

data/spec/app-config/rails_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+ENV["RAILS_ENV"] ||= "test"
+require File.expand_path("../../dummy/config/environment.rb",  __FILE__)
+
+require 'app-config/railtie'
+
+describe "AppConfig with Rails" do
+
+  before :each do 
+    AppConfig::Railtie.initializers.map{|i| i.run}
+  end
+
+  it "Should default to the Rails environment" do
+    AppConfig.configuration.environment.should == Rails.env
+  end
+
+  it "Should default to Rails.root/config/config.yml" do
+    AppConfig.configuration.config_file.should == Rails.root.join("config/config.yml")
+  end
+
+  it "Auto reloads if the Rails environment is development" do
+    Rails.env = "development"
+    AppConfig::Railtie.initializers.map{|i| i.run}
+    AppConfig.configuration.auto_reload.should == true
+  end
+
+  it "Doesn't auto-reload if the Rails environment is production" do
+    Rails.env = "production"
+    AppConfig::Railtie.initializers.map{|i| i.run}
+    AppConfig.configuration.auto_reload.should_not == true
+  end
+
+
+end

data/spec/app-config_spec.rb

@@ -0,0 +1,87 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "AppConfig" do
+
+
+  it "Should be accessible through APP_CONFIG too" do
+    APP_CONFIG.should == AppConfig
+  end
+
+  it "Should set a config file" do
+    AppConfig.configure do |config|
+      config.config_file = config_file("test.yml")
+    end
+    AppConfig.configuration.config_file.should == config_file("test.yml")
+  end
+
+  it "Should set an environment" do
+    AppConfig.configure do |config|
+      config.environment = "production"
+    end
+    AppConfig.configuration.environment.should == "production"
+  end
+
+  it "Should raise an exception if config is accessed without setting a file" do
+    expect { AppConfig.random_method }.to raise_error(AppConfig::Error, /Please set/)
+  end
+
+  it "Should default to autoreload" do
+    AppConfig.configuration.auto_reload.should == true
+  end
+
+  describe "accessing the config" do
+    describe "Single stage configuration" do
+      before :each do
+        AppConfig.configure do |config|
+          config.config_file = config_file("single_stage.yml")
+        end
+      end
+
+      it "Should work" do
+        AppConfig.simple_config.should == "is simple"
+      end
+    end
+
+    before :each do
+      AppConfig.configure do |config|
+        config.config_file = config_file("test.yml")
+        config.environment = "development"
+      end
+    end
+
+    it "Should support dot notation" do
+      AppConfig.test_key.should == "value"
+    end
+
+    it "Should support square bracket notation" do
+      AppConfig[:test_key].should == "value"
+    end
+
+    describe "With auto-reload" do
+      before :all do
+        @original = File.read config_file("reloader.yml")
+      end
+
+      after :each do
+        f = File.open(config_file("reloader.yml"), "w")
+        f.write @original
+        f.close
+      end
+
+      before :each do
+        AppConfig.configure do |config|
+          config.config_file = config_file("reloader.yml")
+          config.auto_reload = true
+        end
+      end
+
+      it "Should auto_reload on file change" do
+        AppConfig.test_key.should == 1
+        f = File.open(config_file("reloader.yml"), "w")
+        f.write(@original.gsub(/1/, "2"))
+        f.close
+        AppConfig.test_key.should == 2
+      end
+    end
+  end
+end

data/spec/config/reloader.yml

@@ -0,0 +1 @@
+:test_key: 1

data/spec/config/single_stage.yml

@@ -0,0 +1 @@
+:simple_config: "is simple"

data/spec/config/test.yml

@@ -0,0 +1,6 @@
+defaults: &defaults
+
+  :test_key: "value"
+
+development:
+  <<: *defaults

data/spec/dummy/.gitignore

@@ -0,0 +1,15 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/spec/dummy/Gemfile

@@ -0,0 +1,38 @@
+source 'https://rubygems.org'
+
+gem 'rails', '3.2.3'
+
+# Bundle edge Rails instead:
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+gem 'sqlite3'
+
+
+# Gems used only for assets and not required
+# in production environments by default.
+group :assets do
+  gem 'sass-rails',   '~> 3.2.3'
+  gem 'coffee-rails', '~> 3.2.1'
+
+  # See https://github.com/sstephenson/execjs#readme for more supported runtimes
+  # gem 'therubyracer', :platform => :ruby
+
+  gem 'uglifier', '>= 1.0.3'
+end
+
+gem 'jquery-rails'
+
+# To use ActiveModel has_secure_password
+# gem 'bcrypt-ruby', '~> 3.0.0'
+
+# To use Jbuilder templates for JSON
+# gem 'jbuilder'
+
+# Use unicorn as the app server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger
+# gem 'ruby-debug19', :require => 'ruby-debug'