haml_lint 0.53.0 → 0.76.0

data/lib/haml_lint/spec/shared_rubocop_autocorrect_context.rb

@@ -74,7 +74,7 @@ module HamlLint
           current_matching_line = 1
           @source_map = {}
           lines.each.with_index do |line, i|
-            next unless line =~ /\S/
+            next unless /\S/.match?(line)
             mo = line.match(/^(.*?)\$?\s*\$\$(\d+)$/)
             if mo
               lines[i] = mo[1]
@@ -115,7 +115,7 @@ module HamlLint
 
           syntax_lints = subject.lints.select { |lint| lint.message =~ %r{Lint/Syntax} }
 
-          if start_ruby.strip != 'SKIP' && subject.last_extracted_source
+          if start_ruby.strip != 'SKIP' && subject.last_extracted_source && ENV['UPDATE_EXAMPLES'] != '1'
             matcher = eq(start_ruby)
             subject.last_extracted_source.source.should(
               matcher,
@@ -125,7 +125,7 @@ module HamlLint
 
           syntax_lints.should(be_empty, "Generated Ruby has Syntax Lints:\n#{format_lints(syntax_lints)}")
 
-          if end_ruby.strip != 'SKIP' && subject.last_new_ruby_source
+          if end_ruby.strip != 'SKIP' && subject.last_new_ruby_source && ENV['UPDATE_EXAMPLES'] != '1'
             matcher = eq(end_ruby)
             subject.last_new_ruby_source.should(
               matcher,
@@ -141,10 +141,40 @@ module HamlLint
             -> { "Final HAML is different from expected. #{matcher.failure_message}\n#{format_lints}" }
           )
 
-          if subject.last_extracted_source && start_ruby.strip != 'SKIP'
+          if subject.last_extracted_source && start_ruby.strip != 'SKIP' && ENV['UPDATE_EXAMPLES'] != '1'
             subject.last_extracted_source.source_map.should == source_map
           end
 
+          if ENV['UPDATE_EXAMPLES'] == '1' && respond_to?(:example_first_line_no) &&
+              start_ruby.strip != 'SKIP' && end_ruby.strip != 'SKIP'
+            original_content = File.read(example_path)
+            old_steps_string = '---' + steps_string.partition('---').last.rpartition('---').first + '---'
+
+            if old_steps_string.scan(/\$\$\d+/).tally.values.any? { |v| v > 1 }
+              # If the $$3 was there twice, let's not update the example
+              return
+            end
+            original_content.scan(old_steps_string).count
+
+            new_generated_ruby_lines = subject.last_extracted_source.source.split("\n", -1)
+            last_seen_haml_line_no = 1
+            subject.last_extracted_source.source_map.each do |ruby_line_no, haml_line_no|
+              if haml_line_no != last_seen_haml_line_no
+                last_seen_haml_line_no = haml_line_no
+                new_generated_ruby_lines[ruby_line_no - 1] += " $$#{haml_line_no}"
+              end
+            end
+
+            new_steps_string = <<~NEW.chop # Chop to remove the added newlines
+              ---
+              #{new_generated_ruby_lines.join("\n")}---
+              #{subject.last_new_ruby_source}---
+            NEW
+
+            new_content = original_content.gsub(old_steps_string, new_steps_string)
+            File.write(example_path, new_content)
+          end
+
           haml_different = start_haml != end_haml
           document.source_was_changed.should == haml_different
         end

data/lib/haml_lint/spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'haml_lint/spec/normalize_indent'
-require 'haml_lint/spec/shared_linter_context'
-require 'haml_lint/spec/shared_rubocop_autocorrect_context'
-require 'haml_lint/spec/matchers/report_lint'
+require_relative 'spec/normalize_indent'
+require_relative 'spec/shared_linter_context'
+require_relative 'spec/shared_rubocop_autocorrect_context'
+require_relative 'spec/matchers/report_lint'

data/lib/haml_lint/tree/comment_node.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module HamlLint::Tree
-  # Represents a visible XHTML comment in a HAML document.
+  # Represents a visible XHTML comment in a Haml document.
   class CommentNode < Node
   end
 end

data/lib/haml_lint/tree/doctype_node.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module HamlLint::Tree
-  # Represents a doctype definition for a HAML document.
+  # Represents a doctype definition for a Haml document.
   class DoctypeNode < Node
   end
 end

data/lib/haml_lint/tree/filter_node.rb

@@ -9,7 +9,7 @@ module HamlLint::Tree
     end
 
     def text
-      # Seems HAML strips the starting blank lines... without them, line numbers become offset,
+      # Seems Haml strips the starting blank lines... without them, line numbers become offset,
       # breaking the source_map and auto-correct
 
       nb_blank_lines = 0
@@ -17,5 +17,18 @@ module HamlLint::Tree
 
       "#{"\n" * nb_blank_lines}#{super}"
     end
+
+    # The line numbers that are contained within the node.
+    #
+    # Unlike most nodes, a filter's content begins on the line *after* the
+    # `:filtername` declaration, so the span runs from the declaration line
+    # through all of the indented content lines.
+    #
+    # @return [Range]
+    def line_numbers
+      return super if lines.empty?
+
+      (line..(line + lines.count))
+    end
   end
 end

data/lib/haml_lint/tree/haml_comment_node.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'haml_lint/directive'
+require_relative '../directive'
 
 module HamlLint::Tree
-  # Represents a HAML comment node.
+  # Represents a Haml comment node.
   class HamlCommentNode < Node
     def directives
       directives = super
@@ -25,6 +25,13 @@ module HamlLint::Tree
              .rstrip
     end
 
+    # Returns whether this comment contains a `locals` directive.
+    #
+    # @return [Boolean]
+    def is_strict_locals? # rubocop:disable Naming
+      text.lstrip.start_with?('locals:')
+    end
+
     private
 
     def contained_directives

data/lib/haml_lint/tree/node.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require 'haml_lint/comment_configuration'
+require_relative '../comment_configuration'
 
 module HamlLint::Tree
-  # Decorator class that provides a convenient set of helpers for HAML's
+  # Decorator class that provides a convenient set of helpers for Haml's
   # {Haml::Parser::ParseNode} struct.
   #
   # The goal is to abstract away the details of the underlying struct and
   # provide a cleaner and more uniform interface for getting information about a
   # node, as there are a number of weird/special cases in the struct returned by
-  # the HAML parser.
+  # the Haml parser.
   #
   # @abstract
   class Node
@@ -21,7 +21,7 @@ module HamlLint::Tree
     # Creates a node wrapping the given {Haml::Parser::ParseNode} struct.
     #
     # @param document [HamlLint::Document] Haml document that created this node
-    # @param parse_node [Haml::Parser::ParseNode] parse node created by HAML's parser
+    # @param parse_node [Haml::Parser::ParseNode] parse node created by Haml's parser
     def initialize(document, parse_node)
       @line = parse_node.line
       @document = document

data/lib/haml_lint/tree/root_node.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'haml_lint/tree/null_node'
+require_relative 'null_node'
 
 module HamlLint::Tree
-  # Represents the root node of a HAML document that contains all other nodes.
+  # Represents the root node of a Haml document that contains all other nodes.
   class RootNode < Node
-    # The name fo the file parsed to build this tree.
+    # The name of the file parsed to build this tree.
     #
     # @return [String] a file name
     def file
@@ -21,7 +21,7 @@ module HamlLint::Tree
         return node if node.line_numbers.cover?(line) && node != self
       end
 
-      # Because HAML doesn't leave any trace in the nodes when it merges lines that
+      # Because Haml doesn't leave any trace in the nodes when it merges lines that
       # end with a comma, it's harder to assign a node to the second line here:
       # = some_call user,
       #             foo, bar

data/lib/haml_lint/tree/script_node.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'haml_lint/parsed_ruby'
+require_relative '../parsed_ruby'
 
 module HamlLint::Tree
   # Represents a node which produces output based on Ruby code.

data/lib/haml_lint/tree/silent_script_node.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module HamlLint::Tree
-  # Represents a HAML silent script node (`- some_expression`) which executes
+  # Represents a Haml silent script node (`- some_expression`) which executes
   # code without producing output.
   class SilentScriptNode < Node
     # The Ruby script contents parsed into a syntax tree.

data/lib/haml_lint/tree/tag_node.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module HamlLint::Tree
-  # Represents a tag node in a HAML document.
+  # Represents a tag node in a Haml document.
   class TagNode < Node
     # Computed set of attribute hashes code.
     #
@@ -33,10 +33,20 @@ module HamlLint::Tree
       @value[:parse] && !@value[:value].strip.empty?
     end
 
+    # Whether this tag outputs unescaped HTML via a `!` marker, e.g. `%tag!=` or
+    # `%tag!~`.
+    #
+    # @return [true,false]
+    def unescape_html?
+      return false unless contains_script?
+
+      /\A\s*[<>]*\s*!/.match?(inline_marker_source)
+    end
+
     # Returns whether this tag has a specified attribute.
     #
     # @return [true,false]
-    def has_hash_attribute?(attribute)
+    def has_hash_attribute?(attribute) # rubocop:disable Naming
       hash_attributes? && existing_attributes.include?(attribute)
     end
 
@@ -94,30 +104,18 @@ module HamlLint::Tree
     #
     # @return [Hash]
     def attributes_source
-      @attributes_source ||=
-        begin
-          _explicit_tag, static_attrs, rest =
-            source_code.scan(/\A\s*(%[-:\w]+)?([-:\w.\#]*)(.*)/m)[0]
-
-          attr_types = {
-            '{' => [:hash, %w[{ }]],
-            '(' => [:html, %w[( )]],
-            '[' => [:object_ref, %w[[ ]]],
-          }
-
-          attr_source = { static: static_attrs }
-          while rest
-            type, chars = attr_types[rest[0]]
-            break unless type # Not an attribute opening character, so we're done
-
-            # Can't define multiple of the same attribute type (e.g. two {...})
-            break if attr_source[type]
-
-            attr_source[type], rest = Haml::Util.balance(rest, *chars)
-          end
+      parsed_attributes_source[:attributes]
+    end
 
-          attr_source
-        end
+    # Source that follows the tag name and attributes. It begins with the
+    # content marker (e.g. `=`, `!=`, `~`, `!~`, or plain text).
+    #
+    # @example For `%tag.class!= foo`, this returns:
+    #   '!= foo'
+    #
+    # @return [String]
+    def inline_marker_source
+      parsed_attributes_source[:marker]
     end
 
     # Whether this tag node has a set of hash attributes defined via the
@@ -157,6 +155,18 @@ module HamlLint::Tree
       dynamic_attributes_source[:html][/\A\((.*)\)\z/, 1] if html_attributes?
     end
 
+    # The tag's static (non-Ruby) attributes parsed into a Ruby hash. Keys are
+    # strings and values are their literal parsed values (e.g. `true` for a
+    # boolean attribute such as `(required)`).
+    #
+    # @note When the tag uses the `.class`/`#id` shorthand, the resulting
+    #   `class`/`id` entries are merged into this hash as well.
+    #
+    # @return [Hash]
+    def static_attributes
+      @value[:attributes]
+    end
+
     # ID of the HTML tag.
     #
     # @return [String]
@@ -229,6 +239,40 @@ module HamlLint::Tree
 
     private
 
+    # Parses the source code following the tag name once into its attribute
+    # sources and the remaining inline content marker.
+    #
+    # @return [Hash{Symbol => Object}] `:attributes` source hash (keyed by
+    #   `:static`/`:hash`/`:html`/`:object_ref`) and the `:marker` string
+    def parsed_attributes_source
+      @parsed_attributes_source ||=
+        begin
+          _explicit_tag, static_attrs, rest =
+            source_code.scan(/\A\s*(%[-:\w]+)?([-:\w.\#]*)(.*)/m)[0]
+
+          attr_types = {
+            '{' => [:hash, %w[{ }]],
+            '(' => [:html, %w[( )]],
+            '[' => [:object_ref, %w[[ ]]],
+          }
+
+          attr_source = { static: static_attrs }
+          while rest
+            type, chars = attr_types[rest[0]]
+            break unless type # Not an attribute opening character, so we're done
+
+            # Can't define multiple of the same attribute type (e.g. two {...})
+            break if attr_source[type]
+
+            attr_source[type], rest = Haml::Util.balance(rest, *chars)
+          end
+
+          # Whatever remains after the tag name and attributes begins with the
+          # content marker (e.g. `=`, `!=`, `~`, `!~`, or plain text).
+          { attributes: attr_source, marker: rest.to_s }
+        end
+    end
+
     def existing_attributes
       parsed_attrs = parsed_attributes
       return {} unless parsed_attrs.respond_to?(:children)

data/lib/haml_lint/utils.rb

@@ -116,7 +116,7 @@ module HamlLint
 
     # Returns indexes of all occurrences of a substring within a string.
     #
-    # Note, this will not return overlaping substrings, so searching for "aa"
+    # Note, this will not return overlapping substrings, so searching for "aa"
     # in "aaa" will only find one substring, not two.
     #
     # @param text [String] the text to search
@@ -233,7 +233,7 @@ module HamlLint
 
     # 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)
+    def is_blank_line?(line) # rubocop:disable Naming
       line && line.index(/\S/).nil?
     end
 
@@ -249,36 +249,9 @@ module HamlLint
       $!
     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)
+    def regexp_for_parts(parts, join_regexp, prefix: nil, suffix: nil)
       regexp_code = parts.map { |c| Regexp.quote(c) }.join(join_regexp)
+      regexp_code = "#{prefix}#{regexp_code}#{suffix}"
       Regexp.new(regexp_code)
     end
   end

data/lib/haml_lint/version.rb

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

data/lib/haml_lint.rb

@@ -3,26 +3,26 @@
 # Need to load haml before we can reference some Haml modules in our code
 require 'haml'
 
-require 'haml_lint/constants'
-require 'haml_lint/exceptions'
-require 'haml_lint/configuration'
-require 'haml_lint/configuration_loader'
-require 'haml_lint/document'
-require 'haml_lint/haml_visitor'
-require 'haml_lint/lint'
-require 'haml_lint/linter_registry'
-require 'haml_lint/ruby_parser'
-require 'haml_lint/linter'
-require 'haml_lint/logger'
-require 'haml_lint/reporter'
-require 'haml_lint/report'
-require 'haml_lint/linter_selector'
-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'
+require_relative 'haml_lint/constants'
+require_relative 'haml_lint/exceptions'
+require_relative 'haml_lint/configuration'
+require_relative 'haml_lint/configuration_loader'
+require_relative 'haml_lint/document'
+require_relative 'haml_lint/haml_visitor'
+require_relative 'haml_lint/lint'
+require_relative 'haml_lint/linter_registry'
+require_relative 'haml_lint/ruby_parser'
+require_relative 'haml_lint/linter'
+require_relative 'haml_lint/logger'
+require_relative 'haml_lint/reporter'
+require_relative 'haml_lint/report'
+require_relative 'haml_lint/linter_selector'
+require_relative 'haml_lint/file_finder'
+require_relative 'haml_lint/runner'
+require_relative 'haml_lint/utils'
+require_relative 'haml_lint/version'
+require_relative 'haml_lint/version_comparer'
+require_relative '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|
@@ -30,8 +30,8 @@ Dir[File.expand_path('haml_lint/extensions/*.rb', File.dirname(__FILE__))].sort.
 end
 
 # Load all parse tree node classes
-require 'haml_lint/tree/node'
-require 'haml_lint/node_transformer'
+require_relative 'haml_lint/tree/node'
+require_relative 'haml_lint/node_transformer'
 Dir[File.expand_path('haml_lint/tree/*.rb', File.dirname(__FILE__))].sort.each do |file|
   require file
 end
@@ -47,7 +47,7 @@ Dir[File.expand_path('haml_lint/reporter/*.rb', File.dirname(__FILE__))].sort.ea
 end
 
 # Load all the chunks for RubyExtraction
-require 'haml_lint/ruby_extraction/base_chunk'
+require_relative '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,13 @@
 --- !ruby/object:Gem::Specification
 name: haml_lint
 version: !ruby/object:Gem::Version
-  version: 0.53.0
+  version: 0.76.0
 platform: ruby
 authors:
 - Shane da Silva
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-08 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
@@ -28,14 +27,14 @@ dependencies:
   name: parallel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
@@ -134,10 +133,12 @@ files:
 - lib/haml_lint/linter/ruby_comments.rb
 - lib/haml_lint/linter/space_before_script.rb
 - lib/haml_lint/linter/space_inside_hash_attributes.rb
+- lib/haml_lint/linter/strict_locals.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/unescaped_html.rb
 - lib/haml_lint/linter/unnecessary_interpolation.rb
 - lib/haml_lint/linter/unnecessary_string_output.rb
 - lib/haml_lint/linter/view_length.rb
@@ -153,6 +154,7 @@ files:
 - lib/haml_lint/reporter/checkstyle_reporter.rb
 - lib/haml_lint/reporter/default_reporter.rb
 - lib/haml_lint/reporter/disabled_config_reporter.rb
+- lib/haml_lint/reporter/github_reporter.rb
 - lib/haml_lint/reporter/hash_reporter.rb
 - lib/haml_lint/reporter/hooks.rb
 - lib/haml_lint/reporter/json_reporter.rb
@@ -176,6 +178,7 @@ files:
 - lib/haml_lint/ruby_parser.rb
 - lib/haml_lint/runner.rb
 - lib/haml_lint/severity.rb
+- lib/haml_lint/source.rb
 - lib/haml_lint/spec.rb
 - lib/haml_lint/spec/matchers/report_lint.rb
 - lib/haml_lint/spec/normalize_indent.rb
@@ -198,8 +201,10 @@ files:
 homepage: https://github.com/sds/haml-lint
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/sds/haml-lint/issues
+  changelog_uri: https://github.com/sds/haml-lint/blob/main/CHANGELOG.md
+  source_code_uri: https://github.com/sds/haml-lint
 rdoc_options: []
 require_paths:
 - lib
@@ -207,15 +212,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 4.0.10
 specification_version: 4
 summary: HAML lint tool
 test_files: []