hamlit 2.15.1 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b60ad4fa07019d3e03bc5d521d624607f4dc1740ccaf73f1cee9de9826f38618
-  data.tar.gz: 4d458ddca75c342e4f10f4cf8ccf8f660f0db230dcd8973f91bd37a3c5cf7ae9
+  metadata.gz: '0739d31df6aecc4a332c868e258322fb77a8e6003d5aa2c5fee02468809f009b'
+  data.tar.gz: 1917aeca307e771331e8e6d997ef58c90f106c2f4c002e35c4fb7fd424779db9
 SHA512:
-  metadata.gz: 2bf9dda73fd3ad47f464a5c05327558f7f21afa2e5fa57e3c48ee726c3fcb93177a8fac9300889e7d42e3c5d0cc443a111fe9b2978d55504dbc92474488e0436
-  data.tar.gz: 06a36cc3240044789e160583742950f3c579f9de273ccb0291cd825264da2ea8821b0152ef4aef5d3f4c888c37c3c318628c23bdf60b8042af865a85812efa81
+  metadata.gz: 80000682f6fa89d6ceedd7137d3b1156bb9850707640bfdaf3330249c81251f6a036b3e175617d6e9b51e218d5f2cf12b551772c223e83bc6f7836afe260e62b
+  data.tar.gz: 87b2fb79433a8c593d0dbd4d0df17f28f5b5d64c250833048d4f6eddeb729c9394aa13a541cad8f2436237dd7da2a218af06910e4d9886f3a6ed7322f62d5d1a

data/.github/workflows/bench.yml

@@ -13,34 +13,12 @@ on:
 jobs:
   bench:
     runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        include:
-          - slim: 1
-          - template: 'benchmark/boolean_attribute.haml,benchmark/class_attribute.haml,benchmark/id_attribute.haml,benchmark/data_attribute.haml,benchmark/common_attribute.haml'
-          - template: 'benchmark/dynamic_attributes/boolean_attribute.haml,benchmark/dynamic_attributes/class_attribute.haml,benchmark/dynamic_attributes/id_attribute.haml,benchmark/dynamic_attributes/data_attribute.haml,benchmark/dynamic_attributes/common_attribute.haml'
-          - template: 'benchmark/etc/attribute_builder.haml'
-          - template: 'benchmark/etc/static_analyzer.haml'
-          - template: 'benchmark/etc/string_interpolation.haml'
-          - template: 'test/haml/templates/standard.haml'
-            compile: 1
     steps:
       - uses: actions/checkout@v2
+      - run: sudo apt-get update && sudo apt-get install -y nodejs libxslt-dev # nodejs for execjs, libxslt for TruffleRuby nokogiri
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.0
-      - uses: actions/cache@v2
-        with:
-          path: vendor/bundle
-          key: ${{ runner.os }}-${{ matrix.ruby }}-gems-${{ hashFiles('**/Gemfile.lock') }}
-          restore-keys: ${{ runner.os }}-gems-
-      - run: sudo apt-get update && sudo apt-get install -y nodejs libxslt-dev # nodejs for execjs, libxslt for TruffleRuby nokogiri
-      - name: bundle install
-        run: bundle config path vendor/bundle && bundle install -j$(nproc) --retry 3
+          ruby-version: '3.0'
+          bundler-cache: true
       - run: bundle exec rake bench
-        env:
-          SLIM_BENCH: ${{ matrix.slim }}
-          TEMPLATE: ${{ matrix.template }}
-          COMPILE: ${{ matrix.compile }}

data/.github/workflows/test.yml

@@ -25,16 +25,10 @@ jobs:
           - truffleruby-head
     steps:
       - uses: actions/checkout@v2
+      - run: sudo apt-get update && sudo apt-get install -y nodejs libxslt-dev # nodejs for execjs, libxslt for TruffleRuby nokogiri
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-      - uses: actions/cache@v2
-        with:
-          path: vendor/bundle
-          key: ${{ runner.os }}-${{ matrix.ruby }}-gems-${{ hashFiles('**/Gemfile.lock') }}
-          restore-keys: ${{ runner.os }}-gems-
-      - run: sudo apt-get update && sudo apt-get install -y nodejs libxslt-dev # nodejs for execjs, libxslt for TruffleRuby nokogiri
-      - name: bundle install
-        run: bundle config path vendor/bundle && bundle install -j$(nproc) --retry 3
+          bundler-cache: true
       - run: bundle exec rake test

