hamlit 2.11.0 → 2.13.0

data/lib/hamlit/parser/haml_temple_engine.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require 'temple'
+require 'hamlit/parser/haml_escapable'
+require 'hamlit/parser/haml_generator'
+
+module Hamlit
+  class HamlTempleEngine < Temple::Engine
+    define_options(
+      attr_wrapper:         "'",
+      autoclose:            %w(area base basefont br col command embed frame
+                               hr img input isindex keygen link menuitem meta
+                               param source track wbr),
+      encoding:             nil,
+      escape_attrs:         true,
+      escape_html:          false,
+      escape_filter_interpolations: nil,
+      filename:             '(haml)',
+      format:               :html5,
+      hyphenate_data_attrs: true,
+      line:                 1,
+      mime_type:            'text/html',
+      preserve:             %w(textarea pre code),
+      remove_whitespace:    false,
+      suppress_eval:        false,
+      cdata:                false,
+      parser_class:         ::Hamlit::HamlParser,
+      compiler_class:       ::Hamlit::HamlCompiler,
+      trace:                false,
+      filters:              {},
+    )
+
+    use :Parser,   -> { options[:parser_class] }
+    use :Compiler, -> { options[:compiler_class] }
+    use HamlEscapable
+    filter :ControlFlow
+    filter :MultiFlattener
+    filter :StaticMerger
+    use HamlGenerator
+
+    def compile(template)
+      initialize_encoding(template, options[:encoding])
+      @precompiled = call(template)
+    end
+
+    # The source code that is evaluated to produce the Haml document.
+    #
+    # This is automatically converted to the correct encoding
+    # (see {file:REFERENCE.md#encodings the `:encoding` option}).
+    #
+    # @return [String]
+    def precompiled
+      encoding = Encoding.find(@encoding || '')
+      return @precompiled.dup.force_encoding(encoding) if encoding == Encoding::ASCII_8BIT
+      return @precompiled.encode(encoding)
+    end
+
+    def precompiled_with_return_value
+      "#{precompiled};#{precompiled_method_return_value}".dup
+    end
+
+    # The source code that is evaluated to produce the Haml document.
+    #
+    # This is automatically converted to the correct encoding
+    # (see {file:REFERENCE.md#encodings the `:encoding` option}).
+    #
+    # @return [String]
+    def precompiled_with_ambles(local_names, after_preamble: '')
+      preamble = <<END.tr("\n", ';')
+begin
+extend Hamlit::HamlHelpers
+_hamlout = @haml_buffer = Hamlit::HamlBuffer.new(haml_buffer, #{HamlOptions.new(options).for_buffer.inspect})
+_erbout = _hamlout.buffer
+#{after_preamble}
+END
+      postamble = <<END.tr("\n", ';')
+#{precompiled_method_return_value}
+ensure
+@haml_buffer = @haml_buffer.upper if @haml_buffer
+end
+END
+      "#{preamble}#{locals_code(local_names)}#{precompiled}#{postamble}".dup
+    end
+
+    private
+
+    def initialize_encoding(template, given_value)
+      if given_value
+        @encoding = given_value
+      else
+        @encoding = Encoding.default_internal || template.encoding
+      end
+    end
+
+    # Returns the string used as the return value of the precompiled method.
+    # This method exists so it can be monkeypatched to return modified values.
+    def precompiled_method_return_value
+      "_erbout"
+    end
+
+    def locals_code(names)
+      names = names.keys if Hash === names
+
+      names.map do |name|
+        # Can't use || because someone might explicitly pass in false with a symbol
+        sym_local = "_haml_locals[#{inspect_obj(name.to_sym)}]"
+        str_local = "_haml_locals[#{inspect_obj(name.to_s)}]"
+        "#{name} = #{sym_local}.nil? ? #{str_local} : #{sym_local};"
+      end.join
+    end
+
+    def inspect_obj(obj)
+      case obj
+      when String
+        %Q!"#{obj.gsub(/[\x00-\x7F]+/) {|s| s.inspect[1...-1]}}"!
+      when Symbol
+        ":#{inspect_obj(obj.to_s)}"
+      else
+        obj.inspect
+      end
+    end
+  end
+end

data/lib/hamlit/parser/haml_util.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 begin
   require 'erubis/tiny'
@@ -126,7 +126,7 @@ MSG
     def inspect_obj(obj)
       case obj
       when String
-        %Q!"#{obj.gsub(/[\x00-\x7F]+/) {|s| s.inspect[1...-1]}}"!
+        %Q!"#{obj.gsub(/[\x00-\x7F]+/) {|s| s.dump[1...-1]}}"!
       when Symbol
         ":#{inspect_obj(obj.to_s)}"
       else
@@ -166,7 +166,7 @@ MSG
     #   and the rest of the string.
     #   `["Foo (Bar (Baz bang) bop)", " (Bang (bop bip))"]` in the example above.
     def balance(scanner, start, finish, count = 0)
-      str = ''
+      str = ''.dup
       scanner = StringScanner.new(scanner) unless scanner.is_a? StringScanner
       regexp = Regexp.new("(.*?)[\\#{start.chr}\\#{finish.chr}]", Regexp::MULTILINE)
       while scanner.scan(regexp)
@@ -198,12 +198,9 @@ MSG
       /#[\{$@]/ === str
     end
 
-    # Original Haml::Util.unescape_interpolation
-    # ex) slow_unescape_interpolation('foo#{bar}baz"', escape_html: true)
-    #   #=> "\"foo\#{::Hamlit::HamlHelpers.html_escape((bar))}baz\\\"\""
-    def slow_unescape_interpolation(str, escape_html = nil)
-      res = ''
-      rest = ::Hamlit::HamlUtil.handle_interpolation str.dump do |scan|
+    def unescape_interpolation(str, escape_html = nil)
+      res = ''.dup
+      rest = Hamlit::HamlUtil.handle_interpolation str.dump do |scan|
         escapes = (scan[2].size - 1) / 2
         char = scan[3] # '{', '@' or '$'
         res << scan.matched[0...-3 - escapes]
@@ -215,36 +212,9 @@ MSG
           else
             scan.scan(/\w+/)
           end
-          content = eval('"' + interpolated + '"')
-          content.prepend(char) if char == '@' || char == '$'
-          content = "::Hamlit::HamlHelpers.html_escape((#{content}))" if escape_html
-
-          res << "\#{#{content}}"
-        end
-      end
-      res + rest
-    end
-
-    # Customized Haml::Util.unescape_interpolation to handle escape by Hamlit.
-    # It wraps double quotes to given `str` with escaping `"`.
-    #
-    # ex) unescape_interpolation('foo#{bar}baz"') #=> "\"foo\#{bar}baz\\\"\""
-    def unescape_interpolation(str)
-      res = ''
-      rest = ::Hamlit::HamlUtil.handle_interpolation str.dump do |scan|
-        escapes = (scan[2].size - 1) / 2
-        char = scan[3] # '{', '@' or '$'
-        res << scan.matched[0...-3 - escapes]
-        if escapes % 2 == 1
-          res << "\##{char}"
-        else
-          interpolated = if char == '{'
-            balance(scan, ?{, ?}, 1)[0][0...-1]
-          else
-            scan.scan(/\w+/)
-          end
-          content = eval('"' + interpolated + '"')
-          content.prepend(char) if char == '@' || char == '$'
+          content = eval("\"#{interpolated}\"")
+          content = "#{char}#{content}" if char == '@' || char == '$'
+          content = "Hamlit::HamlHelpers.html_escape((#{content}))" if escape_html
 
           res << "\#{#{content}}"
         end
@@ -264,7 +234,7 @@ MSG
       scanner = StringScanner.new(str.dup.force_encoding(Encoding::ASCII_8BIT))
       bom = scanner.scan(/\xEF\xBB\xBF/n)
       return bom unless scanner.scan(/-\s*#\s*/n)
-      if coding = try_parse_haml_emacs_magic_comment(scanner)
+      if (coding = try_parse_haml_emacs_magic_comment(scanner))
         return bom, coding
       end
 

data/lib/hamlit/rails_template.rb

@@ -44,7 +44,7 @@ module Hamlit
 
   # https://github.com/haml/haml/blob/4.0.7/lib/haml/template.rb
   module HamlHelpers
-    require 'hamlit/parser/haml_xss_mods'
+    require 'hamlit/parser/haml_helpers/xss_mods'
     include Hamlit::HamlHelpers::XssMods
   end
 

data/lib/hamlit/string_splitter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'ripper'
 require 'hamlit/ruby_expression'
 

data/lib/hamlit/temple_line_counter.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+module Hamlit
+  # A module to count lines of expected code. This would be faster than actual code generation
+  # and counting newlines in it.
+  module TempleLineCounter
+    class UnexpectedExpression < StandardError; end
+
+    def self.count_lines(exp)
+      type, *args = exp
+      case type
+      when :multi
+        args.map { |a| count_lines(a) }.reduce(:+) || 0
+      when :dynamic, :code
+        args.first.count("\n")
+      when :static
+        0 # It has not real newline "\n" but escaped "\\n".
+      when :case
+        arg, *cases = args
+        arg.count("\n") + cases.map do |cond, e|
+          (cond == :else ? 0 : cond.count("\n")) + count_lines(e)
+        end.reduce(:+)
+      when :escape
+        count_lines(args[1])
+      when :newline
+        1
+      else
+        raise UnexpectedExpression.new("[HAML BUG] Unexpected Temple expression '#{type}' is given!")
+      end
+    end
+  end
+end

data/lib/hamlit/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Hamlit
-  VERSION = '2.11.0'
+  VERSION = '2.13.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hamlit
 version: !ruby/object:Gem::Version
-  version: 2.11.0
+  version: 2.13.0
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-13 00:00:00.000000000 Z
+date: 2020-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: temple
@@ -303,6 +303,7 @@ files:
 - bin/setup
 - bin/stackprof
 - bin/test
+- bin/update-haml
 - exe/hamlit
 - ext/hamlit/extconf.rb
 - ext/hamlit/hamlit.c
@@ -348,22 +349,25 @@ files:
 - lib/hamlit/identity.rb
 - lib/hamlit/object_ref.rb
 - lib/hamlit/parser.rb
-- lib/hamlit/parser/MIT-LICENSE
-- lib/hamlit/parser/README.md
+- lib/hamlit/parser/haml_attribute_builder.rb
 - lib/hamlit/parser/haml_buffer.rb
 - lib/hamlit/parser/haml_compiler.rb
 - lib/hamlit/parser/haml_error.rb
+- lib/hamlit/parser/haml_escapable.rb
+- lib/hamlit/parser/haml_generator.rb
 - lib/hamlit/parser/haml_helpers.rb
+- lib/hamlit/parser/haml_helpers/xss_mods.rb
 - lib/hamlit/parser/haml_options.rb
 - lib/hamlit/parser/haml_parser.rb
+- lib/hamlit/parser/haml_temple_engine.rb
 - lib/hamlit/parser/haml_util.rb
-- lib/hamlit/parser/haml_xss_mods.rb
 - lib/hamlit/rails_helpers.rb
 - lib/hamlit/rails_template.rb
 - lib/hamlit/railtie.rb
 - lib/hamlit/ruby_expression.rb
 - lib/hamlit/string_splitter.rb
 - lib/hamlit/template.rb
+- lib/hamlit/temple_line_counter.rb
 - lib/hamlit/utils.rb
 - lib/hamlit/version.rb
 homepage: https://github.com/k0kubun/hamlit
@@ -385,7 +389,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: High Performance Haml Implementation

data/lib/hamlit/parser/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2006-2009 Hampton Catlin and Natalie Weizenbaum
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/hamlit/parser/README.md

@@ -1,30 +0,0 @@
-# lib/hamlit/parser/haml\_\*.rb
-
-Hamlit::HamlFoo is originally Haml::Foo in haml gem.
-
-This directory is NOT intended to be updated other than following Haml's changes.
-
-## License
-
-lib/hamlit/parser/haml\_\*.rb is:
-
-Copyright (c) 2006-2009 Hampton Catlin and Natalie Weizenbaum
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.