renee-render 0.0.1

data/README.md

@@ -0,0 +1,38 @@
+# Renee Render
+
+Rendering templates in Renee should be familiar and intuitive using the `render` command:
+
+```ruby
+run Renee::Core.new {
+ path('blog') do
+   get { render! :haml, :"blogs/index" }
+ end
+}
+```
+
+This above is the standard render syntax, specifying the engine followed by the template. You can also render without specifying an engine:
+
+```ruby
+path('blog') do
+  get { render! "blogs/index" }
+end
+```
+
+This will do a lookup in the views path to find the appropriately named template. You can also pass locals and layout options as you would expect:
+
+```ruby
+path('blog') do
+  get { render! "blogs/index", :locals => { :foo => "bar" }, :layout => :bar }
+end
+```
+
+This will render the "blogs/index.erb" file if it exists, passing the 'foo' local variable
+and wrapping the result in the 'bar.erb' layout file. You can also render without returning the response by using:
+
+```ruby
+path('blog') do
+  get { render "blogs/index" }
+end
+```
+
+This allows you to render the content as a string without immediately responding.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList[File.expand_path('../test/**/*_test.rb', __FILE__)]
+  t.verbose = true
+end

data/lib/renee-render/version.rb

@@ -0,0 +1,6 @@
+class Renee
+  module Render
+    # The version for the renee-render gem.
+    VERSION = "0.0.1"
+  end
+end

data/lib/renee-render.rb

@@ -0,0 +1,136 @@
+require 'tilt'
+
+class Renee
+  # This module is responsible for handling the rendering of templates
+  # using Tilt supporting all included template engines.
+  module Render
+    ##
+    # Exception responsible for when a generic rendering error occurs.
+    #
+    class RenderError < RuntimeError; end
+
+    ##
+    # Exception responsible for when an expected template does not exist.
+    #
+    class TemplateNotFound < RenderError; end
+
+    # Same as render but automatically halts.
+    # @param  (see #render)
+    # @return (see #render)
+    # @see #render
+    def render!(*args, &blk)
+      halt render(*args, &blk)
+    end
+
+    ##
+    # Renders a string given the engine and the content.
+    #
+    # @param [Symbol] engine The template engine to use for rendering.
+    # @param [String] data The content or file to render.
+    # @param [Hash] options The rendering options to pass onto tilt.
+    #
+    # @return [String] The result of rendering the data with specified engine.
+    #
+    # @example
+    #  render :haml, "%p test" => "<p>test</p>"
+    #  render :haml, :index => "<p>test</p>"
+    #  render "index" => "<p>test</p>"
+    #
+    # @api public
+    #
+    def render(engine, data=nil, options={}, &block)
+      # Handles the case where engine is unspecified by shifting the data (i.e render "index")
+      engine, data, options = nil, engine.to_sym, data if data.nil? || data.is_a?(Hash)
+
+      options                    ||= {}
+      options[:outvar]           ||= '@_out_buf'
+      # TODO allow default encoding to be set (as an option)
+      options[:default_encoding] ||= "utf-8"
+
+      locals         = options.delete(:locals) || {}
+      views          = options.delete(:views)  || settings.views_path || "./views"
+      layout         = options.delete(:layout)
+      layout_engine  = options.delete(:layout_engine) || engine
+      # TODO suppress template errors for layouts?
+      # TODO allow content_type to be set with an option to render?
+      scope          = options.delete(:scope) || self
+
+      # TODO default layout file convention?
+      template       = compile_template(engine, data, options, views)
+      output         = template.render(scope, locals, &block)
+
+      if layout # render layout
+        # TODO handle when layout is missing better!
+        options = options.merge(:views => views, :layout => false, :scope => scope)
+        return render(layout_engine, layout, options.merge(:locals => locals)) { output }
+      end
+
+      output
+    end # render
+
+    ##
+    # Constructs a template based on engine, data and options.
+    #
+    # @param [Symbol] engine The template engine to use for rendering.
+    # @param [String] data The content or file to render.
+    # @param [Hash] options The rendering options to pass onto tilt.
+    # @param [String] views The view_path from which to locate the template.
+    #
+    # @return [Tilt::Template] The tilt template to render with all required options.
+    # @raise  [TemplateNotFound] The template to render could not be located.
+    # @raise  [RenderError] The template to render could not be located.
+    #
+    # @api private
+    #
+    def compile_template(engine, data, options, views)
+      template_cache.fetch engine, data, options do
+        if data.is_a?(Symbol) # data is template path
+          file_path, engine = find_template(views, data, engine)
+          template = Tilt[engine]
+          raise TemplateNotFound, "Template engine not found: #{engine}" if template.nil?
+          raise TemplateNotFound, "Template '#{data}' not found in '#{views}'!"  unless file_path
+          # TODO suppress errors for layouts?
+          template.new(file_path, 1, options)
+        elsif data.is_a?(String) # data is body string
+          # TODO figure out path based on caller file
+          path, line  = options[:path] || "caller file", options[:line] || 1
+          body = data.is_a?(String) ? Proc.new { data } : data
+          template = Tilt[engine]
+          raise "Template engine not found: #{engine}" if template.nil?
+          template.new(path, line.to_i, options, &body)
+        else # data can't be handled
+          raise RenderError, "Cannot render data #{data.inspect}."
+        end
+      end # template_cache.fetch
+    end # compile_template
+
+    ##
+    # Searches view paths for template based on data and engine with rendering options.
+    # Supports finding a template without an engine.
+    #
+    # @param [String] views The view paths
+    # @param [String] name The name of the template
+    # @param [Symbol] engine The engine to use for rendering.
+    #
+    # @return [<String, Symbol>] An array of the file path and the engine.
+    #
+    # @example
+    #  find_template("./views", "index", :erb) => ["path/to/index.erb", :erb]
+    #  find_template("./views", "foo")         => ["path/to/index.haml", :haml]
+    #
+    # @api private
+    #
+    def find_template(views, name, engine=nil)
+      lookup_ext = (engine || File.extname(name.to_s)[1..-1] || "*").to_s
+      base_name = name.to_s.chomp(".#{lookup_ext}")
+      file_path = Dir[File.join(views, "#{base_name}.#{lookup_ext}")].first
+      engine ||= File.extname(file_path)[1..-1].to_sym if file_path
+      [file_path, engine]
+    end # find_template
+
+    # Maintain Tilt::Cache of the templates.
+    def template_cache
+      @template_cache ||= Tilt::Cache.new
+    end
+  end
+end

