haml 5.2.2 → 6.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec6cbb2e4023f397f1d7b6d84f06d78ab492a61e88c3f16496f39d0baeb47a83
-  data.tar.gz: 004c2dd34697cb61a8c12854bf4b99abb3cab5195f28922b813ee299225e7663
+  metadata.gz: e9efb6d42c07f38f08e6406c470be766f751439a63c0b151aca4040d5ea583d8
+  data.tar.gz: 8bcc4b22a87eb105e380990aa1fcfee19c9cf1ae61467e9bb9c3130f81977279
 SHA512:
-  metadata.gz: a7430b4e42cf809f847448a9e04623b4b58878e44facedef5e43714820e8068f0bb853772564d5545936cdad8346f0c33abfc11642a3737d91c9a1f6242b3e41
-  data.tar.gz: 8a91df0cb185014512ee473a21755ba41edb06e835b29740e8e46c76287a81405b2706d8a10ea148893a9429de306c67584ac1c286637c0812a5562cf149431b
+  metadata.gz: 07ebd7d512eac2b19e8d8d2d2611064a4742ead90ad9e6570e7612dd45535797d4479aa169371105a37f9f9ba32e6066337ef4a772b7430c7d2ac3a519d34ebb
+  data.tar.gz: 2fae2a68a205536580450fdd0c1ee1ab2c7f14268a01cc65b225f2115a1b3ee529865c2c184fc9b18e7a2141f6cb08d7a2254f14e0a7d5f61bde477387a114f9

data/.github/FUNDING.yml

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

data/.github/workflows/test.yml

@@ -8,15 +8,21 @@ on:
       - opened
       - synchronize
       - reopened
+  schedule:
+    - cron: "00 15 * * *"
 jobs:
   test:
-    name: 'Ruby: ${{ matrix.ruby }}, Rails: ${{ matrix.rails }}'
     runs-on: ubuntu-latest
     strategy:
-      fail-fast: false
       matrix:
-        ruby: [2.6, 2.7, 3.0, jruby-9.2]
-        rails: [5.2.x, 6.0.x, 6.1.x, rails-edge]
+        ruby:
+          - '2.5'
+          - '2.6'
+          - '2.7'
+          - '3.0'
+          - '3.1'
+          - jruby
+          - truffleruby-head
     steps:
       - uses: actions/checkout@v2
       - name: Set up Ruby
@@ -28,9 +34,7 @@ jobs:
           path: vendor/bundle
           key: ${{ runner.os }}-${{ matrix.ruby }}-gems-${{ hashFiles('**/Gemfile.lock') }}
           restore-keys: ${{ runner.os }}-gems-
-      - name: bundle install --gemfile=test/gemfiles/Gemfile.rails-${{matrix.rails}}.x
+      - 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
-      - name: rake test
-        run: bundle exec rake test submodules
-        env:
-          RUBYOPT: "--enable-frozen-string-literal"
+      - 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/.yardopts

@@ -7,10 +7,7 @@
 --title            "Haml Documentation"
 --query            'object.type != :classvariable'
 --query            'object.type != :constant || @api && @api.text == "public"'
---exclude          lib/haml/plugin.rb
 --exclude          lib/haml/railtie.rb
---exclude          lib/haml/helpers/action_view_mods.rb
---exclude          lib/haml/helpers/xss_mods.rb
 --hide-void-return
 --protected
 --no-private

data/CHANGELOG.md

@@ -1,12 +1,72 @@
 # Haml Changelog
 
+## 6.0.5
+
+* Resurrect `#haml_object_ref` support in an object reference [#1097](https://github.com/haml/haml/issues/1097)
+  * This was removed in 6.0.0, and added back in this version.
+* Stop warning `remove_whitespace: true` option.
+
+## 6.0.4
+
+Released on October 2, 2022
+([diff](https://github.com/haml/haml/compare/v6.0.3...v6.0.4)).
+
+* Fix a parse failure of `%` in attributes [#1096](https://github.com/haml/haml/issues/1096)
+* Add another fallback from C to Ruby for Wasm.
+
+## 6.0.3
+
+Released on September 28, 2022
+([diff](https://github.com/haml/haml/compare/v6.0.2...v6.0.3)).
+
+* For Wasm, fallback to Ruby when C extension is not available.
+
+## 6.0.2
+
+Released on September 28, 2022
+([diff](https://github.com/haml/haml/compare/v6.0.1...v6.0.2)).
+
+* Unescape HTML-safe arguments for `surround`, `succeed`, and `precede` on Rails
+  [#1088](https://github.com/haml/haml/issues/1088)
+
+## 6.0.1
+
+Released on September 23, 2022
+([diff](https://github.com/haml/haml/compare/v6.0.0...v6.0.1)).
+
+* Unescape HTML-safe interpolation on Rails [#1084](https://github.com/haml/haml/issues/1084)
+* Resurrect Haml 5's `AttributeParser.available?` for syntax\_tree-haml [#1085](https://github.com/haml/haml/issues/1085)
+
+## 6.0.0
+
+Released on September 21, 2022
+([diff](https://github.com/haml/haml/compare/v5.2.2...v6.0.0)).
+
+* 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.
+  * The `haml` CLI interface was also replaced.
+  * The interface of `Haml::Engine` is changed. `Haml::Template` is most likely what you need now.
+  * Most Haml helpers are removed.
+     * Rails:
+         * Kept: `find_and_reserve`, `preserve`, `surround`, `precede`, `succeed`, `capture_haml`
+         * Removed: `block_is_haml?`, `flatten`, `haml_concat`, `haml_indent`, `haml_tag`, `haml_tag_if`, `html_attrs`,
+           `html_escape`, `init_haml_helpers`, `is_haml?`, `list_of`, `non_haml`, `tab_down`, `tab_up`, `with_tabs`
+     * Tilt:
+         * Kept: `preserve`
+         * Removed: `block_is_haml?`, `capture_haml`, `escape_once`, `find_and_preserve`, `flatten`, `haml_concat`,
+           `haml_indent`, `haml_tag`, `haml_tag_if`, `html_attrs`, `html_escape`, `init_haml_helpers`, `is_haml?`,
+           `list_of`, `non_haml`, `precede`, `succeed`, `surround`, `tab_down`, `tab_up`, `with_tabs`
+  * Only the attributes in [`Haml::AttributeBuilder::BOOLEAN_ATTRIBUTES`](lib/haml/attribute_builder.rb)
+    are handled as boolean attributes.
+  * 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 for adding Annotations to Haml output (a Rails feature 6.1+)
-* Expanded test matrix to include Ruby 3.0 and Rails 6.1
-* Only testing Ruby 2.7+ and Rails 5.2+
+* Support `config.action_view.annotate_rendered_view_with_filenames = true` of Rails 6.1
 
 ## 5.2.1
 

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/README.md

@@ -1,7 +1,7 @@
 # Haml
 
 [![Gem Version](https://badge.fury.io/rb/haml.svg)](http://rubygems.org/gems/haml)
-[![Build Status](https://travis-ci.org/haml/haml.svg?branch=main)](http://travis-ci.org/haml/haml)
+[![test](https://github.com/haml/haml/actions/workflows/test.yml/badge.svg)](https://github.com/haml/haml/actions/workflows/test.yml)
 [![Code Climate](https://codeclimate.com/github/haml/haml/badges/gpa.svg)](https://codeclimate.com/github/haml/haml)
 [![Inline docs](http://inch-ci.org/github/haml/haml.png)](http://inch-ci.org/github/haml/haml)
 
@@ -10,13 +10,6 @@ more pleasant to write HTML documents, by eliminating redundancy, reflecting the
 underlying structure that the document represents, and providing an elegant syntax
 that's both powerful and easy to understand.
 
-### Supported Versions
-
-* Ruby 2.6+
-* Rails 5.1+
-
-Other versions may likely work, but we don't test against them.
-
 ## Basic Usage
 
 Haml can be used from the command line or as part of a Ruby web framework. The
@@ -29,7 +22,7 @@ gem install haml
 After you write some Haml, you can run
 
 ~~~sh
-haml document.haml
+haml render document.haml
 ~~~
 
 to compile it to HTML. For more information on these commands, check out
@@ -48,8 +41,8 @@ To use Haml with Rails, simply add Haml to your Gemfile and run `bundle`.
 gem 'haml'
 ~~~
 
-If you'd like to replace Rails's Erb-based generators with Haml, add
-[haml-rails](https://github.com/indirect/haml-rails) to your Gemfile as well.
+If you'd like to replace Rails's ERB-based generators with Haml, add
+[haml-rails](https://github.com/haml/haml-rails) to your Gemfile as well.
 
 ## Formatting
 
@@ -169,34 +162,35 @@ on a specific area:
 ruby -Itest test/helper_test.rb -n test_buffer_access
 ~~~
 
-Haml currently supports Ruby 2.7.0 and higher, so please make sure your changes run on 2.7+.
+Haml currently supports Ruby 2.0.0 and higher, so please make sure your changes run on 2.0+.
 
 ## Team
 
 ### Current Maintainers
 
-* [Hampton Catlin](https://github.com/hcatlin)
-* [Takashi Kokubun](https://github.com/k0kubun)
 * [Akira Matsuda](https://github.com/amatsuda)
+* [Matt Wildig](https://github.com/mattwildig)
+* [Tee Parham](https://github.com/teeparham)
+* [Takashi Kokubun](https://github.com/k0kubun)
 
 ### Alumni
 
 Haml was created by [Hampton Catlin](http://hamptoncatlin.com), the author of
-the original implementation.
+the original implementation. Hampton is no longer involved in day-to-day coding,
+but still consults on language issues.
 
-[Natalie Weizenbaum](https://github.com/nex3) was for many years the primary developer
+[Natalie Weizenbaum](http://nex-3.com) was for many years the primary developer
 and architect of the "modern" Ruby implementation of Haml.
 
-This project's been around for many years, and we have many amazing people who kept the project 
-alive! as former maintainers like:
-
-[Norman Clarke](http://github.com/norman)
-[Matt Wildig](https://github.com/mattwildig)
-[Tee Parham](https://github.com/teeparham)
+[Norman Clarke](http://github.com/norman) was the primary maintainer of Haml from 2012 to 2016.
 
 ## License
 
-Copyright (c) 2006-2021 Hampton Catlin, Natalie Weizenbaum and the Haml team
+Some of Natalie's work on Haml was supported by Unspace Interactive.
+
+Beyond that, the implementation is licensed under the MIT License.
+
+Copyright (c) 2006-2019 Hampton Catlin, Natalie Weizenbaum and the Haml team
 
 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

data/REFERENCE.md

@@ -30,7 +30,7 @@ The first step for all of these is to install the Haml gem:
 
 To run Haml from the command line, just use
 
-    haml input.haml output.html
+    haml render input.haml > output.html
 
 Use `haml --help` for full documentation.
 
@@ -68,24 +68,6 @@ may be compiled to:
       </div>
     </div>
 
-### Rails XSS Protection
-
-Haml supports Rails' XSS protection scheme, which was introduced in Rails 2.3.5+
-and is enabled by default in 3.0.0+. If it's enabled, Haml's
-{Haml::Options#escape_html `:escape_html`} option is set to `true` by default -
-like in ERB, all strings printed to a Haml template are escaped by default. Also
-like ERB, strings marked as HTML safe are not escaped. Haml also has [its own
-syntax for printing a raw string to the template](#unescaping_html).
-
-If the `:escape_html` option is set to false when XSS protection is enabled,
-Haml doesn't escape Ruby strings by default. However, if a string marked
-HTML-safe is passed to [Haml's escaping syntax](#escaping_html), it won't be
-escaped.
-
-Finally, all the {Haml::Helpers Haml helpers} that return strings that are known
-to be HTML safe are marked as such. In addition, string input is escaped unless
-it's HTML safe.
-
 ### Ruby Module
 
 Haml can also be used completely separately from Rails and ActionView. To do
@@ -93,10 +75,10 @@ this, install the gem with RubyGems:
 
     gem install haml
 
-You can then use it by including the "haml" gem in Ruby code, and using
-{Haml::Engine} like so:
+You can then use it by including the `haml` gem in Ruby code, and using
+{Haml::Template} like so:
 
-    engine = Haml::Engine.new("%p Haml code!")
+    engine = Haml::Template.new { "%p Haml code!" }
     engine.render #=> "<p>Haml code!</p>\n"
 
 ### Options
@@ -104,50 +86,26 @@ You can then use it by including the "haml" gem in Ruby code, and using
 Haml understands various configuration options that affect its performance and
 output.
 
-In Rails, options can be set by setting the {Haml::Template#options Haml::Template.options}
-hash in an initializer:
+In Rails, options can be set by using `Haml::RailsTemplate.set_options` in an initializer:
 
 ```ruby
 # config/initializers/haml.rb
-Haml::Template.options[:format] = :html5
-
-# Avoid escaping attributes which are already escaped
-Haml::Template.options[:escape_attrs] = :once
+Haml::RailsTemplate.set_options(escape_html: false)
 ```
 
-Outside Rails, you can set them by configuring them globally in
-Haml::Options.defaults:
+Outside Rails, you can set them by configuring them globally in `Haml::Template.options`:
 
 ```ruby
-Haml::Options.defaults[:format] = :html5
+Haml::Template.options[:escape_html] = false
 ```
 
 In sinatra specifically, you can set them in global config with:
 ```ruby
-set :haml, { escape_html: true }
+set :haml, { escape_html: false }
 ```
 
-Finally, you can also set them by passing an options hash to
-{Haml::Engine#initialize}. For the complete list of available options, please
-see {Haml::Options}.
-
-### Encodings
-
-Haml supports the same sorts of
-encoding-declaration comments that Ruby does. Although both Ruby and Haml
-support several different styles, the easiest it just to add `-# coding:
-encoding-name` at the beginning of the Haml template (it must come before all
-other lines). This will tell Haml that the template is encoded using the named
-encoding.
-
-By default, the HTML generated by Haml has the same encoding as the Haml
-template. However, if `Encoding.default_internal` is set, Haml will attempt to
-use that instead. In addition, the {Haml::Options#encoding `:encoding` option}
-can be used to specify an output encoding manually.
-
-Note that, like Ruby, Haml does not support templates encoded in UTF-16 or
-UTF-32, since these encodings are not compatible with ASCII. It is possible to
-use these as the output encoding, though.
+Finally, you can also set them by passing an options hash to `Haml::Engine.new` or `Haml::Template.new`.
+For the complete list of available options, please see `Haml::Engine`.
 
 ## Plain Text
 
@@ -325,49 +283,6 @@ Haml also supports Ruby's new hash syntax:
 
     %a{title: @title, href: href} Stuff
 
-#### Attribute Methods
-
-A Ruby method call that returns a hash can be substituted for the hash contents.
-For example, {Haml::Helpers} defines the following method:
-
-    def html_attrs(lang = 'en-US')
-      {:xmlns => "http://www.w3.org/1999/xhtml", 'xml:lang' => lang, :lang => lang}
-    end
-
-This can then be used in Haml, like so:
-
-    %html{html_attrs('fr-fr')}
-
-This is compiled to:
-
-    <html lang='fr-fr' xml:lang='fr-fr' xmlns='http://www.w3.org/1999/xhtml'>
-    </html>
-
-You can use as many such attribute methods as you want by separating them with
-commas, like a Ruby argument list. All the hashes will be merged together, from
-left to right. For example, if you defined
-
-    def hash1
-      {:bread => 'white', :filling => 'peanut butter and jelly'}
-    end
-
-    def hash2
-      {:bread => 'whole wheat'}
-    end
-
-then
-
-    %sandwich{hash1, hash2, :delicious => 'true'}/
-
-would compile to:
-
-    <sandwich bread='whole wheat' delicious='true' filling='peanut butter and jelly' />
-
-Note that the Haml attributes list has the same syntax as a Ruby method call.
-This means that any attribute methods must come before the hash literal.
-
-Attribute methods aren't supported for HTML-style attributes.
-
 #### Boolean Attributes
 
 Some attributes, such as "checked" for `input` tags or "selected" for `option`
@@ -404,6 +319,21 @@ or using `true` and `false`:
 
     %input(selected=true)
 
+This feature works only for attributes that are included in
+[`Haml::AttributeBuilder::BOOLEAN_ATTRIBUTES`](lib/haml/attribute_builder.rb),
+as well as `data-` and `aria-` attributes.
+
+    %input{'data-hidden' => false}
+    %input{'aria-hidden' => false}
+    %input{'xyz-hidden' => false}
+
+will render as:
+
+    <input>
+    <input>
+    <input xyz-hidden='false'>
+
+
 <!-- The title to the next section (Prefixed Attributes) has changed. This
 <a> tag is so old links to here still work. -->
 <a id="html5_custom_data_attributes" style="border:0;"></a>
@@ -993,7 +923,7 @@ is compiled to:
 
 ### Whitespace Preservation: `~` {#tilde}
 
-`~` works just like `=`, except that it runs {Haml::Helpers#find\_and\_preserve}
+`~` works just like `=`, except that it runs {Haml::Helpers.preserve}
 on its input. For example,
 
     ~ "Foo\n<pre>Bar\nBaz</pre>"
@@ -1154,9 +1084,6 @@ is compiled to
       <p>I <strong>really</strong> prefer <em>raspberry</em> jam.</p>
     </div>
 
-Note that `#{}` interpolation within filters is HTML-escaped if you specify true to
-{Haml::Options#escape_filter_interpolations `:escape_filter_interpolations`} option.
-
 The functionality of some filters such as Markdown can be provided by many
 different libraries. Usually you don't have to worry about this - you can just
 load the gem of your choice and Haml will automatically use it.
@@ -1271,43 +1198,10 @@ default. This filter is implemented using Tilt.
 
 ### Custom Filters
 
-You can also define your own filters. See {Haml::Filters} for details.
-
-## Helper Methods {#helper-methods}
-
-Sometimes you need to manipulate whitespace in a more precise fashion than what
-the whitespace removal methods allow. There are a few helper methods that are
-useful when dealing with inline content. All these methods take a Haml block to
-modify.
-
-### surround {#surround}
-
-Surrounds a Haml block with text. Expects 1 or 2 string arguments used to
-surround the Haml block. If a second argument is not provided, the first
-argument is used as the second.
-
-    = surround "(", ")" do
-      = link_to "learn more", "#"
-
-### precede {#precede}
-
-Prepends a Haml block with text. Expects 1 argument.
-
-    = precede "*" do
-      %span Required
-
-### succeed {#succeed}
-
-Appends a Haml block with text. Expects 1 argument.
-
-    Begin by
-    = succeed "," do
-      = link_to "filling out your profile", "#"
-    = succeed "," do
-      = link_to "adding a bio", "#"
-    and
-    = succeed "." do
-      = link_to "inviting friends", "#"
+You can also define your own filters.
+`Haml::Filters::YourCustomFilter#compile` should return
+[a Temple expression](https://github.com/judofyr/temple/blob/master/EXPRESSIONS.md).
+See {Haml::Filters} for examples.
 
 ## Multiline: `|` {#multiline}
 
@@ -1367,14 +1261,7 @@ Haml won't try to re-format the indentation.
 Literal `textarea` and `pre` tags automatically preserve content given through
 `=`. Dynamically-generated `textarea`s and `pre`s can't be preserved
 automatically, and so should be passed through
-{Haml::Helpers#find\_and\_preserve} or the [`~` command](#tilde), which has the
+{Haml::Helpers.preserve} or the [`~` command](#tilde), which has the
 same effect.
 
 Blocks of literal text can be preserved using the [`:preserve` filter](#preserve-filter).
-
-## Helpers
-
-Haml offers a bunch of helpers that are useful for doing stuff like preserving
-whitespace, creating nicely indented output for user-defined helpers, and other
-useful things. The helpers are all documented in the {Haml::Helpers} and
-{Haml::Helpers::ActionViewExtensions} modules.