roger 1.4.6 → 1.5.0

data/lib/roger/template/helpers/rendering.rb

@@ -0,0 +1,15 @@
+module Roger
+  class Template
+    module Helpers
+      # The partial helper
+      module Rendering
+        # Render any file on disk
+        #
+        # @see Renderer#render_file
+        def render_file(path, options = {})
+          renderer.render_file(path, options)
+        end
+      end
+    end
+  end
+end

data/lib/roger/template/template_context.rb

@@ -1,5 +1,6 @@
 require File.dirname(__FILE__) + "/helpers/capture"
 require File.dirname(__FILE__) + "/helpers/partial"
+require File.dirname(__FILE__) + "/helpers/rendering"
 
 module Roger
   class Template
@@ -7,20 +8,25 @@ module Roger
     class TemplateContext
       include Helpers::Capture
       include Helpers::Partial
+      include Helpers::Rendering
 
-      def initialize(template, env = {})
-        @_template = template
+      def initialize(renderer, env = {})
+        @_renderer = renderer
         @_env = env
       end
 
+      def renderer
+        @_renderer
+      end
+
       # The current Roger::Template in use
       def template
-        @_template
+        @_renderer.current_template
       end
 
       # Access to the front-matter of the document (if any)
       def document
-        @_data ||= OpenStruct.new(template.data)
+        @_data ||= OpenStruct.new(@_renderer.data)
       end
 
       # The current environment variables.

data/lib/roger/version.rb

@@ -1,4 +1,4 @@
 # Roger main namespace
 module Roger
-  VERSION = "1.4.6"
+  VERSION = "1.5.0"
 end

data/test/project/html/partials/_local.html.erb

@@ -0,0 +1 @@
+local

data/test/project/html/renderer/file.html.erb

@@ -0,0 +1 @@
+<%= "file" %>

data/test/project/html/renderer/recursive.html.erb

@@ -0,0 +1 @@
+<%= renderer.render_file("recursive.html.erb") %>

data/test/project/partials/test/_underscored.html.erb

@@ -0,0 +1 @@
+underscored

data/test/project/partials/test/deep_recursive.html.erb

@@ -0,0 +1 @@
+<%= partial("test/recursive") %>

data/test/project/partials/test/recursive.html.erb

@@ -0,0 +1 @@
+<%= partial("test/recursive") %>

data/test/unit/release/processors/mockup_test.rb

@@ -18,44 +18,60 @@ module Roger
       files = @mockup.call(@release)
       assert_equal 0, files.length
     end
+
+    def test_run_on_file
+      @release.project.construct.directory "build" do |dir|
+        dir.file "test.html.erb", "<%= 'test' %>"
+      end
+
+      @mockup.call(@release)
+
+      file = @release.build_path + "test.html"
+
+      assert file.exist?
+      assert_equal "test", File.read(file.to_s)
+    end
   end
 
   # Test the target_path function of Mockup
   class MockupTargetPathTest < ::Test::Unit::TestCase
     def setup
       @base = File.dirname(__FILE__) + "/../../../project"
-      @template = Roger::Template.open(@base + "/html/formats/erb.html.erb")
       @processor = Roger::Release::Processors::Mockup.new
     end
 
     def test_with_html_extension
-      assert_equal "bla/test.html", @processor.target_path("bla/test.html", @template).to_s
-      assert_equal "test.html", @processor.target_path("test.html", @template).to_s
+      assert_output "bla/test.html", "bla/test.html"
+      assert_output "test.html", "test.html"
     end
 
     def test_with_double_extension
-      assert_equal "bla/test.html", @processor.target_path("bla/test.html.erb", @template).to_s
-      assert_equal "test.html", @processor.target_path("test.html.erb", @template).to_s
-      assert_equal "test.html", @processor.target_path("test.html.test", @template).to_s
+      assert_output "bla/test.html", "bla/test.html.erb"
+      assert_output "test.html", "test.html.erb"
+      assert_output "test.html", "test.html.test"
     end
 
     def test_with_unknown_template_mime
