konfig 0.2.0 → 0.3.0

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/konfig.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{konfig}
-  s.version = "0.2.0"
+  s.version = "0.3.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-28}
+  s.date = %q{2010-06-01}
   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 = [
@@ -24,8 +24,12 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "konfig.gemspec",
+     "lib/generators/konfig/USAGE",
+     "lib/generators/konfig/konfig_generator.rb",
+     "lib/generators/konfig/templates/konfig.tt",
      "lib/konfig.rb",
      "lib/konfig/adapter.rb",
+     "lib/konfig/child_class_manager.rb",
      "lib/konfig/evaluator.rb",
      "lib/konfig/helpers.rb",
      "lib/konfig/rails/adapters/asset_expansion_adapter.rb",
@@ -34,6 +38,7 @@ Gem::Specification.new do |s|
      "lib/konfig/store.rb",
      "test/fixtures/dynamic.yml",
      "test/fixtures/static.yml",
+     "test/fixtures/template.yml",
      "test/helper.rb",
      "test/test_adapter.rb",
      "test/test_evaluator.rb",

data/lib/generators/konfig/USAGE

@@ -0,0 +1,21 @@
+How to Use Konfig Generator 
+===========================
+
+This generator can be used to create Konfig files for a number
+of plugins, as well as internal rails settings like SMTP, Javascript
+Expansions, etc...
+
+Usage
+-----
+
+To generate a konfig template:
+
+  rails generate konfig [template_name]
+
+Example
+-------
+
+Here's how you would add some smtp settings
+
+  rails generate konfig smtp
+

data/lib/generators/konfig/konfig_generator.rb

@@ -0,0 +1,31 @@
+require 'rails/generators'
+
+class KonfigGenerator < Rails::Generators::Base
+
+  desc "Generates Konfig files"
+  argument :name, :type => :string, :required => false, :desc => "Name of konfig template"
+
+  def generate
+    self.name ? render_template : show_instructions
+  end
+
+  def self.source_root
+    @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+  end
+
+  private
+
+    def show_instructions
+      print File.read(File.join(File.dirname(__FILE__), 'USAGE'))
+    end
+
+    def render_template
+      if Konfig::Adapter.template_for(self.name).present?
+        template('konfig.tt', File.join(Konfig.path, "#{ self.name }.yml"))
+      else
+        print("Invalid Template Name: #{ self.name }\n") 
+      end
+    end
+
+end
+

data/lib/generators/konfig/templates/konfig.tt

@@ -0,0 +1,2 @@
+# <%= self.name %>.yml
+<%= Konfig::Adapter.template_for(self.name) %>

data/lib/konfig.rb

@@ -1,3 +1,4 @@
+require 'konfig/child_class_manager'
 require 'konfig/evaluator'
 require 'konfig/store'
 require 'konfig/adapter'

data/lib/konfig/adapter.rb

@@ -1,39 +1,76 @@
-
 module Konfig
 
+
   # All adapters are subclassed from Konfig::Adapter
   class Adapter
 
+    include ChildClassManager
+
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+    end
+
     class << self
 
-      def inherited(child_class)
-        children << child_class
+      def has_template(key, options = {})
+        if block_given?
+          content = yield
+        else
+          content = options[:file] && File.read(options[:file])
+          unless content
+            content = options[:content]
+            content = adjust_whitespace(content) unless options[:preserve_indentation]
+          end
+        end
+          
+        Adapter.templates[key] = content
+      end
+
+      def template_for(key)
+        Adapter.templates[key] 
       end
 
-      # Get all child classes
-      # @return [Array] an array of child classes
-      def children
-        @children ||= []
+      def templates
+        @templates ||= HashWithIndifferentAccess.new
       end
 
-      # Remove child classes from registry
-      def clear_children
-        @children = []
+      def adjust_whitespace(content)
+        content.gsub!(/\t/, "  ")
+        adjustment = content.lines.map { |l| l =~ /^( *)\S+$/; $1 && $1.size }.compact.min
+        content.lines.map { |l| l =~ /^[ ]{#{ adjustment }}(.*)$/; $1.to_s }.join("\n")
       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
+
+    protected
+
+
+      def ok(key)
+        data[key][:_status] = :ok
+        log("Loaded #{key}")
       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) }
+      def error(key)
+        data[key][:_status] = :error
+        log("Error Loading #{key}")
       end
 
+      def log(message)
+        m = "[Konfig] #{ message }"
+        defined?(Rails) ?  Rails.logger.info(m) : puts(m)
+        m
+      end
 
-    end
+      def using(key, options={})
+        if !data[key]
+          raise(log("Required Konfig key #{key} is missing")) if options[:required]
+          return
+        end
+
+        yield(data[key])
+        ok(key) unless data[key][:_status]
+      end
   end
 end

data/lib/konfig/child_class_manager.rb

@@ -0,0 +1,51 @@
+module Konfig
+
+  # Provides tools for keeping track of a Class's descendents
+  
+  module ChildClassManager
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+
+      # Should not be called directly.
+      def inherited(child_class)
+        child_classes << child_class
+      end
+
+      # Get all child classes
+      # @return [Array] an array of child classes
+      def child_classes
+        @child_classes ||= []
+      end
+
+      # Remove child classes from registry
+      def clear_child_classes
+        @child_classes = []
+      end
+
+      # Instanciates all child classes
+      # @return [Array] Instances of all child classes
+      def create_child_instances(*params)
+        @child_instances = child_classes.map { |c| c.new(*params) }
+      end
+
+      # Invoke 'send' on all child instances
+      # @param params Parameters for 'send'
+      def send_to_child_instances(*params)
+        @child_instances.each { |c| c.send(*params) }
+      end
+
+      # Instanciates all child classes
+      # @return [Array] Instances of all child classes
+      def child_instances
+        @child_instances || []
+      end
+
+    end
+
+  end
+
+end

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

@@ -1,22 +1,15 @@
 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 adapt
+      using(:_javascript_expansions) do |data|
+        ActionView::Helpers::AssetTagHelper.register_javascript_expansion(data)
+      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"
+      using(:_stylesheet_expansions) do |data|
+        ActionView::Helpers::AssetTagHelper.register_stylesheet_expansion(data)
+      end
     end
+
   end
 end

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

@@ -1,14 +1,42 @@
 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
+
+    def adapt
+      using(:_smtp) do |data|
+        ActionMailer::Base.smtp_settings = data[Rails.env]
       end
     end
+
+    # TODO: Implement something like this
+    # configures :smtp do |data|
+      # ActionMailer::Base.smtp_settings = data[Rails.env]
+    # end
+
+    has_template :smtp, :content => %[
+
+      # SMTP Configuration
+      # For more information: http://guides.rails.info/action_mailer_basics.html
+
+      development:
+        enable_starttls_auto: true
+        address: smtp.gmail.com
+        port: 587
+        domain: example.com
+        authentication: :login
+        user_name: example@example.com
+        password: password
+
+      production:
+        enable_starttls_auto: true
+        address: smtp.gmail.com
+        port: 587
+        domain: example.com
+        authentication: :login
+        user_name: example@example.com
+        password: password
+
+      test:
+    ]
+
   end
 end

data/lib/konfig/rails/railtie.rb

@@ -38,7 +38,8 @@ module Konfig
         require_all user_adapters
 
         # Apply the adapters to the data
-        Adapter.create_and_send_to_children :adapt, Konfig.default_store.data
+        Adapter.create_child_instances(Konfig.default_store.data)
+        Adapter.send_to_child_instances :adapt
       end
 
       def require_all(path)

data/test/fixtures/template.yml

@@ -0,0 +1,5 @@
+- this
+- is 
+- a
+- sample
+- template

data/test/test_adapter.rb

@@ -2,10 +2,10 @@ require 'helper'
 
 class TestEvaluator < Test::Unit::TestCase
 
-  Konfig::Adapter.clear_children
-
   context "Adapter with two subclasses" do
 
+    Konfig::Adapter.clear_child_classes
+
     setup do
 
       class FirstAdapter < Konfig::Adapter
@@ -32,29 +32,81 @@ class TestEvaluator < Test::Unit::TestCase
     end
 
     should "have two registered subclasses" do
-      assert_equal 2, Konfig::Adapter.children.size
+      assert_equal 2, Konfig::Adapter.child_classes.size
     end
 
     should "have the correct subclasses in registry" do
-      assert_equal FirstAdapter, Konfig::Adapter.children[0]
-      assert_equal SecondAdapter, Konfig::Adapter.children[1]
+      assert_equal FirstAdapter, Konfig::Adapter.child_classes[0]
+      assert_equal SecondAdapter, Konfig::Adapter.child_classes[1]
     end
 
     should "not have bleed over to child classes" do
-      assert_equal 0, FirstAdapter.children.size
-      assert_equal 0, SecondAdapter.children.size
+      assert_equal 0, FirstAdapter.child_classes.size
+      assert_equal 0, SecondAdapter.child_classes.size
+    end
+
+    context "and create_childeren called" do 
+      setup do
+        @data = { :a => 1, :b => 2 }
+        @child_instances = Konfig::Adapter.create_child_instances(@data)
+      end
+
+      should "create 2 instances" do
+        assert_equal 2, @child_instances.size
+      end
+
+      should "make instances available through accessor" do
+        assert_equal @child_instances, Konfig::Adapter.child_instances
+      end
+
+      should "create the correct instances" do
+        assert @child_instances[0].is_a?(FirstAdapter)
+        assert @child_instances[1].is_a?(SecondAdapter)
+      end
+
+      should "assign the correct data to child instances" do
+        assert_equal @data, @child_instances[0].data
+        assert_equal @data, @child_instances[1].data
+      end
+
+      should "be able to send method calls to chld instances" do
+        r = []
+        Konfig::Adapter.send_to_child_instances(:instance_append, r)
+        assert_equal [9, 8], r
+      end
+
+    end
+
+  end
+
+  context "User adapter with 3 templates" do
+
+    setup do
+
+      class TemplateAdapter < Konfig::Adapter
+        has_template :inline, :content => "inline"
+        has_template :file, :file => "./test/fixtures/template.yml"
+        has_template :block do
+          "block"
+        end
+      end
+
+    end
+
+    should "register 3 templates" do
+      assert_equal 3, Konfig::Adapter.templates.size
+    end
+
+    should "return correct value for inline template" do
+      assert_equal "inline", Konfig::Adapter.templates[:inline]
     end
 
-    should "be able to send method calls to children" do
-      values = []
-      Konfig::Adapter.send_to_children(:append, values)
-      assert_equal [2, 4], values
+    should "return correct value for file template" do
+      assert_equal File.read("./test/fixtures/template.yml"), Konfig::Adapter.templates[:file]
     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
+    should "return correct value for block template" do
+      assert_equal "block", Konfig::Adapter.templates[:block]
     end
 
   end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Starr Horne
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-28 00:00:00 -05:00
+date: 2010-06-01 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,8 +46,12 @@ files:
 - Rakefile
 - VERSION
 - konfig.gemspec
+- lib/generators/konfig/USAGE
+- lib/generators/konfig/konfig_generator.rb
+- lib/generators/konfig/templates/konfig.tt
 - lib/konfig.rb
 - lib/konfig/adapter.rb
+- lib/konfig/child_class_manager.rb
 - lib/konfig/evaluator.rb
 - lib/konfig/helpers.rb
 - lib/konfig/rails/adapters/asset_expansion_adapter.rb
@@ -56,6 +60,7 @@ files:
 - lib/konfig/store.rb
 - test/fixtures/dynamic.yml
 - test/fixtures/static.yml
+- test/fixtures/template.yml
 - test/helper.rb
 - test/test_adapter.rb
 - test/test_evaluator.rb