renee-render 0.1.1 → 0.2.0

data/README.md

@@ -5,7 +5,7 @@ Rendering templates in Renee should be familiar and intuitive using the `render`
 ```ruby
 run Renee::Core.new {
  path('blog') do
-   get { render! :haml, :"blogs/index" }
+   get { render! "blogs/index", :haml }
  end
 }
 ```

data/lib/renee-render/version.rb

@@ -1,5 +1,6 @@
 class Renee
   module Render
-    VERSION = "0.1.1"
+    # Current Renee-render version number.
+    VERSION = "0.2.0"
   end
 end

data/lib/renee-render.rb

@@ -1,108 +1,115 @@
 require 'tilt'
+require 'callsite'
 
+# Top-level Renee constant
 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
+    class TemplateNotFound < RuntimeError; end
 
     # Same as render but automatically halts.
     # @param  (see #render)
     # @return (see #render)
     # @see #render
-    def render!(*args, &blk)
-      halt render(*args, &blk)
+    def render!(file, engine = nil, options = nil, &blk)
+      halt render(file, engine, options, &blk)
+    end
+
+    # Same as inline but automatically halts.
+    # @param  (see #inline)
+    # @return (see #inline)
+    # @see #inline
+    def inline!(data, engine, options = {}, &blk)
+      options[:_caller] = Callsite.parse(caller.first)
+      halt inline(data, engine, options, &blk)
     end
 
+    ##
+    # Renders a file given the engine and the content.
+    #
+    # @param [String] file The path to the file to render
+    # @param [Symbol] engine The name of the engine to use to render the content. If this isn't specified
+    # it will be detected based on the extension of the file.
+    # @param [Hash] options The options to pass in for rendering.
+    #
+    # @return [String] The result of rendering the data with specified engine.
+    #
+    # @example
+    #  render "index", :haml   # => "<p>test</p>"
+    #  render "index"          # => "<p>test</p>"
+    #
+    # @api public
+    #
+    def render(file, engine = nil, options = nil, &block)
+      options, engine = engine, nil if engine.is_a?(Hash)
+      render_setup(engine, options, block) do |view_options, views|
+        template_cache.fetch(engine, file, view_options) do
+          file_path, found_engine = find_template(views, file, engine)
+          template = Tilt[found_engine]
+          raise TemplateNotFound, "Template engine not found: #{found_engine.inspect}" unless template
+          raise TemplateNotFound, "Template #{file.inspect} (with engine #{engine.inspect}) not found in #{views.inspect}!" unless file_path
+          # TODO suppress errors for layouts?
+          template.new(file_path, 1, view_options)
+        end
+      end
+    end # render
+
     ##
     # 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.
+    # @param [String] data The string data to render.
+    # @param [Symbol] engine The name of the engine to use to render the content. If this isn't specified
+    # it will be detected based on the extension of the file.
+    # @param [Hash] options The options to pass in for rendering.
     #
     # @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>"
+    #  inline "%p test", :haml # => "<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)
+    def inline(data, engine, options = nil, &block)
+      options, engine = engine, nil if engine.is_a?(Hash)
+      call_data = options.delete(:_caller) || Callsite.parse(caller.first)
+      render_setup(engine, options, block) do |view_options, views|
+        body = data.is_a?(Proc) ? data : Proc.new { data }
+        template = Tilt[engine]
+        raise "Template engine not found: #{engine}" if template.nil?
+        template.new(call_data.filename, call_data.line, view_options, &body)
+      end
+    end
 
+    private
+    def render_setup(engine, options, block)
       options                    ||= {}
       options[:outvar]           ||= '@_out_buf'
