hamlit 2.10.1 → 2.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc231a76a98c6d527ca80a30385e3161a207814e9e1d3abe593929910e222795
-  data.tar.gz: 21a57103fa4f6ac2df5ff712a8c1e2bc6f799cb59ec06d39769518b251d60139
+  metadata.gz: 49336d834649a0b858580664e658063bdc7286d2a1daac3f669da539fff775a1
+  data.tar.gz: 7606a4faf12c5ef04146fe336c827c518277fb4db9391167fba38a16b33ebfc5
 SHA512:
-  metadata.gz: 95b3596d2f44759d90c3c02065c0986cf107179513bf31a8bb1116d35064cf2049e2ad342c30b884e938fef1a2c228f11ce15c5f4350bb09143d5d19dcf753ff
-  data.tar.gz: dd36a42a6aa53e8f2b3e45865d077dc459d91ec0388a784b3ed5e2420bcaebc3f9b6c01f020d3e68acc17a9e209e8e0f1ac7ab9915390717fbcba2348fdead16
+  metadata.gz: 5f69bcd2ded91a2dd610fb0ec270a623a8abd4ffcec5c5df94b9779cacbec10228bceb71fbf480aa076261b5b2d5448d52b38adf6df203a1a5661aea8ff640c0
+  data.tar.gz: fbd9a6ee757236f8b02b670ca781669fc24f1d81644210bfa40a7d611a2b4b040cdd7694a8a6fb8c711409f2ff42fada31c6693d60de9c246b5d2ffd74c34d9d

data/.github/workflows/test.yml