data/renee-render.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "renee-render/version"
+
+Gem::Specification.new do |s|
+  s.name        = "renee-render"
+  s.version     = Renee::Render::VERSION
+  s.authors     = ["Josh Hull", "Nathan Esquenazi", "Arthur Chiu"]
+  s.email       = ["joshbuddy@gmail.com", "nesquena@gmail.com", "mr.arthur.chiu@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{The super-friendly web framework rendering component}
+  s.description = %q{The super-friendly web framework rendering component.}
+
+  s.rubyforge_project = "renee"
+
+  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"]
+
+  s.add_runtime_dependency 'rack', "~> 1.3.0"
+  s.add_runtime_dependency 'tilt', "~> 1.3.3"
+  s.add_development_dependency 'minitest', "~> 2.6.1"
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'bundler', "~> 1.0.10"
+  s.add_development_dependency "rack-test", ">= 0.5.0"
+  s.add_development_dependency "haml", ">= 2.2.0"
+end

data/test/render_test.rb

@@ -0,0 +1,114 @@
+require File.expand_path('../test_helper', __FILE__)
+
+describe Renee::Render do
+  describe "#render" do
+    after  { remove_views }
+
+    it "should allow rendering string with engine" do
+      mock_app {
+        path("/a") { get { render! :erb, "<p>test</p>" } }
+        path("/b") { get { render! :erb, "<p><%= foo %></p>", :locals => { :foo => "bar" } } }
+        path("/c") { get { halt render(:erb, "<p><%= foo %></p>", :locals => { :foo => "bar" }) } }
+      }
+      get('/a')
+      assert_equal 200, response.status
+      assert_equal "<p>test</p>", response.body
+      get('/b')
+      assert_equal 200, response.status
+      assert_equal "<p>bar</p>", response.body
+      get('/c')
+      assert_equal 200, response.status
+      assert_equal "<p>bar</p>", response.body
+    end # string, with engine
+
+    it "should allow rendering template file with engine" do
+      create_view :index, "%p test", :haml
+      create_view :foo,   "%p= foo", :haml
+      mock_app {
+        path("/a") { get { render! :haml, :index } }
+        path("/b") { get { render! :haml, :foo, :locals => { :foo => "bar" } } }
+        path("/c") { get { halt render(:haml, :foo, :locals => { :foo => "bar" }) } }
+      }
+      get('/a')
+      assert_equal 200, response.status
+      assert_equal "<p>test</p>\n", response.body
+      get('/b')
+      assert_equal 200, response.status
+      assert_equal "<p>bar</p>\n", response.body
+      get('/c')
+      assert_equal 200, response.status
+      assert_equal "<p>bar</p>\n", response.body
+    end # template, with engine
+
+    it "should allow rendering template file with unspecified engine" do
+      create_view :index, "%p test", :haml
+      create_view :foo,   "%p= foo", :haml
+      mock_app {
+        path("/a") { get { render! "index" } }
+        path("/b") { get { render! "foo.haml", :locals => { :foo => "bar" } } }
+      }
+      get('/a')
+      assert_equal 200, response.status
+      assert_equal "<p>test</p>\n", response.body
+      get('/b')
+      assert_equal 200, response.status
+      assert_equal "<p>bar</p>\n", response.body
+    end # template, unspecified engine
+
+    it "should allow rendering template file with engine and layout" do
+      create_view :index, "%p test", :haml
+      create_view :foo,   "%p= foo", :haml
+      create_view :layout, "%div.wrapper= yield", :haml
+      mock_app {
+        path("/a") { get { render! :haml, :index, :layout => :layout } }
+        path("/b") { get { render! :foo, :layout => :layout, :locals => { :foo => "bar" } } }
+      }
+      get('/a')
+      assert_equal 200, response.status
+      assert_equal %Q{<div class='wrapper'><p>test</p></div>\n}, response.body
+      get('/b')
+      assert_equal 200, response.status
+      assert_equal %Q{<div class='wrapper'><p>bar</p></div>\n}, response.body
+    end # with engine and layout specified
+
+    it "should allow rendering template with different layout engines" do
+      create_view :index, "%p test", :haml
+      create_view :foo,   "%p= foo", :haml
+      create_view :base, "<div class='wrapper'><%= yield %></div>", :erb
+      mock_app {
+        path("/a") { get { render! :haml, :index, :layout => :base, :layout_engine => :erb } }
+        path("/b") { get { render! :foo, :layout => :base, :locals => { :foo => "bar" } } }
+      }
+      get('/a')
+      assert_equal 200, response.status
+      assert_equal %Q{<div class='wrapper'><p>test</p>\n</div>}, response.body
+      get('/b')
+      assert_equal 200, response.status
+      assert_equal %Q{<div class='wrapper'><p>bar</p>\n</div>}, response.body
+    end # different layout and template engines
+
+    it "should fail properly rendering template file with invalid engine" do
+      create_view :index, "%p test", :haml
+      mock_app {
+        get { render! :fake, :index }
+      }
+      assert_raises(Renee::Render::TemplateNotFound) { get('/') }
+    end # template, invalid engine
+
+    it "should fail properly rendering missing template file with engine" do
+      create_view :index, "%p test", :haml
+      mock_app {
+        get { render! :haml, :foo }
+      }
+      assert_raises(Renee::Render::TemplateNotFound) { get('/') }
+    end # missing template, with engine
+
+    it "should fail properly rendering invalid data" do
+      create_view :index, "%p test", :haml
+      mock_app {
+        get { render! :haml, /invalid regex data/ }
+      }
+      assert_raises(Renee::Render::RenderError) { get('/') }
+    end # missing template, with engine
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+$: << File.expand_path('../../../renee-core/lib', __FILE__)
+$: << File.expand_path('../../lib', __FILE__)
+require 'renee-core'
+require 'renee-render'
+
+# TODO better registration method (?)
+Renee::Core::Application.send(:include, Renee::Render)
+
+# Load shared test helpers
+require File.expand_path('../../../lib/test_helper', __FILE__)

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification 
+name: renee-render
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Josh Hull
+- Nathan Esquenazi
+- Arthur Chiu
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-15 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  requirement: *id001
+  type: :runtime
+  prerelease: false
+  name: rack
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 1
+        - 3
+        - 3
+        version: 1.3.3
+  requirement: *id002
+  type: :runtime
+  prerelease: false
+  name: tilt
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 2
+        - 6
+        - 1
+        version: 2.6.1
+  requirement: *id003
+  type: :development
+  prerelease: false
+  name: minitest
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+  type: :development
+  prerelease: false
+  name: rake
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 0
+        - 10
+        version: 1.0.10
+  requirement: *id005
+  type: :development
+  prerelease: false
+  name: bundler
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 5
+        - 0
+        version: 0.5.0
+  requirement: *id006
+  type: :development
+  prerelease: false
+  name: rack-test
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 2
+        - 0
+        version: 2.2.0
+  requirement: *id007
+  type: :development
+  prerelease: false
+  name: haml
+description: The super-friendly web framework rendering component.
+email: 
+- joshbuddy@gmail.com
+- nesquena@gmail.com
+- mr.arthur.chiu@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- Rakefile
+- lib/renee-render.rb
+- lib/renee-render/version.rb
+- renee-render.gemspec
+- test/render_test.rb
+- test/test_helper.rb
+homepage: ""
+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: renee
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: The super-friendly web framework rendering component
+test_files: 
+- test/render_test.rb
+- test/test_helper.rb