haml 5.2.2 → 6.3.0

data/lib/haml/string_splitter.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+begin
+  require 'ripper'
+rescue LoadError
+end
+
+module Haml
+  # Compile [:dynamic, "foo#{bar}"] to [:multi, [:static, 'foo'], [:dynamic, 'bar']]
+  class StringSplitter < Temple::Filter
+    if defined?(Ripper) && RUBY_VERSION >= "2.0.0" && Ripper.respond_to?(:lex)
+      class << self
+        # `code` param must be valid string literal
+        def compile(code)
+          [].tap do |exps|
+            tokens = Ripper.lex(code.strip)
+            tokens.pop while tokens.last && [:on_comment, :on_sp].include?(tokens.last[1])
+
+            if tokens.size < 2
+              raise(Haml::InternalError, "Expected token size >= 2 but got: #{tokens.size}")
+            end
+            compile_tokens!(exps, tokens)
+          end
+        end
+
+        private
+
+        def strip_quotes!(tokens)
+          _, type, beg_str = tokens.shift
+          if type != :on_tstring_beg
+            raise(Haml::InternalError, "Expected :on_tstring_beg but got: #{type}")
+          end
+
+          _, type, end_str = tokens.pop
+          if type != :on_tstring_end
+            raise(Haml::InternalError, "Expected :on_tstring_end but got: #{type}")
+          end
+
+          [beg_str, end_str]
+        end
+
+        def compile_tokens!(exps, tokens)
+          beg_str, end_str = strip_quotes!(tokens)
+
+          until tokens.empty?
+            _, type, str = tokens.shift
+
+            case type
+            when :on_tstring_content
+              beg_str, end_str = escape_quotes(beg_str, end_str)
+              exps << [:static, eval("#{beg_str}#{str}#{end_str}").to_s]
+            when :on_embexpr_beg
+              embedded = shift_balanced_embexpr(tokens)
+              exps << [:dynamic, embedded] unless embedded.empty?
+            end
+          end
+        end
+
+        # Some quotes are split-unsafe. Replace such quotes with null characters.
+        def escape_quotes(beg_str, end_str)
+          case [beg_str[-1], end_str]
+          when ['(', ')'], ['[', ']'], ['{', '}']
+            [beg_str.sub(/.\z/) { "\0" }, "\0"]
+          else
+            [beg_str, end_str]
+          end
+        end
+
+        def shift_balanced_embexpr(tokens)
+          String.new.tap do |embedded|
+            embexpr_open = 1
+
+            until tokens.empty?
+              _, type, str = tokens.shift
+              case type
+              when :on_embexpr_beg
+                embexpr_open += 1
+              when :on_embexpr_end
+                embexpr_open -= 1
+                break if embexpr_open == 0
+              end
+
+              embedded << str
+            end
+          end
+        end
+      end
+
+      def on_dynamic(code)
+        return [:dynamic, code] unless string_literal?(code)
+        return [:dynamic, code] if code.include?("\n")
+
+        temple = [:multi]
+        StringSplitter.compile(code).each do |type, content|
+          case type
+          when :static
+            temple << [:static, content]
+          when :dynamic
+            temple << on_dynamic(content)
+          end
+        end
+        temple
+      end
+
+      private
+
+      def string_literal?(code)
+        return false if SyntaxChecker.syntax_error?(code)
+
+        type, instructions = Ripper.sexp(code)
+        return false if type != :program
+        return false if instructions.size > 1
+
+        type, _ = instructions.first
+        type == :string_literal
+      end
+
+      class SyntaxChecker < Ripper
+        class ParseError < StandardError; end
+
+        def self.syntax_error?(code)
+          self.new(code).parse
+          false
+        rescue ParseError
+          true
+        end
+
+        private
+
+        def on_parse_error(*)
+          raise ParseError
+        end
+      end
+    else
+      # Do nothing if ripper is unavailable
+      def call(ast)
+        ast
+      end
+    end
+  end
+end

data/lib/haml/template.rb

@@ -1,39 +1,20 @@
-# frozen_string_literal: true
-
-require 'haml/template/options'
-if defined?(ActiveSupport)
-  ActiveSupport.on_load(:action_view) do
-    require 'haml/helpers/action_view_mods'
-    require 'haml/helpers/action_view_extensions'
-  end
-else
-  require 'haml/helpers/action_view_mods'
-  require 'haml/helpers/action_view_extensions'
-end
-require 'haml/helpers/xss_mods'
-require 'haml/helpers/action_view_xss_mods'
+# frozen_string_literal: false
+require 'temple'
+require 'haml/engine'
+require 'haml/helpers'
 
 module Haml
-  class TempleEngine
-    def precompiled_method_return_value_with_haml_xss
-      "::Haml::Util.html_safe(#{precompiled_method_return_value_without_haml_xss})"
+  Template = Temple::Templates::Tilt.create(
+    Haml::Engine,
+    register_as: [:haml, :haml],
+  )
+
+  module TemplateExtension
+    # Activate Haml::Helpers for tilt templates.
+    # https://github.com/judofyr/temple/blob/v0.7.6/lib/temple/mixins/template.rb#L7-L11
+    def compile(*)
+      "extend Haml::Helpers; #{super}"
     end
-    alias_method :precompiled_method_return_value_without_haml_xss, :precompiled_method_return_value
-    alias_method :precompiled_method_return_value, :precompiled_method_return_value_with_haml_xss
   end
-
-  module Helpers
-    include Haml::Helpers::XssMods
-  end
-
-  module Util
-    undef :rails_xss_safe? if defined? rails_xss_safe?
-    def rails_xss_safe?; true; end
-  end
-
+  Template.send(:extend, TemplateExtension)
 end
-
-
-Haml::Template.options[:escape_html] = true
-
-require 'haml/plugin'

data/lib/haml/temple_line_counter.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-
 module Haml
   # A module to count lines of expected code. This would be faster than actual code generation
   # and counting newlines in it.
@@ -22,6 +21,8 @@ module Haml
         end.reduce(:+)
       when :escape
         count_lines(args[1])
+      when :newline
+        1
       else
         raise UnexpectedExpression.new("[HAML BUG] Unexpected Temple expression '#{type}' is given!")
       end

data/lib/haml/util.rb

@@ -14,6 +14,24 @@ module Haml
   module Util
     extend self
 
+    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
+    end
+
+    # TODO: Remove unescape_interpolation's workaround and get rid of `respond_to?`.
+    def self.escape_html_safe(html)
+      html = html.to_s
+      (html.respond_to?(:html_safe?) && html.html_safe?) ? html : escape_html(html)
+    end
+
     # Silence all output to STDERR within a block.
     #
     # @yield A block in which no output will be printed to STDERR
@@ -35,20 +53,6 @@ module Haml
       false
     end
 
-    # Returns the given text, marked as being HTML-safe.
-    # With older versions of the Rails XSS-safety mechanism,
-    # this destructively modifies the HTML-safety of `text`.
-    #
-    # It only works if you are using ActiveSupport or the parameter `text`
-    # implements the #html_safe method.
-    #
-    # @param text [String, nil]
-    # @return [String, nil] `text`, marked as HTML-safe
-    def html_safe(text)
-      return unless text
-      text.html_safe
-    end
-
     # Checks that the encoding of a string is valid
     # and cleans up potential encoding gotchas like the UTF-8 BOM.
     # If it's not, yields an error string describing the invalid character
@@ -214,7 +218,7 @@ MSG
           end
           content = eval("\"#{interpolated}\"")
           content = "#{char}#{content}" if char == '@' || char == '$'
-          content = "Haml::Helpers.html_escape((#{content}))" if escape_html
+          content = "Haml::Util.escape_html_safe((#{content}).to_s)" if escape_html
 
           res << "\#{#{content}}"
         end

data/lib/haml/version.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-
 module Haml
-  VERSION = "5.2.2"
+  VERSION = '6.3.0'
 end

data/lib/haml/whitespace.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+module Haml
+  class Whitespace < Temple::Filter
+    def on_whitespace
+      [:static, "\n"]
+    end
+  end
+end

data/lib/haml.rb

@@ -1,25 +1,13 @@
 # frozen_string_literal: true
-
+require 'haml/engine'
+require 'haml/error'
 require 'haml/version'
+require 'haml/template'
 
-# The module that contains everything Haml-related:
-#
-# * {Haml::Parser} is Haml's parser.
-# * {Haml::Compiler} is Haml's compiler.
-# * {Haml::Engine} is the class used to render Haml within Ruby code.
-# * {Haml::Options} is where Haml's runtime options are defined.
-# * {Haml::Error} is raised when Haml encounters an error.
-#
-# Also see the {file:REFERENCE.md full Haml reference}.
-module Haml
-
-  def self.init_rails(*args)
-    # Maintain this as a no-op for any libraries that may be depending on the
-    # previous definition here.
+if File.basename($0) != 'haml'
+  begin
+    require 'rails'
+    require 'haml/railtie'
+  rescue LoadError
   end
-
 end
-
-require 'haml/util'
-require 'haml/engine'
-require 'haml/railtie' if defined?(Rails::Railtie)

metadata

@@ -1,17 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: haml
 version: !ruby/object:Gem::Version
-  version: 5.2.2
+  version: 6.3.0
 platform: ruby
 authors:
 - Natalie Weizenbaum
 - Hampton Catlin
 - Norman Clarke
 - Akira Matsuda
+- Takashi Kokubun
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2021-07-27 00:00:00.000000000 Z
+date: 2023-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: temple
@@ -19,14 +20,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.8.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.8.2
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
@@ -42,21 +57,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: benchmark_driver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coffee-script
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rbench
+  name: erubi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -70,7 +113,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: less
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -84,7 +169,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: string_template
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -98,7 +225,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: unindent
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -111,12 +238,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: |
-  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.
+description: An elegant, structured (X)HTML/XML templating engine.
 email:
 - haml@googlegroups.com
 - ronnie@dio.jp
@@ -125,9 +247,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
-- ".gitmodules"
 - ".yardopts"
 - CHANGELOG.md
 - FAQ.md
@@ -136,54 +258,70 @@ files:
 - README.md
 - REFERENCE.md
 - Rakefile
-- TODO
-- benchmark.rb
-- bin/haml
+- bin/bench
+- bin/console
+- bin/ruby
+- bin/setup
+- bin/stackprof
+- bin/test
+- exe/haml
 - haml.gemspec
 - lib/haml.rb
-- lib/haml/.gitattributes
+- lib/haml/ambles.rb
 - lib/haml/attribute_builder.rb
 - lib/haml/attribute_compiler.rb
 - lib/haml/attribute_parser.rb
-- lib/haml/buffer.rb
+- lib/haml/cli.rb
 - lib/haml/compiler.rb
+- lib/haml/compiler/children_compiler.rb
+- lib/haml/compiler/comment_compiler.rb
+- lib/haml/compiler/doctype_compiler.rb
+- lib/haml/compiler/script_compiler.rb
+- lib/haml/compiler/silent_script_compiler.rb
+- lib/haml/compiler/tag_compiler.rb
+- lib/haml/dynamic_merger.rb
 - lib/haml/engine.rb
 - lib/haml/error.rb
-- lib/haml/escapable.rb
-- lib/haml/exec.rb
+- lib/haml/escape.rb
+- lib/haml/escape_any.rb
 - lib/haml/filters.rb
-- lib/haml/generator.rb
+- lib/haml/filters/base.rb
+- lib/haml/filters/cdata.rb
+- lib/haml/filters/coffee.rb
+- lib/haml/filters/css.rb
+- lib/haml/filters/erb.rb
+- lib/haml/filters/escaped.rb
+- lib/haml/filters/javascript.rb
+- lib/haml/filters/less.rb
+- lib/haml/filters/markdown.rb
+- lib/haml/filters/plain.rb
+- lib/haml/filters/preserve.rb
+- lib/haml/filters/ruby.rb
+- lib/haml/filters/sass.rb
+- lib/haml/filters/scss.rb
+- lib/haml/filters/text_base.rb
+- lib/haml/filters/tilt_base.rb
+- lib/haml/force_escape.rb
 - lib/haml/helpers.rb
-- lib/haml/helpers/action_view_extensions.rb
-- lib/haml/helpers/action_view_mods.rb
-- lib/haml/helpers/action_view_xss_mods.rb
-- lib/haml/helpers/safe_erubi_template.rb
-- lib/haml/helpers/safe_erubis_template.rb
-- lib/haml/helpers/xss_mods.rb
-- lib/haml/options.rb
+- lib/haml/html.rb
+- lib/haml/identity.rb
+- lib/haml/object_ref.rb
 - lib/haml/parser.rb
-- lib/haml/plugin.rb
+- lib/haml/rails_helpers.rb
+- lib/haml/rails_template.rb
 - lib/haml/railtie.rb
-- lib/haml/sass_rails_filter.rb
+- lib/haml/ruby_expression.rb
+- lib/haml/string_splitter.rb
 - lib/haml/template.rb
-- lib/haml/template/options.rb
-- lib/haml/temple_engine.rb
 - lib/haml/temple_line_counter.rb
 - lib/haml/util.rb
 - lib/haml/version.rb
-- yard/default/.gitignore
-- yard/default/fulldoc/html/css/common.sass
-- yard/default/layout/html/footer.erb
-homepage: http://haml.info/
+- lib/haml/whitespace.rb
+homepage: https://haml.info
 licenses:
 - MIT
 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
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -192,14 +330,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: An elegant, structured (X)HTML/XML templating engine.

data/.gitmodules

@@ -1,3 +0,0 @@
-[submodule "test/haml-spec"]
-	path = test/haml-spec
-	url = git://github.com/haml/haml-spec.git