hamlit 2.9.5 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 818a7688a58be17941aea6ddd21986d58186048882d0672b9f8a586d19a00972
-  data.tar.gz: 22c7eaef6d2fb67fe939c8d861780d4d56affa6df0d478ede2b0beb7da6bf79f
+  metadata.gz: ea5913914011f369b96f45e350597bd102cd21adaa708c71bdd78e48a9d0379f
+  data.tar.gz: 1e02820e534617ffe3df742ac06aa28b2c8ff49e3bf7d6b22d67bac36017e6f8
 SHA512:
-  metadata.gz: 56fa71f1352812b9f98e2042f4f59fb54cb35183ee3ee9c29fd9302293446522bbd5c03e0cd9859fb0d757ec854692e544a4a51e169bb9478da68b251f1059a2
-  data.tar.gz: 564b8282a5a1db7b476d664792d157112fbe5f4d28be48b0d31f89542c084fda0c17f86a2930306c3ed9b599b04e43073e81929488d49b0101a78ed2c336bceb
+  metadata.gz: 0cb42767eb9b77de2c881d7c0b3546b086dd97f65a05a4cd81d525ff3428e5065c33a41bd0dbddf19045682181fd3eaf73fb541dbf930554d3bbe80c7fee77aa
+  data.tar.gz: 47fe8b4b28777a5aaa84f37049b163625b24f1d111cb41e20df6275c2c49d3755cd8231aa81311019e0b961668c19f6ad43512d7eef6a7ff89dd26c38e6741ed

data/.gitignore

@@ -11,6 +11,7 @@
 .ruby-version
 *.bundle
 *.so
+*.su
 *.o
 *.a
 *.swp

data/CHANGELOG.md

