templette 0.3.2 → 0.4.0

data/lib/tasks/templette_tasks.rb

@@ -7,6 +7,29 @@ task(:build) do
   end
 end
 
+desc "Build and view the site locally using WEBrick"
+task(:preview) do
+  gen = Templette::Generator.new('preview')
+  gen.run
+  
+  require 'webrick'
+  
+  server = WEBrick::HTTPServer.new(
+    :BindAddress     =>    "localhost",
+    :Port            =>    4444,
+    :DocumentRoot    =>    'preview/'
+  )
+  
+  %w(INT).each do |signal|
+    trap(signal) { 
+      server.shutdown 
+      gen.clean
+    }
+  end
+  
+  server.start
+end
+
 desc "Remove all generated files"
 task :clean do
   Templette::Generator.new.clean

data/lib/templette.rb

@@ -1,5 +1,5 @@
 %w{erb yaml fileutils}.each {|lib| require lib}
 
-%w{data_accessors errors generator method_collector page template}.each do |file|
-  require File.dirname(__FILE__) +"/templette/#{file}"
+%w{data_accessors errors generator method_collector page template engineer}.each do |file|
+  require File.dirname(__FILE__) + "/templette/#{file}"
 end

data/lib/templette/engineer.rb

@@ -0,0 +1,40 @@
+module Templette
+
+  # The engineer is simply in charge of the engines.
+  #
+  # Additional templating languages can be supported by adding a class in the Templette::Engines
+  # module which implements render(html, the_binding) in the templates/engines/ folder.  Name
+  # the class the same as the 'type' for the template.
+  
+  module Engineer
+    
+    ENGINES_DIR = File.dirname(__FILE__) + "/engines/"
+    
+    @@engines = {}
+    
+    # Takes a string type and attempts to load a rendering engine of the same name.
+    # If the Engine is found, an instance of the class will be returned.
+    # A failure to find a matching engine file will result in a RenderError.
+    
+    def self.engine_for(type)
+      load_engine(type)
+    end
+    
+    private 
+    
+      def self.load_engine(type)        
+        unless @@engines[type]
+          unless File.exists?(ENGINES_DIR + type + '.rb')
+            raise RenderError.new("Rendering engine '#{type}' is not supported!")
+          end
+          begin
+            require ENGINES_DIR + type
+            @@engines[type] = Templette::Engines.const_get(type.capitalize)
+          rescue
+            raise RenderError.new("Rendering engine '#{type}' failed to load!")
+          end
+        end
+        @@engines[type].new
+      end
+  end
+end

data/lib/templette/engines/erb.rb

@@ -0,0 +1,11 @@
+module Templette
+  module Engines
+    class Erb
+    
+      def render(html, the_binding)
+        ERB.new(html, 0, "%<>").result(the_binding)
+      end
+      
+    end
+  end
+end

data/lib/templette/engines/haml.rb

@@ -0,0 +1,13 @@
+require 'haml'
+
+module Templette
+  module Engines
+    class Haml
+    
+      def render(html, the_binding)
+        ::Haml::Engine.new(html).render(the_binding)
+      end
+    
+    end
+  end
+end

data/lib/templette/errors.rb

@@ -17,4 +17,7 @@ module Templette
   class PageError < TempletteError  # :nodoc:
   end
   
+  class RenderError < StandardError; # :nodoc:
+  end
+  
 end

data/lib/templette/method_collector.rb

@@ -10,7 +10,7 @@ module Templette
       @methods = {}
       if template
         include_helpers(template.helpers)
-        ERB.new(template.to_html, 0, "%<>").result(binding)
+        template.render(binding)
       end
     end    
   

data/lib/templette/page.rb

