haml 6.1.2 → 6.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f721367f32b443559aa0aa20e75bd7b9d179fffbfff06873cca328f26ae70689
-  data.tar.gz: dc52332427ab542277bb52374e6c20ba696180caad8a86cd04eee247c6c0f9bb
+  metadata.gz: e0e28e40ec5137482caae5c2fb466d21976027139b3f39d428035dbd35914774
+  data.tar.gz: c906550bd147f7e6a2961ebd07bc59fcc69b3433c454141cb2ae29e1ccd64e2b
 SHA512:
-  metadata.gz: 13197f48f55be37cec0eb76bc6b9c2e32d37cc1b3e430a509bb9c362fbb1e8f44fb858f1d39b22a0b2c654dfb6b2c237756a08a4495cf31c42eae59a6ea15c77
-  data.tar.gz: 073bc4c02899dea76c285bb8561df5631e3553fc3d939e30f94fe1671814ca5c3c812c3bcec251b3f0a562c03a2db606ef9b7e37b3014c50638cf2e29c44c465
+  metadata.gz: '0583d8a879f6c7eda656d6c956a9e5573eedd5f94d14b28d378af85bbab73f220499b9c8021af0bad5946c95073cd1201d2d2765556e138696462bf2d28a4304'
+  data.tar.gz: 2847f03720469d3eaabcc689f628198569f668b1c87c70f67422c70ed1af25103998cc004a86d9f430d57fb12f88078ef2fa27d544dad69ad9df95cc9241bfdd

data/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Haml Changelog
 
+## 6.2.3
+
+* Resurrect RDFa doctype support [#1147](https://github.com/haml/haml/issues/1147)
+
+## 6.2.2
+
+* Allow adding custom attributes to `Haml::BOOLEAN_ATTRIBUTES` [#1148](https://github.com/haml/haml/issues/1148)
+* Consider `aria-xxx: false` as a boolean attribute
+
+## 6.2.1
+
+* Fix v6.2.0's bug in rendering dynamic `aria` attributes [#1149](https://github.com/haml/haml/issues/1149)
+
+## 6.2.0
+
+* Drop the C extension [#1146](https://github.com/haml/haml/issues/1146)
+
+## 6.1.4
+
+* Let `Haml::Util.escape_html` use `ERB::Escape` if available [#1145](https://github.com/haml/haml/issues/1145)
+
+## 6.1.3
+
+* Add `Haml::RailsTemplate#default_format` for Turbo compatibility [#1144](https://github.com/haml/haml/issues/1144)
+
+## 6.1.2
+
+* Use the rails template path as `filename` [#1140](https://github.com/haml/haml/issues/1140)
+
 ## 6.1.1
 
 * Fix an empty output of Ruby 3.1's Hash shorthand syntax [#1083](https://github.com/haml/haml/issues/1083)
@@ -102,6 +131,12 @@ Released on September 21, 2022
            `list_of`, `non_haml`, `precede`, `succeed`, `surround`, `tab_down`, `tab_up`, `with_tabs`
      * `:ruby` filter
          * Removed: `haml_io`
+     * Alternatives to the removed helpers:
+         * Some simple ones could work by copying [the original definition](https://github.com/haml/haml/blob/v5.2.2/lib/haml/helpers.rb).
+         * For helpers generating general HTML tags, also consider using what your framework provides, e.g. Rails `content_tag`.
+           Same applies to `capture_haml`, e.g. Rails `capture`.
+         * Ones that rely on `Haml::Buffer` have no direct alternative by design. They existed at the cost of performance.
+           You need to define a helper, instantiate a String buffer in it, append stuff to it, and call it inside `=`.
   * Only the following attributes and `aria`/`data` attributes are considered boolean attributes:
      * `allowfullscreen`, `async`, `autobuffer`, `autofocus`, `autoplay`, `checked`, `controls`, `default`,
        `defer`, `disabled`, `download`, `formnovalidate`, `hidden`, `inert`, `ismap`, `itemscope`, `loop`,
@@ -1426,7 +1461,7 @@ Haml 2.2 introduces a new syntax for attributes
 based on the HTML syntax.
 For example:
 
-    %a(href="http://haml.info" title="Haml's so cool!")
+    %a(href="https://haml.info" title="Haml's so cool!")
       %img(src="/images/haml.png" alt="Haml")
 
 There are two main reasons for this.

data/FAQ.md

@@ -141,7 +141,7 @@ For other plugins, a little searching will probably turn up a way to fix them as
 
 ## You still haven't answered my question!
 
-Sorry! Try looking at the [Haml](http://haml.info/docs/yardoc/file.REFERENCE.html) reference,
+Sorry! Try looking at the [Haml](https://haml.info/docs/yardoc/file.REFERENCE.html) reference,
 If you can't find an answer there,
 feel free to ask in `#haml` on irc.freenode.net
 or send an email to the [mailing list](http://groups.google.com/group/haml).

data/README.md

@@ -1,6 +1,6 @@
 # Haml
 
-[![Gem Version](https://badge.fury.io/rb/haml.svg)](http://rubygems.org/gems/haml)
+[![Gem Version](https://badge.fury.io/rb/haml.svg)](https://rubygems.org/gems/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](https://inch-ci.org/github/haml/haml.svg)](https://inch-ci.org/github/haml/haml)
@@ -31,7 +31,7 @@ to compile it to HTML. For more information on these commands, check out
 haml --help
 ~~~
 
-To use Haml programmatically, check out the [YARD documentation](http://haml.info/docs/yardoc/).
+To use Haml programmatically, check out the [YARD documentation](https://haml.info/docs/yardoc/).
 
 ## Using Haml with Rails
 
@@ -120,7 +120,7 @@ output the result. You can even use control statements like `if` and `while`:
 ~~~
 
 Haml provides far more tools than those presented here. Check out the [reference
-documentation](http://haml.info/docs/yardoc/file.REFERENCE.html)
+documentation](https://haml.info/docs/yardoc/file.REFERENCE.html)
 for full details.
 
 ### Indentation
@@ -132,7 +132,7 @@ can't be mixed, and the same number of tabs or spaces must be used throughout.
 ## Contributing
 
 Contributions are welcomed, but before you get started please read the
-[guidelines](http://haml.info/development.html#contributing).
+[guidelines](https://haml.info/development.html#contributing).
 
 After forking and then cloning the repo locally, install Bundler and then use it
 to install the development gem dependencies:
@@ -182,7 +182,7 @@ but still consults on language issues.
 [Natalie Weizenbaum](http://nex-3.com) was for many years the primary developer
 and architect of the "modern" Ruby implementation of Haml.
 
-[Norman Clarke](http://github.com/norman) was the primary maintainer of Haml from 2012 to 2016.
+[Norman Clarke](https://github.com/norman) was the primary maintainer of Haml from 2012 to 2016.
 
 ## License
 

data/REFERENCE.md

@@ -1200,40 +1200,36 @@ You can also define your own filters.
 
 The simplest example of a filter might be something like:
 
-```ruby
-class HelloFilter < Haml::Filters::Base
-  def compile(_node)
-    [:static, "hello world"]
-  end
-end
-
-Haml::Filters.registered[:hello] ||= HelloFilter
-```
+    class HelloFilter < Haml::Filters::Base
+      def compile(_node)
+        [:static, "hello world"]
+      end
+    end
+    
+    Haml::Filters.registered[:hello] ||= HelloFilter
 
 A more complex example:
 
-```ruby
-class BetterFilter < Haml::Filters::Base
-  def compile(node)
-    temple = [:multi]
-    temple << [:static, "hello "]
-    temple << compile_text(node.value[:text])
-    temple << [:static, " world"]
-    temple
-  end
-
-  private
-  def compile_text(text)
-    if ::Haml::Util.contains_interpolation?(text)
-      [:dynamic, ::Haml::Util.unescape_interpolation(text)]
-    else
-      [:static, text]
+    class BetterFilter < Haml::Filters::Base
+      def compile(node)
+        temple = [:multi]
+        temple << [:static, "hello "]
+        temple << compile_text(node.value[:text])
+        temple << [:static, " world"]
+        temple
+      end
+    
+      private
+      def compile_text(text)
+        if ::Haml::Util.contains_interpolation?(text)
+          [:dynamic, ::Haml::Util.unescape_interpolation(text)]
+        else
+          [:static, text]
+        end
+      end
     end
-  end
-end
 
-Haml::Filters.registered[:better] ||= BetterFilter
-```
+    Haml::Filters.registered[:better] ||= BetterFilter
 
 See {Haml::Filters} for examples.
 

data/Rakefile

@@ -1,39 +1,5 @@
 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
-
 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
-
-  task :compile do
-    # dummy for now
-  end
-else
-  require 'rake/extensiontask'
-  Rake::ExtensionTask.new(:haml) do |ext|
-    ext.lib_dir = 'lib/haml'
-  end
-end
-
-Dir['benchmark/*.rake'].each { |b| import(b) }
 
 Rake::TestTask.new do |t|
   t.libs << 'lib' << 'test'
@@ -42,10 +8,10 @@ Rake::TestTask.new do |t|
   t.test_files = files
   t.verbose = true
 end
-task test: :compile
+task :test
 
 desc 'bench task for CI'
-task bench: :compile do
+task :bench do
   if ENV['SLIM_BENCH'] == '1'
     cmd = %w[bundle exec ruby benchmark/slim/run-benchmarks.rb]
   else
@@ -79,4 +45,4 @@ task(:doc => 'doc:sass') {sh "yard"}
 desc "Generate documentation incrementally"
 task(:redoc) {sh "yard -c"}
 
-task default: %w[compile test]
+task default: :test

data/haml.gemspec

@@ -21,12 +21,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata      = { 'rubygems_mfa_required' => 'true' }
 
-  if /java/ === RUBY_PLATFORM
-    spec.platform = 'java'
-  else
-    spec.extensions = ['ext/haml/extconf.rb']
-    spec.required_ruby_version = '>= 2.1.0'
-  end
+  spec.required_ruby_version = '>= 2.1.0'
 
   spec.add_dependency 'temple', '>= 0.8.2'
   spec.add_dependency 'thor'
@@ -41,7 +36,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest-reporters', '~> 1.1'
   spec.add_development_dependency 'rails', '>= 4.0'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rake-compiler'
   spec.add_development_dependency 'sass'
   spec.add_development_dependency 'slim'
   spec.add_development_dependency 'string_template'

data/lib/haml/attribute_builder.rb

@@ -2,173 +2,161 @@
 require 'haml/object_ref'
 
 module Haml::AttributeBuilder
-  BOOLEAN_ATTRIBUTES = %w[disabled readonly multiple checked autobuffer
-                       autoplay controls loop selected hidden scoped async
-                       defer reversed ismap seamless muted required
-                       autofocus novalidate formnovalidate open pubdate
-                       itemscope allowfullscreen default inert sortable
-                       truespeed typemustmatch download].freeze
-
-  # For JRuby, TruffleRuby, and Wasm, fallback to Ruby implementation.
-  if /java|wasm/ === RUBY_PLATFORM || RUBY_ENGINE == 'truffleruby'
-    class << self
-      def build(escape_attrs, quote, format, boolean_attributes, object_ref, *hashes)
-        hashes << Haml::ObjectRef.parse(object_ref) if object_ref
-        buf  = []
-        hash = merge_all_attrs(hashes)
-
-        keys = hash.keys.sort!
-        keys.each do |key|
-          case key
-          when 'id'.freeze
-            buf << " id=#{quote}#{build_id(escape_attrs, *hash[key])}#{quote}"
-          when 'class'.freeze
-            buf << " class=#{quote}#{build_class(escape_attrs, *hash[key])}#{quote}"
-          when 'data'.freeze
-            buf << build_data(escape_attrs, quote, *hash[key])
-          when *boolean_attributes, /\Adata-/
-            build_boolean!(escape_attrs, quote, format, buf, key, hash[key])
-          else
-            buf << " #{key}=#{quote}#{escape_html(escape_attrs, hash[key].to_s)}#{quote}"
-          end
+  class << self
+    def build(escape_attrs, quote, format, object_ref, *hashes)
+      hashes << Haml::ObjectRef.parse(object_ref) if object_ref
+      buf  = []
+      hash = merge_all_attrs(hashes)
+
+      keys = hash.keys.sort!
+      keys.each do |key|
+        case key
+        when 'id'
+          buf << " id=#{quote}#{build_id(escape_attrs, *hash[key])}#{quote}"
+        when 'class'
+          buf << " class=#{quote}#{build_class(escape_attrs, *hash[key])}#{quote}"
+        when 'data'
+          buf << build_data(escape_attrs, quote, *hash[key])
+        when 'aria'
+          buf << build_aria(escape_attrs, quote, *hash[key])
+        when *Haml::BOOLEAN_ATTRIBUTES, /\Adata-/, /\Aaria-/
+          build_boolean!(escape_attrs, quote, format, buf, key, hash[key])
+        else
+          buf << " #{key}=#{quote}#{escape_html(escape_attrs, hash[key].to_s)}#{quote}"
         end
-        buf.join
-      end
-
-      def build_id(escape_attrs, *values)
-        escape_html(escape_attrs, values.flatten.select { |v| v }.join('_'))
       end
+      buf.join
+    end
 
-      def build_class(escape_attrs, *values)
-        if values.size == 1
-          value = values.first
-          case
-          when value.is_a?(String)
-            # noop
-          when value.is_a?(Array)
-            value = value.flatten.select { |v| v }.map(&:to_s).uniq.join(' ')
-          when value
-            value = value.to_s
-          else
-            return ''
-          end
-          return escape_html(escape_attrs, value)
-        end
+    def build_id(escape_attrs, *values)
+      escape_html(escape_attrs, values.flatten.select { |v| v }.join('_'))
+    end
 
-        classes = []
-        values.each do |value|
-          case
-          when value.is_a?(String)
-            classes += value.split(' ')
-          when value.is_a?(Array)
-            classes += value.select { |v| v }
-          when value
-            classes << value.to_s
-          end
+    def build_class(escape_attrs, *values)
+      if values.size == 1
+        value = values.first
+        case
+        when value.is_a?(String)
+          # noop
+        when value.is_a?(Array)
+          value = value.flatten.select { |v| v }.map(&:to_s).uniq.join(' ')
+        when value
+          value = value.to_s
+        else
+          return ''
         end
-        escape_html(escape_attrs, classes.map(&:to_s).uniq.join(' '))
+        return escape_html(escape_attrs, value)
       end
 
-      def build_data(escape_attrs, quote, *hashes)
-        build_data_attribute(:data, escape_attrs, quote, *hashes)
+      classes = []
+      values.each do |value|
+        case
+        when value.is_a?(String)
+          classes += value.split(' ')
+        when value.is_a?(Array)
+          classes += value.select { |v| v }
+        when value
+          classes << value.to_s
+        end
       end
+      escape_html(escape_attrs, classes.map(&:to_s).uniq.join(' '))
+    end
 
-      def build_aria(escape_attrs, quote, *hashes)
-        build_data_attribute(:aria, escape_attrs, quote, *hashes)
-      end
+    def build_data(escape_attrs, quote, *hashes)
+      build_data_attribute(:data, escape_attrs, quote, *hashes)
+    end
 
-      private
+    def build_aria(escape_attrs, quote, *hashes)
+      build_data_attribute(:aria, escape_attrs, quote, *hashes)
+    end
 
-      def build_data_attribute(key, escape_attrs, quote, *hashes)
-        attrs = []
-        if hashes.size > 1 && hashes.all? { |h| h.is_a?(Hash) }
-          data_value = merge_all_attrs(hashes)
-        else
-          data_value = hashes.last
-        end
-        hash = flatten_attributes(key => data_value)
+    private
 
-        hash.sort_by(&:first).each do |key, value|
-          case value
-          when true
-            attrs << " #{key}"
-          when nil, false
-            # noop
-          else
-            attrs << " #{key}=#{quote}#{escape_html(escape_attrs, value.to_s)}#{quote}"
-          end
-        end
-        attrs.join
+    def build_data_attribute(key, escape_attrs, quote, *hashes)
+      attrs = []
+      if hashes.size > 1 && hashes.all? { |h| h.is_a?(Hash) }
+        data_value = merge_all_attrs(hashes)
+      else
+        data_value = hashes.last
       end
+      hash = flatten_attributes(key => data_value)
 
-      def flatten_attributes(attributes)
-        flattened = {}
-
-        attributes.each do |key, value|
-          case value
-          when attributes
-          when Hash
-            flatten_attributes(value).each do |k, v|
-              if k.nil?
-                flattened[key] = v
-              else
-                flattened["#{key}-#{k.to_s.gsub(/_/, '-')}"] = v
-              end
-            end
-          else
-            flattened[key] = value if value
-          end
+      hash.sort_by(&:first).each do |key, value|
+        case value
+        when true
+          attrs << " #{key}"
+        when nil, false
+          # noop
+        else
+          attrs << " #{key}=#{quote}#{escape_html(escape_attrs, value.to_s)}#{quote}"
         end
-        flattened
       end
+      attrs.join
+    end
+
+    def flatten_attributes(attributes)
+      flattened = {}
 
-      def merge_all_attrs(hashes)
-        merged = {}
-        hashes.each do |hash|
-          hash.each do |key, value|
-            key = key.to_s
-            case key
-            when 'id'.freeze, 'class'.freeze, 'data'.freeze
-              merged[key] ||= []
-              merged[key] << value
+      attributes.each do |key, value|
+        case value
+        when attributes
+        when Hash
+          flatten_attributes(value).each do |k, v|
+            if k.nil?
+              flattened[key] = v
             else
-              merged[key] = value
+              flattened["#{key}-#{k.to_s.gsub(/_/, '-')}"] = v
             end
           end
+        else
+          flattened[key] = value if value
         end
-        merged
       end
+      flattened
+    end
 
-      def build_boolean!(escape_attrs, quote, format, buf, key, value)
-        case value
-        when true
-          case format
-          when :xhtml
-            buf << " #{key}=#{quote}#{key}#{quote}"
+    def merge_all_attrs(hashes)
+      merged = {}
+      hashes.each do |hash|
+        unless hash.is_a?(Hash)
+          raise ArgumentError, "Non-hash object is given to attributes!"
+        end
+        hash.each do |key, value|
+          key = key.to_s
+          case key
+          when 'id', 'class', 'data', 'aria'
+            merged[key] ||= []
+            merged[key] << value
           else
-            buf << " #{key}"
+            merged[key] = value
           end
-        when false, nil
-          # omitted
-        else
-          buf << " #{key}=#{quote}#{escape_html(escape_attrs, value)}#{quote}"
         end
       end
+      merged
+    end
 
-      def escape_html(escape_attrs, str)
-        if escape_attrs
-          Haml::Util.escape_html(str)
+    def build_boolean!(escape_attrs, quote, format, buf, key, value)
+      case value
+      when true
+        case format
+        when :xhtml
+          buf << " #{key}=#{quote}#{key}#{quote}"
         else
-          str
+          buf << " #{key}"
         end
+      when false, nil
+        # omitted
+      else
+        buf << " #{key}=#{quote}#{escape_html(escape_attrs, value)}#{quote}"
+      end
+    end
+
+    def escape_html(escape_attrs, str)
+      if escape_attrs
+        Haml::Util.escape_html(str)
+      else
+        str
       end
     end
-  else
-    # Haml::AttributeBuilder.build
-    # Haml::AttributeBuilder.build_id
-    # Haml::AttributeBuilder.build_class
-    # Haml::AttributeBuilder.build_data
-    # Haml::AttributeBuilder.build_aria
-    require 'haml/haml'
   end
 end

data/lib/haml/attribute_compiler.rb

@@ -4,6 +4,14 @@ require 'haml/attribute_parser'
 require 'haml/ruby_expression'
 
 module Haml
+  # The list of boolean attributes. You may add custom attributes to this constant.
+  BOOLEAN_ATTRIBUTES = %w[disabled readonly multiple checked autobuffer
+                       autoplay controls loop selected hidden scoped async
+                       defer reversed ismap seamless muted required
+                       autofocus novalidate formnovalidate open pubdate
+                       itemscope allowfullscreen default inert sortable
+                       truespeed typemustmatch download]
+
   class AttributeCompiler
     def initialize(identity, options)
       @identity = identity
@@ -31,10 +39,7 @@ module Haml
       attrs = []
       attrs.unshift(node.value[:attributes].inspect) if node.value[:attributes] != {}
 
-      args = [
-        @escape_attrs.inspect, "#{@quote.inspect}.freeze", @format.inspect,
-        '::Haml::AttributeBuilder::BOOLEAN_ATTRIBUTES', node.value[:object_ref],
-      ] + attrs
+      args = [@escape_attrs.inspect, "#{@quote.inspect}.freeze", @format.inspect, node.value[:object_ref]] + attrs
       [:html, :attrs, [:dynamic, "::Haml::AttributeBuilder.build(#{args.join(', ')}, #{node.value[:dynamic_attributes].to_literal})"]]
     end
 
@@ -52,7 +57,7 @@ module Haml
           compile_class!(temple, key, values)
         when 'data', 'aria'
           compile_data!(temple, key, values)
-        when *AttributeBuilder::BOOLEAN_ATTRIBUTES, /\Adata-/, /\Aaria-/
+        when *BOOLEAN_ATTRIBUTES, /\Adata-/, /\Aaria-/
           compile_boolean!(temple, key, values)
         else
           compile_common!(temple, key, values)

data/lib/haml/compiler/doctype_compiler.rb

@@ -8,10 +8,12 @@ module Haml
 
       def compile(node)
         case node.value[:type]
-        when 'xml'
-          xml_doctype
         when ''
           html_doctype(node)
+        when 'xml'
+          xml_doctype
+        when 'rdfa'
+          rdfa_doctype
         else
           [:html, :doctype, node.value[:type]]
         end
@@ -41,6 +43,10 @@ module Haml
           [:multi]
         end
       end
+
+      def rdfa_doctype
+        [:static, '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML+RDFa 1.0//EN" "http://www.w3.org/MarkUp/DTD/xhtml-rdfa-1.dtd">']
+      end
     end
   end
 end

data/lib/haml/rails_template.rb

@@ -48,6 +48,11 @@ module Haml
       Engine.new(options).call(source)
     end
 
+    # Rails Turbo looks for this
+    def default_format
+      :html
+    end
+
     def supports_streaming?
       RailsTemplate.options[:streaming]
     end

data/lib/haml/util.rb

@@ -14,15 +14,16 @@ module Haml
   module Util
     extend self
 
-    # For JRuby, TruffleRuby, and Wasm, fallback to Ruby implementation.
-    if /java|wasm/ === RUBY_PLATFORM || RUBY_ENGINE == 'truffleruby'
+    begin # Ruby 3.2+ or ERB 4+
+      require 'erb/escape'
+
+      define_singleton_method(:escape_html, ERB::Escape.instance_method(:html_escape))
+    rescue LoadError
       require 'cgi/escape'
 
       def self.escape_html(html)
         CGI.escapeHTML(html.to_s)
       end
-    else
-      require 'haml/haml' # Haml::Util.escape_html
     end
 
     # TODO: Remove unescape_interpolation's workaround and get rid of `respond_to?`.