-      # TODO allow default encoding to be set (as an option)
-      options[:default_encoding] ||= "utf-8"
+      options[:default_encoding] ||= settings.default_encoding || options[: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
+      layout_engine  = options.delete(:layout_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)
+      template       = yield(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 }
+        render(layout, layout_engine, options.merge(:locals => locals)) { output }
+      else
+        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
+    end
 
     ##
     # Searches view paths for template based on data and engine with rendering options.

data/renee-render.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'rack', "~> 1.3.0"
   s.add_runtime_dependency 'tilt', "~> 1.3.3"
+  s.add_runtime_dependency 'callsite', '~> 0.0.6'
   s.add_development_dependency 'minitest', "~> 2.6.1"
   s.add_development_dependency 'rake'
   s.add_development_dependency 'bundler', "~> 1.0.10"

data/test/render_test.rb

@@ -6,9 +6,9 @@ describe Renee::Render do
 
     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" }) } }
+        path("/a") { get { inline! "<p>test</p>", :erb } }
+        path("/b") { get { inline! "<p><%= foo %></p>", :erb, :locals => { :foo => "bar" } } }
+        path("/c") { get { halt inline("<p><%= foo %></p>", :erb, :locals => { :foo => "bar" }) } }
       }
       get('/a')
       assert_equal 200, response.status
@@ -25,9 +25,9 @@ describe Renee::Render 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" }) } }
+        path("/a") { get { render! 'index', :haml } }
+        path("/b") { get { render! 'foo', :haml, :locals => { :foo => "bar" } } }
+        path("/c") { get { halt render('foo', :haml, :locals => { :foo => "bar" }) } }
       }
       get('/a')
       assert_equal 200, response.status
@@ -60,8 +60,8 @@ describe Renee::Render do
       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" } } }
+        path("/a") { get { render! 'index', :haml, :layout => :layout } }
+        path("/b") { get { render! 'foo', :layout => :layout, :locals => { :foo => "bar" } } }
       }
       get('/a')
       assert_equal 200, response.status
@@ -76,8 +76,8 @@ describe Renee::Render do
       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" } } }
+        path("/a") { get { render! 'index', :haml, :layout => 'base', :layout_engine => :erb } }
+        path("/b") { get { render! 'foo', :haml, :layout => 'base', :locals => { :foo => "bar" } } }
       }
       get('/a')
       assert_equal 200, response.status
@@ -102,13 +102,5 @@ describe Renee::Render do
       }
       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

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: renee-render
 version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: 
-  version: 0.1.1
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Josh Hull
@@ -12,85 +17,134 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-19 00:00:00 Z
+date: 2011-10-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rack
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  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
-  version_requirements: *id001
+  name: rack
 - !ruby/object:Gem::Dependency 
-  name: tilt
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  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
-  version_requirements: *id002
+  name: tilt
 - !ruby/object:Gem::Dependency 
-  name: minitest
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 0
+        - 6
+        version: 0.0.6
+  requirement: *id003
+  type: :runtime
+  prerelease: false
+  name: callsite
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 2
+        - 6
+        - 1
         version: 2.6.1
+  requirement: *id004
   type: :development
   prerelease: false
-  version_requirements: *id003
+  name: minitest
 - !ruby/object:Gem::Dependency 
-  name: rake
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
+  requirement: *id005
   type: :development
   prerelease: false
-  version_requirements: *id004
+  name: rake
 - !ruby/object:Gem::Dependency 
-  name: bundler
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 0
+        - 10
         version: 1.0.10
+  requirement: *id006
   type: :development
   prerelease: false
-  version_requirements: *id005
+  name: bundler
 - !ruby/object:Gem::Dependency 
-  name: rack-test
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 5
+        - 0
         version: 0.5.0
+  requirement: *id007
   type: :development
   prerelease: false
-  version_requirements: *id006
+  name: rack-test
 - !ruby/object:Gem::Dependency 
-  name: haml
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 2
+        - 0
         version: 2.2.0
+  requirement: *id008
   type: :development
   prerelease: false
-  version_requirements: *id007
+  name: haml
 description: The super-friendly web framework rendering component.
 email: 
 - joshbuddy@gmail.com
@@ -124,7 +178,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2087846859516822907
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -133,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2087846859516822907
+      hash: 3
       segments: 
       - 0
       version: "0"