haml 5.2.2 → 6.3.0

data/lib/haml/attribute_compiler.rb

@@ -1,237 +1,133 @@
 # frozen_string_literal: true
-
+require 'haml/attribute_builder'
 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
-    # @param type [Symbol] :static or :dynamic
-    # @param key [String]
-    # @param value [String] Actual string value for :static type, value's Ruby literal for :dynamic type.
-    AttributeValue = Struct.new(:type, :key, :value)
-
-    # @param options [Haml::Options]
-    def initialize(options)
-      @is_html = [:html4, :html5].include?(options[:format])
-      @attr_wrapper = options[:attr_wrapper]
+    def initialize(identity, options)
+      @identity = identity
+      @quote  = options[:attr_quote]
+      @format = options[:format]
       @escape_attrs = options[:escape_attrs]
-      @hyphenate_data_attrs = options[:hyphenate_data_attrs]
     end
 
-    # Returns Temple expression to render attributes.
-    #
-    # @param attributes [Hash]
-    # @param object_ref [String,:nil]
-    # @param dynamic_attributes [Haml::Parser::DynamicAttributes]
-    # @return [Array] Temple expression
-    def compile(attributes, object_ref, dynamic_attributes)
-      if object_ref != :nil || !AttributeParser.available?
-        return [:dynamic, compile_runtime_build(attributes, object_ref, dynamic_attributes)]
+    def compile(node)
+      hashes = []
+      if node.value[:object_ref] != :nil || !AttributeParser.available?
+        return runtime_compile(node)
       end
-
-      parsed_hashes = [dynamic_attributes.new, dynamic_attributes.old].compact.map do |attribute_hash|
-        unless (hash = AttributeParser.parse(attribute_hash))
-          return [:dynamic, compile_runtime_build(attributes, object_ref, dynamic_attributes)]
-        end
-        hash
+      [node.value[:dynamic_attributes].new, node.value[:dynamic_attributes].old].compact.each do |attribute_str|
+        hash = AttributeParser.parse(attribute_str)
+        return runtime_compile(node) if hash.nil? || hash.any? { |_key, value| value.empty? }
+        hashes << hash
       end
-      attribute_values = build_attribute_values(attributes, parsed_hashes)
-      AttributeBuilder.verify_attribute_names!(attribute_values.map(&:key))
-
-      [:multi, *group_values_for_sort(attribute_values).map { |value_group|
-        compile_attribute_values(value_group)
-      }]
+      static_compile(node.value[:attributes], hashes)
     end
 
     private
 
-    # Returns a script to render attributes on runtime.
-    #
-    # @param attributes [Hash]
-    # @param object_ref [String,:nil]
-    # @param dynamic_attributes [Haml::Parser::DynamicAttributes]
-    # @return [String] Attributes rendering code
-    def compile_runtime_build(attributes, object_ref, dynamic_attributes)
-      arguments = [@is_html, @attr_wrapper, @escape_attrs, @hyphenate_data_attrs].map(&method(:to_literal)).join(', ')
-      "::Haml::AttributeBuilder.build(#{to_literal(attributes)}, #{object_ref}, #{arguments}, #{dynamic_attributes.to_literal})"
-    end
-
-    # Build array of grouped values whose sort order may go back and forth, which is also sorted with key name.
-    # This method needs to group values with the same start because it can be changed in `Haml::AttributeBuidler#build_data_keys`.
-    # @param values [Array<Haml::AttributeCompiler::AttributeValue>]
-    # @return [Array<Array<Haml::AttributeCompiler::AttributeValue>>]
-    def group_values_for_sort(values)
-      sorted_values = values.sort_by(&:key)
-      [].tap do |value_groups|
-        until sorted_values.empty?
-          key = sorted_values.first.key
-          value_group, sorted_values = sorted_values.partition { |v| v.key.start_with?(key) }
-          value_groups << value_group
+    def runtime_compile(node)
+      attrs = []
+      attrs.unshift(node.value[:attributes].inspect) if node.value[:attributes] != {}
+
+      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
+
+    def static_compile(static_hash, dynamic_hashes)
+      temple = [:html, :attrs]
+      keys = [*static_hash.keys, *dynamic_hashes.map(&:keys).flatten].uniq.sort
+      keys.each do |key|
+        values = [[:static, static_hash[key]], *dynamic_hashes.map { |h| [:dynamic, h[key]] }]
+        values.select! { |_, exp| exp != nil }
+
+        case key
+        when 'id'
+          compile_id!(temple, key, values)
+        when 'class'
+          compile_class!(temple, key, values)
+        when 'data', 'aria'
+          compile_data!(temple, key, values)
+        when *BOOLEAN_ATTRIBUTES, /\Adata-/, /\Aaria-/
+          compile_boolean!(temple, key, values)
+        else
+          compile_common!(temple, key, values)
         end
       end
