haml 4.0.6 → 5.0.0

data/lib/haml/attribute_compiler.rb

@@ -0,0 +1,215 @@
+# frozen_string_literal: true
+require 'haml/attribute_parser'
+
+module Haml
+  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.
+    class AttributeValue < Struct.new(:type, :key, :value)
+      # @return [String] A Ruby literal of value.
+      def to_literal
+        case type
+        when :static
+          Haml::Util.inspect_obj(value)
+        when :dynamic
+          value
+        end
+      end
+
+      # Key's substring before a hyphen. This is necessary because values with the same
+      # base_key can conflict by Haml::AttributeBuidler#build_data_keys.
+      def base_key
+        key.split('-', 2).first
+      end
+    end
+
+    # Returns a script to render attributes on runtime.
+    #
+    # @param attributes [Hash]
+    # @param object_ref [String,:nil]
+    # @param dynamic_attributes [DynamicAttributes]
+    # @return [String] Attributes rendering code
+    def self.runtime_build(attributes, object_ref, dynamic_attributes)
+      "_hamlout.attributes(#{Haml::Util.inspect_obj(attributes)}, #{object_ref},#{dynamic_attributes.to_literal})"
+    end
+
+    # @param options [Haml::Options]
+    def initialize(options)
+      @is_html = [:html4, :html5].include?(options[:format])
+      @attr_wrapper = options[:attr_wrapper]
+      @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 [DynamicAttributes]
+    # @return [Array] Temple expression
+    def compile(attributes, object_ref, dynamic_attributes)
+      if object_ref != :nil || !AttributeParser.available?
+        return [:dynamic, AttributeCompiler.runtime_build(attributes, object_ref, dynamic_attributes)]
+      end
+
+      parsed_hashes = [dynamic_attributes.new, dynamic_attributes.old].compact.map do |attribute_hash|
+        unless (hash = AttributeParser.parse(attribute_hash))
+          return [:dynamic, AttributeCompiler.runtime_build(attributes, object_ref, dynamic_attributes)]
+        end
+        hash
+      end
+      attribute_values = build_attribute_values(attributes, parsed_hashes)
+      AttributeBuilder.verify_attribute_names!(attribute_values.map(&:key))
+
+      values_by_base_key = attribute_values.group_by(&:base_key)
+      [:multi, *values_by_base_key.keys.sort.map { |base_key|
+        compile_attribute_values(values_by_base_key[base_key])
+      }]
+    end
+
+    private
+
+    # 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 same base_key to Temple expression.
+    #
+    # @param values [Array<AttributeValue>] `base_key`'s results are the same. `key`'s result may differ.
+    # @return [Array] Temple expression
+    def compile_attribute_values(values)
+      if values.map(&:key).uniq.size == 1
+        compile_attribute(values.first.key, values)
+      else
+        runtime_build(values)
+      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(', ')
+      [:dynamic, "_hamlout.attributes({ #{hash_content} }, nil)"]
+    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 { |a| Haml::Util.inspect_obj(a) }.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
+        values.first.to_literal
+      else
+        "::Haml::AttributeBuilder.merge_values(#{frozen_string(key)}, #{values.map(&:to_literal).join(', ')})"
+      end
+    end
+
+    # @param str [String]
+    # @return [String]
+    def frozen_string(str)
+      "#{Haml::Util.inspect_obj(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?(v.to_literal) }
+        return static_build(values)
+      end
+
+      case key
+      when 'id', 'class'
+        compile_id_or_class_attribute(key, values)
+      else
+        compile_common_attribute(key, values)
+      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, @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, @escape_attrs, [:dynamic, var]],
+                 [:static, @attr_wrapper]],
+        ]
+       ],
+      ]
+    end
+
+    def true_value(key)
+      if @is_html
+        [:static, " #{key}"]
+      else
+        [:static, " #{key}=#{@attr_wrapper}#{key}#{@attr_wrapper}"]
+      end
+    end
+
+    def unique_name
+      @unique_name ||= 0
+      "_haml_attribute_compiler#{@unique_name += 1}"
+    end
+  end
+end

data/lib/haml/attribute_parser.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+begin
+  require 'ripper'
+rescue LoadError
+end
+
+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]
+
+    class << self
+      # @return [Boolean] - return true if AttributeParser.parse can be used.
+      def available?
+        defined?(Ripper) && Temple::StaticAnalyzer.available?
+      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)
+
+        hash = {}
+        each_attribute(exp) do |key, value|
+          hash[key] = value
+        end
+        hash
+      rescue UnexpectedTokenError, UnexpectedKeyError
+        nil
+      end
+
+      private
+
+      # @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
+      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
+
+        _, 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
+
+      # @param [Array] tokens - Ripper tokens
+      def shift_hash_rocket!(tokens)
+        until tokens.empty?
+          _, type, str = tokens.shift
+          break if type == :on_op && str == '=>'
+        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
+
+        each_balaned_tokens(all_tokens) do |tokens|
+          key   = shift_key!(tokens)
+          value = tokens.map(&:last).join.strip
+          block.call(key, value)
+        end
+      end
+
+      # @param [Array] tokens - Ripper tokens
+      # @param [Proc] block - that takes balanced Ripper tokens as arguments
+      def each_balaned_tokens(tokens, &block)
+        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 *IGNORED_TYPES
+            next if attr_tokens.empty?
+          end
+
+          attr_tokens << token
+        end
+        block.call(attr_tokens) unless attr_tokens.empty?
+      end
+    end
+  end
+end

data/lib/haml/buffer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Haml
   # This class is used only internally. It holds the buffer of HTML that
   # is eventually output as the resulting document.
@@ -90,7 +91,8 @@ module Haml
     def initialize(upper = nil, options = {})
       @active     = true
       @upper      = upper
-      @options    = options
+      @options    = Options.buffer_defaults
+      @options    = @options.merge(options) unless options.empty?
       @buffer     = new_encoded_string
       @tabulation = 0
 
@@ -115,8 +117,8 @@ module Haml
         text.sub!(tabs, '') if dont_tab_up
       end
 
-      @buffer << text
       @real_tabs += tab_change
+      @buffer << text
     end
 
     # Modifies the indentation of the document.
@@ -127,82 +129,13 @@ module Haml
       @real_tabs += tab_change
     end
 
-    Haml::Util.def_static_method(self, :format_script, [:result],
-                                 :preserve_script, :in_tag, :preserve_tag, :escape_html,
-                                 :nuke_inner_whitespace, :interpolated, :ugly, <<RUBY)
-      <% # Escape HTML here so that the safety of the string is preserved in Rails
-         result_name = escape_html ? "html_escape(result.to_s)" : "result.to_s" %>
-      <% unless ugly %>
-        # If we're interpolated,
-        # then the custom tabulation is handled in #push_text.
-        # The easiest way to avoid it here is to reset @tabulation.
-        <% if interpolated %>
-          old_tabulation = @tabulation
-          @tabulation = 0
-        <% end %>
-
-        <% if !(in_tag && preserve_tag && !nuke_inner_whitespace) %>
-        tabulation = @real_tabs
-        <% end %>
-        result = <%= result_name %>.<% if nuke_inner_whitespace %>strip<% else %>rstrip<% end %>
-      <% else %>
-        result = <%= result_name %><% if nuke_inner_whitespace %>.strip<% end %>
-      <% end %>
-
-      <% if preserve_tag %>
-        result = Haml::Helpers.preserve(result)
-      <% elsif preserve_script %>
-        result = Haml::Helpers.find_and_preserve(result, options[:preserve])
-      <% end %>
-
-      <% if ugly %>
-        fix_textareas!(result) if toplevel? && result.include?('<textarea')
-        return result
-      <% else %>
-        <% if !(in_tag && preserve_tag && !nuke_inner_whitespace) %>
-        has_newline = result.include?("\\n")
-        <% end %>
-
-        <% if in_tag && !nuke_inner_whitespace %>
-          <% unless preserve_tag %> if !has_newline <% end %>
-          @real_tabs -= 1
-          <% if interpolated %> @tabulation = old_tabulation <% end %>
-          return result
-          <% unless preserve_tag %> end <% end %>
-        <% end %>
-
-        <% if !(in_tag && preserve_tag && !nuke_inner_whitespace) %>
-        # Precompiled tabulation may be wrong
-        <% if !interpolated && !in_tag %>
-          result = tabs + result if @tabulation > 0
-        <% end %>
-
-        if has_newline
-          result = result.gsub "\\n", "\\n" + tabs(tabulation)
-
-          # Add tabulation if it wasn't precompiled
-          <% if in_tag && !nuke_inner_whitespace %> result = tabs(tabulation) + result <% end %>
-        end
-
-        fix_textareas!(result) if toplevel? && result.include?('<textarea')
-
-        <% if in_tag && !nuke_inner_whitespace %>
-          result = "\\n\#{result}\\n\#{tabs(tabulation-1)}"
-          @real_tabs -= 1
-        <% end %>
-        <% if interpolated %> @tabulation = old_tabulation <% end %>
-        result
-        <% end %>
-      <% end %>
-RUBY
-
     def attributes(class_id, obj_ref, *attributes_hashes)
       attributes = class_id
       attributes_hashes.each do |old|
-        self.class.merge_attrs(attributes, Hash[old.map {|k, v| [k.to_s, v]}])
+        AttributeBuilder.merge_attributes!(attributes, Hash[old.map {|k, v| [k.to_s, v]}])
       end
-      self.class.merge_attrs(attributes, parse_object_ref(obj_ref)) if obj_ref
-      Compiler.build_attributes(
+      AttributeBuilder.merge_attributes!(attributes, parse_object_ref(obj_ref)) if obj_ref
+      AttributeBuilder.build_attributes(
         html?, @options[:attr_wrapper], @options[:escape_attrs], @options[:hyphenate_data_attrs], attributes)
     end
 
@@ -217,50 +150,6 @@ RUBY
       buffer << buffer.slice!(capture_position..-1).rstrip
     end
 
-    # Merges two attribute hashes.
-    # This is the same as `to.merge!(from)`,
-    # except that it merges id, class, and data attributes.
-    #
-    # ids are concatenated with `"_"`,
-    # and classes are concatenated with `" "`.
-    # data hashes are simply merged.
-    #
-    # Destructively modifies both `to` and `from`.
-    #
-    # @param to [{String => String}] The attribute hash to merge into
-    # @param from [{String => #to_s}] The attribute hash to merge from
-    # @return [{String => String}] `to`, after being merged
-    def self.merge_attrs(to, from)
-      from['id'] = Compiler.filter_and_join(from['id'], '_') if from['id']
-      if to['id'] && from['id']
-        to['id'] << '_' << from.delete('id').to_s
-      elsif to['id'] || from['id']
-        from['id'] ||= to['id']
-      end
-
-      from['class'] = Compiler.filter_and_join(from['class'], ' ') if from['class']
-      if to['class'] && from['class']
-        # Make sure we don't duplicate class names
-        from['class'] = (from['class'].to_s.split(' ') | to['class'].split(' ')).sort.join(' ')
-      elsif to['class'] || from['class']
-        from['class'] ||= to['class']
-      end
-
-      from_data = from.delete('data') || {}
-      to_data = to.delete('data') || {}
-
-      # forces to_data & from_data into a hash
-      from_data = { nil => from_data } unless from_data.is_a?(Hash)
-      to_data = { nil => to_data } unless to_data.is_a?(Hash)
-
-      merged_data = to_data.merge(from_data)
-
-      to['data'] = merged_data unless merged_data.empty?
-      to.merge!(from)
-    end
-
-    private
-
     # Works like #{find_and_preserve}, but allows the first newline after a
     # preserved opening tag to remain unencoded, and then outdents the content.
     # This change was motivated primarily by the change in Rails 3.2.3 to emit
@@ -270,27 +159,26 @@ RUBY
     # @since Haml 4.0.1
     # @private
     def fix_textareas!(input)
-      pattern = /([ ]*)<(textarea)([^>]*)>(\n|&#x000A;)(.*?)(<\/\2>)/im
+      return input unless toplevel? && input.include?('<textarea'.freeze)
+
+      pattern = /<(textarea)([^>]*)>(\n|&#x000A;)(.*?)<\/textarea>/im
       input.gsub!(pattern) do |s|
         match = pattern.match(s)
-        content = match[5]
-        if match[4] == '&#x000A;'
+        content = match[4]
+        if match[3] == '&#x000A;'
           content.sub!(/\A /, '&#x0020;')
         else
           content.sub!(/\A[ ]*/, '')
         end
-        "#{match[1]}<#{match[2]}#{match[3]}>\n#{content}</#{match[2]}>"
+        "<#{match[1]}#{match[2]}>\n#{content}</#{match[1]}>"
       end
+      input
     end
 
-    if RUBY_VERSION < "1.9"
-      def new_encoded_string
-        ""
-      end
-    else
-      def new_encoded_string
-        "".encode(Encoding.find(options[:encoding]))
-      end
+    private
+
+    def new_encoded_string
+      "".encode(options[:encoding])
     end
 
     @@tab_cache = {}
@@ -328,18 +216,20 @@ RUBY
         id = "#{ prefix }_#{ id }"
       end
 
-      {'id' => id, 'class' => class_name}
+      { 'id'.freeze => id, 'class'.freeze => class_name }
     end
 
     # Changes a word from camel case to underscores.
     # Based on the method of the same name in Rails' Inflector,
     # but copied here so it'll run properly without Rails.
     def underscore(camel_cased_word)
-      camel_cased_word.to_s.gsub(/::/, '_').
-        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-        gsub(/([a-z\d])([A-Z])/,'\1_\2').
-        tr("-", "_").
-        downcase
+      word = camel_cased_word.to_s.dup
+      word.gsub!(/::/, '_')
+      word.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+      word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+      word.tr!('-', '_')
+      word.downcase!
+      word
     end
   end
 end