@@ -0,0 +1,30 @@
+name: test
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+  schedule:
+    - cron: "00 15 * * *" # 7:00 PST (-8), 8:00 PDT (-7)
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    container: ${{ matrix.ruby }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - ruby:2.5
+          - ruby:2.6
+          - ruby:2.7
+          # TODO: add jruby and truffleruby
+    steps:
+      - uses: actions/checkout@v2
+      - run: apt-get update && apt-get install -y nodejs # For execjs
+      - name: bundle install
+        run: bundle install -j$(nproc) --retry 3
+      - run: bundle exec rake test

data/.gitignore

@@ -7,6 +7,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/haml/
 .sass-cache
 .ruby-version
 *.bundle

data/CHANGELOG.md

@@ -4,6 +4,48 @@ 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.13.1](https://github.com/k0kubun/hamlit/compare/v2.13.0...v2.13.1) - 2020-12-27
+
+### Added
+
+- Support [multiline attributes](https://github.com/haml/haml/pull/1043) of Haml 5.2.1.
+
+## [2.13.0](https://github.com/k0kubun/hamlit/compare/v2.12.0...v2.13.0) - 2020-10-02
+
+### Added
+
+- Support `--enable-frozen-string-literal` [#162](https://github.com/k0kubun/hamlit/issues/162).
+  *Thanks to @aliismayilov*
+
+### Changed
+
+- Upgrade the Haml parser from Haml 4.0 to 5.2 [#163](https://github.com/k0kubun/hamlit/issues/163).
+  - Allow `@` as tag's class name.
+  - Fix NameError on an `InvalidAttributeNameError` reference introduced at Hamlit v2.12.0.
+  - You can no longer specify `ugly` option, which has had no effect.
+
+## [2.12.0](https://github.com/k0kubun/hamlit/compare/v2.11.1...v2.12.0) - 2020-09-30
+
+### Changed
+
+- Class names are no longer ordered alphabetically.
+  *Thanks to @aliismayilov*
+  - This is compatible with [Haml 5.2](https://github.com/haml/haml/blob/v5.2.0/CHANGELOG.md#52)
+
+## [2.11.1](https://github.com/k0kubun/hamlit/compare/v2.11.0...v2.11.1) - 2020-08-25
+
+### Fixed
+
+- Fix a line number on an error after filters like preserve, plain, and ruby.
+  *Thanks to @rgisiger*
+
+## [2.11.0](https://github.com/k0kubun/hamlit/compare/v2.10.1...v2.11.0) - 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

data/Gemfile

@@ -8,10 +8,6 @@ end
 # Specify your gem's dependencies in hamlit.gemspec
 gemspec
 
-if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.2.2')
-  gem 'rack', '< 2'
-end
-
 gem 'benchmark-ips', '2.3.0'
 gem 'maxitest'
 gem 'pry'
@@ -22,9 +18,7 @@ else
   gem 'redcarpet'
 
   if RUBY_PLATFORM !~ /mswin|mingw/ && RUBY_ENGINE != 'truffleruby'
-    if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.7.0') # Travis cannot compile ruby.h with C++
-      gem 'faml'
-    end
+    gem 'faml'
     gem 'stackprof'
   end
 end

data/LICENSE.txt

@@ -1,3 +1,29 @@
+Copyright (c) 2006-2019 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.
+
+===
+
+The above license is applied to lib/hamlit/parser/*.rb and test/haml/*.
+Everything else is licensed under:
+
 The MIT License (MIT)
 
 Copyright (c) 2015 Takashi Kokubun
@@ -19,26 +45,3 @@ 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.
-
-lib/hamlit/parser/*.rb and test/haml/* are:
-
-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/README.md

@@ -10,17 +10,17 @@ Hamlit is a high performance [Haml](https://github.com/haml/haml) implementation
 ### What is Hamlit?
 Hamlit is another implementation of [Haml](https://github.com/haml/haml).
 With some [limitations](REFERENCE.md#limitations) by design for performance,
-Hamlit is **2.39x times faster** than original haml gem in [this benchmark](benchmark/slim/run-benchmarks.rb),
-which is an HTML-escaped version of [slim-template/slim's one](https://github.com/slim-template/slim/blob/v3.0.8/benchmarks/run-benchmarks.rb) for fairness. ([Result on Travis](https://travis-ci.org/k0kubun/hamlit/jobs/236567391))
+Hamlit is **1.94x times faster** than original haml gem in [this benchmark](benchmark/slim/run-benchmarks.rb),
+which is an HTML-escaped version of [slim-template/slim's one](https://github.com/slim-template/slim/blob/4.1.0/benchmarks/run-benchmarks.rb) for fairness. ([Result on Travis](https://travis-ci.org/github/k0kubun/hamlit/jobs/732178446))
 
-<img src="https://i.gyazo.com/0f0c0362b6bd69f82715bec1d8caa191.png" width="600px" alt="Hamlit Benchmark"/>
+<img src="https://raw.githubusercontent.com/k0kubun/hamlit/afcc2b36c4861c2f764baa09afd9530ca25eeafa/benchmark/graph/graph.png" width="600x" alt="Hamlit Benchmark" />
 
 ```
-       hamlit v2.8.1:   131048.9 i/s
-        erubi v1.6.0:   125445.4 i/s - 1.04x slower
-         slim v3.0.8:   121390.4 i/s - 1.08x slower
-         faml v0.8.1:   100750.5 i/s - 1.30x slower
-         haml v5.0.1:    54882.6 i/s - 2.39x slower
+      hamlit v2.13.0:   247404.4 i/s
+        erubi v1.9.0:   244356.4 i/s - 1.01x slower
+         slim v4.1.0:   238254.3 i/s - 1.04x slower
+         faml v0.8.1:   197293.2 i/s - 1.25x slower
+         haml v5.2.0:   127834.4 i/s - 1.94x slower
 ```
 
 ### Why is Hamlit faster?

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
@@ -121,10 +122,10 @@ and merging multiple ids results in concatenation by "\_".
 %div{ id: false }
 
 # Output
-<div id='foo_bar'></span>
-<div id='foo_bar'></span>
-<div id='foo_bar'></span>
-<div id=''></span>
+<div id='foo_bar'></div>
+<div id='foo_bar'></div>
+<div id='foo_bar'></div>
+<div id=''></div>
 ```
 
 ### class attribute
@@ -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/bin/update-haml

@@ -0,0 +1,125 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+require 'tmpdir'
+
+HAML_REPO    = 'haml/haml'
+HAML_VERSION = '5.2.1'
+
+module GitHubFetcher
+  def self.fetch(repo, tag:, path:)
+    Dir.mktmpdir do |dir|
+      Dir.chdir(dir) do
+        url = "https://github.com/#{repo}/archive/#{tag}.tar.gz"
+        system("curl -L --fail --retry 3 --retry-delay 1 #{url} -o - | tar zxf -")
+        FileUtils.mv("#{File.basename(repo)}-#{tag.sub(/\Av/, '')}", path)
+      end
+    end
+  end
+end
+
+class LicenseBuilder
+  DELIMITER = "\n==="
+
+  def initialize(haml_license:, hamlit_license:)
+    @haml_license = haml_license
+    @hamlit_license = hamlit_license
+  end
+
+  def build
+    license = [
+      File.read(@haml_license),
+      File.read(@hamlit_license).split(DELIMITER, 2).last,
+    ].join(DELIMITER)
+    File.write(@hamlit_license, license)
+  end
+end
+
+# Generate lib/hamlit/parser from haml
+class HamlitParserBuilder
+  TARGET_FILES = [
+    'attribute_builder.rb',
+    'buffer.rb',
+    'error.rb',
+    'helpers.rb',
+    'options.rb',
+    'temple_engine.rb',
+    # TODO: make the upstream sharable first
+    # 'parser.rb',
+    'util.rb',
+    'helpers/xss_mods.rb',
+  ]
+
+  # Classes which are just referenced by Options and not really used by the parser
+  DUMMY_CLASSES = {
+    'compiler.rb' => 'Compiler',
+    'escapable.rb' => 'Escapable',
+    'generator.rb' => 'Generator',
+  }
+
+  def initialize(haml:, hamlit_parser:)
+    @haml = haml
+    @hamlit_parser = hamlit_parser
+  end
+
+  def build
+    TARGET_FILES.each do |file|
+      src_path  = File.join(@haml, file)
+      dest_path = File.join(@hamlit_parser, "haml_#{file}")
+
+      FileUtils.mkdir_p(File.dirname(dest_path))
+      FileUtils.cp(src_path, dest_path)
+
+      src = File.read(dest_path)
+      patch_source!(src, file: file)
+      File.write(dest_path, src)
+    end
+
+    DUMMY_CLASSES.each do |file, klass|
+      dest_path = File.join(@hamlit_parser, "haml_#{file}")
+      src = "class Hamlit::Haml#{klass}; end\n"
+      File.write(dest_path, src)
+    end
+  end
+
+  private
+
+  def patch_source!(src, file:)
+    # Use Hamlit::HamlFoo instead of Haml::Foo
+    src.gsub!(/^module Haml\n((?:  #[^\n]+\n)*)  (module|class) ([^ ]+)/, "module Hamlit\n\\1  \\2 Haml\\3")
+    src.gsub!(/\bHaml::/, 'Hamlit::Haml')
+
+    # Prefix Haml to references without Haml::
+    src.gsub!(/\b(AttributeBuilder|Error|InvalidAttributeNameError|Options|Parser|SyntaxError)\./, 'Haml\0')
+    src.gsub!(/\brescue SyntaxError /, 'rescue HamlSyntaxError ')
+
+    # Hamlit should not rely on Haml
+    src.gsub!(/^require 'haml\/([^']+)'/, "require 'hamlit/parser/haml_\\1'")
+
+    case file
+    when 'error.rb'
+      src.gsub!(/^  class ([^ ]+) < ([^ ]+);/, '  class Haml\1 < Haml\2;')
+    when 'helpers.rb'
+      src.gsub!(/^  def is_haml\?\n    false\n  end/m) { |str| str.gsub(/^  /, '  # ') } # not needed for the parser
+    when 'options.rb'
+      src.gsub!(/\.is_a\?\(Options\)/, '.is_a?(HamlOptions)')
+    when 'temple_engine.rb'
+      src.gsub!(/\buse (Generator|Escapable)$/, 'use Haml\1')
+    end
+  end
+end
+
+FileUtils.rm_rf(haml = File.expand_path('../haml', __dir__))
+GitHubFetcher.fetch(HAML_REPO, tag: HAML_VERSION, path: haml)
+
+hamlit = File.expand_path('..', __dir__)
+LicenseBuilder.new(
+  haml_license: File.join(haml, 'MIT-LICENSE'),
+  hamlit_license: File.join(hamlit, 'LICENSE.txt'),
+).build
+
+hamlit_parser = File.join(hamlit, 'lib/hamlit/parser')
+# TODO: FileUtils.rm_rf(hamlit_parser = File.join(hamlit, 'lib/hamlit/parser'))
+HamlitParserBuilder.new(
+  haml: File.join(haml, 'lib/haml'),
+  hamlit_parser: hamlit_parser,
+).build

data/ext/hamlit/hamlit.c

@@ -152,7 +152,6 @@ hamlit_build_multi_class(VALUE escape_attrs, VALUE values)
     }
   }
 
-  rb_ary_sort_bang(buf);
   rb_funcall(buf, id_uniq_bang, 0);
 
   return escape_attribute(escape_attrs, rb_ary_join(buf, str_space()));

data/hamlit.gemspec

@@ -37,7 +37,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'haml', '>= 5'
   spec.add_development_dependency 'less'
   spec.add_development_dependency 'minitest-reporters', '~> 1.1'
-  spec.add_development_dependency 'rails', '>= 4.0.0'
+  spec.add_development_dependency 'rails', '>= 4.0'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rake-compiler'
   spec.add_development_dependency 'sass'

data/lib/hamlit/attribute_builder.rb

@@ -47,7 +47,7 @@ module Hamlit::AttributeBuilder
           when value.is_a?(String)
             # noop
           when value.is_a?(Array)
-            value = value.flatten.select { |v| v }.map(&:to_s).sort.uniq.join(' ')
+            value = value.flatten.select { |v| v }.map(&:to_s).uniq.join(' ')
           when value
             value = value.to_s
           else
@@ -67,7 +67,7 @@ module Hamlit::AttributeBuilder
             classes << value.to_s
           end
         end
-        escape_html(escape_attrs, classes.map(&:to_s).sort.uniq.join(' '))
+        escape_html(escape_attrs, classes.map(&:to_s).uniq.join(' '))
       end
 
       def build_data(escape_attrs, quote, *hashes)

data/lib/hamlit/attribute_compiler.rb

@@ -17,7 +17,7 @@ module Hamlit
       if node.value[:object_ref] != :nil || !Ripper.respond_to?(:lex) # No Ripper.lex in truffleruby
         return runtime_compile(node)
       end
-      node.value[:attributes_hashes].each do |attribute_str|
+      [node.value[:dynamic_attributes].new, node.value[:dynamic_attributes].old].compact.each do |attribute_str|
         hash = AttributeParser.parse(attribute_str)
         return runtime_compile(node) unless hash
         hashes << hash
@@ -28,11 +28,11 @@ module Hamlit
     private
 
     def runtime_compile(node)
-      attrs = node.value[:attributes_hashes]
+      attrs = []
       attrs.unshift(node.value[:attributes].inspect) if node.value[:attributes] != {}
 
       args = [@escape_attrs.inspect, "#{@quote.inspect}.freeze", @format.inspect].push(node.value[:object_ref]) + attrs
-      [:html, :attrs, [:dynamic, "::Hamlit::AttributeBuilder.build(#{args.join(', ')})"]]
+      [:html, :attrs, [:dynamic, "::Hamlit::AttributeBuilder.build(#{args.join(', ')}, #{node.value[:dynamic_attributes].to_literal})"]]
     end
 
     def static_compile(static_hash, dynamic_hashes)

data/lib/hamlit/compiler/children_compiler.rb

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
+require 'hamlit/temple_line_counter'
+
 module Hamlit
   class Compiler
     class ChildrenCompiler
@@ -14,7 +16,7 @@ module Hamlit
         node.children.each do |n|
           rstrip_whitespace!(temple) if nuke_prev_whitespace?(n)
           insert_newlines!(temple, n)
-          temple << yield(n)
+          temple << moving_lineno(n) { block.call(n) }
           temple << :whitespace if insert_whitespace?(n)
         end
         rstrip_whitespace!(temple) if nuke_inner_whitespace?(node)
@@ -27,19 +29,31 @@ module Hamlit
         (node.line - @lineno).times do
           temple << [:newline]
         end
+
         @lineno = node.line
+      end
 
+      def moving_lineno(node, &block)
+        # before: As they may have children, we need to increment lineno before compilation.
         case node.type
         when :script, :silent_script
           @lineno += 1
-        when :filter
-          @lineno += (node.value[:text] || '').split("\n").size
         when :tag
-          node.value[:attributes_hashes].each do |attribute_hash|
+          [node.value[:dynamic_attributes].new, node.value[:dynamic_attributes].old].compact.each do |attribute_hash|
             @lineno += attribute_hash.count("\n")
           end
           @lineno += 1 if node.children.empty? && node.value[:parse]
         end
+
+        temple = block.call # compile
+
+        # after: filter may not have children, and for some dynamic filters we can't predict the number of lines.
+        case node.type
+        when :filter
+          @lineno += TempleLineCounter.count_lines(temple)
+        end
+
+        temple
       end
 
       def confirm_whitespace(temple)