@@ -1,88 +1,88 @@
-module Templette
-
-  # The Page is the core object of a Templette project.  Pages won't get generate
-  # unless there are available .yml files to build out the necessary info.
-  #
-  # A general Page yaml structure example:
-  #
-  #     template_name: main
-  #     sections:
-  #       title: Page Title
-  #       nav:
-  #         active-class: foo
-  #         title: Foo!
-  #
-  # The <tt>template_name</tt> will be used to load a template.
-  #
-  # Everything in <tt>sections</tt> will be made available as methods in the template when
-  # it's evaluated by ERB.  Yaml hash items nested within others will be loaded into nested
-  # objects.  To call the nav title, the template should call <tt>nav.title</tt>.
-  
-  class Page
-
-    include Templette::DataAccessors
-    attr_reader :name, :template
-    
-    class <<self
-      def pages_dir
-        @@pages_dir ||= 'pages'
-      end
-      
-      def pages_dir=(path)
-        @@pages_dir = path
-      end
-  
-      # Grabs all of the yaml files found in /pages, and loads them as
-      # Page objects.
-      def find_all
-        Dir["#{pages_dir}/**/*.yml"].map {|f| new f }
-      end
-    end
-  
-    def initialize(page_config)
-      raise PageError.new(self, "missing page #{page_config}") unless File.exists?(page_config)
-
-      data = YAML::load_file(page_config)
-      @name = page_config.dup
-      @name.slice!(self.class.pages_dir + '/')
-      @name.chomp!('.yml')
-      raise PageError.new(self, "missing required section \"template_name\" for page config #{page_config}") unless data['template_name']
-      @template = Template.new(data['template_name'])
-
-      raise PageError.new(self, "missing sections in yml for page config #{page_config}") unless data['sections']
-      generate_accessors(data['sections'])
-      include_helpers(template.helpers)
-    end
-  
-    def generate(out_dir)
-      generate_subdirectory(out_dir)
-      File.open(output_file_name(out_dir), 'w') do |f| 
-        f << ERB.new(@template.to_html, 0, "%<>").result(binding)
-      end
-    end
-
-    # A requriement of the Templette::DataAccessors interface.  Returns self.
-    def page; self end
-    
-    private
-
-      def output_file_name(out_dir)
-        "#{out_dir}/#{@name}.html"
-      end
-    
-      def generate_subdirectory(out_dir)
-        FileUtils.mkdir_p(File.expand_path("#{out_dir}/" + name.chomp(File.basename(name)))) if name.index('/')
-      end
-      
-      class Section # :nodoc:
-        include Templette::DataAccessors
-        attr_reader :page
-      
-        def initialize(page, hash={})
-          @page = page
-          generate_accessors(hash)
-        end
-      
-      end 
-  end
-end
+module Templette
+
+  # The Page is the core object of a Templette project.  Pages won't get generate
+  # unless there are available .yml files to build out the necessary info.
+  #
+  # A general Page yaml structure example:
+  #
+  #     template_name: main
+  #     sections:
+  #       title: Page Title
+  #       nav:
+  #         active-class: foo
+  #         title: Foo!
+  #
+  # The <tt>template_name</tt> will be used to load a template.
+  #
+  # Everything in <tt>sections</tt> will be made available as methods in the template when
+  # it's evaluated by ERB.  Yaml hash items nested within others will be loaded into nested
+  # objects.  To call the nav title, the template should call <tt>nav.title</tt>.
+  
+  class Page
+
+    include Templette::DataAccessors
+    attr_reader :name, :template
+    
+    class <<self
+      def pages_dir
+        @@pages_dir ||= 'pages'
+      end
+      
+      def pages_dir=(path)
+        @@pages_dir = path
+      end
+  
+      # Grabs all of the yaml files found in /pages, and loads them as
+      # Page objects.
+      def find_all
+        Dir["#{pages_dir}/**/*.yml"].map {|f| new f }
+      end
+    end
+  
+    def initialize(page_config)
+      raise PageError.new(self, "missing page #{page_config}") unless File.exists?(page_config)
+
+      data = YAML::load_file(page_config)
+      @name = page_config.dup
+      @name.slice!(self.class.pages_dir + '/')
+      @name.chomp!('.yml')
+      raise PageError.new(self, "missing required section \"template_name\" for page config #{page_config}") unless data['template_name']
+      @template = Template.new(data['template_name'])
+
+      raise PageError.new(self, "missing sections in yml for page config #{page_config}") unless data['sections']
+      generate_accessors(data['sections'])
+      include_helpers(template.helpers)
+    end
+  
+    def generate(out_dir)
+      generate_subdirectory(out_dir)
+      File.open(output_file_name(out_dir), 'w') do |f| 
+        f << @template.render(binding)
+      end
+    end
+
+    # A requriement of the Templette::DataAccessors interface.  Returns self.
+    def page; self end
+    
+    private
+
+      def output_file_name(out_dir)
+        "#{out_dir}/#{@name}.html"
+      end
+    
+      def generate_subdirectory(out_dir)
+        FileUtils.mkdir_p(File.expand_path("#{out_dir}/" + name.chomp(File.basename(name)))) if name.index('/')
+      end
+      
+      class Section # :nodoc:
+        include Templette::DataAccessors
+        attr_reader :page
+      
+        def initialize(page, hash={})
+          @page = page
+          generate_accessors(hash)
+        end
+      
+      end 
+  end
+end

data/lib/templette/template.rb

@@ -2,9 +2,15 @@ module Templette
   # The Template acts as a layout for pages.  It contains an html layout for the
   # page and contains method calls which are answered by helper methods or the 
   # loaded yaml of a page.
+  #
+  # Templates now support ERB or Haml for rendering.  
+  # * template.html.haml   
+  # * template.html.erb   
+  # * template.html  -> defaults to ERB 
 
   class Template
     TEMPLATE_DIR = 'templates' unless defined?(TEMPLATE_DIR)
+    
     attr_accessor :name
     
     # The name parameter refers to the actual filename of the template.  To load
@@ -12,11 +18,6 @@ module Templette
     def initialize(name)
       @name = name      
     end
-  
-    def to_html
-      raise TemplateError.new(self, "Template rendering failed.  File not found.") unless File.exists?(path)
-      File.read(path)
-    end
     
     # Generates the yaml necessary to render empty page yaml files.
     def to_yaml
@@ -27,10 +28,28 @@ module Templette
     def helpers
       ["default_helper","#{name}_helper"]
     end
+    
+    # Generates the final HTML.
+    def render(the_binding)
+      raise TemplateError.new(self, "Template rendering failed.  File not found.") unless File.exists?(path)
+      Engineer.engine_for(type).render(to_html, the_binding)
+    rescue RenderError => e
+      raise TemplateError.new(self, e.message)
+    end
 
     private
+
       def path
-        "#{TEMPLATE_DIR}/#{@name}.html"
+        Dir["#{TEMPLATE_DIR}/#{@name}.html*"].first || ''
       end
+      
+      def type
+        path.match(/html\.?(\w+)?/)[1] || 'erb'
+      end      
+      
+      def to_html
+        File.read(path)
+      end    
+      
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: templette
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors: 
 - Jacob Dunphy and Steve Holder
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-29 00:00:00 -07:00
+date: 2009-02-04 00:00:00 -08:00
 default_executable: templette
 dependencies: []
 
@@ -25,6 +25,9 @@ files:
 - lib/file_generator.rb
 - lib/tasks/templette_tasks.rb
 - lib/templette/data_accessors.rb
+- lib/templette/engineer.rb
+- lib/templette/engines/erb.rb
+- lib/templette/engines/haml.rb
 - lib/templette/errors.rb
 - lib/templette/generator.rb
 - lib/templette/method_collector.rb
@@ -59,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: templette
-rubygems_version: 1.2.0
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: HTML site generation through templates