haml_lint 0.40.0 → 0.51.0

data/lib/haml_lint/utils.rb

@@ -4,7 +4,7 @@ require 'pathname'
 
 module HamlLint
   # A miscellaneous set of utility functions.
-  module Utils
+  module Utils # rubocop:disable Metrics/ModuleLength
     module_function
 
     # Returns whether a glob pattern (or any of a list of patterns) matches the
@@ -52,12 +52,21 @@ module HamlLint
     #   the text.
     # @yieldparam interpolated_code [String] code that was interpolated
     # @yieldparam line [Integer] line number code appears on in text
-    def extract_interpolated_values(text)
+    def extract_interpolated_values(text) # rubocop:disable Metrics/AbcSize
       dumped_text = text.dump
-      newline_positions = extract_substring_positions(dumped_text, '\\\n')
+
+      # Basically, match pairs of '\' and '\ followed by the letter 'n'
+      quoted_regex_s = "(#{Regexp.quote('\\\\')}|#{Regexp.quote('\\n')})"
+      newline_positions = extract_substring_positions(dumped_text, quoted_regex_s)
+
+      # Filter the matches to only keep those ending in 'n'.
+      # This way, escaped \n will not be considered
+      newline_positions.select! do |pos|
+        dumped_text[pos - 1] == 'n'
+      end
 
       Haml::Util.handle_interpolation(dumped_text) do |scan|
-        line = (newline_positions.find_index { |marker| scan.pos <= marker } ||
+        line = (newline_positions.find_index { |marker| scan.charpos <= marker } ||
                 newline_positions.size) + 1
 
         escape_count = (scan[2].size - 1) / 2
@@ -70,6 +79,41 @@ module HamlLint
       end
     end
 
+    def handle_interpolation_with_indexes(text)
+      newline_indexes = extract_substring_positions(text, "\n")
+
+      handle_interpolation_with_newline(text) do |scan|
+        line_index = newline_indexes.find_index { |index| scan.charpos <= index }
+        line_index ||= newline_indexes.size
+
+        line_start_char_index = if line_index == 0
+                                  0
+                                else
+                                  newline_indexes[line_index - 1]
+                                end
+
+        char_index = scan.charpos - line_start_char_index
+
+        yield scan, line_index, char_index
+      end
+    end
+
+    if Gem::Version.new(Haml::VERSION) >= Gem::Version.new('5')
+      # Same as Haml::Util.handle_interpolation, but enables multiline mode on the regex
+      def handle_interpolation_with_newline(str)
+        scan = StringScanner.new(str)
+        yield scan while scan.scan(/(.*?)(\\*)#([{@$])/m)
+        scan.rest
+      end
+    else
+      # Same as Haml::Util.handle_interpolation, but enables multiline mode on the regex
+      def handle_interpolation_with_newline(str)
+        scan = StringScanner.new(str)
+        yield scan while scan.scan(/(.*?)(\\*)\#\{/m)
+        scan.rest
+      end
+    end
+
     # Returns indexes of all occurrences of a substring within a string.
     #
     # Note, this will not return overlaping substrings, so searching for "aa"
@@ -81,7 +125,7 @@ module HamlLint
     def extract_substring_positions(text, substr)
       positions = []
       scanner = StringScanner.new(text)
-      positions << scanner.pos while scanner.scan(/(.*?)#{substr}/)
+      positions << scanner.charpos while scanner.scan(/(.*?)#{substr}/)
       positions
     end
 
@@ -136,6 +180,22 @@ module HamlLint
       count
     end
 
+    # Process ERB, providing some values for for versions to it
+    #
+    # @param content [String] the (usually yaml) content to process
+    # @return [String]
+    def process_erb(content)
+      # Variables for use in the ERB's post-processing
+      rubocop_version = HamlLint::VersionComparer.for_rubocop
+
+      ERB.new(content).result(binding)
+    end
+
+    def insert_after_indentation(code, insert)
+      index = code.index(/\S/)
+      "#{code[0...index]}#{insert}#{code[index..]}"
+    end
+
     # Calls a block of code with a modified set of environment variables,
     # restoring them once the code has executed.
     #
@@ -151,5 +211,75 @@ module HamlLint
     ensure
       old_env.each { |var, value| ENV[var.to_s] = value }
     end
+
+    def indent(string, nb_indent)
+      if nb_indent < 0
+        string.gsub(/^ {1,#{-nb_indent}}/, '')
+      else
+        string.gsub(/^/, ' ' * nb_indent)
+      end
+    end
+
+    def map_subset!(array, range, &block)
+      subset = array[range]
+      return if subset.nil? || subset.empty?
+
+      array[range] = subset.map(&block)
+    end
+
+    def map_after_first!(array, &block)
+      map_subset!(array, 1..-1, &block)
+    end
+
+    # Returns true if line is only whitespace.
+    # Note, this is not like blank? is rails. For nil, this returns false.
+    def is_blank_line?(line)
+      line && line.index(/\S/).nil?
+    end
+
+    def check_error_when_compiling_haml(haml_string)
+      begin
+        ruby_code = ::HamlLint::Adapter.detect_class.new(haml_string).precompile
+      rescue StandardError => e
+        return e
+      end
+      eval("BEGIN {return nil}; #{ruby_code}", binding, __FILE__, __LINE__) # rubocop:disable Security/Eval
+      # The eval will return nil
+    rescue ::SyntaxError
+      $!
+    end
+
+    # Overrides the global stdin, stdout and stderr while within the block, to
+    # push a string in stdin, and capture both stdout and stderr which are returned.
+    #
+    # @param stdin_str [String] the string to push in as stdin
+    # @param _block [Block] the block to perform with the overridden std streams
+    # @return [String, String]
+    def with_captured_streams(stdin_str, &_block)
+      original_stdin = $stdin
+      # The dup is needed so that stdin_data isn't altered (encoding-wise at least)
+      $stdin = StringIO.new(stdin_str.dup)
+      begin
+        original_stdout = $stdout
+        $stdout = StringIO.new
+        begin
+          original_stderr = $stderr
+          $stderr = StringIO.new
+          yield
+          [$stdout.string, $stderr.string]
+        ensure
+          $stderr = original_stderr
+        end
+      ensure
+        $stdout = original_stdout
+      end
+    ensure
+      $stdin = original_stdin
+    end
+
+    def regexp_for_parts(parts, join_regexp)
+      regexp_code = parts.map { |c| Regexp.quote(c) }.join(join_regexp)
+      Regexp.new(regexp_code)
+    end
   end
 end

data/lib/haml_lint/version.rb

@@ -2,5 +2,5 @@
 
 # Defines the gem version.
 module HamlLint
-  VERSION = '0.40.0'
+  VERSION = '0.51.0'
 end

data/lib/haml_lint/version_comparer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module HamlLint
+  # A simple wrapper around Gem::Version to allow comparison with String instances
+  # This makes code shorter in some places
+  class VersionComparer
+    def initialize(version)
+      @version = Gem::Version.new(version)
+    end
+
+    include Comparable
+    def <=>(other)
+      @version <=> Gem::Version.new(other)
+    end
+
+    # Shortcut to create a version comparer for the current RuboCop's version
+    def self.for_rubocop
+      new(RuboCop::Version::STRING)
+    end
+
+    def self.for_haml
+      new(Haml::VERSION)
+    end
+  end
+end

data/lib/haml_lint.rb

@@ -21,8 +21,14 @@ require 'haml_lint/file_finder'
 require 'haml_lint/runner'
 require 'haml_lint/utils'
 require 'haml_lint/version'
+require 'haml_lint/version_comparer'
 require 'haml_lint/severity'
 
+# Lead all extensions to external source code
+Dir[File.expand_path('haml_lint/extensions/*.rb', File.dirname(__FILE__))].sort.each do |file|
+  require file
+end
+
 # Load all parse tree node classes
 require 'haml_lint/tree/node'
 require 'haml_lint/node_transformer'
@@ -39,3 +45,9 @@ end
 Dir[File.expand_path('haml_lint/reporter/*.rb', File.dirname(__FILE__))].sort.each do |file|
   require file
 end
+
+# Load all the chunks for RubyExtraction
+require 'haml_lint/ruby_extraction/base_chunk'
+Dir[File.expand_path('haml_lint/ruby_extraction/*.rb', File.dirname(__FILE__))].sort.each do |file|
+  require file
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: haml_lint
 version: !ruby/object:Gem::Version
-  version: 0.40.0
+  version: 0.51.0
 platform: ruby
 authors:
 - Shane da Silva
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-27 00:00:00.000000000 Z
+date: 2023-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
@@ -17,9 +17,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.3'
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -64,14 +58,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: sysexits
   requirement: !ruby/object:Gem::Requirement
@@ -96,10 +90,12 @@ extra_rdoc_files: []
 files:
 - bin/haml-lint
 - config/default.yml
+- config/forced_rubocop_config.yml
 - lib/haml_lint.rb
 - lib/haml_lint/adapter.rb
 - lib/haml_lint/adapter/haml_4.rb
 - lib/haml_lint/adapter/haml_5.rb
+- lib/haml_lint/adapter/haml_6.rb
 - lib/haml_lint/cli.rb
 - lib/haml_lint/comment_configuration.rb
 - lib/haml_lint/configuration.rb
@@ -108,6 +104,7 @@ files:
 - lib/haml_lint/directive.rb
 - lib/haml_lint/document.rb
 - lib/haml_lint/exceptions.rb
+- lib/haml_lint/extensions/haml_util_unescape_interpolation_tracking.rb
 - lib/haml_lint/file_finder.rb
 - lib/haml_lint/haml_visitor.rb
 - lib/haml_lint/lint.rb
@@ -131,6 +128,7 @@ files:
 - lib/haml_lint/linter/line_length.rb
 - lib/haml_lint/linter/multiline_pipe.rb
 - lib/haml_lint/linter/multiline_script.rb
+- lib/haml_lint/linter/no_placeholders.rb
 - lib/haml_lint/linter/object_reference_attributes.rb
 - lib/haml_lint/linter/repeated_id.rb
 - lib/haml_lint/linter/rubocop.rb
@@ -139,6 +137,7 @@ files:
 - lib/haml_lint/linter/space_inside_hash_attributes.rb
 - lib/haml_lint/linter/syntax.rb
 - lib/haml_lint/linter/tag_name.rb
+- lib/haml_lint/linter/trailing_empty_lines.rb
 - lib/haml_lint/linter/trailing_whitespace.rb
 - lib/haml_lint/linter/unnecessary_interpolation.rb
 - lib/haml_lint/linter/unnecessary_string_output.rb
@@ -161,7 +160,20 @@ files:
 - lib/haml_lint/reporter/offense_count_reporter.rb
 - lib/haml_lint/reporter/progress_reporter.rb
 - lib/haml_lint/reporter/utils.rb
-- lib/haml_lint/ruby_extractor.rb
+- lib/haml_lint/ruby_extraction/ad_hoc_chunk.rb
+- lib/haml_lint/ruby_extraction/base_chunk.rb
+- lib/haml_lint/ruby_extraction/chunk_extractor.rb
+- lib/haml_lint/ruby_extraction/coordinator.rb
+- lib/haml_lint/ruby_extraction/haml_comment_chunk.rb
+- lib/haml_lint/ruby_extraction/implicit_end_chunk.rb
+- lib/haml_lint/ruby_extraction/interpolation_chunk.rb
+- lib/haml_lint/ruby_extraction/non_ruby_filter_chunk.rb
+- lib/haml_lint/ruby_extraction/placeholder_marker_chunk.rb
+- lib/haml_lint/ruby_extraction/ruby_filter_chunk.rb
+- lib/haml_lint/ruby_extraction/ruby_source.rb
+- lib/haml_lint/ruby_extraction/script_chunk.rb
+- lib/haml_lint/ruby_extraction/tag_attributes_chunk.rb
+- lib/haml_lint/ruby_extraction/tag_script_chunk.rb
 - lib/haml_lint/ruby_parser.rb
 - lib/haml_lint/runner.rb
 - lib/haml_lint/severity.rb
@@ -169,6 +181,7 @@ files:
 - lib/haml_lint/spec/matchers/report_lint.rb
 - lib/haml_lint/spec/normalize_indent.rb
 - lib/haml_lint/spec/shared_linter_context.rb
+- lib/haml_lint/spec/shared_rubocop_autocorrect_context.rb
 - lib/haml_lint/tree/comment_node.rb
 - lib/haml_lint/tree/doctype_node.rb
 - lib/haml_lint/tree/filter_node.rb
@@ -182,11 +195,12 @@ files:
 - lib/haml_lint/tree/tag_node.rb
 - lib/haml_lint/utils.rb
 - lib/haml_lint/version.rb
+- lib/haml_lint/version_comparer.rb
 homepage: https://github.com/sds/haml-lint
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -194,7 +208,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -202,7 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: HAML lint tool
 test_files: []

data/lib/haml_lint/ruby_extractor.rb

@@ -1,222 +0,0 @@
-# frozen_string_literal: true
-
-module HamlLint
-  # Utility class for extracting Ruby script from a HAML file that can then be
-  # linted with a Ruby linter (i.e. is "legal" Ruby). The goal is to turn this:
-  #
-  #     - if signed_in?(viewer)
-  #       %span Stuff
-  #       = link_to 'Sign Out', sign_out_path
-  #     - else
-  #       .some-class{ class: my_method }= my_method
-  #       = link_to 'Sign In', sign_in_path
-  #
-  # into this:
-  #
-  #     if signed_in?(viewer)
-  #       link_to 'Sign Out', sign_out_path
-  #     else
-  #       { class: my_method }
-  #       my_method
-  #       link_to 'Sign In', sign_in_path
-  #     end
-  #
-  # The translation won't be perfect, and won't make any real sense, but the
-  # relationship between variable declarations/uses and the flow control graph
-  # will remain intact.
-  class RubyExtractor # rubocop:disable Metrics/ClassLength
-    include HamlVisitor
-
-    # Stores the extracted source and a map of lines of generated source to the
-    # original source that created them.
-    #
-    # @attr_reader source [String] generated source code
-    # @attr_reader source_map [Hash] map of line numbers from generated source
-    #   to original source line number
-    RubySource = Struct.new(:source, :source_map)
-
-    # Extracts Ruby code from Sexp representing a Slim document.
-    #
-    # @param document [HamlLint::Document]
-    # @return [HamlLint::RubyExtractor::RubySource]
-    def extract(document)
-      visit(document.tree)
-      RubySource.new(@source_lines.join("\n"), @source_map)
-    end
-
-    def visit_root(_node)
-      @source_lines = []
-      @source_map = {}
-      @line_count = 0
-      @indent_level = 0
-      @output_count = 0
-
-      yield # Collect lines of code from children
-    end
-
-    def visit_plain(node)
-      # Don't output the text, as we don't want to have to deal with any RuboCop
-      # cops regarding StringQuotes or AsciiComments, and it's not important to
-      # overall document anyway.
-      add_dummy_puts(node)
-    end
-
-    def visit_tag(node)
-      additional_attributes = node.dynamic_attributes_sources
-
-      # Include dummy references to code executed in attributes list
-      # (this forces a "use" of a variable to prevent "assigned but unused
-      # variable" lints)
-      additional_attributes.each do |attributes_code|
-        # Normalize by removing excess whitespace to avoid format lints
-        attributes_code = attributes_code.gsub(/\s*\n\s*/, ' ').strip
-
-        # Attributes can either be a method call or a literal hash, so wrap it
-        # in a method call itself in order to avoid having to differentiate the
-        # two.
-        add_line("{}.merge(#{attributes_code.strip})", node)
-      end
-
-      check_tag_static_hash_source(node)
-
-      # We add a dummy puts statement to represent the tag name being output.
-      # This prevents some erroneous RuboCop warnings.
-      add_dummy_puts(node, node.tag_name)
-
-      code = node.script.strip
-      add_line(code, node) unless code.empty?
-    end
-
-    def after_visit_tag(node)
-      # We add a dummy puts statement for closing tag.
-      add_dummy_puts(node, "#{node.tag_name}/")
-    end
-
-    def visit_script(node)
-      code = node.text
-      add_line(code.strip, node)
-
-      start_block = anonymous_block?(code) || start_block_keyword?(code)
-
-      if start_block
-        @indent_level += 1
-      end
-
-      yield # Continue extracting code from children
-
-      if start_block
-        @indent_level -= 1
-        add_line('end', node)
-      end
-    end
-
-    def visit_haml_comment(node)
-      # We want to preseve leading whitespace if it exists, but include leading
-      # whitespace if it doesn't exist so that RuboCop's LeadingCommentSpace
-      # doesn't complain
-      comment = node.text
-                    .gsub(/\n(\S)/, "\n# \\1")
-                    .gsub(/\n(\s)/, "\n#\\1")
-      add_line("##{comment}", node)
-    end
-
-    def visit_silent_script(node, &block)
-      visit_script(node, &block)
-    end
-
-    def visit_filter(node)
-      if node.filter_type == 'ruby'
-        node.text.split("\n").each_with_index do |line, index|
-          add_line(line, node.line + index + 1, false)
-        end
-      else
-        add_dummy_puts(node, ":#{node.filter_type}")
-        HamlLint::Utils.extract_interpolated_values(node.text) do |interpolated_code, line|
-          add_line(interpolated_code, node.line + line)
-        end
-      end
-    end
-
-    private
-
-    def check_tag_static_hash_source(node)
-      # Haml::Parser converts hashrocket-style hash attributes of strings and symbols
-      # to static attributes, and excludes them from the dynamic attribute sources:
-      # https://github.com/haml/haml/blob/08f97ec4dc8f59fe3d7f6ab8f8807f86f2a15b68/lib/haml/parser.rb#L400-L404
-      # https://github.com/haml/haml/blob/08f97ec4dc8f59fe3d7f6ab8f8807f86f2a15b68/lib/haml/parser.rb#L540-L554
-      # Here, we add the hash source back in so it can be inspected by rubocop.
-      if node.hash_attributes? && node.dynamic_attributes_sources.empty?
-        normalized_attr_source = node.dynamic_attributes_source[:hash].gsub(/\s*\n\s*/, ' ')
-
-        add_line(normalized_attr_source, node)
-      end
-    end
-
-    # Adds a dummy method call with a unique name so we don't get
-    # Style/IdenticalConditionalBranches RuboCop warnings
-    def add_dummy_puts(node, annotation = nil)
-      annotation = " # #{annotation}" if annotation
-      add_line("_haml_lint_puts_#{@output_count}#{annotation}", node)
-      @output_count += 1
-    end
-
-    def add_line(code, node_or_line, discard_blanks = true)
-      return if code.empty? && discard_blanks
-
-      indent_level = @indent_level
-
-      if node_or_line.respond_to?(:line)
-        # Since mid-block keywords are children of the corresponding start block
-        # keyword, we need to reduce their indentation level by 1. However, we
-        # don't do this unless this is an actual tag node (a raw line number
-        # means this came from a `:ruby` filter).
-        indent_level -= 1 if mid_block_keyword?(code)
-      end
-
-      indent = (' ' * 2 * indent_level)
-
-      @source_lines << indent_code(code, indent)
-
-      original_line =
-        node_or_line.respond_to?(:line) ? node_or_line.line : node_or_line
-
-      # For interpolated code in filters that spans multiple lines, the
-      # resulting code will span multiple lines, so we need to create a
-      # mapping for each line.
-      (code.count("\n") + 1).times do
-        @line_count += 1
-        @source_map[@line_count] = original_line
-      end
-    end
-
-    def indent_code(code, indent)
-      codes = code.split("\n")
-      codes.map { |c| indent + c }.join("\n")
-    end
-
-    def anonymous_block?(text)
-      text =~ /\bdo\s*(\|\s*[^\|]*\s*\|)?(\s*#.*)?\z/
-    end
-
-    START_BLOCK_KEYWORDS = %w[if unless case begin for until while].freeze
-    def start_block_keyword?(text)
-      START_BLOCK_KEYWORDS.include?(block_keyword(text))
-    end
-
-    MID_BLOCK_KEYWORDS = %w[else elsif when rescue ensure].freeze
-    def mid_block_keyword?(text)
-      MID_BLOCK_KEYWORDS.include?(block_keyword(text))
-    end
-
-    LOOP_KEYWORDS = %w[for until while].freeze
-    def block_keyword(text)
-      # Need to handle 'for'/'while' since regex stolen from HAML parser doesn't
-      if keyword = text[/\A\s*([^\s]+)\s+/, 1]
-        return keyword if LOOP_KEYWORDS.include?(keyword)
-      end
-
-      return unless keyword = text.scan(Haml::Parser::BLOCK_KEYWORD_REGEX)[0]
-      keyword[0] || keyword[1]
-    end
-  end
-end