temple 0.6.0 → 0.6.3

data/.travis.yml

@@ -2,6 +2,7 @@ language: ruby
 rvm:
   - 1.8.7
   - 1.9.3
+  - 2.0.0
   - ruby-head
   - jruby-18mode
   - jruby-19mode

data/CHANGES

@@ -1,3 +1,15 @@
+0.6.3
+
+  * Fix HTML escaping for HTML::Pretty (Issue #69)
+
+0.6.2
+
+  * [:html, :js, code] abstraction added
+
+0.6.1
+
+  * HTML::Pretty improved
+
 0.6.0
 
   * HTML::AttributeMerger: rename option :attr_delimiter to :merge_attrs

data/EXPRESSIONS.md

@@ -238,6 +238,10 @@ List of html attributes [:html, :attr, identifier, sexp]
 
 HTML attribute abstraction. Identifier can be a String or a Symbol.
 
+### [:html, :js, code]
+
+HTML javascript abstraction which wraps the js code in a HTML comment or CDATA depending on document format.
+
 Formal grammar
 --------------
 

data/Gemfile

@@ -1,3 +1,3 @@
-source :rubygems
+source 'https://rubygems.org/'
 gemspec
 

data/README.md

@@ -1,7 +1,7 @@
 Temple
 ======
 
-[![Build Status](https://secure.travis-ci.org/judofyr/temple.png?branch=master)](http://travis-ci.org/judofyr/temple) [![Dependency Status](https://gemnasium.com/judofyr/temple.png?travis)](https://gemnasium.com/judofyr/temple) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/judofyr/temple)
+[![Build Status](https://secure.travis-ci.org/judofyr/temple.png?branch=master)](http://travis-ci.org/judofyr/temple) [![Dependency Status](https://gemnasium.com/judofyr/temple.png?travis)](https://gemnasium.com/judofyr/temple) [![Code Climate](https://codeclimate.com/github/judofyr/temple.png)](https://codeclimate.com/github/judofyr/temple)
 
 Temple is an abstraction and a framework for compiling templates to pure Ruby.
 It's all about making it easier to experiment, implement and optimize template

data/lib/temple/generators.rb

@@ -128,7 +128,7 @@ module Temple
 
     # Implements a rails output buffer.
     #
-    #   @output_buffer = ActionView::SafeBuffer
+    #   @output_buffer = ActiveSupport::SafeBuffer
     #   @output_buffer.safe_concat "static"
     #   @output_buffer.safe_concat dynamic.to_s
     #   @output_buffer

data/lib/temple/grammar.rb

@@ -30,6 +30,7 @@ module Temple
       [:html, :doctype, String]                |
       [:html, :comment, Expression]            |
       [:html, :condcomment, String, Expression]|
+      [:html, :js, Expression]                 |
       [:html, :tag, HTMLIdentifier, Expression, 'Expression?'] |
       [:html, :attrs, 'HTMLAttr*']             |
       HTMLAttr

data/lib/temple/html/dispatcher.rb

@@ -18,6 +18,10 @@ module Temple
         [:html, :condcomment, condition, compile(content)]
       end
 
+      def on_html_js(content)
+        [:html, :js, compile(content)]
+      end
+
       def on_html_tag(name, attrs, content = nil)
         result = [:html, :tag, name, compile(attrs)]
         content ? (result << compile(content)) : result

data/lib/temple/html/fast.rb

@@ -23,7 +23,8 @@ module Temple
 
       define_options :format => :xhtml,
                      :attr_quote => '"',
-                     :autoclose => %w[meta img link br hr input area param col base]
+                     :autoclose => %w[meta img link br hr input area param col base],
+                     :js_wrapper => nil
 
       HTML = [:html, :html4, :html5]
 
@@ -32,6 +33,22 @@ module Temple
         unless [:xhtml, *HTML].include?(options[:format])
           raise ArgumentError, "Invalid format #{options[:format].inspect}"
         end
+        wrapper = options[:js_wrapper]
+        wrapper = xhtml? ? :cdata : :comment if wrapper == :guess
+        @js_wrapper =
+          case wrapper
+          when :comment
+            [ "<!--\n", "\n//-->" ]
+          when :cdata
+            [ "\n//<![CDATA[\n", "\n//]]>\n" ]
+          when :both
+            [ "<!--\n//<![CDATA[\n", "\n//]]>\n//-->" ]
+          when nil
+          when Array
+            wrapper
+          else
+            raise ArgumentError, "Invalid JavaScript wrapper #{wrapper.inspect}"
+          end
       end
 
       def xhtml?
@@ -92,6 +109,17 @@ module Temple
          compile(value),
          [:static, options[:attr_quote]]]
       end
+
+      def on_html_js(content)
+        if @js_wrapper
+          [:multi,
+           [:static, @js_wrapper.first],
+           compile(content),
+           [:static, @js_wrapper.last]]
+        else
+          compile(content)
+        end
+      end
     end
   end
 end

data/lib/temple/html/pretty.rb

@@ -13,7 +13,7 @@ module Temple
 
       def initialize(opts = {})
         super
-        @last = :noindent
+        @last = nil
         @indent = 0
         @pretty = options[:pretty]
         @pre_tags = Regexp.new(options[:pre_tags].map {|t| "<#{t}" }.join('|'))
@@ -25,24 +25,31 @@ module Temple
 
       def on_static(content)
         if @pretty
-          content = content.gsub("\n", indent) if @pre_tags !~ content
-          @last = :noindent
+          if @pre_tags !~ content
+            content = content.sub(/\A\s*\n?/, "\n") if options[:indent_tags].include?(@last)
+            content = content.gsub("\n", indent)
+          end
+          @last = :static
         end
         [:static, content]
       end
 
       def on_dynamic(code)
         if @pretty
-          @last = :noindent
           tmp = unique_name
-          gsub_code = if ''.respond_to?(:html_safe?)
-                        "#{tmp} = #{tmp}.html_safe? ? #{tmp}.gsub(\"\\n\", #{indent.inspect}).html_safe : #{tmp}.gsub(\"\\n\", #{indent.inspect})"
-                      else
-                        "#{tmp} = #{tmp}.gsub(\"\\n\", #{indent.inspect})"
-                      end
+          indent_code = ''
+          indent_code << "#{tmp} = #{tmp}.sub(/\\A\\s*\\n?/, \"\\n\"); " if options[:indent_tags].include?(@last)
+          indent_code << "#{tmp} = #{tmp}.gsub(\"\n\", #{indent.inspect}); "
+          if ''.respond_to?(:html_safe)
+            safe = unique_name
+            # we have to first save if the string was html_safe
+            # otherwise the gsub operation will lose that knowledge
+            indent_code = "#{safe} = #{tmp}.html_safe?; #{indent_code}#{tmp} = #{tmp}.html_safe if #{safe}; "
+          end
+          @last = :dynamic
           [:multi,
            [:code, "#{tmp} = (#{code}).to_s"],
-           [:code, "if #{@pre_tags_name} !~ #{tmp}; #{gsub_code}; end"],
+           [:code, "if #{@pre_tags_name} !~ #{tmp}; #{indent_code}end"],
            [:dynamic, tmp]]
         else
           [:dynamic, code]
@@ -56,8 +63,8 @@ module Temple
 
       def on_html_comment(content)
         return super unless @pretty
-        result = [:multi, [:static, tag_indent(nil)], super]
-        @last = nil
+        result = [:multi, [:static, tag_indent('comment')], super]
+        @last = :comment
         result
       end
 
@@ -96,7 +103,7 @@ module Temple
 
       # Return indentation before tag
       def tag_indent(name)
-        result = @last != :noindent && (options[:indent_tags].include?(@last) || options[:indent_tags].include?(name)) ? indent : ''
+        result = @last && (options[:indent_tags].include?(@last) || options[:indent_tags].include?(name)) ? indent : ''
         @last = name
         result
       end

data/lib/temple/templates/rails.rb

@@ -1,4 +1,4 @@
-unless Object.const_defined?(:Rails)
+unless defined?(ActionView)
   raise "Rails is not loaded - Temple::Templates::Rails cannot be used"
 end
 

data/lib/temple/version.rb

@@ -1,3 +1,3 @@
 module Temple
-  VERSION = '0.6.0'
+  VERSION = '0.6.3'
 end

data/test/filters/test_escapable.rb

@@ -1,11 +1,5 @@
 require 'helper'
 
-class HtmlSafeString < String
-  def html_safe?
-    true
-  end
-end
-
 describe Temple::Filters::Escapable do
   before do
     @filter = Temple::Filters::Escapable.new

data/test/helper.rb

@@ -1,12 +1,24 @@
 require 'bacon'
 require 'temple'
 
+class HtmlSafeString < String
+  def html_safe?
+    true
+  end
+
+  def to_s
+    self
+  end
+end
+
 module TestHelper
-  def with_html_safe(flag)
-    String.send(:define_method, :html_safe?) { flag }
+  def with_html_safe
+    String.send(:define_method, :html_safe?) { false }
+    String.send(:define_method, :html_safe) { HtmlSafeString.new(self) }
     yield
   ensure
     String.send(:undef_method, :html_safe?) if String.method_defined?(:html_safe?)
+    String.send(:undef_method, :html_safe) if String.method_defined?(:html_safe)
   end
 
   def grammar_validate(grammar, exp, message)

data/test/html/test_fast.rb

@@ -20,6 +20,18 @@ describe Temple::HTML::Fast do
     @html.call([:html, :comment, [:static, 'test']]).should.equal [:multi, [:static, "<!--"], [:static, "test"], [:static, "-->"]]
   end
 
+  it 'should compile js wrapped in comments' do
+    Temple::HTML::Fast.new(:js_wrapper => nil).call([:html, :js, [:static, 'test']]).should.equal [:static, "test"]
+    Temple::HTML::Fast.new(:js_wrapper => :comment).call([:html, :js, [:static, 'test']]).should.equal [:multi, [:static, "<!--\n"], [:static, "test"], [:static, "\n//-->"]]
+    Temple::HTML::Fast.new(:js_wrapper => :cdata).call([:html, :js, [:static, 'test']]).should.equal [:multi, [:static, "\n//<![CDATA[\n"], [:static, "test"], [:static, "\n//]]>\n"]]
+    Temple::HTML::Fast.new(:js_wrapper => :both).call([:html, :js, [:static, 'test']]).should.equal [:multi, [:static, "<!--\n//<![CDATA[\n"], [:static, "test"], [:static, "\n//]]>\n//-->"]]
+  end
+
+  it 'should guess default js comment' do
+    Temple::HTML::Fast.new(:js_wrapper => :guess, :format => :xhtml).call([:html, :js, [:static, 'test']]).should.equal [:multi, [:static, "\n//<![CDATA[\n"], [:static, "test"], [:static, "\n//]]>\n"]]
+    Temple::HTML::Fast.new(:js_wrapper => :guess, :format => :html).call([:html, :js, [:static, 'test']]).should.equal [:multi, [:static, "<!--\n"], [:static, "test"], [:static, "\n//-->"]]
+  end
+
   it 'should compile autoclosed html tag' do
     @html.call([:html, :tag,
       'img', [:attrs],

data/test/html/test_pretty.rb

@@ -19,16 +19,15 @@ describe Temple::HTML::Pretty do
                        [:multi],
                        [:static, ">"],
                        [:multi,
-                        [:static, "text"],
+                        [:static, "\n    text"],
                         [:multi,
                          [:code, "_temple_html_pretty2 = (code).to_s"],
-                         [:code, 'if _temple_html_pretty1 !~ _temple_html_pretty2; _temple_html_pretty2 = _temple_html_pretty2.gsub("\n", "\n    "); end'],
+                         [:code, "if _temple_html_pretty1 !~ _temple_html_pretty2; _temple_html_pretty2 = _temple_html_pretty2.gsub(\"\n\", \"\\n    \"); end"],
                          [:dynamic, "_temple_html_pretty2"]]],
-                       [:static, "</p>"]],
+                       [:static, "\n  </p>"]],
                       [:static, "\n</div>"]]]
   end
 
-
   it 'should not indent preformatted tags' do
     @html.call([:html, :tag, 'pre', [:multi],
       [:html, :tag, 'p', [:multi], [:static, 'text']]
@@ -46,4 +45,17 @@ describe Temple::HTML::Pretty do
                        [:static, "</p>"]],
                       [:static, "</pre>"]]]
   end
+
+  it 'should not escape html_safe strings' do
+    with_html_safe do
+      @html.call(
+        [:dynamic, '"text<".html_safe']
+      ).should.equal [:multi,
+                      [:code, "_temple_html_pretty1 = /<code|<pre|<textarea/"],
+                      [:multi,
+                       [:code, "_temple_html_pretty2 = (\"text<\".html_safe).to_s"],
+                       [:code, "if _temple_html_pretty1 !~ _temple_html_pretty2; _temple_html_pretty3 = _temple_html_pretty2.html_safe?; _temple_html_pretty2 = _temple_html_pretty2.gsub(\"\n\", \"\\n\"); _temple_html_pretty2 = _temple_html_pretty2.html_safe if _temple_html_pretty3; end"],
+                       [:dynamic, "_temple_html_pretty2"]]]
+    end
+  end
 end

data/test/test_utils.rb

@@ -26,14 +26,14 @@ describe Temple::Utils do
   end
 
   it 'should escape unsafe html strings' do
-    with_html_safe(false) do
+    with_html_safe do
       Temple::Utils.escape_html_safe('<').should.equal '&lt;'
     end
   end
 
   it 'should not escape safe html strings' do
-    with_html_safe(true) do
-      Temple::Utils.escape_html_safe('<').should.equal '<'
+    with_html_safe do
+      Temple::Utils.escape_html_safe('<'.html_safe).should.equal '<'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: temple
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-21 00:00:00.000000000 Z
+date: 2013-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tilt
@@ -182,4 +182,3 @@ test_files:
 - test/test_grammar.rb
 - test/test_hash.rb
 - test/test_utils.rb
-has_rdoc: