hamlit 2.11.1 → 2.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 315b433bd4a2af17f13b1a8ff54787c65b25beabcbdb1274dd86b29248e75f60
-  data.tar.gz: cd02934b413dd1cf6891f35f5cb1ee8731d68e0f82eb300bf92679b7574ec598
+  metadata.gz: 3a301e3719b15a8bd389c69273087c6133a0f64a50794e256106c65fb402a652
+  data.tar.gz: f5548a7ca946d6339a4767c13fc4dfcf8779274a95d179dccabf4ceb269aa35e
 SHA512:
-  metadata.gz: 128daeb6d3f1d34fd33718b90b20b75117cda4147e8783d039b2daf0e019d836ac580d78fd3e01561f53f4348e442d3a04169761048cc2105ef1e3cae5c5c131
-  data.tar.gz: 0c11bc8dce803aa8d2adfdc78c7b91274678371adb7d30a8a36d997b60ada32320349712cd39c1feec7d965f5e1bbf6b6ab878a3769d4e20ee245afd1772bf79
+  metadata.gz: c5858d26f7573e085d1da827a3d9eee1a6c8252e8a6a0459a8e1022dc99a2cb15cce1bd4931ffc2df26815e85a717df0fd119f3585d605aaeb67a5c7c38021df
+  data.tar.gz: 6fa9187e20778096808fce4e997df74c67b9d980ba4219baf55b64f9930b87c3b35b21a74c50355c6a443750e6d5465d6b6977dd322aeea5bdc7ecdb57d44519

data/.github/workflows/test.yml

@@ -0,0 +1,36 @@
+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
+          - ruby:3.0
+          # TODO: add jruby and truffleruby
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-${{ matrix.ruby }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: ${{ runner.os }}-gems-
+      - run: apt-get update && apt-get install -y nodejs # For execjs
+      - name: bundle install
+        run: bundle config path vendor/bundle && bundle install -j$(nproc) --retry 3
+      - run: bundle exec rake test

data/.gitignore

@@ -7,11 +7,12 @@
 /pkg/
 /spec/reports/
 /tmp/
+/haml/
 .sass-cache
 .ruby-version
 *.bundle
 *.so
 *.su
-*.o
 *.a
+*.o
 *.swp

data/CHANGELOG.md

@@ -4,6 +4,59 @@ 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.14.1](https://github.com/k0kubun/hamlit/compare/v2.14.0...v2.14.1) - 2021-01-07
+
+### Added
+
+- Add `-c` option to `hamlit compile` that works like `haml -c` [#166](https://github.com/k0kubun/hamlit/issues/166)
+  *Thanks to @knightq*
+
+## [2.14.0](https://github.com/k0kubun/hamlit/compare/v2.13.2...v2.14.0) - 2021-01-07
+
+### Changed
+
+- CLI changes
+  - Remove `-c` shorthand of `--color`.
+  - Make `--color` default. Please use `--no-color` to disable it.
+  - `--color` uses IRB instead of Pry for syntax highlight.
+     - Syntax highlight of `hamlit compile` is enabled only with IRB of Ruby 2.7+.
+     - Syntax highlight of `hamlit parse` / `hamlit temple` is enabled only with IRB of Ruby 3.1+.
+
+## [2.13.2](https://github.com/k0kubun/hamlit/compare/v2.13.1...v2.13.2) - 2020-12-27
+
+### Added
+
+- Speed up `hamlit` commands [#166](https://github.com/k0kubun/hamlit/issues/166)
+  *Thanks to @knightq*
+
+## [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

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'

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

@@ -2,6 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/hamlit.svg)](http://badge.fury.io/rb/hamlit)
 [![Build Status](https://travis-ci.org/k0kubun/hamlit.svg?branch=master)](https://travis-ci.org/k0kubun/hamlit)
+[![test](https://github.com/k0kubun/hamlit/workflows/test/badge.svg)](https://github.com/k0kubun/hamlit/actions?query=workflow%3Atest)
 
 Hamlit is a high performance [Haml](https://github.com/haml/haml) implementation.
 
@@ -10,17 +11,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/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.rb

@@ -4,8 +4,10 @@ require 'hamlit/error'
 require 'hamlit/version'
 require 'hamlit/template'
 
-begin
-  require 'rails'
-  require 'hamlit/railtie'
-rescue LoadError
+if File.basename($0) != 'hamlit'
+  begin
+    require 'rails'
+    require 'hamlit/railtie'
+  rescue LoadError
+  end
 end

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/cli.rb

@@ -13,25 +13,33 @@ module Hamlit
     def render(file)
       process_load_options
       code = generate_code(file)
-      puts eval(code)
+      puts eval(code, binding, file)
     end
 
     desc 'compile HAML', 'Show compile result'
     option :actionview, type: :boolean, default: false, aliases: %w[-a]
-    option :color, type: :boolean, default: false, aliases: %w[-c]
+    option :color, type: :boolean, default: true
+    option :check, type: :boolean, default: false, aliases: %w[-c]
     def compile(file)
       code = generate_code(file)
+      if options[:check]
+        if error = validate_ruby(code, file)
+          abort error.message.split("\n").first
+        end
+        puts "Syntax OK"
+        return
+      end
       puts_code(code, color: options[:color])
     end
 
     desc 'temple HAML', 'Show temple intermediate expression'
-    option :color, type: :boolean, default: false, aliases: %w[-c]
+    option :color, type: :boolean, default: true
     def temple(file)
       pp_object(generate_temple(file), color: options[:color])
     end
 
     desc 'parse HAML', 'Show parse result'
-    option :color, type: :boolean, default: false, aliases: %w[-c]
+    option :color, type: :boolean, default: true
     def parse(file)
       pp_object(generate_ast(file), color: options[:color])
     end
@@ -107,24 +115,40 @@ module Hamlit
       render(args.first.to_s)
     end
 
-    def puts_code(code, color: false)
+    def puts_code(code, color: true)
+      begin
+        require 'irb/color'
+      rescue LoadError
+        color = false
+      end
       if color
-        require 'pry'
-        puts Pry.Code(code).highlighted
+        puts IRB::Color.colorize_code(code)
       else
         puts code
       end
     end
 
     # Enable colored pretty printing only for development environment.
-    def pp_object(arg, color: false)
+    def pp_object(arg, color: true)
+      begin
+        require 'irb/color_printer'
+      rescue LoadError
+        color = false
+      end
       if color
-        require 'pry'
-        Pry::ColorPrinter.pp(arg)
+        IRB::ColorPrinter.pp(arg)
       else
         require 'pp'
         pp(arg)
       end
     end
+
+    def validate_ruby(code, file)
+      begin
+        eval("BEGIN {return nil}; #{code}", binding, file)
+      rescue ::SyntaxError # Not to be confused with Hamlit::SyntaxError
+        $!
+      end
+    end
   end
 end