temple 0.7.6 → 0.7.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49450d407bc6ae1762271d1ece670cdb9913b787
-  data.tar.gz: 946bbd14856936cb2d7dbbb431ecc8a9df55f26a
+  metadata.gz: 70234f9ea5cb84da4b1a8cdcfc8f63056d8af5ce
+  data.tar.gz: 4b76d19c5643183eb268c83dffc968f777c8d97a
 SHA512:
-  metadata.gz: 26a6a8e828240ea1293548173b2816b4378fce9f1609b946c48317652b02c2eb3e29aec99570e313de2a2155cab975cdc135c3529a209be693f6a9e8279ce97a
-  data.tar.gz: 542489791fab203a48b9810def3718e6416c00be2aa0a86587f4234b4f8d292977e29b4322b709ed2d9164ed1d21c71900c1feb58863a6c74952688622a7a954
+  metadata.gz: 9c7ec6543f4fc8d3d95fc5046a606135605886b5e0ab67deb50e311ae50b5ff7b3030971173ca42d1ca8b67a45c33427b2b2cbaaac0b071f02d17dfcae0ef274
+  data.tar.gz: a8fb82e723319e0b4f1b11cd33c7b155f1cebda73345bf418b22626bd23b566b85904e45474535c8406fdd9693c6e1a7d75547b9c9d323d8b298cb9bffa86c50

data/.travis.yml

@@ -4,12 +4,17 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
+  - 2.3.0
   - ruby-head
   - jruby-19mode
   - rbx-2
 
 sudo: false
 
+env:
+  - ESCAPE_UTILS=1
+  - ""
+
 matrix:
   allow_failures:
     - rvm: ruby-head

data/CHANGES

@@ -1,3 +1,8 @@
+0.7.7
+
+  * Add StaticAnalyzer, StringSplitter
+  * Freeze string literals
+
 0.7.6
 
   * EngineDSL - add support for use(:Filter) { FilterClassName }

data/Gemfile

@@ -1,3 +1,3 @@
 source 'https://rubygems.org/'
 gemspec
-
+gem 'escape_utils' if ENV['ESCAPE_UTILS']

data/lib/temple.rb

@@ -43,7 +43,9 @@ module Temple
     autoload :CodeMerger,         'temple/filters/code_merger'
     autoload :ControlFlow,        'temple/filters/control_flow'
     autoload :MultiFlattener,     'temple/filters/multi_flattener'
+    autoload :StaticAnalyzer,     'temple/filters/static_analyzer'
     autoload :StaticMerger,       'temple/filters/static_merger'
+    autoload :StringSplitter,     'temple/filters/string_splitter'
     autoload :DynamicInliner,     'temple/filters/dynamic_inliner'
     autoload :Escapable,          'temple/filters/escapable'
     autoload :Eraser,             'temple/filters/eraser'

data/lib/temple/filters/remove_bom.rb

@@ -6,7 +6,7 @@ module Temple
     class RemoveBOM < Parser
       def call(s)
         return s if s.encoding.name !~ /^UTF-(8|16|32)(BE|LE)?/
-        s.gsub(Regexp.new("\\A\uFEFF".encode(s.encoding.name)), '')
+        s.gsub(Regexp.new("\\A\uFEFF".encode(s.encoding.name)), ''.freeze)
       end
     end
   end

data/lib/temple/filters/static_analyzer.rb

