haml 4.0.6 → 5.2.0

data/TODO

@@ -0,0 +1,24 @@
+# -*- mode: org -*-
+#+STARTUP: nofold
+
+* Documentation
+  Redo tutorial?
+  Using helpers
+    haml_concat and haml_tag in particular
+  Syntax highlighting?
+
+* Code
+  Keep track of error offsets everywhere
+    Use this to show error location in messages
+** Haml
+   Support finer-grained HTML-escaping in filters
+   Speed
+     Make tags with dynamic attributes pre-render as much as possible
+     Including the attribute name where doable
+   :html improvements
+     Ignore closing tags where we can
+       http://code.google.com/speed/articles/optimizing-html.html
+       Requires Haml parsing refactor
+     Don't quote attributes that don't require it
+       http://www.w3.org/TR/REC-html40/intro/sgmltut.html#h-3.2.2
+       http://www.w3.org/TR/html5/syntax.html#attributes

data/benchmark.rb

@@ -0,0 +1,70 @@
+require "bundler/setup"
+require "haml"
+require "rbench"
+
+times = (ARGV.first || 1000).to_i
+
+if times == 0 # Invalid parameter
+  puts <<END
+ruby #$0 [times=1000]
+  Benchmark Haml against various other templating languages.
+END
+  exit 1
+end
+
+%w[erb erubi rails active_support action_controller
+   action_view action_pack haml/template rbench].each {|dep| require(dep)}
+
+def view
+  base = ActionView::Base.new
+  base.view_paths << File.join(File.dirname(__FILE__), '/test')
+  base
+end
+
+def render(view, file)
+  view.render :file => file
+end
+
+RBench.run(times) do
+  column :haml, :title => "Haml"
+  column :erb, :title => "ERB"
+  column :erubi, :title => "Erubi"
+
+  template_name = 'standard'
+  haml_template    = File.read("#{File.dirname(__FILE__)}/test/templates/#{template_name}.haml")
+  erb_template     = File.read("#{File.dirname(__FILE__)}/test/erb/#{template_name}.erb")
+
+  report "Cached" do
+    obj = Object.new
+
+    Haml::Engine.new(haml_template).def_method(obj, :haml)
+    if ERB.instance_method(:initialize).parameters.assoc(:key) # Ruby 2.6+
+      obj.instance_eval("def erb; #{ERB.new(erb_template, trim_mode: '-').src}; end")
+    else
+      obj.instance_eval("def erb; #{ERB.new(erb_template, nil, '-').src}; end")
+    end
+    obj.instance_eval("def erubi; #{Erubi::Engine.new(erb_template).src}; end")
+
+    haml      { obj.haml }
+    erb       { obj.erb }
+    erubi     { obj.erubi }
+  end
+
+  report "ActionView" do
+    # To cache the template
+    render view, 'templates/standard'
+    render view, 'erb/standard'
+
+    haml  { render view, 'templates/standard' }
+    erubi { render view, 'erb/standard' }
+  end
+
+  report "ActionView with deep partials" do
+    # To cache the template
+    render view, 'templates/action_view'
+    render view, 'erb/action_view'
+
+    haml  { render view, 'templates/action_view' }
+    erubi { render view, 'erb/action_view' }
+  end
+end

data/haml.gemspec

@@ -0,0 +1,45 @@
+($LOAD_PATH << File.expand_path("../lib", __FILE__)).uniq!
+require "haml/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = 'haml'
+  spec.summary     = "An elegant, structured (X)HTML/XML templating engine."
+  spec.version     = Haml::VERSION
+  spec.authors     = ['Natalie Weizenbaum', 'Hampton Catlin', 'Norman Clarke', 'Akira Matsuda']
+  spec.email       = ['haml@googlegroups.com', 'ronnie@dio.jp']
+
+  spec.executables = ['haml']
+  spec.files       = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{\Atest/})
+  end
+  spec.homepage    = 'http://haml.info/'
+  spec.license     = "MIT"
+  spec.metadata    = {
+    "bug_tracker_uri"   => "https://github.com/haml/haml/issues",
+    "changelog_uri"     => "https://github.com/haml/haml/blob/main/CHANGELOG.md",
+    "documentation_uri" => "http://haml.info/docs.html",
+    "homepage_uri"      => "http://haml.info",
+    "mailing_list_uri"  => "https://groups.google.com/forum/?fromgroups#!forum/haml",
+    "source_code_uri"   => "https://github.com/haml/haml"
+  }
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_dependency 'temple', '>= 0.8.0'
+  spec.add_dependency 'tilt'
+
+  spec.add_development_dependency 'rails', '>= 4.0.0'
+  spec.add_development_dependency 'rbench'
+  spec.add_development_dependency 'minitest', '>= 4.0'
+  spec.add_development_dependency 'nokogiri'
+  spec.add_development_dependency 'simplecov', '0.17.1' # Locked to this version due to https://github.com/codeclimate/test-reporter/issues/418
+
+  spec.description = <<-END
+Haml (HTML Abstraction Markup Language) is a layer on top of HTML or XML that's
+designed to express the structure of documents in a non-repetitive, elegant, and
+easy way by using indentation rather than closing tags and allowing Ruby to be
+embedded with ease. It was originally envisioned as a plugin for Ruby on Rails,
+but it can function as a stand-alone templating engine.
+END
+
+end

data/lib/haml.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'haml/version'
 
 # The module that contains everything Haml-related:

data/lib/haml/.gitattributes

@@ -0,0 +1 @@
+version.rb merge=ours

data/lib/haml/attribute_builder.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+module Haml
+  module AttributeBuilder
+    # https://html.spec.whatwg.org/multipage/syntax.html#attributes-2
+    INVALID_ATTRIBUTE_NAME_REGEX = /[ \0"'>\/=]/
+
+    class << self
+      def build_attributes(is_html, attr_wrapper, escape_attrs, hyphenate_data_attrs, attributes = {})
+        # @TODO this is an absolutely ridiculous amount of arguments. At least
+        # some of this needs to be moved into an instance method.
+        join_char = hyphenate_data_attrs ? '-' : '_'
+
+        attributes.each do |key, value|
+          if value.is_a?(Hash)
+            data_attributes = attributes.delete(key)
+            data_attributes = flatten_data_attributes(data_attributes, '', join_char)
+            data_attributes = build_data_keys(data_attributes, hyphenate_data_attrs, key)
+            verify_attribute_names!(data_attributes.keys)
+            attributes = data_attributes.merge(attributes)
+          end
+        end
+
+        result = attributes.collect do |attr, value|
+          next if value.nil?
+
+          value = filter_and_join(value, ' ') if attr == 'class'
+          value = filter_and_join(value, '_') if attr == 'id'
+
+          if value == true
+            next " #{attr}" if is_html
+            next " #{attr}=#{attr_wrapper}#{attr}#{attr_wrapper}"
+          elsif value == false
+            next
+          end
+
+          value =
+            if escape_attrs == :once
+              Haml::Helpers.escape_once_without_haml_xss(value.to_s)
+            elsif escape_attrs
+              Haml::Helpers.html_escape_without_haml_xss(value.to_s)
+            else
+              value.to_s
+            end
+          " #{attr}=#{attr_wrapper}#{value}#{attr_wrapper}"
+        end
+        result.compact!
+        result.sort!
+        result.join
+      end
+
+      # @return [String, nil]
+      def filter_and_join(value, separator)
+        return '' if (value.respond_to?(:empty?) && value.empty?)
+
+        if value.is_a?(Array)
+          value = value.flatten
+          value.map! {|item| item ? item.to_s : nil}
+          value.compact!
+          value = value.join(separator)
+        else
+          value = value ? value.to_s : nil
+        end
+        !value.nil? && !value.empty? && value
+      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 `to`.
+      #
+      # @param to [{String => String,Hash}] The attribute hash to merge into
+      # @param from [{String => Object}] The attribute hash to merge from
+      # @return [{String => String,Hash}] `to`, after being merged
+      def merge_attributes!(to, from)
+        from.keys.each do |key|
+          to[key] = merge_value(key, to[key], from[key])
+        end
+        to
+      end
+
+      # Merge multiple values to one attribute value. No destructive operation.
+      #
+      # @param key [String]
+      # @param values [Array<Object>]
+      # @return [String,Hash]
+      def merge_values(key, *values)
+        values.inject(nil) do |to, from|
+          merge_value(key, to, from)
+        end
+      end
+
+      def verify_attribute_names!(attribute_names)
+        attribute_names.each do |attribute_name|
+          if attribute_name =~ INVALID_ATTRIBUTE_NAME_REGEX
+            raise InvalidAttributeNameError.new("Invalid attribute name '#{attribute_name}' was rendered")
+          end
+        end
+      end
+
+      private
+
+      # Merge a couple of values to one attribute value. No destructive operation.
+      #
+      # @param to [String,Hash,nil]
+      # @param from [Object]
+      # @return [String,Hash]
+      def merge_value(key, to, from)
+        if from.kind_of?(Hash) || to.kind_of?(Hash)
+          from = { nil => from } if !from.is_a?(Hash)
+          to   = { nil => to }   if !to.is_a?(Hash)
+          to.merge(from)
+        elsif key == 'id'
+          merged_id = filter_and_join(from, '_')
+          if to && merged_id
+            merged_id = "#{to}_#{merged_id}"
+          elsif to || merged_id
+            merged_id ||= to
+          end
+          merged_id
+        elsif key == 'class'
+          merged_class = filter_and_join(from, ' ')
+          if to && merged_class
+            merged_class = (to.split(' ') | merged_class.split(' ')).join(' ')
+          elsif to || merged_class
+            merged_class ||= to
+          end
+          merged_class
+        else
+          from
+        end
+      end
+
+      def build_data_keys(data_hash, hyphenate, attr_name="data")
+        Hash[data_hash.map do |name, value|
+          if name == nil
+            [attr_name, value]
+          elsif hyphenate
+            ["#{attr_name}-#{name.to_s.tr('_', '-')}", value]
+          else
+            ["#{attr_name}-#{name}", value]
+          end
+        end]
+      end
+
+      def flatten_data_attributes(data, key, join_char, seen = [])
+        return {key => data} unless data.is_a?(Hash)
+
+        return {key => nil} if seen.include? data.object_id
+        seen << data.object_id
+
+        data.sort {|x, y| x[0].to_s <=> y[0].to_s}.inject({}) do |hash, (k, v)|
+          joined = key == '' ? k : [key, k].join(join_char)
+          hash.merge! flatten_data_attributes(v, joined, join_char, seen)
+        end
+      end
+    end
+  end
+end

data/lib/haml/attribute_compiler.rb

@@ -0,0 +1,235 @@
+# 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.
+    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]
+      @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)]
+      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
+      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)
+      }]
+    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)
+      "_hamlout.attributes(#{to_literal(attributes)}, #{object_ref}, #{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
+        end
+      end
+    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)
+      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(&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)
+      else
+        "::Haml::AttributeBuilder.merge_values(#{frozen_string(key)}, #{values.map(&method(:attr_literal)).join(', ')})"
+      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
+
+      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, 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 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
+
+    # @param [Haml::AttributeCompiler::AttributeValue] attr
+    def attr_literal(attr)
+      case attr.type
+      when :static
+        to_literal(attr.value)
+      when :dynamic
+        attr.value
+      end
+    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
+    end
+  end
+end