haml 6.0.4 → 6.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31325683e3bd7edbd6ec19bf99be81bde203ea948059cec704ac260528d6ff8a
-  data.tar.gz: 053cbe5fb763691b4fcedd4a8c15649e31dea757a0c7f25366849ae49941e840
+  metadata.gz: 686b38a185b57f5b0ce392e06047aa1cadff2b54a0416d1a25b88d9c6d2675d5
+  data.tar.gz: 77abae61a0ca3eb4d42e30e15d3dad08781f4d0566f4565ddf40ff6609370e00
 SHA512:
-  metadata.gz: e480bd4afab654ef3ffdc122cb81c78ca773ca5715310dd876a095491b574722a6b574ae685affb41d5d34eca2465bae737eb3496e3a9bf41df55cdbc74261ac
-  data.tar.gz: 9d6c05804e701bca33709a441fdb815f779143a66ad5664f22c8b15583415b198a07044682ed78fb22f653533b26fa5f8ee5d8f96cc4026478ec32796cc99f59
+  metadata.gz: d392228708c2754f52dd073839a3b13d3fd4954a04cb11547c016d3a4ee4b792ef3242328df691d834515a94a500c63b5812d017be23805a5c0a6c40e818a60b
+  data.tar.gz: 82262e5e10fd2392a91034ab57621e8c80cd9156be99964642403687f2c6f6409154b7dd7b1ed12a68b9fc3809058a3284ef6bfac20f11ddcc7911be487cf9b8

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Haml Changelog
 
+## 6.0.6
+
+* Prevent CRuby from accidentally using the Ruby implementation fallback
+  * Reversing what v6.0.3 and v6.0.4 did, but still supporting Wasm.
+
+## 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

data/REFERENCE.md

@@ -81,6 +81,32 @@ You can then use it by including the `haml` gem in Ruby code, and using
     engine = Haml::Template.new { "%p Haml code!" }
     engine.render #=> "<p>Haml code!</p>\n"
 
+### Options
+
+Haml understands various configuration options that affect its performance and
+output.
+
+In Rails, options can be set by using `Haml::RailsTemplate.set_options` in an initializer:
+
+```ruby
+# config/initializers/haml.rb
+Haml::RailsTemplate.set_options(escape_html: false)
+```
+
+Outside Rails, you can set them by configuring them globally in `Haml::Template.options`:
+
+```ruby
+Haml::Template.options[:escape_html] = false
+```
+
+In sinatra specifically, you can set them in global config with:
+```ruby
+set :haml, { escape_html: false }
+```
+
+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
 
 A substantial portion of any HTML document is its content, which is plain old
@@ -294,7 +320,19 @@ 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).
+[`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. -->
@@ -1163,6 +1201,44 @@ default. This filter is implemented using Tilt.
 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).
+
+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
+```
+
+A more complex 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]
+    end
+  end
+end
+
+Haml::Filters.registered[:better] ||= BetterFilter
+```
+
 See {Haml::Filters} for examples.
 
 ## Multiline: `|` {#multiline}

data/lib/haml/attribute_builder.rb

@@ -9,15 +9,8 @@ module Haml::AttributeBuilder
                        itemscope allowfullscreen default inert sortable
                        truespeed typemustmatch download].freeze
 
-  begin
-    # Haml::AttributeBuilder.build
-    # Haml::AttributeBuilder.build_id
-    # Haml::AttributeBuilder.build_class
-    # Haml::AttributeBuilder.build_data
-    # Haml::AttributeBuilder.build_aria
-    require 'haml/haml'
-  rescue LoadError
-    # For JRuby and Wasm, fallback to Ruby implementation when C extension is not available.
+  # 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
@@ -170,5 +163,12 @@ module Haml::AttributeBuilder
         end
       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/engine.rb

@@ -23,6 +23,7 @@ module Haml
                        param source track wbr),
       filename:     "",
       disable_capture: false,
+      remove_whitespace: false,
     )
 
     use Parser

data/lib/haml/object_ref.rb

@@ -6,7 +6,12 @@ module Haml
         object, prefix = args
         return {} unless object
 
-        suffix = underscore(object.class)
+        suffix =
+          if object.respond_to?(:haml_object_ref)
+            object.haml_object_ref
+          else
+            underscore(object.class)
+          end
         {
           'class' => [prefix, suffix].compact.join('_'),
           'id'    => [prefix, suffix, object.id || 'new'].compact.join('_'),

data/lib/haml/util.rb

@@ -14,15 +14,15 @@ module Haml
   module Util
     extend self
 
-    begin
-      require 'haml/haml' # Haml::Util.escape_html
-    rescue LoadError
-      # For JRuby and Wasm, fallback to Ruby implementation when C extension is not available.
+    # For JRuby, TruffleRuby, and Wasm, fallback to Ruby implementation.
+    if /java|wasm/ === RUBY_PLATFORM || RUBY_ENGINE == 'truffleruby'
       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?`.

data/lib/haml/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Haml
-  VERSION = '6.0.4'
+  VERSION = '6.0.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: haml
 version: !ruby/object:Gem::Version
-  version: 6.0.4
+  version: 6.0.6
 platform: ruby
 authors:
 - Natalie Weizenbaum
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-03 00:00:00.000000000 Z
+date: 2022-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: temple