@@ -0,0 +1,87 @@
+begin
+  require 'ripper'
+rescue LoadError
+end
+
+module Temple
+  module Filters
+    # Convert [:dynamic, code] to [:static, text] if code is static Ruby expression.
+    class StaticAnalyzer < Filter
+      STATIC_TOKENS = [
+        :on_tstring_beg, :on_tstring_end, :on_tstring_content,
+        :on_embexpr_beg, :on_embexpr_end,
+        :on_lbracket, :on_rbracket,
+        :on_qwords_beg, :on_words_sep, :on_qwords_sep,
+        :on_lparen, :on_rparen,
+        :on_lbrace, :on_rbrace, :on_label,
+        :on_int, :on_float, :on_imaginary,
+        :on_comma, :on_sp,
+      ].freeze
+
+      DYNAMIC_TOKENS = [
+        :on_ident, :on_period,
+      ].freeze
+
+      STATIC_KEYWORDS = [
+        'true', 'false', 'nil',
+      ].freeze
+
+      STATIC_OPERATORS = [
+        '=>',
+      ].freeze
+
+      if defined?(Ripper)
+        def self.static?(code)
+          return false if code.nil? || code.strip.empty?
+          return false if SyntaxChecker.syntax_error?(code)
+
+          Ripper.lex(code).each do |(_, col), token, str|
+            case token
+            when *STATIC_TOKENS
+              # noop
+            when :on_kw
+              return false unless STATIC_KEYWORDS.include?(str)
+            when :on_op
+              return false unless STATIC_OPERATORS.include?(str)
+            when *DYNAMIC_TOKENS
+              return false
+            else
+              return false
+            end
+          end
+          true
+        end
+
+        def on_dynamic(code)
+          if StaticAnalyzer.static?(code)
+            [:static, eval(code).to_s]
+          else
+            [:dynamic, code]
+          end
+        end
+
+        class SyntaxChecker < Ripper
+          class ParseError < StandardError; end
+
+          def self.syntax_error?(code)
+            self.new(code).parse
+            false
+          rescue ParseError
+            true
+          end
+
+          private
+
+          def on_parse_error(*)
+            raise ParseError
+          end
+        end
+      else
+        # Do nothing if ripper is unavailable
+        def call(ast)
+          ast
+        end
+      end
+    end
+  end
+end

data/lib/temple/filters/string_splitter.rb

@@ -0,0 +1,130 @@
+begin
+  require 'ripper'
+rescue LoadError
+end
+
+module Temple
+  module Filters
+    # Compile [:dynamic, "foo#{bar}"] to [:multi, [:static, 'foo'], [:dynamic, 'bar']]
+    class StringSplitter < Filter
+      if defined?(Ripper) && RUBY_VERSION >= "2.0.0"
+        class << self
+          # `code` param must be valid string literal
+          def compile(code)
+            [].tap do |exps|
+              tokens = Ripper.lex(code.strip)
+              tokens.pop while tokens.last && [:on_comment, :on_sp].include?(tokens.last[1])
+
+              if tokens.size < 2
+                raise "Expected token size >= 2 but got: #{tokens.size}"
+              end
+              compile_tokens!(exps, tokens)
+            end
+          end
+
+          private
+
+          def strip_quotes!(tokens)
+            _, type, beg_str = tokens.shift
+            if type != :on_tstring_beg
+              raise "Expected :on_tstring_beg but got: #{type}"
+            end
+
+            _, type, end_str = tokens.pop
+            if type != :on_tstring_end
+              raise "Expected :on_tstring_end but got: #{type}"
+            end
+
+            [beg_str, end_str]
+          end
+
+          def compile_tokens!(exps, tokens)
+            beg_str, end_str = strip_quotes!(tokens)
+
+            until tokens.empty?
+              _, type, str = tokens.shift
+
+              case type
+              when :on_tstring_content
+                exps << [:static, eval("#{beg_str}#{str}#{end_str}").to_s]
+              when :on_embexpr_beg
+                embedded = shift_balanced_embexpr(tokens)
+                exps << [:dynamic, embedded] unless embedded.empty?
+              end
+            end
+          end
+
+          def shift_balanced_embexpr(tokens)
+            String.new.tap do |embedded|
+              embexpr_open = 1
+
+              until tokens.empty?
+                _, type, str = tokens.shift
+                case type
+                when :on_embexpr_beg
+                  embexpr_open += 1
+                when :on_embexpr_end
+                  embexpr_open -= 1
+                  break if embexpr_open == 0
+                end
+
+                embedded << str
+              end
+            end
+          end
+        end
+
+        def on_dynamic(code)
+          return [:dynamic, code] unless string_literal?(code)
+          return [:dynamic, code] if code.include?("\n")
+
+          temple = [:multi]
+          StringSplitter.compile(code).each do |type, content|
+            case type
+            when :static
+              temple << [:static, content]
+            when :dynamic
+              temple << on_dynamic(content)
+            end
+          end
+          temple
+        end
+
+        private
+
+        def string_literal?(code)
+          return false if SyntaxChecker.syntax_error?(code)
+
+          type, instructions = Ripper.sexp(code)
+          return false if type != :program
+          return false if instructions.size > 1
+
+          type, _ = instructions.first
+          type == :string_literal
+        end
+
+        class SyntaxChecker < Ripper
+          class ParseError < StandardError; end
+
+          def self.syntax_error?(code)
+            self.new(code).parse
+            false
+          rescue ParseError
+            true
+          end
+
+          private
+
+          def on_parse_error(*)
+            raise ParseError
+          end
+        end
+      else
+        # Do nothing if ripper is unavailable
+        def call(ast)
+          ast
+        end
+      end
+    end
+  end
+end