-      assert_equal "bla/test.rhtml", @processor.target_path("bla/test.rhtml", @template).to_s
-      assert_equal "test.rhtml", @processor.target_path("test.rhtml", @template).to_s
+      assert_output "bla/test.supafriek", "bla/test.supafriek"
+      assert_output "test.supafriek", "test.supafriek"
     end
 
     def test_with_template_mime_with_existing_extension
-      template = Roger::Template.open(@base + "/html/formats/csv.rcsv")
-
-      assert_equal "bla/test.csv", @processor.target_path("bla/test.rcsv", template).to_s
-      assert_equal "test.csv", @processor.target_path("test.erb", template).to_s
+      assert_equal "bla/test.csv", @processor.target_path("bla/test.rcsv").to_s
+      assert_equal "test.csv", @processor.target_path("test.rcsv").to_s
     end
 
     def test_with_template_mime_without_existing_extension
-      template = Roger::Template.open(@base + "/html/formats/csv.rcsv")
+      assert_output "bla/test", @processor.target_path("bla/test").to_s
+      assert_output "test", @processor.target_path("test").to_s
+    end
+
+    def assert_output(outfile, infile)
+      assert_equal outfile, @processor.target_path(infile).to_s
+    end
 
-      assert_equal "bla/test.csv", @processor.target_path("bla/test", template).to_s
-      assert_equal "test.csv", @processor.target_path("test", template).to_s
+    def template(path)
+      Roger::Template.new("", {}, source_path: path)
     end
   end
 end

data/test/unit/renderer/renderer_base_test.rb

@@ -0,0 +1,123 @@
+# encoding: UTF-8
+# Generators register themself on the CLI module
+require "test_helper"
+require "./lib/roger/renderer.rb"
+
+module Roger
+  # Roger template tests
+  class RendererBaseTest < ::Test::Unit::TestCase
+    def setup
+      @base = Pathname.new(File.dirname(__FILE__) + "/../../project")
+      @config = {
+        partials_path: @base + "partials",
+        layouts_path: @base + "layouts",
+        source_path: @base + "html/test.html.erb"
+      }
+      @template_path = @base + "html"
+
+      @renderer = Renderer.new({}, @config)
+    end
+
+    def test_render
+      result = @renderer.render("test.html.erb", source: "<%= 'yes' %>")
+      assert_equal "yes", result
+    end
+
+    def test_render_file_absolute
+      result = @renderer.render_file(@base + "html/renderer/file.html.erb")
+      assert_equal "file", result
+    end
+
+    def test_render_file_relative
+      result = @renderer.render(
+        @base + "html/dir1/test.html.erb",
+        source: "<%= renderer.render_file('../renderer/file.html.erb') %>"
+      )
+      assert_equal "file", result
+    end
+
+    def test_render_file_prevent_recursive
+      assert_raise(ArgumentError) do
+        @renderer.render(@base + "html/renderer/recursive.html.erb")
+      end
+    end
+
+    # Formats
+
+    def test_render_md
+      result = @renderer.render("test.md", source: "# h1")
+      assert_equal "<h1>h1</h1>\n", result
+    end
+
+    def test_render_md_erb
+      result = @renderer.render("test.md.erb", source: "<%= '# h1' %>")
+      assert_equal "<h1>h1</h1>\n", result
+    end
+
+    # Environment
+
+    def test_template_env
+      renderer = Renderer.new({ test: "test" }, @config)
+      result = renderer.render("test.erb", source: "<%= env[:test] %>")
+      assert_equal "test", result
+    end
+
+    # Extension
+    def test_source_extension
+      mime_types = {
+        "html" => "html",
+        # "md.erb" => "md.erb",
+        "html.erb" => "html.erb",
+        "css.erb" => "css.erb",
+        "json.erb" => "json.erb",
+        "sjon.json.erb" => "json.erb",
+        "js.erb" => "js.erb"
+      }
+
+      mime_types.each do |ext, ext_out|
+        assert_equal(
+          ext_out,
+          Renderer.source_extension_for(@base + "html/file.#{ext}")
+        )
+      end
+    end
+
+    def test_target_extension
+      mime_types = {
+        "html" => "html",
+        "html.erb" => "html",
+        # "md" => "html",
+        # "md.erb" => "html",
+        "css.erb" => "css",
+        "json.erb" => "json",
+        "js.erb" => "js"
+      }
+
+      mime_types.each do |ext, ext_out|
+        assert_equal(
+          ext_out,
+          Renderer.target_extension_for(@base + "html/file.#{ext}")
+        )
+      end
+    end
+
+    # Mime type
+    def test_target_mime_type
+      mime_types = {
+        "html" => "text/html",
+        # "md" => "text/html",
+        # "md.erb" => "text/html",
+        "html.erb" => "text/html",
+        "css.erb" => "text/css",
+        "json.erb" => "application/json"
+      }
+
+      mime_types.each do |ext, mime|
+        assert_equal(
+          mime,
+          Renderer.target_mime_type_for(@base + "html/file.#{ext}")
+        )
+      end
+    end
+  end
+end

