konfig 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+.yardoc

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Starr Horne
+
+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,43 @@
+= konfig: Config file management for rails apps
+
+Every app needs to store seldom-changing data like facebook access keys, or 
+SMTP settings, or Authorize.net credentials.
+
+Usually, you just stick it in an intializer. Or if you're feeling really 
+sassy, you might make a yml file and create an initializer to load it.
+It's kind of a pain, and it's kind of messy.
+
+Konfig gives you a better, easier way to manage these config files.
+
+== Overview
+
+It works like this:
+
+  > mkidr ./config/settings
+  > cat "bar: baz" > ./config/settings/foo.yml
+  > rails console
+
+  irb(main):001:0> Konfig[:foo][:bar]
+
+  => "baz"
+
+
+Konfig automagically loads all .yml files in the 
+RAILS_ROOT/config/settings directory. It makes them
+accessible via the Konfig module. ie. Konfig[:filename][:key]
+
+Note: Konfig only works with Rails 3
+
+== 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 Starr Horne. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "konfig"
+    gem.summary = %Q{Configuration manager for rails apps}
+    gem.description = %Q{So you need to store some static config values in your app? Konfig does that.}
+    gem.email = "starr@chromahq.com"
+    gem.homepage = "http://github.com/starrhorne/konfig"
+    gem.authors = ["Starr Horne"]
+    gem.add_development_dependency "shoulda", ">= 0"
+    # 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 '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|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "konfig #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/konfig.gemspec