data/lib/temple/generator.rb

@@ -46,7 +46,7 @@ module Temple
     end
 
     def on_multi(*exp)
-      exp.map {|e| compile(e) }.join('; ')
+      exp.map {|e| compile(e) }.join('; '.freeze)
     end
 
     def on_newline

data/lib/temple/generators/array_buffer.rb

@@ -5,7 +5,7 @@ module Temple
     #   _buf = []
     #   _buf << "static"
     #   _buf << dynamic
-    #   _buf.join
+    #   _buf.join("")
     #
     # @api public
     class ArrayBuffer < Array
@@ -21,7 +21,8 @@ module Temple
       end
 
       def return_buffer
-        "#{buffer} = #{buffer}.join"
+        freeze = options[:freeze_static] ? '.freeze' : ''
+        "#{buffer} = #{buffer}.join(\"\"#{freeze})"
       end
     end
   end

data/lib/temple/generators/erb.rb

@@ -9,7 +9,7 @@ module Temple
       end
 
       def on_multi(*exp)
-        exp.map {|e| compile(e) }.join
+        exp.map {|e| compile(e) }.join('')
       end
 
       def on_capture(name, exp)

data/lib/temple/generators/rails_output_buffer.rb

@@ -16,7 +16,7 @@ module Temple
                      capture_generator: RailsOutputBuffer
 
       def call(exp)
-        [preamble, compile(exp), postamble].flatten.compact.join('; ')
+        [preamble, compile(exp), postamble].flatten.compact.join('; '.freeze)
       end
 
       def create_buffer

data/lib/temple/html/attribute_merger.rb

@@ -6,40 +6,35 @@ module Temple
       define_options merge_attrs: {'id' => '_', 'class' => ' '}
 
       def on_html_attrs(*attrs)
-        names = []
         values = {}
 
-        attrs.each do |attr|
-          name, value = attr[2].to_s, attr[3]
+        attrs.each do |_, _, name, value|
+          name = name.to_s
           if values[name]
             raise(FilterError, "Multiple #{name} attributes specified") unless options[:merge_attrs][name]
             values[name] << value
           else
             values[name] = [value]
-            names << name
           end
         end
 
-        attrs = names.map do |name|
-          value = values[name]
+        attrs = values.map do |name, value|
           if (delimiter = options[:merge_attrs][name]) && value.size > 1
             exp = [:multi]
             if value.all? {|v| contains_nonempty_static?(v) }
               exp << value.first
               value[1..-1].each {|v| exp << [:static, delimiter] << v }
-              [:html, :attr, name, exp]
             else
               captures = unique_name
               exp << [:code, "#{captures} = []"]
               value.each_with_index {|v, i| exp << [:capture, "#{captures}[#{i}]", v] }
               exp << [:dynamic, "#{captures}.reject(&:empty?).join(#{delimiter.inspect})"]
             end
-            [:html, :attr, name, exp]
           else
-            [:html, :attr, name, value.first]
+            exp = value.first
           end
+          [:html, :attr, name, exp]
         end
-
         [:html, :attrs, *attrs]
       end
     end

data/lib/temple/html/pretty.rb