data/test/unit/renderer/renderer_content_for_test.rb

@@ -0,0 +1,50 @@
+# encoding: UTF-8
+# Generators register themself on the CLI module
+require "test_helper"
+require "./lib/roger/renderer.rb"
+
+module Roger
+  # Roger template tests
+  class RendererContentForTest < ::Test::Unit::TestCase
+    def setup
+      @base = Pathname.new(File.dirname(__FILE__) + "/../../project")
+      @config = {
+        partials_path: @base + "partials",
+        layouts_path: @base + "layouts"
+      }
+      @template_path = @base + "html"
+
+      @source_path = @base + "html/test.html.erb"
+
+      @renderer = Renderer.new({}, @config)
+    end
+
+    # Content for parts
+
+    def test_content_for_not_returning_in_template
+      content_for_block = 'B<% content_for :one do %><%= "one" %><% end %>A'
+      assert_equal "BA", @renderer.render(@source_path, source: content_for_block)
+    end
+
+    def test_content_for_yield_in_layout
+      content_for_block = "---\nlayout: \"yield\"\n---\n"
+      content_for_block << "B<% content_for :one do %><%= \"one\" %><% end %>A"
+
+      assert_equal "BAone", @renderer.render(@source_path, source: content_for_block)
+    end
+
+    def test_content_for_yield_in_layout_without_content_for
+      content_for_block = "---\nlayout: \"yield\"\n---\nBA"
+      assert_equal "BA", @renderer.render(@source_path, source: content_for_block)
+    end
+
+    def test_content_for_yield_with_partial_with_block
+      template_string = "---\nlayout: \"yield\"\n---\nB"
+      template_string << "<% content_for :one do %>"
+      template_string << "<% partial 'test/yield' do %>CONTENT<% end %>"
+      template_string << "<% end %>A"
+
+      assert_equal "BAB-CONTENT-A", @renderer.render(@source_path, source: template_string)
+    end
+  end
+end

data/test/unit/renderer/renderer_helper_test.rb

@@ -0,0 +1,54 @@
+# encoding: UTF-8
+# Generators register themself on the CLI module
+require "test_helper"
+require "./lib/roger/renderer.rb"
+
+module Roger
+  # A simple template helper to use for testing
+  module RendererHelper
+    def a
+      "a"
+    end
+
+    def from_env(key)
+      env[key]
+    end
+  end
+
+  # Roger template tests
+  class RendererHelperTest < ::Test::Unit::TestCase
+    def setup
+      @base = Pathname.new(File.dirname(__FILE__) + "/../../project")
+      @config = {
+        partials_path: @base + "partials",
+        layouts_path: @base + "layouts"
+      }
+      @template_path = @base + "html"
+
+      @source_path = @base + "html/test.html.erb"
+
+      @renderer = Renderer.new({}, @config)
+    end
+
+    def test_register_helper
+      Roger::Renderer.helper RendererHelper
+
+      assert Roger::Renderer.helpers.include?(RendererHelper)
+    end
+
+    def test_helper_works
+      Roger::Renderer.helper RendererHelper
+
+      result = @renderer.render(@source_path, source: "<%= a %>")
+      assert_equal "a", result
+    end
+
+    def test_helper_has_access_to_env
+      Roger::Renderer.helper RendererHelper
+
+      renderer = Renderer.new({ test: "test" }, @config)
+      result = renderer.render(@source_path, source: "<%= from_env(:test) %>")
+      assert_equal result, "test"
+    end
+  end
+end

data/test/unit/renderer/renderer_partial_test.rb

@@ -0,0 +1,88 @@
+# encoding: UTF-8
+# Generators register themself on the CLI module
+require "test_helper"
+require "./lib/roger/template.rb"
+
+module Roger
+  # Roger template tests
+  class RendererPartialTest < ::Test::Unit::TestCase
+    def setup
+      @base = Pathname.new(File.dirname(__FILE__) + "/../../project")
+      @config = {
+        partials_path: @base + "partials",
+        layouts_path: @base + "layouts",
+        source_path: @base + "html/test.html.erb"
+      }
+      @template_path = @base + "html"
+
+      @renderer = Renderer.new({}, @config)
+    end
+
+    # Partials
+
+    def test_partial
+      result = render_erb_template "<%= partial 'test/simple' %>"
+      assert_equal result, "ERB"
+
+      result = render_erb_template "<%= partial 'test/simple.html' %>"
+      assert_equal result, "ERB"
+    end
+
+    def test_partial_with_double_template_extensions
+      result = render_erb_template "<%= partial 'test/json.json' %>"
+      assert_equal result, "{ key: value }"
+    end
+
+    def test_partial_with_underscored_name
+      result = render_erb_template "<%= partial 'test/underscored' %>"
+      assert_equal result, "underscored"
+    end
+
+    def test_local_partial
+      result = render_erb_template "<%= partial 'local' %>"
+      assert_equal result, "local"
+    end
+
+    def test_partial_with_preferred_extension
+      assert_raise(ArgumentError) do
+        render_erb_template "<%= partial 'test/json' %>"
+      end
+      result = @renderer.render(@base + "html/test.json.erb", source: "<%= partial 'test/json' %>")
+      assert_equal result, "{ key: value }"
+    end
+
+    def test_partial_with_block
+      result = render_erb_template "<% partial 'test/yield' do %>CONTENT<% end %>"
+      assert_equal result, "B-CONTENT-A"
+
+      result = render_erb_template "<% partial 'test/yield' do %><%= 'CONTENT' %><% end %>"
+      assert_equal result, "B-CONTENT-A"
+    end
+
+    def test_partial_with_block_without_yield
+      result = render_erb_template "<% partial 'test/simple' do %>CONTENT<% end %>"
+      assert_equal result, "ERB"
+    end
+
+    def test_front_matter_partial_access
+      result = render_erb_template "---\ntest: yay!\n---\n<%= partial 'test/front_matter' %>"
+      assert_equal result, "yay!"
+    end
+
+    def test_partial_prevent_recursive
+      assert_raise(ArgumentError) do
+        render_erb_template "<% partial 'test/recursive' %>"
+      end
+    end
+
+    def test_partial_prevent_deep_recursive
+      assert_raise(ArgumentError) do
+        render_erb_template "<% partial 'test/deep_recursive' %>"
+      end
+    end
+
+    def render_erb_template(template)
+      @renderer.render(@base + "html/partials/test.html.erb", source: template)
+    end
+  end
+end