@@ -4,6 +4,30 @@ All notable changes to this project will be documented in this file. This
 project adheres to [Semantic Versioning](http://semver.org/). This change log is based upon
 [keep-a-changelog](https://github.com/olivierlacan/keep-a-changelog).
 
+## [2.11.0](https://github.com/k0kubun/hamlit/compare/v2.10.0...v2.10.1) - 2019-12-12
+
+### Added
+
+- Support Haml's _revealed_ conditional comment feature on `/![if !IE]` [#153](https://github.com/k0kubun/hamlit/issues/153).
+  *Thanks to @esb*
+
+## [2.10.1](https://github.com/k0kubun/hamlit/compare/v2.10.0...v2.10.1) - 2019-11-28
+
+### Added
+
+- Register `Hamlit::Template` to Tilt as :hamlit as well, in addition to :haml
+
+## [2.10.0](https://github.com/k0kubun/hamlit/compare/v2.9.5...v2.10.0) - 2019-09-15
+
+### Added
+
+- Optimize template rendering by string interpolation [#146](https://github.com/k0kubun/hamlit/issues/146)
+  - Exploiting pre-allocation of string interpolation introduced in Ruby 2.5 [ruby/ruby#1626](https://github.com/ruby/ruby/pull/1626)
+
+### Changed
+
+- Require temple.gem >= 0.8.2
+
 ## [2.9.5](https://github.com/k0kubun/hamlit/compare/v2.9.4...v2.9.5) - 2019-09-08
 
 ### Added

data/Gemfile

@@ -14,11 +14,11 @@ end
 
 gem 'benchmark-ips', '2.3.0'
 gem 'maxitest'
+gem 'pry'
 
 if /java/ === RUBY_PLATFORM # JRuby
   gem 'pandoc-ruby'
 else
-  gem 'pry-byebug'
   gem 'redcarpet'
 
   if RUBY_PLATFORM !~ /mswin|mingw/ && RUBY_ENGINE != 'truffleruby'

data/REFERENCE.md

@@ -57,6 +57,7 @@ for full features in original implementation.
   - [x] :plain
   - [x] :preserve
   - [x] :ruby
+     - `haml_io` API is not supported. Use [hamlit-haml\_io.gem](https://github.com/hamlit/hamlit-haml_io) if you need.
   - [x] :sass
   - [x] :scss
   - [ ] :textile
@@ -224,6 +225,14 @@ Hamlit::RailsTemplate.set_options attr_quote: '"'
 set :haml, { attr_quote: '"' }
 ```
 
+## Ruby module
+
+`Hamlit::Template` is a module registered to `Tilt`. You can use it like:
+
+```rb
+Hamlit::Template.new { "%strong Yay for HAML!" }.render
+```
+
 ## Creating a custom filter
 
 Currently it doesn't have filter registering interface compatible with Haml.

data/benchmark/dynamic_merger/benchmark.rb

@@ -0,0 +1,25 @@
+# Original: https://github.com/amatsuda/string_template/blob/master/benchmark.rb
+require 'benchmark_driver'
+
+Benchmark.driver(repeat_count: 8) do |x|
+  x.prelude %{
+    require 'rails'
+    require 'action_view'
+    require 'string_template'
+    StringTemplate::Railtie.run_initializers
+    require 'hamlit'
+    Hamlit::Railtie.run_initializers
+    Hamlit::RailsTemplate.set_options(escape_html: false, generator: Temple::Generators::ArrayBuffer)
+    require 'action_view/base'
+
+    (view = Class.new(ActionView::Base).new(ActionView::LookupContext.new(''))).instance_variable_set(:@world, 'world!')
+
+    # compile template
+    hello = 'benchmark/dynamic_merger/hello'
+    view.render(template: hello, handlers: 'string')
+    view.render(template: hello, handlers: 'haml')
+  }
+  x.report 'string', %{ view.render(template: hello, handlers: 'string') }
+  x.report 'hamlit', %{ view.render(template: hello, handlers: 'haml') }
+  x.loop_count 100_000
+end

data/benchmark/dynamic_merger/hello.haml

@@ -0,0 +1,50 @@
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }

data/benchmark/dynamic_merger/hello.string

@@ -0,0 +1,50 @@
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }

data/bin/bench

@@ -25,7 +25,7 @@ class Bench < Thor
     haml = File.read(file)
 
     Benchmark.ips do |x|
-      x.report("haml v#{Haml::VERSION}") { Haml::Engine.new(haml, escape_html: true, escape_attrs: true, ugly: true).precompiled }
+      x.report("haml v#{Haml::VERSION}") { Haml::Engine.new(haml, escape_html: true, escape_attrs: true).precompiled }
       x.report("faml v#{Faml::VERSION}") { Faml::Engine.new.call(haml) }
       x.report("hamlit v#{Hamlit::VERSION}") { Hamlit::Engine.new.call(haml) }
       x.compare!
@@ -43,7 +43,7 @@ class Bench < Thor
       object.instance_eval(File.read(ruby_file))
     end
 
-    Haml::Engine.new(haml, escape_html: true, escape_attrs: true, ugly: true).def_method(object, :haml)
+    Haml::Engine.new(haml, escape_html: true, escape_attrs: true).def_method(object, :haml)
     object.instance_eval "def faml; #{Faml::Engine.new.call(haml)}; end"
     object.instance_eval "def hamlit; #{Hamlit::Engine.new.call(haml)}; end"
 
@@ -59,7 +59,7 @@ class Bench < Thor
   def code(file)
     haml = File.read(file)
     puts "#{?= * 49}\n Haml Source: #{file}\n#{?= * 49}"
-    puts Haml::Engine.new(haml, escape_html: true, escape_attrs: true, ugly: true).precompiled
+    puts Haml::Engine.new(haml, escape_html: true, escape_attrs: true).precompiled
     puts "\n#{?= * 49}\n Faml Source: #{file}\n#{?= * 49}"
     puts Faml::Engine.new.call(haml)
     puts "\n#{?= * 49}\n Hamlit Source: #{file}\n#{?= * 49}"

data/hamlit.gemspec

@@ -26,10 +26,11 @@ Gem::Specification.new do |spec|
     spec.required_ruby_version = '>= 2.1.0'
   end
 
-  spec.add_dependency 'temple', '>= 0.8.0'
+  spec.add_dependency 'temple', '>= 0.8.2'
   spec.add_dependency 'thor'
   spec.add_dependency 'tilt'
 
+  spec.add_development_dependency 'benchmark_driver'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'coffee-script'
   spec.add_development_dependency 'erubi'
@@ -41,5 +42,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake-compiler'
   spec.add_development_dependency 'sass'
   spec.add_development_dependency 'slim'
+  spec.add_development_dependency 'string_template'
   spec.add_development_dependency 'unindent'
 end

data/lib/hamlit/compiler/comment_compiler.rb

@@ -25,11 +25,13 @@ module Hamlit
           condition = $1
         end
 
-        if node.children.empty?
-          [:html, :condcomment, condition, [:static, " #{node.value[:text]} "]]
-        else
-          [:html, :condcomment, condition, yield(node)]
-        end
+        content =
+          if node.children.empty?
+            [:static, " #{node.value[:text]} "]
+          else
+            yield(node)
+          end
+        [:html, :condcomment, condition, content, node.value[:revealed]]
       end
     end
   end

data/lib/hamlit/compiler/tag_compiler.rb

@@ -55,10 +55,6 @@ module Hamlit
 
       # We should handle interpolation here to escape only interpolated values.
       def compile_interpolated_plain(node)
-        unless Ripper.respond_to?(:lex) # No Ripper.lex in truffleruby
-          return [:multi, [:escape, node.value[:escape_interpolation], [:dynamic, "%Q[#{node.value[:value]}]"]], [:newline]]
-        end
-
         temple = [:multi]
         StringSplitter.compile(node.value[:value]).each do |type, value|
           case type

data/lib/hamlit/dynamic_merger.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+module Hamlit
+  # Compile [:multi, [:static, 'foo'], [:dynamic, 'bar']] to [:dynamic, '"foo#{bar}"']
+  class DynamicMerger < Temple::Filter
+    def on_multi(*exps)
+      exps = exps.dup
+      result = [:multi]
+      buffer = []
+
+      until exps.empty?
+        type, arg = exps.first
+        if type == :dynamic && arg.count("\n") == 0
+          buffer << exps.shift
+        elsif type == :static && exps.size > (count = arg.count("\n")) &&
+              exps[1, count].all? { |e| e == [:newline] }
+          (1 + count).times { buffer << exps.shift }
+        elsif type == :newline && exps.size > (count = count_newline(exps)) &&
+              exps[count].first == :static && count == exps[count].last.count("\n")
+          (count + 1).times { buffer << exps.shift }
+        else
+          result.concat(merge_dynamic(buffer))
+          buffer = []
+          result << compile(exps.shift)
+        end
+      end
+      result.concat(merge_dynamic(buffer))
+
+      result.size == 2 ? result[1] : result
+    end
+
+    private
+
+    def merge_dynamic(exps)
+      # Merge exps only when they have both :static and :dynamic
+      unless exps.any? { |type,| type == :static } && exps.any? { |type,| type == :dynamic }
+        return exps
+      end
+
+      strlit_body = String.new
+      exps.each do |type, arg|
+        case type
+        when :static
+          strlit_body << arg.dump.sub!(/\A"/, '').sub!(/"\z/, '').gsub('\n', "\n")
+        when :dynamic
+          strlit_body << "\#{#{arg}}"
+        when :newline
+          # newline is added by `gsub('\n', "\n")`
+        else
+          raise "unexpected type #{type.inspect} is given to #merge_dynamic"
+        end
+      end
+      [[:dynamic, "%Q\0#{strlit_body}\0"]]
+    end
+
+    def count_newline(exps)
+      count = 0
+      exps.each do |exp|
+        if exp == [:newline]
+          count += 1
+        else
+          return count
+        end
+      end
+      return count
+    end
+  end
+end

data/lib/hamlit/engine.rb

@@ -2,10 +2,10 @@
 require 'temple'
 require 'hamlit/parser'
 require 'hamlit/compiler'
+require 'hamlit/html'
 require 'hamlit/escapable'
 require 'hamlit/force_escapable'
-require 'hamlit/html'
-require 'hamlit/string_splitter'
+require 'hamlit/dynamic_merger'
 
 module Hamlit
   class Engine < Temple::Engine
@@ -25,15 +25,14 @@ module Hamlit
     use Parser
     use Compiler
     use HTML
-    if Ripper.respond_to?(:lex) # No Ripper.lex in truffleruby
-      use StringSplitter
-      filter :StaticAnalyzer
-    end
+    filter :StringSplitter
+    filter :StaticAnalyzer
     use Escapable
     use ForceEscapable
     filter :ControlFlow
     filter :MultiFlattener
     filter :StaticMerger
+    use DynamicMerger
     use :Generator, -> { options[:generator] }
   end
 end

data/lib/hamlit/filters/plain.rb

@@ -14,10 +14,6 @@ module Hamlit
 
       def compile_plain(text)
         string_literal = ::Hamlit::HamlUtil.unescape_interpolation(text)
-        unless Ripper.respond_to?(:lex) # truffleruby doesn't have Ripper.lex
-          return [[:escape, false, [:dynamic, string_literal]]]
-        end
-
         StringSplitter.compile(string_literal).map do |temple|
           type, str = temple
           case type

data/lib/hamlit/html.rb

@@ -10,5 +10,13 @@ module Hamlit
       end
       super(opts)
     end
+
+    # This dispatcher supports Haml's "revealed" conditional comment.
+    def on_html_condcomment(condition, content, revealed = false)
+      on_html_comment [:multi,
+                       [:static, "[#{condition}]>#{'<!-->' if revealed}"],
+                       content,
+                       [:static, "#{'<!--' if revealed}<![endif]"]]
+    end
   end
 end

data/lib/hamlit/string_splitter.rb

@@ -2,87 +2,18 @@ require 'ripper'
 require 'hamlit/ruby_expression'
 
 module Hamlit
-  class StringSplitter < Temple::Filter
-    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 && %i[on_comment on_sp].include?(tokens.last[1])
-
-          if tokens.size < 2
-            raise Hamlit::InternalError.new("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 Hamlit::InternalError.new("Expected :on_tstring_beg but got: #{type}")
-        end
-
-        _, type, end_str = tokens.pop
-        if type != :on_tstring_end
-          raise Hamlit::InternalError.new("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}")]
-          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
+  module StringSplitter
+    # `code` param must be valid string literal
+    def self.compile(code)
+      unless Ripper.respond_to?(:lex) # truffleruby doesn't have Ripper.lex
+        return [[:dynamic, code]]
       end
-    end
-
-    def on_dynamic(code)
-      return [:dynamic, code] unless RubyExpression.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
+      begin
+        Temple::Filters::StringSplitter.compile(code)
+      rescue Temple::FilterError => e
+        raise Hamlit::InternalError.new(e.message)
       end
-      temple
     end
   end
 end

data/lib/hamlit/template.rb

@@ -14,7 +14,7 @@ end
 module Hamlit
   Template = Temple::Templates::Tilt.create(
     Hamlit::Engine,
-    register_as: :haml,
+    register_as: [:haml, :hamlit],
   )
 
   module TemplateExtension

data/lib/hamlit/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hamlit
 version: !ruby/object:Gem::Version
-  version: 2.9.5
+  version: 2.11.0
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-08 00:00:00.000000000 Z
+date: 2019-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: temple
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.8.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.8.2
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: benchmark_driver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -206,6 +220,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: string_template
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: unindent
   requirement: !ruby/object:Gem::Requirement
@@ -247,6 +275,9 @@ files:
 - benchmark/dynamic_attributes/data_attribute.haml
 - benchmark/dynamic_attributes/id_attribute.haml
 - benchmark/dynamic_boolean_attribute.haml
+- benchmark/dynamic_merger/benchmark.rb
+- benchmark/dynamic_merger/hello.haml
+- benchmark/dynamic_merger/hello.string
 - benchmark/etc/attribute_builder.haml
 - benchmark/etc/real_sample.haml
 - benchmark/etc/real_sample.rb
@@ -290,6 +321,7 @@ files:
 - lib/hamlit/compiler/script_compiler.rb
 - lib/hamlit/compiler/silent_script_compiler.rb
 - lib/hamlit/compiler/tag_compiler.rb
+- lib/hamlit/dynamic_merger.rb
 - lib/hamlit/engine.rb
 - lib/hamlit/error.rb
 - lib/hamlit/escapable.rb
@@ -311,7 +343,6 @@ files:
 - lib/hamlit/filters/text_base.rb
 - lib/hamlit/filters/tilt_base.rb
 - lib/hamlit/force_escapable.rb
-- lib/hamlit/hamlit.su
 - lib/hamlit/helpers.rb
 - lib/hamlit/html.rb
 - lib/hamlit/identity.rb