@@ -26,8 +26,8 @@ module Temple
       def on_static(content)
         return [:static, content] unless @pretty
         unless @pre_tags && @pre_tags =~ content
-          content = content.sub(/\A\s*\n?/, "\n") if @indent_next
-          content = content.gsub("\n", indent)
+          content = content.sub(/\A\s*\n?/, "\n".freeze) if @indent_next
+          content = content.gsub("\n".freeze, indent)
         end
         @indent_next = false
         [:static, content]

data/lib/temple/mixins/dispatcher.rb

@@ -58,12 +58,14 @@ module Temple
       def replace_dispatcher(exp)
         tree = DispatchNode.new
         dispatched_methods.each do |method|
-          method.split('_')[1..-1].inject(tree) {|node, type| node[type.to_sym] }.method = method
+          method.split('_'.freeze)[1..-1].inject(tree) {|node, type| node[type.to_sym] }.method = method
         end
-        self.class.class_eval %{def dispatcher(exp)
-  return replace_dispatcher(exp) if self.class != #{self.class}
-  #{tree.compile.gsub("\n", "\n  ")}
-end}
+        self.class.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def dispatcher(exp)
+            return replace_dispatcher(exp) if self.class != #{self.class}
+            #{tree.compile.gsub("\n", "\n  ")}
+          end
+        RUBY
         dispatcher(exp)
       end
 
@@ -91,7 +93,7 @@ end}
             code = "case(exp[#{level}])\n"
             each do |key, child|
               code << "when #{key.inspect}\n  " <<
-                child.compile(level + 1, call_method).gsub("\n", "\n  ") << "\n"
+                child.compile(level + 1, call_method).gsub("\n".freeze, "\n  ".freeze) << "\n".freeze
             end
             code << "else\n  " << (call_method || 'exp') << "\nend"
           end

data/lib/temple/utils.rb

@@ -1,7 +1,10 @@
 begin
   require 'escape_utils'
 rescue LoadError
-  # Loading EscapeUtils failed
+  begin
+    require 'cgi/escape'
+  rescue LoadError
+  end
 end
 
 module Temple
@@ -26,6 +29,14 @@ module Temple
       def escape_html(html)
         EscapeUtils.escape_html(html.to_s, false)
       end
+    elsif defined?(CGI.escapeHTML)
+      # Returns an escaped copy of `html`.
+      #
+      # @param html [String] The string to escape
+      # @return [String] The escaped string
+      def escape_html(html)
+        CGI.escapeHTML(html.to_s)
+      end
     else
       # Used by escape_html
       # @api private
@@ -54,7 +65,7 @@ module Temple
     # @return [String] Variable name
     def unique_name(prefix = nil)
       @unique_name ||= 0
-      prefix ||= (@unique_prefix ||= self.class.name.gsub('::', '_').downcase)
+      prefix ||= (@unique_prefix ||= self.class.name.gsub('::'.freeze, '_'.freeze).downcase)
       "_#{prefix}#{@unique_name += 1}"
     end
 