data/CHANGELOG.md

@@ -4,6 +4,70 @@ 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).
 
+## [3.0.3](https://github.com/k0kubun/hamlit/compare/v3.0.2...v3.0.3) - 2022-11-07
+
+### Added
+
+- Support sass-embedded [#196](https://github.com/k0kubun/hamlit/issues/196)
+  *Thanks to @ntkme*
+
+## [3.0.2](https://github.com/k0kubun/hamlit/compare/v3.0.1...v3.0.2) - 2022-10-13
+
+### Changed
+
+- `Hamlit::Engine` and `Hamlit::Template` use StringBuffer instead of ArrayBuffer
+  - It seems more performant in many cases with recent Ruby versions.
+  - `Hamlit::RailsTemplate` is not affected.
+
+## [3.0.1](https://github.com/k0kubun/hamlit/compare/v3.0.0...v3.0.1) - 2022-08-18
+
+### Changed
+
+- coffee-script is removed from development dependency
+  - It's not runtime dependency, so it shouldn't impact your application
+  - `:coffee` filter still works if you explicitly install coffee-script,
+    however, it's no longer maintained and possibly removed in the future.
+
+## [3.0.0](https://github.com/k0kubun/hamlit/compare/v2.16.2...v3.0.0) - 2022-08-07
+
+### Changed
+
+- [**breaking**] Use `disable_capture: false` for non-Rails environments
+  - `:disable_capture` is an option introduced in v2.16.1. See its release notes for details.
+  - If you use Rails, it continues to use `disable_capture: true`, so you're not impacted by this change.
+
+## [2.16.2](https://github.com/k0kubun/hamlit/compare/v2.16.1...v2.16.2) - 2022-08-07
+
+### Fixed
+
+- Fix an issue when `disable_capture: false` is set and a Ruby comment is put after `do`
+
+## [2.16.1](https://github.com/k0kubun/hamlit/compare/v2.16.0...v2.16.1) - 2022-08-07
+
+### Added
+
+- Introduce `:disable_capture` option to capture a block 
+  - Default: `disable_capture: true` (backward-compatible)
+     - For Rails, this must be `true` anyway to use Rails-native capturing.
+  - If you override the option like `disable_capture: false` in Hamlit::Template,
+    scripts starting with `=` (e.g. `= render do`) capture a block content.
+     - Scripts starting with `-` (e.g. `- users.each do`) are not impacted.
+
+## [2.16.0](https://github.com/k0kubun/hamlit/compare/v2.15.2...v2.16.0) - 2022-02-03
+
+### Added
+
+- Raise an exception on a Haml-level syntax error with `hamlit compile -c`
+  [#189](https://github.com/k0kubun/hamlit/issues/189)
+  *Thanks to @dlwr*
+
+## [2.15.2](https://github.com/k0kubun/hamlit/compare/v2.15.1...v2.15.2) - 2022-01-04
+
+### Fixed
+
+- Consider `playsinline` a boolean attribute [#187](https://github.com/k0kubun/hamlit/issues/187)
+  *Thanks to @ghiculescu*
+
 ## [2.15.1](https://github.com/k0kubun/hamlit/compare/v2.15.0...v2.15.1) - 2021-07-23
 
 ### Fixed

data/Gemfile

@@ -18,7 +18,6 @@ else
   gem 'redcarpet'
 
   if RUBY_PLATFORM !~ /mswin|mingw/ && RUBY_ENGINE != 'truffleruby'
-    gem 'faml'
     gem 'stackprof'
   end
 end

data/README.md

@@ -5,12 +5,22 @@
 
 Hamlit is a high performance [Haml](https://github.com/haml/haml) implementation.
 
+## Project status
+
+**Hamlit's implementation was copied to Haml 6.**
+From Haml 6, you don't need to switch to Hamlit.
+
+Both Haml 6 and Hamlit are still maintained by [@k0kubun](https://github.com/k0kubun).
+While you don't need to immediately deprecate Hamlit, Haml 6 has more maintainers
+and you'd better start a new project with Haml rather than Hamlit,
+given no performance difference between them.
+
 ## Introduction
 
 ### 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 **1.94x times faster** than original haml gem in [this benchmark](benchmark/slim/run-benchmarks.rb),
+With some [Hamlit's characteristics](REFERENCE.md#hamlits-characteristics) for performance,
+Hamlit is **1.94x times faster** than the original Haml 5 in [this benchmark](benchmark/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://raw.githubusercontent.com/k0kubun/hamlit/afcc2b36c4861c2f764baa09afd9530ca25eeafa/benchmark/graph/graph.png" width="600x" alt="Hamlit Benchmark" />
@@ -23,11 +33,12 @@ which is an HTML-escaped version of [slim-template/slim's one](https://github.co
          haml v5.2.0:   127834.4 i/s - 1.94x slower
 ```
 
-### Why is Hamlit faster?
+### Why is Hamlit fast?
 
 #### Less string concatenation by design
-As written in [limitations](REFERENCE.md#limitations), Hamlit drops some not-so-important features which require
-works on runtime. With the optimized language design, we can reduce the string concatenation
+As written in [Hamlit's characteristics](REFERENCE.md#hamlits-characteristics),
+Hamlit drops some not-so-important features which require works on runtime.
+With the optimized language design, we can reduce the string concatenation
 to build attributes.
 
 #### Static analyzer
@@ -42,7 +53,7 @@ with C extension.
 
 ## Usage
 
-Hamlit currently supports Ruby 2.1 and higher. See [REFERENCE.md](REFERENCE.md) for detail features of Hamlit.
+See [REFERENCE.md](REFERENCE.md) for details.
 
 ### Rails
 
@@ -97,40 +108,6 @@ $ hamlit render in.haml
 
 ## Contributing
 
-### Test latest version
-
-```rb
-# Gemfile
-gem 'hamlit', github: 'k0kubun/hamlit', submodules: true
-```
-
-### Development
-
-Contributions are welcomed. It'd be good to see
-[Temple's EXPRESSIONS.md](https://github.com/judofyr/temple/blob/v0.7.6/EXPRESSIONS.md)
-to learn Temple which is a template engine framework used in Hamlit.
-
-```bash
-$ git clone --recursive https://github.com/k0kubun/hamlit
-$ cd hamlit
-$ bundle install
-
-# Run all tests
-$ bundle exec rake test
-
-# Run one test
-$ bundle exec ruby -Ilib:test -rtest_helper test/hamlit/line_number_test.rb -l 12
-
-# Show compiling/rendering result of some template
-$ bundle exec exe/hamlit compile in.haml
-$ bundle exec exe/hamlit render in.haml
-
-# Use rails app to debug Hamlit
-$ cd sample/rails
-$ bundle install
-$ bundle exec rails s
-```
-
 ### Reporting an issue
 
 Please report an issue with following information:

data/REFERENCE.md

@@ -5,81 +5,7 @@ See [Haml's tutorial](http://haml.info/tutorial.html) if you are not familiar wi
 
 [REFERENCE - Haml Documentation](http://haml.info/docs/yardoc/file.REFERENCE.html)
 
-## Supported features
-
-See [Haml's reference](http://haml.info/docs/yardoc/file.REFERENCE.html)
-for full features in original implementation.
-
-- [ ] Using Haml
-  - [x] Rails XSS Protection
-  - [x] Ruby Module
-  - [x] Options
-  - [ ] Encodings
-- [x] Plain Text
-  - [x] Escaping: \
-- [ ] HTML Elements
-  - [x] Element Name: %
-  - [ ] Attributes: `
-     - [x] :class and :id Attributes
-     - [x] HTML-style Attributes: ()
-     - [x] Ruby 1.9-style Hashes
-     - [ ] Attribute Methods
-     - [x] Boolean Attributes
-     - [x] HTML5 Custom Data Attributes
-  - [x] Class and ID: . and #
-     - Implicit Div Elements
-  - [x] Empty (void) Tags: /
-  - [x] Whitespace Removal: > and <
-  - [x] Object Reference: []
-- [x] Doctype: !!!
-- [x] Comments
-  - [x] HTML Comments: /
-     - [x] Conditional Comments: /[]
-  - [x] Haml Comments: -#
-- [x] Ruby Evaluation
-  - [x] Inserting Ruby: =
-  - [x] Running Ruby: -
-     - [x] Ruby Blocks
-  - [x] Whitespace Preservation: ~
-  - [x] Ruby Interpolation: #{}
-  - [x] Escaping HTML: &=
-  - [x] Unescaping HTML: !=
-- [ ] Filters
-  - [x] :cdata
-  - [x] :coffee
-  - [x] :css
-  - [x] :erb
-  - [x] :escaped
-  - [x] :javascript
-  - [x] :less
-  - [x] :markdown
-  - [ ] :maruku
-  - [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
-  - [ ] Custom Filters
-- [x] Helper Methods
-  - [x] preserve
-  - [x] surround
-  - [x] precede
-  - [x] succeed
-- [x] Multiline: |
-- [x] Whitespace Preservation
-- [ ] Helpers
-
-
-## Limitations
-
-### No Haml buffer
-Hamlit uses `Array` as buffer for performance. So you can't touch Haml::Buffer from template when using Hamlit.
-
-### Haml helpers are still in development
-At the same time, because some methods in `Haml::Helpers` require `Haml::Buffer`, they are not supported now.
-But some helpers are supported on Rails. Some of not-implemented methods are planned to be supported.
+## Hamlit's characteristics
 
 ### Limited attributes hyphenation
 In Haml, `%a{ foo: { bar: 'baz' } }` is rendered as `<a foo-bar='baz'></a>`, whatever foo is.

data/Rakefile

@@ -1,4 +1,3 @@
-require 'bundler/setup'
 require 'bundler/gem_tasks'
 
 #
@@ -105,11 +104,7 @@ end
 
 desc 'bench task for CI'
 task bench: :compile do
-  if ENV['SLIM_BENCH'] == '1'
-    cmd = %w[bundle exec ruby benchmark/slim/run-benchmarks.rb]
-  else
-    cmd = ['bin/bench', 'bench', ('-c' if ENV['COMPILE'] == '1'), *ENV['TEMPLATE'].split(',')].compact
-  end
+  cmd = %w[bundle exec ruby benchmark/run-benchmarks.rb]
   exit system(*cmd)
 end
 

data/bin/bench

@@ -2,7 +2,6 @@
 
 require 'bundler/setup'
 require 'hamlit'
-require 'faml'
 require 'thor'
 require 'benchmark/ips'
 require_relative '../benchmark/utils/benchmark_ips_extension'
@@ -26,7 +25,6 @@ class Bench < Thor
 
     Benchmark.ips do |x|
       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!
     end
@@ -44,12 +42,10 @@ class Bench < Thor
     end
 
     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"
 
     Benchmark.ips do |x|
       x.report("haml v#{Haml::VERSION}") { object.haml }
-      x.report("faml v#{Faml::VERSION}") { object.faml }
       x.report("hamlit v#{Hamlit::VERSION}") { object.hamlit }
       x.compare!
     end
@@ -60,8 +56,6 @@ class Bench < Thor
     haml = File.read(file)
     puts "#{?= * 49}\n Haml Source: #{file}\n#{?= * 49}"
     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}"
     puts Hamlit::Engine.new.call(haml)
   end

data/hamlit.gemspec

@@ -32,7 +32,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'benchmark_driver'
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'coffee-script'
   spec.add_development_dependency 'erubi'
   spec.add_development_dependency 'haml', '>= 5'
   spec.add_development_dependency 'less'

data/lib/hamlit/attribute_builder.rb

@@ -7,7 +7,7 @@ module Hamlit::AttributeBuilder
                        defer reversed ismap seamless muted required
                        autofocus novalidate formnovalidate open pubdate
                        itemscope allowfullscreen default inert sortable
-                       truespeed typemustmatch download].freeze
+                       truespeed typemustmatch download playsinline].freeze
 
   # Java extension is not implemented for JRuby yet.
   # TruffleRuby does not implement `rb_ary_sort_bang`, etc.

data/lib/hamlit/cli.rb

@@ -106,6 +106,7 @@ module Hamlit
       Hamlit::Engine.options.to_h.merge(
         escape_attrs: options[:escape_attrs],
         escape_html:  options[:escape_html],
+        check_syntax: options[:check],
       )
     end
 

data/lib/hamlit/compiler/script_compiler.rb

@@ -6,8 +6,9 @@ require 'hamlit/string_splitter'
 module Hamlit
   class Compiler
     class ScriptCompiler
-      def initialize(identity)
+      def initialize(identity, options)
         @identity = identity
+        @disable_capture = options[:disable_capture]
       end
 
       def compile(node, &block)
@@ -79,7 +80,7 @@ module Hamlit
         else
           [:multi,
            [:block, "#{var} = #{node.value[:text]}",
-            [:multi, [:newline], yield(node)],
+            [:multi, [:newline], @disable_capture ? yield(node) : [:capture, Temple::Utils.unique_name, yield(node)]]
            ],
           ]
         end

data/lib/hamlit/compiler.rb

@@ -16,7 +16,7 @@ module Hamlit
       @comment_compiler       = CommentCompiler.new
       @doctype_compiler       = DoctypeCompiler.new(options)
       @filter_compiler        = Filters.new(options)
-      @script_compiler        = ScriptCompiler.new(identity)
+      @script_compiler        = ScriptCompiler.new(identity, options)
       @silent_script_compiler = SilentScriptCompiler.new
       @tag_compiler           = TagCompiler.new(identity, options)
     end

data/lib/hamlit/engine.rb

@@ -12,7 +12,7 @@ module Hamlit
   class Engine < Temple::Engine
     define_options(
       :buffer_class,
-      generator:    Temple::Generators::ArrayBuffer,
+      generator:    Temple::Generators::StringBuffer,
       format:       :html,
       attr_quote:   "'",
       escape_html:  true,
@@ -21,6 +21,8 @@ module Hamlit
                        hr img input isindex keygen link menuitem meta
                        param source track wbr),
       filename:     "",
+      check_syntax: false,
+      disable_capture: false,
     )
 
     use Parser

data/lib/hamlit/filters/tilt_base.rb

@@ -7,7 +7,11 @@ module Hamlit
       def self.render(name, source, indent_width: 0)
         text = ::Tilt["t.#{name}"].new { source }.render
         return text if indent_width == 0
-        text.gsub!(/^/, ' ' * indent_width)
+        if text.frozen?
+          text.gsub(/^/, ' ' * indent_width)
+        else
+          text.gsub!(/^/, ' ' * indent_width)
+        end
       end
 
       def explicit_require?(needed_registration)

data/lib/hamlit/parser.rb

@@ -20,6 +20,7 @@ module Hamlit
       autoclose
       escape_html
       escape_attrs
+      check_syntax
     ].freeze
 
     def initialize(options = {})
@@ -35,6 +36,7 @@ module Hamlit
       end
       HamlParser.new(HamlOptions.new(@options)).call(template)
     rescue ::Hamlit::HamlError => e
+      raise e if @options[:check_syntax]
       error_with_lineno(e)
     end
 

data/lib/hamlit/rails_template.rb

@@ -15,6 +15,7 @@ module Hamlit
           use_html_safe: true,
           streaming:     true,
           buffer_class:  'ActionView::OutputBuffer',
+          disable_capture: true,
         }
       end
 
@@ -34,8 +35,10 @@ module Hamlit
       end
 
       if ActionView::Base.try(:annotate_rendered_view_with_filenames) && template.format == :html
-        options[:preamble] = "<!-- BEGIN #{template.short_identifier} -->\n"
-        options[:postamble] = "<!-- END #{template.short_identifier} -->\n"
+        options = options.merge(
+          preamble: "<!-- BEGIN #{template.short_identifier} -->\n",
+          postamble: "<!-- END #{template.short_identifier} -->\n",
+        )
       end
 
       Engine.new(options).call(source)

data/lib/hamlit/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hamlit
 version: !ruby/object:Gem::Version
-  version: 2.15.1
+  version: 3.0.3
 platform: ruby
 authors:
 - Takashi Kokubun
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-23 00:00:00.000000000 Z
+date: 2022-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: temple
@@ -80,20 +80,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: coffee-script
-  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: erubi
   requirement: !ruby/object:Gem::Requirement
@@ -345,7 +331,7 @@ homepage: https://github.com/k0kubun/hamlit
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -360,8 +346,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 3.3.7
+signing_key: 
 specification_version: 4
 summary: High Performance Haml Implementation
 test_files: []