+      temple
     end
 
-    # Returns array of AttributeValue instances from static attributes and dynamic_attributes. For each key,
-    # the values' order in returned value is preserved in the same order as Haml::Buffer#attributes's merge order.
-    #
-    # @param attributes [{ String => String }]
-    # @param parsed_hashes [{ String => String }]
-    # @return [Array<AttributeValue>]
-    def build_attribute_values(attributes, parsed_hashes)
-      [].tap do |attribute_values|
-        attributes.each do |key, static_value|
-          attribute_values << AttributeValue.new(:static, key, static_value)
-        end
-        parsed_hashes.each do |parsed_hash|
-          parsed_hash.each do |key, dynamic_value|
-            attribute_values << AttributeValue.new(:dynamic, key, dynamic_value)
-          end
-        end
-      end
-    end
-
-    # Compiles attribute values with the similar key to Temple expression.
-    #
-    # @param values [Array<AttributeValue>] whose `key`s are partially or fully the same from left.
-    # @return [Array] Temple expression
-    def compile_attribute_values(values)
-      if values.map(&:key).uniq.size == 1
-        compile_attribute(values.first.key, values)
+    def compile_id!(temple, key, values)
+      build_code = attribute_builder(:id, values)
+      if values.all? { |type, exp| type == :static || Temple::StaticAnalyzer.static?(exp) }
+        temple << [:html, :attr, key, [:static, eval(build_code).to_s]]
       else
-        runtime_build(values)
+        temple << [:html, :attr, key, [:dynamic, build_code]]
       end
     end
 
-    # @param values [Array<AttributeValue>]
-    # @return [Array] Temple expression
-    def runtime_build(values)
-      hash_content = values.group_by(&:key).map do |key, values_for_key|
-        "#{frozen_string(key)} => #{merged_value(key, values_for_key)}"
-      end.join(', ')
-      arguments = [@is_html, @attr_wrapper, @escape_attrs, @hyphenate_data_attrs].map(&method(:to_literal)).join(', ')
-      [:dynamic, "::Haml::AttributeBuilder.build({ #{hash_content} }, nil, #{arguments})"]
-    end
-
-    # Renders attribute values statically.
-    #
-    # @param values [Array<AttributeValue>]
-    # @return [Array] Temple expression
-    def static_build(values)
-      hash_content = values.group_by(&:key).map do |key, values_for_key|
-        "#{frozen_string(key)} => #{merged_value(key, values_for_key)}"
-      end.join(', ')
-
-      arguments = [@is_html, @attr_wrapper, @escape_attrs, @hyphenate_data_attrs]
-      code = "::Haml::AttributeBuilder.build_attributes"\
-        "(#{arguments.map(&method(:to_literal)).join(', ')}, { #{hash_content} })"
-      [:static, eval(code).to_s]
-    end
-
-    # @param key [String]
-    # @param values [Array<AttributeValue>]
-    # @return [String]
-    def merged_value(key, values)
-      if values.size == 1
-        attr_literal(values.first)
+    def compile_class!(temple, key, values)
+      build_code = attribute_builder(:class, values)
+      if values.all? { |type, exp| type == :static || Temple::StaticAnalyzer.static?(exp) }
+        temple << [:html, :attr, key, [:static, eval(build_code).to_s]]
       else
-        "::Haml::AttributeBuilder.merge_values(#{frozen_string(key)}, #{values.map(&method(:attr_literal)).join(', ')})"
+        temple << [:html, :attr, key, [:dynamic, build_code]]
       end
     end
 
-    # @param str [String]
-    # @return [String]
-    def frozen_string(str)
-      "#{to_literal(str)}.freeze"
-    end
-
-    # Compiles attribute values for one key to Temple expression that generates ` key='value'`.
-    #
-    # @param key [String]
-    # @param values [Array<AttributeValue>]
-    # @return [Array] Temple expression
-    def compile_attribute(key, values)
-      if values.all? { |v| Temple::StaticAnalyzer.static?(attr_literal(v)) }
-        return static_build(values)
-      end
+    def compile_data!(temple, key, values)
+      args = [@escape_attrs.inspect, "#{@quote.inspect}.freeze", values.map { |v| literal_for(v) }]
+      build_code = "::Haml::AttributeBuilder.build_#{key}(#{args.join(', ')})"
 
-      case key
-      when 'id', 'class'
-        compile_id_or_class_attribute(key, values)
+      if values.all? { |type, exp| type == :static || Temple::StaticAnalyzer.static?(exp) }
+        temple << [:static, eval(build_code).to_s]
       else
-        compile_common_attribute(key, values)
+        temple << [:dynamic, build_code]
       end
     end
 
-    # @param id_or_class [String] "id" or "class"
-    # @param values [Array<AttributeValue>]
-    # @return [Array] Temple expression
-    def compile_id_or_class_attribute(id_or_class, values)
-      var = unique_name
-      [:multi,
-       [:code, "#{var} = (#{merged_value(id_or_class, values)})"],
-       [:case, var,
-        ['Hash, Array', runtime_build([AttributeValue.new(:dynamic, id_or_class, var)])],
-        ['false, nil', [:multi]],
-        [:else, [:multi,
-                 [:static, " #{id_or_class}=#{@attr_wrapper}"],
-                 [:escape, Escapable::EscapeSafeBuffer.new(@escape_attrs), [:dynamic, var]],
-                 [:static, @attr_wrapper]],
-        ]
-       ],
-      ]
-    end
-
-    # @param key [String] Not "id" or "class"
-    # @param values [Array<AttributeValue>]
-    # @return [Array] Temple expression
-    def compile_common_attribute(key, values)
-      var = unique_name
-      [:multi,
-       [:code, "#{var} = (#{merged_value(key, values)})"],
-       [:case, var,
-        ['Hash', runtime_build([AttributeValue.new(:dynamic, key, var)])],
-        ['true', true_value(key)],
-        ['false, nil', [:multi]],
-        [:else, [:multi,
-                 [:static, " #{key}=#{@attr_wrapper}"],
-                 [:escape, Escapable::EscapeSafeBuffer.new(@escape_attrs), [:dynamic, var]],
-                 [:static, @attr_wrapper]],
-        ]
-       ],
-      ]
-    end
+    def compile_boolean!(temple, key, values)
+      exp = literal_for(values.last)
 
-    def true_value(key)
-      if @is_html
-        [:static, " #{key}"]
+      if Temple::StaticAnalyzer.static?(exp)
+        value = eval(exp)
+        case value
+        when true then temple << [:html, :attr, key, @format == :xhtml ? [:static, key] : [:multi]]
+        when false, nil
+        else temple << [:html, :attr, key, [:fescape, @escape_attrs, [:static, value.to_s]]]
+        end
       else
-        [:static, " #{key}=#{@attr_wrapper}#{key}#{@attr_wrapper}"]
+        var = @identity.generate
+        temple << [
+          :case, "(#{var} = (#{exp}))",
+          ['true', [:html, :attr, key, @format == :xhtml ? [:static, key] : [:multi]]],
+          ['false, nil', [:multi]],
+          [:else, [:multi, [:static, " #{key}=#{@quote}"], [:fescape, @escape_attrs, [:dynamic, var]], [:static, @quote]]],
+        ]
       end
     end
 
-    def unique_name
-      @unique_name ||= 0
-      "_haml_attribute_compiler#{@unique_name += 1}"
+    def compile_common!(temple, key, values)
+      temple << [:html, :attr, key, [:fescape, @escape_attrs, values.last]]
     end
 
-    # @param [Haml::AttributeCompiler::AttributeValue] attr
-    def attr_literal(attr)
-      case attr.type
-      when :static
-        to_literal(attr.value)
-      when :dynamic
-        attr.value
-      end
+    def attribute_builder(type, values)
+      args = [@escape_attrs.inspect, *values.map { |v| literal_for(v) }]
+      "::Haml::AttributeBuilder.build_#{type}(#{args.join(', ')})"
     end
 
-    # For haml/haml#972
-    # @param [Object] value
-    def to_literal(value)
-      case value
-      when true, false
-        value.to_s
-      else
-        Haml::Util.inspect_obj(value)
-      end
+    def literal_for(value)
+      type, exp = value
+      type == :static ? "#{exp.inspect}.freeze" : exp
     end
   end
 end

data/lib/haml/attribute_parser.rb

@@ -1,150 +1,116 @@
 # frozen_string_literal: true
-
-begin
-  require 'ripper'
-rescue LoadError
-end
-require 'temple/static_analyzer'
+require 'haml/ruby_expression'
 
 module Haml
-  # Haml::AttriubuteParser parses Hash literal to { String (key name) => String (value literal) }.
-  module AttributeParser
-    class UnexpectedTokenError < StandardError; end
-    class UnexpectedKeyError < StandardError; end
-
-    # Indices in Ripper tokens
-    TYPE = 1
-    TEXT = 2
-
-    IGNORED_TYPES = %i[on_sp on_ignored_nl].freeze
-
-    class << self
-      # @return [Boolean] - return true if AttributeParser.parse can be used.
-      def available?
-        defined?(Ripper) && Temple::StaticAnalyzer.available?
-      end
+  class AttributeParser
+    class ParseSkip < StandardError
+    end
 
-      # @param  [String] exp - Old attributes literal or Hash literal generated from new attributes.
-      # @return [Hash<String, String>,nil] - Return parsed attribute Hash whose values are Ruby literals, or return nil if argument is not a single Hash literal.
-      def parse(exp)
-        return nil unless hash_literal?(exp)
+    # @return [TrueClass, FalseClass] - return true if AttributeParser.parse can be used.
+    def self.available?
+      # TruffleRuby doesn't have Ripper.lex
+      defined?(Ripper) && Ripper.respond_to?(:lex) && Temple::StaticAnalyzer.available?
+    end
 
-        hash = {}
-        each_attribute(exp) do |key, value|
-          hash[key] = value
-        end
-        hash
-      rescue UnexpectedTokenError, UnexpectedKeyError
-        nil
-      end
+    def self.parse(text)
+      self.new.parse(text)
+    end
 
-      private
+    def parse(text)
+      exp = wrap_bracket(text)
+      return if Temple::StaticAnalyzer.syntax_error?(exp)
 
-      # @param  [String] exp - Ruby expression
-      # @return [Boolean] - Return true if exp is a single Hash literal
-      def hash_literal?(exp)
-        return false if Temple::StaticAnalyzer.syntax_error?(exp)
-        sym, body = Ripper.sexp(exp)
-        sym == :program && body.is_a?(Array) && body.size == 1 && body[0] && body[0][0] == :hash
+      hash = {}
+      tokens = Ripper.lex(exp)[1..-2] || []
+      each_attr(tokens) do |attr_tokens|
+        key = parse_key!(attr_tokens)
+        hash[key] = attr_tokens.map { |t| t[2] }.join.strip
       end
+      hash
+    rescue ParseSkip
+      nil
+    end
 
-      # @param [Array] tokens - Ripper tokens. Scanned tokens will be destructively removed from this argument.
-      # @return [String] - attribute name in String
-      def shift_key!(tokens)
-        while !tokens.empty? && IGNORED_TYPES.include?(tokens.first[TYPE])
-          tokens.shift # ignore spaces
-        end
+    private
 
-        _, type, first_text = tokens.shift
-        case type
-        when :on_label # `key:`
-          first_text.tr(':', '')
-        when :on_symbeg # `:key =>`, `:'key' =>` or `:"key" =>`
-          key = tokens.shift[TEXT]
-          if first_text != ':' # `:'key'` or `:"key"`
-            expect_string_end!(tokens.shift)
-          end
-          shift_hash_rocket!(tokens)
-          key
-        when :on_tstring_beg # `"key":`, `'key':` or `"key" =>`
-          key = tokens.shift[TEXT]
-          next_token = tokens.shift
-          if next_token[TYPE] != :on_label_end # on_label_end is `":` or `':`, so `"key" =>`
-            expect_string_end!(next_token)
-            shift_hash_rocket!(tokens)
-          end
-          key
-        else
-          raise UnexpectedKeyError.new("unexpected token is given!: #{first_text} (#{type})")
-        end
-      end
-
-      # @param [Array] token - Ripper token
-      def expect_string_end!(token)
-        if token[TYPE] != :on_tstring_end
-          raise UnexpectedTokenError
-        end
-      end
+    def wrap_bracket(text)
+      text = text.strip
+      return text if text[0] == '{'
+      "{#{text}}"
+    end
 
-      # @param [Array] tokens - Ripper tokens
-      def shift_hash_rocket!(tokens)
-        until tokens.empty?
-          _, type, str = tokens.shift
-          break if type == :on_op && str == '=>'
+    def parse_key!(tokens)
+      _, type, str = tokens.shift
+      case type
+      when :on_sp
+        parse_key!(tokens)
+      when :on_label
+        str.tr(':', '')
+      when :on_symbeg
+        _, _, key = tokens.shift
+        assert_type!(tokens.shift, :on_tstring_end) if str != ':'
+        skip_until_hash_rocket!(tokens)
+        key
+      when :on_tstring_beg
+        _, _, key = tokens.shift
+        next_token = tokens.shift
+        unless next_token[1] == :on_label_end
+          assert_type!(next_token, :on_tstring_end)
+          skip_until_hash_rocket!(tokens)
         end
+        key
+      else
+        raise ParseSkip
       end
+    end
 
-      # @param [String] hash_literal
-      # @param [Proc] block - that takes [String, String] as arguments
-      def each_attribute(hash_literal, &block)
-        all_tokens = Ripper.lex(hash_literal.strip)
-        all_tokens = all_tokens[1...-1] || [] # strip tokens for brackets
+    def assert_type!(token, type)
+      raise ParseSkip if token[1] != type
+    end
 
-        each_balanced_tokens(all_tokens) do |tokens|
-          key   = shift_key!(tokens)
-          value = tokens.map {|t| t[2] }.join.strip
-          block.call(key, value)
-        end
+    def skip_until_hash_rocket!(tokens)
+      until tokens.empty?
+        _, type, str = tokens.shift
+        break if type == :on_op && str == '=>'
       end
+    end
 
-      # @param [Array] tokens - Ripper tokens
-      # @param [Proc] block - that takes balanced Ripper tokens as arguments
-      def each_balanced_tokens(tokens, &block)
-        attr_tokens = []
-        open_tokens = Hash.new { |h, k| h[k] = 0 }
+    def each_attr(tokens)
+      attr_tokens = []
+      open_tokens = Hash.new { |h, k| h[k] = 0 }
 
-        tokens.each do |token|
-          case token[TYPE]
-          when :on_comma
-            if open_tokens.values.all?(&:zero?)
-              block.call(attr_tokens)
-              attr_tokens = []
-              next
-            end
-          when :on_lbracket
-            open_tokens[:array] += 1
-          when :on_rbracket
-            open_tokens[:array] -= 1
-          when :on_lbrace
-            open_tokens[:block] += 1
-          when :on_rbrace
-            open_tokens[:block] -= 1
-          when :on_lparen
-            open_tokens[:paren] += 1
-          when :on_rparen
-            open_tokens[:paren] -= 1
-          when :on_embexpr_beg
-            open_tokens[:embexpr] += 1
-          when :on_embexpr_end
-            open_tokens[:embexpr] -= 1
-          when *IGNORED_TYPES
-            next if attr_tokens.empty?
+      tokens.each do |token|
+        _, type, _ = token
+        case type
+        when :on_comma
+          if open_tokens.values.all?(&:zero?)
+            yield(attr_tokens)
+            attr_tokens = []
+            next
           end
-
-          attr_tokens << token
+        when :on_lbracket
+          open_tokens[:array] += 1
+        when :on_rbracket
+          open_tokens[:array] -= 1
+        when :on_lbrace
+          open_tokens[:block] += 1
+        when :on_rbrace
+          open_tokens[:block] -= 1
+        when :on_lparen
+          open_tokens[:paren] += 1
+        when :on_rparen
+          open_tokens[:paren] -= 1
+        when :on_embexpr_beg
+          open_tokens[:embexpr] += 1
+        when :on_embexpr_end
+          open_tokens[:embexpr] -= 1
+        when :on_sp
+          next if attr_tokens.empty?
         end
-        block.call(attr_tokens) unless attr_tokens.empty?
+
+        attr_tokens << token
       end
+      yield(attr_tokens) unless attr_tokens.empty?
     end
   end
 end