konfig 0.1.1 → 0.2.0

data/README.rdoc

@@ -13,7 +13,7 @@ Konfig gives you a better, easier way to manage these config files.
 
 It works like this:
 
-  > mkidr ./config/settings
+  > mkdir ./config/settings
   > cat "bar: baz" > ./config/settings/foo.yml
   > rails console
 
@@ -44,7 +44,7 @@ This code has access to all of the data in the template.
 
   one: 1
   two: 2
-  one_plus_two: << data[:one] + data[:two]
+  one_plus_two: `data[:one] + data[:two]`
 
 == Helpers
 
@@ -59,7 +59,7 @@ You can also access helper methods in your embedded code.
     - ["Blue", "#0000ff"]
 
   # This returns {"#ff0000" => "Red", ...etc }
-  color_names: << names_by_value(:colors)
+  color_names: `names_by_value(:colors)`
 
 
 == Rails 3

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/konfig.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{konfig}
-  s.version = "0.1.1"
+  s.version = "0.2.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.date = %q{2010-05-28}
   s.description = %q{ Automatically loads yaml config files and makes them available to your rails app.}
   s.email = %q{starr@chromahq.com}
   s.extra_rdoc_files = [
@@ -25,13 +25,17 @@ Gem::Specification.new do |s|
      "VERSION",
      "konfig.gemspec",
      "lib/konfig.rb",
+     "lib/konfig/adapter.rb",
      "lib/konfig/evaluator.rb",
      "lib/konfig/helpers.rb",
-     "lib/konfig/railtie.rb",
+     "lib/konfig/rails/adapters/asset_expansion_adapter.rb",
+     "lib/konfig/rails/adapters/smtp_adapter.rb",
+     "lib/konfig/rails/railtie.rb",
      "lib/konfig/store.rb",
      "test/fixtures/dynamic.yml",
      "test/fixtures/static.yml",
      "test/helper.rb",
+     "test/test_adapter.rb",
      "test/test_evaluator.rb",
      "test/test_konfig.rb",
      "test/test_store.rb"
@@ -43,6 +47,7 @@ Gem::Specification.new do |s|
   s.summary = %q{Yaml config file manager for rails 3 apps}
   s.test_files = [
     "test/helper.rb",
+     "test/test_adapter.rb",
      "test/test_evaluator.rb",
      "test/test_konfig.rb",
      "test/test_store.rb"

data/lib/konfig.rb

@@ -1,8 +1,9 @@
 require 'konfig/evaluator'
 require 'konfig/store'
+require 'konfig/adapter'
 
 if defined?(::Rails::Railtie)
-  require 'konfig/railtie'
+  require 'konfig/rails/railtie'
 end
 
 # Provides a global accessor for configuration. 
@@ -29,4 +30,8 @@ module Konfig
     (@default_store || self).inspect
   end
 
+  def self.default_store
+    @default_store
+  end
+
 end

data/lib/konfig/adapter.rb

@@ -0,0 +1,39 @@
+
+module Konfig
+
+  # All adapters are subclassed from Konfig::Adapter
+  class Adapter
+
+    class << self
+
+      def inherited(child_class)
+        children << child_class
+      end
+
+      # Get all child classes
+      # @return [Array] an array of child classes
+      def children
+        @children ||= []
+      end
+
+      # Remove child classes from registry
+      def clear_children
+        @children = []
+      end
+
+      # Evokes the send method on all child classes, 
+      # and passes the args along
+      def send_to_children(*args)
+        children.each { |c| c.send(*args) }
+      end
+
+      # Instanciates all child classes and envokes
+      # a method via obj.send
+      def create_and_send_to_children(*args)
+        children.each { |c| c.new.send(*args) }
+      end
+
+
+    end
+  end
+end

data/lib/konfig/rails/adapters/asset_expansion_adapter.rb

@@ -0,0 +1,22 @@
+module Konfig
+  class AssetExpansionAdapter < Adapter
+    def adapt(data)
+      javascripts(data)
+      stylesheets(data)
+    end
+
+    def javascripts(data)
+      return unless (d = data[:_javascript_expansions])
+      ActionView::Helpers::AssetTagHelper.register_javascript_expansion(d)
+      c = d[:_adapted] = true
+      Rails.logger.info "[Konfig] Loaded javascript expansions"
+    end
+
+    def stylesheets(data)
+      return unless (d = data[:_stylesheet_expansions])
+      ActionView::Helpers::AssetTagHelper.register_stylesheet_expansion(d)
+      c = d[:_adapted] = true
+      Rails.logger.info "[Konfig] Loaded stylesheet expansions"
+    end
+  end
+end

data/lib/konfig/rails/adapters/smtp_adapter.rb

@@ -0,0 +1,14 @@
+module Konfig
+  class SmtpAdapter < Adapter
+    def adapt(data)
+      begin
+        c = data[:_smtp][Rails.env]
+        ActionMailer::Base.smtp_settings = c.symbolize_keys
+
+        c = data[:_smtp][:_adapted] = true
+        Rails.logger.info "[Konfig] Loaded SMTP setting"
+      rescue
+      end
+    end
+  end
+end

data/lib/konfig/rails/railtie.rb

@@ -0,0 +1,49 @@
+require 'konfig'
+require 'rails'
+
+
+module Konfig
+
+  # @return [String] returns the path where config files are located
+  def self.path
+    @path = File.join(Rails.root, "config", "settings")
+  end
+
+  class InitializeKonfig < Rails::Railtie
+    initializer "initialize_konfig.configure_rails_initialization" do
+
+      path = Konfig.path
+
+      if File.directory?(path)
+        load_settings(path)
+      else
+        Rails.logger.warn "[Konfig Warning] Unable to access #{ path }. Please make sure the directory exists and has the correct permissions."
+      end
+    end
+
+    private
+
+      # Set up the Konfig system
+      # @param [String] path the path to the directory containing config files
+      def load_settings(path)
+
+        # Load the data files
+        Konfig.load_directory(path)
+
+        # Load all adapters
+        built_in_adapters = File.join(File.dirname(__FILE__), 'adapters', '*.rb')
+        require_all built_in_adapters
+
+        user_adapters = File.join(path, 'adapters', '*_adapter.rb')
+        require_all user_adapters
+
+        # Apply the adapters to the data
+        Adapter.create_and_send_to_children :adapt, Konfig.default_store.data
+      end
+
+      def require_all(path)
+        Dir[path].each { |file| require file }
+      end
+
+  end
+end

data/lib/konfig/store.rb

@@ -46,13 +46,17 @@ module Konfig
       @data.inspect
     end
 
+    def data
+      @data
+    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/
+          elsif v.is_a?(String) && v.strip =~ /\A`(.*)`\z/
             piece[k] = evaluator.run($1)
           end
         end

data/test/fixtures/dynamic.yml

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

data/test/test_adapter.rb

@@ -0,0 +1,63 @@
+require 'helper'
+
+class TestEvaluator < Test::Unit::TestCase
+
+  Konfig::Adapter.clear_children
+
+  context "Adapter with two subclasses" do
+
+    setup do
+
+      class FirstAdapter < Konfig::Adapter
+
+        def instance_append(value)
+          value << 9
+        end
+
+        def self.append(value)
+          value << 2
+        end
+      end
+
+      class SecondAdapter < Konfig::Adapter
+
+        def instance_append(value)
+          value << 8
+        end
+
+        def self.append(value)
+          value << 4
+        end
+      end
+    end
+
+    should "have two registered subclasses" do
+      assert_equal 2, Konfig::Adapter.children.size
+    end
+
+    should "have the correct subclasses in registry" do
+      assert_equal FirstAdapter, Konfig::Adapter.children[0]
+      assert_equal SecondAdapter, Konfig::Adapter.children[1]
+    end
+
+    should "not have bleed over to child classes" do
+      assert_equal 0, FirstAdapter.children.size
+      assert_equal 0, SecondAdapter.children.size
+    end
+
+    should "be able to send method calls to children" do
+      values = []
+      Konfig::Adapter.send_to_children(:append, values)
+      assert_equal [2, 4], values
+    end
+
+    should "be able to instanciate all children, and send" do
+      values = []
+      Konfig::Adapter.create_and_send_to_children(:instance_append, values)
+      assert_equal [9, 8], values
+    end
+
+  end
+
+end
+

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Starr Horne
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-27 00:00:00 -05:00
+date: 2010-05-28 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,13 +47,17 @@ files:
 - VERSION
 - konfig.gemspec
 - lib/konfig.rb
+- lib/konfig/adapter.rb
 - lib/konfig/evaluator.rb
 - lib/konfig/helpers.rb
-- lib/konfig/railtie.rb
+- lib/konfig/rails/adapters/asset_expansion_adapter.rb
+- lib/konfig/rails/adapters/smtp_adapter.rb
+- lib/konfig/rails/railtie.rb
 - lib/konfig/store.rb
 - test/fixtures/dynamic.yml
 - test/fixtures/static.yml
 - test/helper.rb
+- test/test_adapter.rb
 - test/test_evaluator.rb
 - test/test_konfig.rb
 - test/test_store.rb
@@ -89,6 +93,7 @@ specification_version: 3
 summary: Yaml config file manager for rails 3 apps
 test_files: 
 - test/helper.rb
+- test/test_adapter.rb
 - test/test_evaluator.rb
 - test/test_konfig.rb
 - test/test_store.rb

data/lib/konfig/railtie.rb

@@ -1,19 +0,0 @@
-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