@@ -0,0 +1,64 @@
+# 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{konfig}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Starr Horne"]
+  s.date = %q{2010-05-27}
+  s.description = %q{So you need to store some static config values in your app? Konfig does that.}
+  s.email = %q{starr@chromahq.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "konfig.gemspec",
+     "lib/konfig.rb",
+     "lib/konfig/evaluator.rb",
+     "lib/konfig/helpers.rb",
+     "lib/konfig/railtie.rb",
+     "lib/konfig/store.rb",
+     "test/fixtures/dynamic.yml",
+     "test/fixtures/static.yml",
+     "test/helper.rb",
+     "test/test_evaluator.rb",
+     "test/test_konfig.rb",
+     "test/test_store.rb"
+  ]
+  s.homepage = %q{http://github.com/starrhorne/konfig}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Configuration manager for rails apps}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_evaluator.rb",
+     "test/test_konfig.rb",
+     "test/test_store.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<shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+  end
+end
+

data/lib/konfig.rb

@@ -0,0 +1,32 @@
+require 'konfig/evaluator'
+require 'konfig/store'
+
+if defined?(::Rails::Railtie)
+  require 'konfig/railtie'
+end
+
+# Provides a global accessor for configuration. 
+# ie. Konfig[:some_key]
+module Konfig
+
+  # Creates a default store and loads a directory into it
+  # @param [String] path path to a directory with yml files
+  def self.load_directory(path)
+    @default_store ||= Konfig::Store.new
+    @default_store.load_directory(path)
+  end
+
+  # Hash-style access to data
+  # @param [String, Symbol] key
+  def self.[](key)
+    if !@default_store
+      raise "Konfig default store not set. Call Konfig.load(path) to set one."
+    end
+    @default_store[key]
+  end
+
+  def self.inspect
+    (@default_store || self).inspect
+  end
+
+end

data/lib/konfig/evaluator.rb

@@ -0,0 +1,32 @@
+module Konfig
+
+  # Used by Konfig::Store to evaluate inline code pulled from
+  # configuration files.
+  class Evaluator
+
+    attr_accessor :data
+
+    # Set up the evaluator
+    # @param [Hash] data data to be available inline code
+    def initialize(data)
+      @data = data
+    end
+
+    # Runs a code fragment
+    # @param [String] code some valid ruby code
+    # @return the results of the eval
+    def run(code)
+      eval(code, binding)
+    end
+
+    # Converts an options-style nested array into a hash
+    # for easy name lookup
+    # @param [Array] a an array like [['name', 'val']]
+    # @return [Hash] a hash like { val => name }
+    def names_by_value(a)
+      a = @data[a] if a.is_a?(String) || a.is_a?(Symbol)
+      Hash[ a.map { |i| i.reverse } ]
+    end
+
+  end
+end

data/lib/konfig/helpers.rb

@@ -0,0 +1,8 @@
+module Konfig
+  module Helpers
+    def names_for(a)
+      p "!!!!!"
+      a.reverse_hash
+    end
+  end
+end

data/lib/konfig/railtie.rb

@@ -0,0 +1,19 @@
+require 'konfig'
+require 'rails'
+
+module Konfig
+  class InitializeKonfig < Rails::Railtie
+    initializer "initialize_konfig.configure_rails_initialization" do
+
+      path = File.join(Rails.root, "config", "settings")
+      Konfig.load_directory(path)
+
+      begin
+        c = Konfig[:email][:smtp][Rails.env]
+        ActionMailer::Base.smtp_settings = c.symbolize_keys
+      rescue
+      end
+
+    end
+  end
+end

data/lib/konfig/store.rb

@@ -0,0 +1,65 @@
+require 'active_support/hash_with_indifferent_access'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'yaml'
+
+module Konfig
+
+  class Store
+
+    def initialize
+      @data = HashWithIndifferentAccess.new
+    end
+
+    # Loads all yml files in a directory into this store
+    # Will not recurse into subdirectories.
+    # @param [String] path to directory
+    def load_directory(path)
+
+      unless File.directory?(path)
+        raise "Konfig couldn't load because it was unable to access #{ path }. Please make sure the directory exists and has the correct permissions."
+      end
+
+      Dir[File.join(path, "*.yml")].each { |f| load_file(f) }
+    end
+
+    # Loads a single yml file into the store
+    # @param [String] path to file
+    def load_file(path)
+      d = YAML.load_file(path)
+
+      if d.is_a?(Hash) 
+        d = HashWithIndifferentAccess.new(d)
+        e = Evaluator.new(d)
+        d = process(d, e)
+      end
+
+      @data[File.basename(path, ".yml").downcase] = d
+    end
+
+    # Hash-style access to data
+    # @param [String, Symbol] key
+    def [](key)
+      @data[key]
+    end
+
+    def inspect
+      @data.inspect
+    end
+
+    protected 
+
+      def process(piece, evaluator)
+        piece.each do |k, v|
+          if v.is_a?(Hash)
+            piece[k] = process(v, evaluator) 
+          elsif v.is_a?(String) && v.strip =~ /\A<<(.*)\z/
+            piece[k] = evaluator.run($1)
+          end
+        end
+        piece
+      end
+
+
+  end
+
+end

data/test/fixtures/dynamic.yml

@@ -0,0 +1,8 @@
+one_plus_one: << 1 + 1
+five: 5
+six: 6
+five_times_six: << data[:five] * data['six']
+
+parent:
+  child: 5
+  child_plus_one: << data[:parent][:child] + 1

data/test/fixtures/static.yml

@@ -0,0 +1,6 @@
+one: 1
+two: 2
+three:
+  - a
+  - b
+  - c

data/test/helper.rb

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

data/test/test_evaluator.rb

@@ -0,0 +1,37 @@
+require 'helper'
+
+class TestEvaluator < Test::Unit::TestCase
+
+  context "an evaluator with simple data" do
+    setup do
+      @data = { :a => 1, :b => 2 }
+      @evaluator = Konfig::Evaluator.new(@data)
+    end
+
+    should "evaluate" do
+      assert_equal 4, @evaluator.run("2+2")
+    end
+
+    should "have access to data" do
+      assert_equal @data[:a], @evaluator.run("data[:a]")
+    end
+
+  end
+
+  context "names_by_value helper" do
+    setup do
+      @data = { :options => [["name", "val"], ["name2", "val2"]] }
+      @evaluator = Konfig::Evaluator.new(@data)
+    end
+
+    should "work when given key" do
+      assert_equal({"val" => "name", "val2" => "name2"}, @evaluator.run("names_by_value(:options)"))
+    end
+
+    should "work when given an array" do
+      assert_equal({"val" => "name", "val2" => "name2"}, @evaluator.run("names_by_value(data[:options])"))
+    end
+
+  end
+
+end

data/test/test_konfig.rb

@@ -0,0 +1,27 @@
+require 'helper'
+require 'yaml'
+
+class TestKonfig < Test::Unit::TestCase
+
+  context "no store loaded" do
+
+    should "raise an exception on access" do
+      assert_raises(RuntimeError) { Konfig[:some_key] }
+    end
+
+  end
+
+  context "store loaded" do
+
+    setup do
+      Konfig.load_directory("./test/fixtures")
+    end
+
+    should "load all files" do
+      assert Konfig[:static]
+      assert Konfig[:dynamic]
+    end
+
+  end
+
+end

data/test/test_store.rb

@@ -0,0 +1,75 @@
+require 'helper'
+require 'yaml'
+
+class TestStore < Test::Unit::TestCase
+
+  context "an empty store" do
+
+    setup do
+      @store = Konfig::Store.new
+    end
+
+    should "return nil from store[key]" do
+      assert_nil @store[:some_key]
+    end
+
+    should "return an empty string on inspect" do
+      assert_equal "{}", @store.inspect
+    end
+
+    context "with static.yml file loaded" do 
+
+      setup do
+        @store.load_file("./test/fixtures/static.yml")
+        @static = YAML.load_file("./test/fixtures/static.yml")
+      end
+
+      should "have key named static" do
+        assert @store[:static]
+      end
+
+      should "have correct_values" do
+        assert_equal @static, @store[:static]
+      end
+
+    end
+
+    context "with dynamic.yml file loaded" do 
+
+      setup do
+        @store.load_file("./test/fixtures/dynamic.yml")
+      end
+
+      should "evaluate code" do
+        assert_equal 2, @store[:dynamic][:one_plus_one]
+      end
+
+      should "be able to reference itself" do
+        assert_equal 5, @store[:dynamic][:five]
+        assert_equal 6, @store[:dynamic][:six]
+        assert_equal 5*6, @store[:dynamic][:five_times_six]
+      end
+
+      should "be able to reference nested attributes" do
+        assert_equal 5, @store[:dynamic][:parent][:child]
+        assert_equal 5+1, @store[:dynamic][:parent][:child_plus_one]
+      end
+
+    end
+
+    context "with directory loaded" do 
+      setup do
+        @store.load_directory("./test/fixtures")
+      end
+
+      should "load all files" do
+        assert @store[:static]
+        assert @store[:dynamic]
+      end
+
+    end
+
+  end
+
+
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: konfig
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Starr Horne
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-27 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: So you need to store some static config values in your app? Konfig does that.
+email: starr@chromahq.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- konfig.gemspec
+- lib/konfig.rb
+- lib/konfig/evaluator.rb
+- lib/konfig/helpers.rb
+- lib/konfig/railtie.rb
+- lib/konfig/store.rb
+- test/fixtures/dynamic.yml
+- test/fixtures/static.yml
+- test/helper.rb
+- test/test_evaluator.rb
+- test/test_konfig.rb
+- test/test_store.rb
+has_rdoc: true
+homepage: http://github.com/starrhorne/konfig
+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: Configuration manager for rails apps
+test_files: 
+- test/helper.rb
+- test/test_evaluator.rb
+- test/test_konfig.rb
+- test/test_store.rb