hamlit 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff4644b3625c52ef89dd93a014324209d343055e7ff6d4be2bc928d701207d79
-  data.tar.gz: fa7e502f834887ca24edcceacb0e3ac179fc926446b54149ba31e41a87d59673
+  metadata.gz: a2630e3f6654fd5d8810fdc99d6396fe75de14389c213593fba8df5f49fa9de9
+  data.tar.gz: aff43e55f4f7d211a2437e258f94b0ffb5338908b31761ee7f36cdabbd68a473
 SHA512:
-  metadata.gz: b6d19a0e3dd9be45782fc5770cb9e8e38ba7d3c82f8b98e4d9271607135628c9582d628e31745153a0a477a56445ffd31cbcff2e5f9ed9c887485f07db9e5cba
-  data.tar.gz: f61c4f0af81edd24249bf48315f773c4872ae8429f0c6640576185ec891fef8e0839be8555db8d7cb2d4be3397d64fd794c912f04136a3c070316176fcea82ca
+  metadata.gz: cdbed489a25180e8eac72da2941d54f643c88a678582bc3ca5d54945803b2ad954af516e74f6ebbda5b9b88ac05d51a6771e67ddf99eeec2fe2b98db3506073a
+  data.tar.gz: 6f6d9168fd3f2d0de56b7b78ba99396f7ab79e6a728a55ea2807292da5e6fe33d19bf78d779e1eefc926d96e7287304d29391adedaaa70c05f83862013f13777

data/.github/workflows/bench.yml

@@ -13,18 +13,6 @@ 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
       - name: Set up Ruby
@@ -40,7 +28,3 @@ jobs:
       - name: bundle install
         run: bundle config path vendor/bundle && bundle install -j$(nproc) --retry 3
       - run: bundle exec rake bench
-        env:
-          SLIM_BENCH: ${{ matrix.slim }}
-          TEMPLATE: ${{ matrix.template }}
-          COMPILE: ${{ matrix.compile }}

data/CHANGELOG.md

@@ -4,6 +4,14 @@ 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.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

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/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,

data/lib/hamlit/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hamlit
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-19 00:00:00.000000000 Z
+date: 2022-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: temple
@@ -346,7 +346,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.0.dev
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: High Performance Haml Implementation