@@ -81,8 +92,8 @@ module Temple
       level = text.scan(/^\s*/).map(&:size).min
       text = text.gsub(/(?!\A)^\s{#{level}}/, '') if level > 0
 
-      text = text.sub(/\A\s*\n?/, "\n") if indent_next
-      text = text.gsub("\n", indent)
+      text = text.sub(/\A\s*\n?/, "\n".freeze) if indent_next
+      text = text.gsub("\n".freeze, indent)
 
       safe ? text.html_safe : text
     end

data/lib/temple/version.rb

@@ -1,3 +1,3 @@
 module Temple
-  VERSION = '0.7.6'
+  VERSION = '0.7.7'
 end

data/test/filters/test_static_analyzer.rb

@@ -0,0 +1,23 @@
+require 'helper'
+begin
+  require 'ripper'
+rescue LoadError
+end
+
+if defined?(Ripper)
+  describe Temple::Filters::StaticAnalyzer do
+    before do
+      @filter = Temple::Filters::StaticAnalyzer.new
+    end
+
+    it 'should convert :dynamic to :static if code is static' do
+      @filter.call([:dynamic, '"#{"hello"}#{100}"']
+      ).should.equal [:static, 'hello100']
+    end
+
+    it 'should not convert :dynamic if code is dynamic' do
+      exp = [:dynamic, '"#{hello}#{100}"']
+      @filter.call(exp).should.equal(exp)
+    end
+  end
+end

data/test/filters/test_string_splitter.rb

@@ -0,0 +1,18 @@
+require 'helper'
+begin
+  require 'ripper'
+rescue LoadError
+end
+
+if defined?(Ripper) && RUBY_VERSION >= "2.0.0"
+  describe Temple::Filters::StringSplitter do
+    before do
+      @filter = Temple::Filters::StringSplitter.new
+    end
+
+    it 'should split :dynamic with string literal' do
+      @filter.call([:dynamic, '"static#{dynamic}"']
+      ).should.equal [:multi, [:static, 'static'], [:dynamic, 'dynamic']]
+    end
+  end
+end

data/test/test_generator.rb

@@ -97,16 +97,16 @@ describe Temple::Generators::ArrayBuffer do
     gen = Temple::Generators::ArrayBuffer.new(freeze_static: false)
     gen.call([:static,  'test']).should.equal '_buf = "test"'
     gen.call([:dynamic, 'test']).should.equal '_buf = (test).to_s'
-    gen.call([:code,    'test']).should.equal '_buf = []; test; _buf = _buf.join'
+    gen.call([:code,    'test']).should.equal '_buf = []; test; _buf = _buf.join("")'
 
-    gen.call([:multi, [:static, 'a'], [:static,  'b']]).should.equal '_buf = []; _buf << ("a"); _buf << ("b"); _buf = _buf.join'
-    gen.call([:multi, [:static, 'a'], [:dynamic, 'b']]).should.equal '_buf = []; _buf << ("a"); _buf << (b); _buf = _buf.join'
+    gen.call([:multi, [:static, 'a'], [:static,  'b']]).should.equal '_buf = []; _buf << ("a"); _buf << ("b"); _buf = _buf.join("")'
+    gen.call([:multi, [:static, 'a'], [:dynamic, 'b']]).should.equal '_buf = []; _buf << ("a"); _buf << (b); _buf = _buf.join("")'
   end
 
   it 'should freeze static' do
     gen = Temple::Generators::ArrayBuffer.new(freeze_static: true)
     gen.call([:static,  'test']).should.equal '_buf = "test"'
-    gen.call([:multi, [:dynamic, '1'], [:static,  'test']]).should.equal '_buf = []; _buf << (1); _buf << ("test".freeze); _buf = _buf.join'
+    gen.call([:multi, [:dynamic, '1'], [:static,  'test']]).should.equal '_buf = []; _buf << (1); _buf << ("test".freeze); _buf = _buf.join("".freeze)'
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: temple
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 0.7.7
 platform: ruby
 authors:
 - Magnus Holm
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-07 00:00:00.000000000 Z
+date: 2016-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tilt
@@ -100,7 +100,9 @@ files:
 - lib/temple/filters/escapable.rb
 - lib/temple/filters/multi_flattener.rb
 - lib/temple/filters/remove_bom.rb
+- lib/temple/filters/static_analyzer.rb
 - lib/temple/filters/static_merger.rb
+- lib/temple/filters/string_splitter.rb
 - lib/temple/filters/validator.rb
 - lib/temple/generator.rb
 - lib/temple/generators/array.rb
@@ -136,7 +138,9 @@ files:
 - test/filters/test_eraser.rb
 - test/filters/test_escapable.rb
 - test/filters/test_multi_flattener.rb
+- test/filters/test_static_analyzer.rb
 - test/filters/test_static_merger.rb
+- test/filters/test_string_splitter.rb
 - test/helper.rb
 - test/html/test_attribute_merger.rb
 - test/html/test_attribute_remover.rb
@@ -177,4 +181,3 @@ signing_key:
 specification_version: 4
 summary: Template compilation framework in Ruby
 test_files: []
-has_rdoc: