haml 5.2.0 → 6.0.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccbf9b5c93745c83284467b77b73dd156f049dacf55861dd486bd14404d84e84
-  data.tar.gz: 4e2439c5e370db4bd765ca76ab4d76c027d9a9f9f6b68e5d38761e6858f3312f
+  metadata.gz: 6bda3cad64d59ca87a154986af35ca0e8f4aad63ccb20dcfc6baef0d4d1c5484
+  data.tar.gz: 025dca6d373cc07efe22112720722b4b419cb64b7588db502ee96d3597798edb
 SHA512:
-  metadata.gz: f0c7b716e9866070fc50281e4486eb519832c3f098cbd58bb62ca18f2659ca85bc44cd6a275121fe71f37f8d9e442ac9b75f254b28747b5fbff47a98b1e633c5
-  data.tar.gz: 3e870080f42d925cddc479a52318d2cb8e6a9dbfd5613e8027c0c4dfd80e4f7636fa9f50cd41d3eca6f72f12bcc1cc7e5a5b2b9120223e1e6218ad8d6dcf9ca8
+  metadata.gz: e526126720ad094d1a15281c028c8c8e002a3bcc1929f40d92caeebe25dccd1e8dc99471e7f52f95290241b65e4a83266c6e7fe58771891095e897408eef9b80
+  data.tar.gz: '078dfbdbd0c4f3904d303a376f2c460f4e35ba33b0e87bb33d449246e925e4d7e42248b32bd1060586d527130629d41e682ee426b2fb9a2539a6adca3ecde09c'

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: haml

data/.github/workflows/test.yml

@@ -0,0 +1,40 @@
+name: test
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+  schedule:
+    - cron: "00 15 * * *"
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - '2.5'
+          - '2.6'
+          - '2.7'
+          - '3.0'
+          - '3.1'
+          - jruby
+          - truffleruby-head
+    steps:
+      - uses: actions/checkout@v2
+      - 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
+      - run: bundle exec rake test

data/.gitignore

@@ -1,19 +1,19 @@
-/.idea
+/.bundle/
 /.yardoc
-/coverage
-/doc
-/log
-/pkg
-/test/rails
-/test/gemfiles/*.lock
-/.haml
-/site
-*.rbc
+/Gemfile.lock
+/_yardoc/
+/.idea
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/haml/
 .sass-cache
-.rbenv-version
-.rbx
 .ruby-version
-.rvmrc
-Gemfile.lock
-tmp
-.bundle/
+*.bundle
+*.so
+*.su
+*.a
+*.o
+*.swp

data/CHANGELOG.md

@@ -1,9 +1,34 @@
 # Haml Changelog
 
+## 6.0.0
+
+Not released yet
+([diff](https://github.com/haml/haml/compare/v5.2.2...main)).
+
+* Replace the implementation with Hamlit
+  * Haml 6 is about 1.7x faster than Haml 5 in [this benchmark](benchmark/slim/run-benchmarks.rb).
+  * The parser is kept as is, but everything else is replaced.
+  * All Haml helpers except for `preserve` are removed.
+  * Some legacy Rails integration is removed.
+
+## 5.2.2
+
+Released on July 27, 2021
+([diff](https://github.com/haml/haml/compare/v5.2.1...v5.2.2)).
+
+* Support `config.action_view.annotate_rendered_view_with_filenames = true` of Rails 6.1
+
+## 5.2.1
+
+Released on November 30, 2020
+([diff](https://github.com/haml/haml/compare/v5.2.0...v5.2.1)).
+
+* Add in improved "multiline" support for attributes [#1043](https://github.com/haml/haml/issues/1043)
+
 ## 5.2
 
 Released on September 28, 2020
-([diff](https://github.com/haml/haml/compare/v5.1.2...v5.2)).
+([diff](https://github.com/haml/haml/compare/v5.1.2...v5.2.0)).
 
 * Fix crash in the attribute optimizer when `#inspect` is overridden in TrueClass / FalseClass [#972](https://github.com/haml/haml/issues/972)
 * Do not HTML-escape templates that are declared to be plaintext [#1014](https://github.com/haml/haml/issues/1014) (Thanks [@cesarizu](https://github.com/cesarizu))

data/Gemfile

@@ -1,16 +1,23 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
+
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?("/")
+  "https://github.com/#{repo_name}.git"
+end
+
+# Specify your gem's dependencies in haml.gemspec
 gemspec
 
-gem "m"
-gem "pry"
-gem "simplecov"
+gem 'benchmark-ips', '2.3.0'
+gem 'maxitest'
+gem 'pry'
 
-group :docs do
-  gem "yard"
-  gem "kramdown"
-  gem "sass"
-end
+if /java/ === RUBY_PLATFORM # JRuby
+  gem 'pandoc-ruby'
+else
+  gem 'redcarpet'
 
-platform :mri do
-  gem "ruby-prof"
+  if RUBY_PLATFORM !~ /mswin|mingw/ && RUBY_ENGINE != 'truffleruby'
+    gem 'stackprof'
+  end
 end

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2006-2019 Hampton Catlin and Natalie Weizenbaum
+Copyright (c) 2006-2021 Hampton Catlin, Natalie Weizenbaum and Takashi Kokubun
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/REFERENCE.md

@@ -107,13 +107,20 @@ output.
 In Rails, options can be set by setting the {Haml::Template#options Haml::Template.options}
 hash in an initializer:
 
-    # config/initializers/haml.rb
-    Haml::Template.options[:format] = :html5
+```ruby
+# config/initializers/haml.rb
+Haml::Template.options[:format] = :html5
+
+# Avoid escaping attributes which are already escaped
+Haml::Template.options[:escape_attrs] = :once
+```
 
 Outside Rails, you can set them by configuring them globally in
 Haml::Options.defaults:
 
-    Haml::Options.defaults[:format] = :html5
+```ruby
+Haml::Options.defaults[:format] = :html5
+```
 
 In sinatra specifically, you can set them in global config with:
 ```ruby
@@ -228,15 +235,19 @@ is compiled to:
     <html xmlns='http://www.w3.org/1999/xhtml' xml:lang='en' lang='en'></html>
 
 Attribute hashes can also be stretched out over multiple lines to accommodate
-many attributes. However, newlines may only be placed immediately after commas.
-For example:
+many attributes.
 
-    %script{:type => "text/javascript",
-            :src  => "javascripts/script_#{2 + 7}"}
+    %script{
+      "type": text/javascript",
+      "src": javascripts/script_#{2 + 7}",
+      "data": {
+        "controller": "reporter",
+      },
+    }
 
 is compiled to:
 
-    <script src='javascripts/script_9' type='text/javascript'></script>
+    <script src='javascripts/script_9' type='text/javascript' data-controller='reporter'></script>
 
 #### `:class` and `:id` Attributes {#class-and-id-attributes}
 

data/Rakefile

@@ -1,115 +1,117 @@
-require "rake/clean"
-require "rake/testtask"
-require "bundler/gem_tasks"
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+
+#
+# Prepend DevKit into compilation phase
+#
+if Gem.win_platform?
+  desc 'Activates DevKit'
+  task :devkit do
+    begin
+      require 'devkit'
+    rescue LoadError
+      abort 'Failed to load DevKit required for compilation'
+    end
+  end
+  task compile: :devkit
+end
 
-task :default => :test
+require 'rake/testtask'
+if /java/ === RUBY_PLATFORM
+  # require 'rake/javaextensiontask'
+  # Rake::JavaExtensionTask.new(:haml) do |ext|
+  #   ext.ext_dir = 'ext/java'
+  #   ext.lib_dir = 'lib/haml'
+  # end
 
-# FIXME: Redefining :test task to run test/options_test.rb in isolated process since it depends on whether Rails is loaded or not.
-# Remove this task when we finished changing escape_html option to be true by default.
-isolated_test = Rake::TestTask.new do |t|
-  t.libs << 'test'
-  t.test_files = %w[test/options_test.rb]
-  t.warning = true
-  t.verbose = true
-end
-Rake::TestTask.new do |t|
-  t.libs << 'test'
-  t.test_files = Dir['test/*_test.rb'] + Dir['test/haml-spec/*_test.rb'] + Dir['test/cases/*_test.rb'] - isolated_test.file_list
-  t.warning = true
-  t.verbose = true
+  task :compile do
+    # dummy for now
+  end
+else
+  require 'rake/extensiontask'
+  Rake::ExtensionTask.new(:haml) do |ext|
+    ext.lib_dir = 'lib/haml'
+  end
 end
 
-CLEAN.replace %w(pkg doc coverage .yardoc test/haml vendor)
+Dir['benchmark/*.rake'].each { |b| import(b) }
 
-desc "Benchmark Haml against ERB. TIMES=n sets the number of runs, default is 1000."
-task :benchmark do
-  sh "ruby benchmark.rb #{ENV['TIMES']}"
+namespace :haml do
+  Rake::TestTask.new do |t|
+    t.libs << 'lib' << 'test'
+    files = Dir['test/haml/*_test.rb']
+    files << 'test/haml/haml-spec/*_test.rb'
+    t.ruby_opts = %w[-rtest_helper]
+    t.test_files = files
+    t.verbose = true
+  end
 end
 
-task :submodules do
-  if File.exist?(File.dirname(__FILE__) + "/.git")
-    sh %{git submodule sync}
-    sh %{git submodule update --init --recursive}
+namespace :hamlit do
+  Rake::TestTask.new do |t|
+    t.libs << 'lib' << 'test'
+    t.ruby_opts = %w[-rtest_helper]
+    t.test_files = Dir['test/hamlit/**/*_test.rb']
+    t.verbose = true
   end
 end
 
-namespace :doc do
-  task :sass do
-    require 'sass'
-    Dir["yard/default/**/*.sass"].each do |sass|
-      File.open(sass.gsub(/sass$/, 'css'), 'w') do |f|
-        f.write(Sass::Engine.new(File.read(sass)).render)
-      end
-    end
+namespace :test do
+  Rake::TestTask.new(:all) do |t|
+    t.libs << 'lib' << 'test'
+    files = Dir['test/hamlit/**/*_test.rb']
+    files += Dir['test/haml/*_test.rb']
+    files << 'test/haml/haml-spec/*_test.rb'
+    t.ruby_opts = %w[-rtest_helper]
+    t.test_files = files
+    t.verbose = true
   end
 
-  desc "List all undocumented methods and classes."
-  task :undocumented do
-    command = 'yard --list --query '
-    command << '"object.docstring.blank? && '
-    command << '!(object.type == :method && object.is_alias?)"'
-    sh command
+  Rake::TestTask.new(:spec) do |t|
+    t.libs << 'lib' << 'test'
+    t.ruby_opts = %w[-rtest_helper]
+    t.test_files = %w[test/haml/haml-spec/ugly_test.rb test/haml/haml-spec/pretty_test.rb]
+    t.verbose = true
   end
-end
-
-desc "Generate documentation"
-task(:doc => 'doc:sass') {sh "yard"}
-
-desc "Generate documentation incrementally"
-task(:redoc) {sh "yard -c"}
-
-desc <<END
-Profile Haml.
-  TIMES=n sets the number of runs. Defaults to 1000.
-  FILE=str sets the file to profile. Defaults to 'standard'
-  OUTPUT=str sets the ruby-prof output format.
-    Can be Flat, CallInfo, or Graph. Defaults to Flat. Defaults to Flat.
-END
-task :profile do
-  times  = (ENV['TIMES'] || '1000').to_i
-  file   = ENV['FILE'] || 'test/templates/standard.haml'
 
-  require 'bundler/setup'
-  require 'ruby-prof'
-  require 'haml'
-  file = File.read(File.expand_path("../#{file}", __FILE__))
-  obj = Object.new
-  Haml::Engine.new(file).def_method(obj, :render)
-  result = RubyProf.profile { times.times { obj.render } }
-
-  RubyProf.const_get("#{(ENV['OUTPUT'] || 'Flat').capitalize}Printer").new(result).print
-end
-
-def gemfiles
-  @gemfiles ||= Dir[File.dirname(__FILE__) + '/test/gemfiles/Gemfile.*'].reject {|f| f =~ /\.lock$/}
-end
+  Rake::TestTask.new(:engine) do |t|
+    t.libs << 'lib' << 'test'
+    t.ruby_opts = %w[-rtest_helper]
+    t.test_files = %w[test/haml/engine_test.rb]
+    t.verbose = true
+  end
 
-def with_each_gemfile
-  gemfiles.each do |gemfile|
-    Bundler.with_clean_env do
-      puts "Using gemfile: #{gemfile}"
-      ENV['BUNDLE_GEMFILE'] = gemfile
-      yield
-    end
+  Rake::TestTask.new(:filters) do |t|
+    t.libs << 'lib' << 'test'
+    t.ruby_opts = %w[-rtest_helper]
+    t.test_files = %w[test/haml/filters_test.rb]
+    t.verbose = true
   end
-end
 
-namespace :test do
-  namespace :bundles do
-    desc "Install all dependencies necessary to test Haml."
-    task :install do
-      with_each_gemfile {sh "bundle"}
-    end
+  Rake::TestTask.new(:helper) do |t|
+    t.libs << 'lib' << 'test'
+    t.ruby_opts = %w[-rtest_helper]
+    t.test_files = %w[test/haml/helper_test.rb]
+    t.verbose = true
+  end
 
-    desc "Update all dependencies for testing Haml."
-    task :update do
-      with_each_gemfile {sh "bundle update"}
-    end
+  Rake::TestTask.new(:template) do |t|
+    t.libs << 'lib' << 'test'
+    t.ruby_opts = %w[-rtest_helper]
+    t.test_files = %w[test/haml/template_test.rb]
+    t.verbose = true
   end
+end
 
-  desc "Test all supported versions of rails. This takes a while."
-  task :rails_compatibility => 'test:bundles:install' do
-    with_each_gemfile {sh "bundle exec rake test"}
+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
-  task :rc => :rails_compatibility
+  exit system(*cmd)
 end
+
+task default: %w[compile hamlit:test]
+task test: %w[compile test:all]

data/bin/bench

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'haml'
+require 'thor'
+require 'benchmark/ips'
+require_relative '../benchmark/utils/benchmark_ips_extension'
+
+class Bench < Thor
+  class_option :show_template, type: :boolean, aliases: ['-t']
+
+  desc 'bench HAML', 'Benchmark haml template'
+  option :compile, type: :boolean, aliases: ['-c']
+  option :show_code, type: :boolean, aliases: ['-s']
+  def bench(*files)
+    files.each { |file| render(file) }
+    files.each { |file| compile(file) if options[:compile] }
+    files.each { |file| code(file) if options[:show_code] }
+  end
+
+  desc 'compile HAML', 'Benchmark compilation'
+  def compile(file)
+    puts "#{?= * 49}\n Compilation: #{file}\n#{?= * 49}"
+    haml = File.read(file)
+
+    Benchmark.ips do |x|
+      x.report("haml v#{Haml::VERSION}") { Haml::Engine.new.call(haml) }
+      x.compare!
+    end
+  end
+
+  desc 'render HAML', 'Benchmark rendering'
+  def render(file)
+    puts "#{?= * 49}\n Rendering: #{file}\n#{?= * 49}"
+    haml = File.read(file)
+    puts haml + "\n" if options[:show_template]
+    object = Object.new
+    ruby_file = file.gsub(/\.haml\z/, '.rb')
+    if File.exist?(ruby_file)
+      object.instance_eval(File.read(ruby_file))
+    end
+
+    object.instance_eval "def haml; #{Haml::Engine.new.call(haml)}; end"
+
+    Benchmark.ips do |x|
+      x.report("haml v#{Haml::VERSION}") { object.haml }
+      x.compare!
+    end
+  end
+
+  desc 'code HAML', 'Show compiled code'
+  def code(file)
+    haml = File.read(file)
+    puts "\n#{?= * 49}\n Haml Source: #{file}\n#{?= * 49}"
+    puts Haml::Engine.new.call(haml)
+  end
+
+  private
+
+  def method_missing(*args)
+    return super if args.length > 1
+    render(args.first.to_s)
+  end
+end
+
+Bench.start

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'hamlit'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require 'pry'
+Pry.start

data/bin/ruby

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+bundle exec ruby -Ilib:test -rtest_helper $@

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/stackprof

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'hamlit'
+require 'stackprof'
+
+def open_flamegraph(report)
+  temp = `mktemp /tmp/stackflame-XXXXXXXX`.strip
+  data_path = "#{temp}.js"
+  system("mv #{temp} #{data_path}")
+
+  File.open(data_path, 'w') do |f|
+    report.print_flamegraph(f)
+  end
+
+  viewer_path = File.join(`bundle show stackprof`.strip, 'lib/stackprof/flamegraph/viewer.html')
+  url = "file://#{viewer_path}?data=#{data_path}"
+  system(%Q[osascript -e 'open location "#{url}"'])
+end
+
+haml = File.read(ARGV.first)
+StackProf.start(mode: :wall, interval: 1, raw: false)
+Hamlit::Engine.new.call(haml)
+StackProf.stop
+
+report = StackProf::Report.new(StackProf.results)
+report.print_text(false)

data/bin/test

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+VERSIONS=(
+  2.1.10
+  2.2.5
+  2.3.1
+)
+
+set -e
+trap 'echo "${VERSIONS[2]}" > .ruby-version' 0
+
+function test_with() {
+  version=$1
+  rbenv local $version
+  if ! bundle check > /dev/null; then
+    bundle install
+  fi
+  ruby -v
+  bundle exec rake test
+}
+
+for version in ${VERSIONS[@]}; do
+  test_with $version
+done

data/exe/haml

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path('../lib', __dir__)
+require 'haml/cli'
+
+Haml::CLI.start(ARGV)

data/ext/haml/extconf.rb

@@ -0,0 +1,10 @@
+require 'mkmf'
+
+$CFLAGS << ' -Wall -Wextra'
+
+$srcs = %w[
+  haml.c
+  hescape.c
+]
+
+create_makefile('haml/haml')