tarot 0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+gemspec
+gem 'rspec'

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2011 Chris Heald
+
+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,62 @@
+# Tarot
+
+Tarot is a quick, simple, and useful configuration manager for Rails applications. It supports easy-to-use deeply-nested configuration trees, default values, and multiple environments. Tarot leverages YAML to enable DRY configurations, and features I18n-style access to subtrees.
+
+## Getting Started
+
+Add Tarot to your gemfile:
+
+    gem "tarot"
+
+Next, install the Tarot configuration:
+
+    bundle install
+    script/generate tarot
+
+This installs config/tarot.yml (your primary configuration), and an initializer to help you get up and running quickly.
+
+## Usage
+
+Tarot installs a helper method, `config`, with the following signature:
+
+    config(path, default = nil, override_environment = nil)
+
+Assuming you have a config file like so:
+
+    ---
+    base: &base
+      foo: bar
+      nested:
+        tree: value
+      array:
+        - value 1
+        - value 2
+
+    development: &development
+      <<: *base
+
+    test: &test
+      <<: *base
+
+    production: &production
+      <<: *base
+      foo: baz
+
+You could can access values by key, or by dot-delimited path:
+
+    config('foo') => 'bar'
+    config('nested.tree') => value
+
+Default values are similarly easy.
+
+    config('foo.missing', 42) => 42
+
+Finally, while Tarot will read your current application environment's config, if you want to reach into another environment, that's likewise easy:
+
+    config('foo', nil, 'production') => 'baz'
+
+This lets you build out config files easily while sharing common configuration between environments.
+
+## Credits
+ 
+Tarot was written by Chris Heald (cheald@gmail.com). See LICENSE for license details.

data/Rakefile

@@ -0,0 +1,3 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')

data/generators/tarot_generator.rb

@@ -0,0 +1,12 @@
+require "rails_generator"
+
+module Tarot
+  class TarotGenerator < Rails::Generator::Base
+    def manifest
+      record do |m|
+        m.file 'initializer.rb', 'config/initializers/tarot.rb'
+        m.file 'config.yml', 'config/tarot.yml'
+      end
+    end    
+  end
+end

data/generators/templates/config.yml

@@ -0,0 +1,18 @@
+---
+
+base: &base
+  foo: bar
+  nested:
+    tree: value
+  array:
+    - value 1
+    - value 2
+
+development: &development
+  <<: *base
+
+test: &test
+  <<: *base
+
+production: &production
+  <<: *base

data/generators/templates/initializer.rb

@@ -0,0 +1,4 @@
+TAROT = Tarot::Config.new(File.join(Rails.root, "config", "tarot.yml"), Rails.env)
+def config *args
+  TAROT.get *args
+end

data/lib/tarot.rb

@@ -0,0 +1,19 @@
+require "tarot/version"
+require "active_support/core_ext"
+
+module Tarot
+  class Config
+    attr_accessor :config_file, :yaml, :env
+    def initialize(file, env)
+      @config_file = file
+      @yaml = YAML::load(File.open(file).read.untaint).stringify_keys!
+      @config_cache = {}
+      @env = env
+    end
+    
+    def get(key, default = nil, env = @env)
+      @config_cache[env] ||= {}
+      @config_cache[env][key] ||= key.split('.').inject(@yaml[env || @env]) {|e, part| e.try(:[], part) } || default
+    end
+  end
+end

data/lib/tarot/version.rb

@@ -0,0 +1,3 @@
+module Tarot
+  VERSION = "0.1"
+end

data/spec/data/test.yml

@@ -0,0 +1,12 @@
+---
+development: &development
+  foo: bar
+  fizz: buzz
+  nested:
+    tree:
+      with:
+        value: 42
+
+production: &production
+  <<: *development
+  fizz: bang

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'tarot'
+
+RSpec.configure do |config|
+end

data/spec/tarot_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Tarot do
+  before :all do
+    @tarot = Tarot::Config.new("spec/data/test.yml", "development")
+  end
+
+  it "should load a YAML file" do
+    @tarot.should_not == nil
+    @tarot.yaml.should be_a(Hash)
+  end
+
+  it "should accept a default value for a key" do
+    @tarot.get("bad key").should == nil
+    @tarot.get("bad key", "with default").should == "with default"
+  end  
+
+  it "should walk a nested tree" do
+    @tarot.get( "nested.tree.with.value" ).should == 42
+    @tarot.get( "nested.tree.with.bad.key" ).should == nil
+  end
+
+  it "should accept an override environment" do
+    @tarot.get("fizz").should == "buzz"
+    @tarot.get("fizz", nil, "production").should == "bang"
+  end
+end

data/tarot.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "tarot/version"
+
+Gem::Specification.new do |s|
+  s.name        = "tarot"
+  s.version     = Tarot::VERSION
+  s.authors     = ["Chris Heald"]
+  s.email       = ["cheald@gmail.com"]
+  s.homepage    = "http://coffeepowered.net"
+  s.summary     = %q{Tarot is a small, concise configuration library for Rails apps.}
+  s.description = %q{Tarot is a small, concise configuration library for Rails apps.}
+
+  s.add_dependency('activesupport')
+
+  s.rubyforge_project = "tarot"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: tarot
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Chris Heald
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-28 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Tarot is a small, concise configuration library for Rails apps.
+email: 
+- cheald@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- generators/tarot_generator.rb
+- generators/templates/config.yml
+- generators/templates/initializer.rb
+- lib/tarot.rb
+- lib/tarot/version.rb
+- spec/data/test.yml
+- spec/spec_helper.rb
+- spec/tarot_spec.rb
+- tarot.gemspec
+has_rdoc: true
+homepage: http://coffeepowered.net
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: tarot
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Tarot is a small, concise configuration library for Rails apps.
+test_files: 
+- spec/data/test.yml
+- spec/spec_helper.rb
+- spec/tarot_spec.rb