haml_lint 0.53.0 → 0.57.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49bb0bec15e96c047439560e80f83eaf6f4c3baec24a12b1f10248f1d2f347d3
-  data.tar.gz: 153f65eda76c5751bbae1d02fc49d0d4477f401bb273096ad9308868b9d21288
+  metadata.gz: '092e548aae63e23d9c6a5c3c11087590219e52792459ee548a5802503e80f6ec'
+  data.tar.gz: 120a88fbfb5b78e5d08724dffc9c7cf22292e391633c780da94161295ea745e0
 SHA512:
-  metadata.gz: a4d2c2682e7b12d9aaf8164054f3533c0667f5f6035bfbf5ef6bbb694a40f9a70d9d13a9aa56dabf27131be27e74d346c9eff642a65d0e2aac8992ebc1999fba
-  data.tar.gz: 343aee9ed9bf4a766640aabbbaf96af9a5c36261fb6e6943b9a0b9eadcb5c75bc5a15665cae30c3c4c8925b307ecca837130fb04cf1d14a74549978db235f60c
+  metadata.gz: 5123d876bb4b79d4fbf14fae8acef295993c909baaee63975f899571fe450cf67f503c761b2628ddb96874f39a4be51a8c489ddb94a87eb95034e3a05ba44431
+  data.tar.gz: 152d02d1daa2f51e9c0ddca5602d74642b324e860daa33aeec715ff4e2be297054abaf0d35dd9d15cfafcf15955bfce48823575643b18c4375707f172621eb66

data/lib/haml_lint/constants.rb

@@ -6,5 +6,5 @@ module HamlLint
   APP_NAME = 'haml-lint'
 
   REPO_URL = 'https://github.com/sds/haml-lint'
-  BUG_REPORT_URL = "#{REPO_URL}/issues"
+  BUG_REPORT_URL = "#{REPO_URL}/issues".freeze
 end

data/lib/haml_lint/directive.rb

@@ -3,7 +3,7 @@
 module HamlLint
   # Handles linter configuration transformation via Haml comments.
   class Directive
-    LINTER_REGEXP = /(?:[A-Z]\w+)/.freeze
+    LINTER_REGEXP = /(?:[A-Z]\w+)/
 
     DIRECTIVE_REGEXP = /
       # "haml-lint:" with optional spacing
@@ -14,7 +14,7 @@ module HamlLint
 
       # "all" or a comma-separated list (with optional spaces) of linters
       (?<linters>all | (?:#{LINTER_REGEXP}\s*,\s*)* #{LINTER_REGEXP})
-    /x.freeze
+    /x
 
     # Constructs a directive from source code as a given line.
     #

data/lib/haml_lint/document.rb

@@ -14,6 +14,9 @@ module HamlLint
     # @return [String] Haml template file path
     attr_reader :file
 
+    # @return [Boolean] true if source changes (from autocorrect) should be written to stdout instead of disk
+    attr_reader :write_to_stdout
+
     # @return [HamlLint::Tree::Node] Root of the parse tree
     attr_reader :tree
 
@@ -36,10 +39,12 @@ module HamlLint
     # @param source [String] Haml code to parse
     # @param options [Hash]
     # @option options :file [String] file name of document that was parsed
+    # @option options :write_to_stdout [Boolean] true if source changes should be written to stdout
     # @raise [Haml::Parser::Error] if there was a problem parsing the document
     def initialize(source, options)
       @config = options[:config]
       @file = options.fetch(:file, STRING_SOURCE)
+      @write_to_stdout = options[:write_to_stdout]
       @source_was_changed = false
       process_source(source)
     end
@@ -82,7 +87,11 @@ module HamlLint
       if file == STRING_SOURCE
         raise HamlLint::Exceptions::InvalidFilePath, 'Cannot write without :file option'
       end
-      File.write(file, unstrip_frontmatter(source))
+      if @write_to_stdout
+        $stdout << unstrip_frontmatter(source)
+      else
+        File.write(file, unstrip_frontmatter(source))
+      end
       @source_was_changed = false
     end
 

data/lib/haml_lint/linter/alignment_tabs.rb

@@ -3,7 +3,7 @@
 module HamlLint
   # Checks for tabs that are placed for alignment of tag content
   class Linter::AlignmentTabs < Linter
-    REGEX = /[^\s*]\t+/.freeze
+    REGEX = /[^\s*]\t+/
 
     def visit_tag(node)
       if REGEX.match?(node.source_code)

data/lib/haml_lint/linter/class_attribute_with_static_value.rb

@@ -20,7 +20,7 @@ module HamlLint
 
     STATIC_TYPES = %i[str sym].freeze
 
-    VALID_CLASS_REGEX = /^-?[_a-zA-Z]+[_a-zA-Z0-9-]*$/.freeze
+    VALID_CLASS_REGEX = /^-?[_a-zA-Z]+[_a-zA-Z0-9-]*$/
 
     def visit_tag(node)
       return unless contains_class_attribute?(node.dynamic_attributes_sources)

data/lib/haml_lint/linter/indentation.rb

@@ -11,7 +11,7 @@ module HamlLint
       tab: /^\t*(?! )/,
     }.freeze
 
-    LEADING_SPACES_REGEX = /^( +)(?! )/.freeze
+    LEADING_SPACES_REGEX = /^( +)(?! )/
 
     def visit_root(root)
       character = config['character'].to_sym

data/lib/haml_lint/linter/multiline_pipe.rb

@@ -31,7 +31,7 @@ module HamlLint
 
     private
 
-    MULTILINE_PIPE_REGEX = /\s+\|\s*$/.freeze
+    MULTILINE_PIPE_REGEX = /\s+\|\s*$/
 
     def line_text_for_node(node)
       document.source_lines[node.line - 1]

data/lib/haml_lint/linter/no_placeholders.rb

@@ -6,8 +6,8 @@ module HamlLint
     include LinterRegistry
 
     MSG = 'Placeholders attributes should not be used.'
-    HASH_REGEXP = /:?['"]?placeholder['"]?(?::| *=>)/.freeze
-    HTML_REGEXP = /placeholder=/.freeze
+    HASH_REGEXP = /:?['"]?placeholder['"]?(?::| *=>)/
+    HTML_REGEXP = /placeholder=/
 
     def visit_tag(node)
       return unless node.hash_attributes_source =~ HASH_REGEXP || node.html_attributes_source =~ HTML_REGEXP

data/lib/haml_lint/options.rb

@@ -32,7 +32,7 @@ module HamlLint
 
     private
 
-    def add_linter_options(parser) # rubocop:disable Metrics/MethodLength
+    def add_linter_options(parser) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       parser.on('--auto-gen-config', 'Generate a configuration file acting as a TODO list') do
         @options[:auto_gen_config] = true
       end
@@ -70,7 +70,13 @@ module HamlLint
         @options[:autocorrect] ||= :safe
       end
 
-      parser.on('--stderr', 'Write all output to stderr') do
+      parser.on('-s', '--stdin FILE', 'Pipe source from STDIN, using FILE in ' \
+          'offense when combined with --auto-correct and --stdin.') do |file_path|
+        @options[:stdin] = file_path
+      end
+
+      parser.on('--stderr', 'Write all output to stderr except for the autocorrected source. ' \
+          'This is especially useful when combined with --auto-correct and --stdin') do
         @options[:stderr] = true
       end
     end

data/lib/haml_lint/reporter/github_reporter.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: false
+
+module HamlLint
+  # Outputs GitHub workflow commands for GitHub check annotations when run within GitHub actions.
+  class Reporter::GithubReporter < Reporter
+    ESCAPE_MAP = { '%' => '%25', "\n" => '%0A', "\r" => '%0D' }.freeze
+
+    include Reporter::Utils
+
+    def added_lint(lint, report)
+      if lint.severity >= report.fail_level
+        print_workflow_command(lint: lint)
+      else
+        print_workflow_command(severity: 'warning', lint: lint)
+      end
+    end
+
+    def display_report(report)
+      print_summary(report)
+    end
+
+    private
+
+    def print_workflow_command(lint:, severity: 'error')
+      log.log "::#{severity} file=#{lint.filename},line=#{lint.line}::#{github_escape(lint.message)}"
+    end
+
+    def github_escape(string)
+      string.gsub(Regexp.union(ESCAPE_MAP.keys), ESCAPE_MAP)
+    end
+  end
+end

data/lib/haml_lint/ruby_extraction/chunk_extractor.rb

@@ -247,31 +247,29 @@ module HamlLint::RubyExtraction
     def visit_tag(node)
       indent = @original_haml_lines[node.line - 1].index(/\S/)
 
+      @ruby_chunks << PlaceholderMarkerChunk.new(node, 'tag', indent: indent)
+
+      current_line_index = visit_tag_attributes(node, indent: indent)
+      visit_tag_script(node, line_index: current_line_index, indent: indent)
+
       # We don't want to use a block because assignments in a block are local to that block,
       # so the semantics of the extracted ruby would be different from the one generated by
       # Haml. Those differences can make some cops, such as UselessAssignment, have false
       # positives
       code = 'begin'
-      @ruby_chunks << AdHocChunk.new(node,
-                                     [' ' * indent + code])
-      indent += 2
-
-      tag_chunk = PlaceholderMarkerChunk.new(node, 'tag', indent: indent)
-      @ruby_chunks << tag_chunk
+      begin_chunk = AdHocChunk.new(node, [' ' * indent + code])
+      @ruby_chunks << begin_chunk
 
-      current_line_index = visit_tag_attributes(node, indent: indent)
-      visit_tag_script(node, line_index: current_line_index, indent: indent)
+      indent += 2
 
       yield
 
       indent -= 2
 
-      if @ruby_chunks.last.equal?(tag_chunk)
+      if @ruby_chunks.last.equal?(begin_chunk)
         # So there is nothing going "in" the tag, remove the wrapping "begin" and replace the PlaceholderMarkerChunk
         # by one less indented
         @ruby_chunks.pop
-        @ruby_chunks.pop
-        @ruby_chunks << PlaceholderMarkerChunk.new(node, 'tag', indent: indent)
       else
         @ruby_chunks << AdHocChunk.new(node,
                                        [' ' * indent + 'ensure', ' ' * indent + '  HL.noop', ' ' * indent + 'end'],
@@ -600,9 +598,12 @@ module HamlLint::RubyExtraction
         return [char_index, [haml_processed_ruby_code]]
       end
 
-      min_non_white_chars_to_add = haml_processed_ruby_code.scan(/\S/).size
+      # The +1 is for the closing brace, which we need
+      min_non_white_chars_to_add = haml_processed_ruby_code.scan(/\S/).size + 1
 
-      regexp = HamlLint::Utils.regexp_for_parts(haml_processed_ruby_code.split(/\s+/), '\\s+')
+      regexp = HamlLint::Utils.regexp_for_parts(
+        haml_processed_ruby_code.split(/\s+/), '\\s+', prefix: '\s*', suffix: '\s*(?=[)}])'
+      )
 
       joined_lines = first_line.rstrip
       process_multiline!(joined_lines)
@@ -624,7 +625,7 @@ module HamlLint::RubyExtraction
 
       first_line_offset = match.begin(0)
       raw_ruby = match[0]
-      ruby_lines = raw_ruby.split("\n")
+      ruby_lines = raw_ruby.split("\n", -1)
 
       [first_line_offset, ruby_lines]
     end

data/lib/haml_lint/runner.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'parallel'
+require_relative 'source'
 
 module HamlLint
   # Responsible for running the applicable linters against the desired files.
@@ -20,12 +21,13 @@ module HamlLint
     # @return [HamlLint::Report] a summary of all lints found
     def run(options = {})
       @config = load_applicable_config(options)
-      @files = extract_applicable_files(config, options)
+      @sources = extract_applicable_sources(config, options)
       @linter_selector = HamlLint::LinterSelector.new(config, options)
       @fail_fast = options.fetch(:fail_fast, false)
       @cache = {}
       @autocorrect = options[:autocorrect]
       @autocorrect_only = options[:autocorrect_only]
+      @autocorrect_stdout = options[:stdin] && options[:stderr]
 
       report(options)
     end
@@ -48,10 +50,10 @@ module HamlLint
     #   @return [true, false]
     alias fail_fast? fail_fast
 
-    # The list of files to lint during this run.
+    # The list of sources to lint during this run.
     #
-    # @return [Array<String>]
-    attr_reader :files
+    # @return [Array<HamlLint::Source>]
+    attr_reader :sources
 
     # The selector for which linters to run during this run.
     #
@@ -79,18 +81,20 @@ module HamlLint
     # Runs all provided linters using the specified config against the given
     # file.
     #
-    # @param file [String] path to file to lint
+    # @param source [HamlLint::Source] source to lint
     # @param linter_selector [HamlLint::LinterSelector]
     # @param config [HamlLint::Configuration]
-    def collect_lints(file, linter_selector, config)
+    def collect_lints(source, linter_selector, config)
       begin
-        document = HamlLint::Document.new(File.read(file), file: file, config: config)
+        document = HamlLint::Document.new source.contents, file: source.path,
+                                                           config: config,
+                                                           write_to_stdout: @autocorrect_stdout
       rescue HamlLint::Exceptions::ParseError => e
-        return [HamlLint::Lint.new(HamlLint::Linter::Syntax.new(config), file,
+        return [HamlLint::Lint.new(HamlLint::Linter::Syntax.new(config), source.path,
                                    e.line, e.to_s, :error)]
       end
 
-      linters = linter_selector.linters_for_file(file)
+      linters = linter_selector.linters_for_file(source.path)
       lint_arrays = []
 
       if @autocorrect
@@ -125,40 +129,46 @@ module HamlLint
       lint_arrays
     end
 
-    # Returns the list of files that should be linted given the specified
+    # Returns the list of sources that should be linted given the specified
     # configuration and options.
     #
     # @param config [HamlLint::Configuration]
     # @param options [Hash]
-    # @return [Array<String>]
-    def extract_applicable_files(config, options)
-      included_patterns = options[:files]
-      excluded_patterns = config['exclude']
-      excluded_patterns += options.fetch(:excluded_files, [])
+    # @return [Array<HamlLint::Source>]
+    def extract_applicable_sources(config, options)
+      if options[:stdin]
+        [HamlLint::Source.new(io: $stdin, path: options[:stdin])]
+      else
+        included_patterns = options[:files]
+        excluded_patterns = config['exclude']
+        excluded_patterns += options.fetch(:excluded_files, [])
 
-      HamlLint::FileFinder.new(config).find(included_patterns, excluded_patterns)
+        HamlLint::FileFinder.new(config).find(included_patterns, excluded_patterns).map do |file_path|
+          HamlLint::Source.new path: file_path
+        end
+      end
     end
 
-    # Process the files and add them to the given report.
+    # Process the sources and add them to the given report.
     #
     # @param report [HamlLint::Report]
     # @return [void]
-    def process_files(report)
-      files.each do |file|
-        process_file(file, report)
+    def process_sources(report)
+      sources.each do |source|
+        process_source(source, report)
         break if report.failed? && fail_fast?
       end
     end
 
     # Process a file and add it to the given report.
     #
-    # @param file [String] the name of the file to process
+    # @param source [HamlLint::Source] the source to process
     # @param report [HamlLint::Report]
     # @return [void]
-    def process_file(file, report)
-      lints = @cache[file] || collect_lints(file, linter_selector, config)
+    def process_source(source, report)
+      lints = @cache[source.path] || collect_lints(source, linter_selector, config)
       lints.each { |lint| report.add_lint(lint) }
-      report.finish_file(file, lints)
+      report.finish_file(source.path, lints)
     end
 
     # Generates a report based on the given options.
@@ -168,9 +178,9 @@ module HamlLint
     # @return [HamlLint::Report]
     def report(options)
       report = HamlLint::Report.new(reporter: options[:reporter], fail_level: options[:fail_level])
-      report.start(@files)
+      report.start(sources.map(&:path))
       warm_cache if options[:parallel]
-      process_files(report)
+      process_sources(report)
       report
     end
 
@@ -178,9 +188,9 @@ module HamlLint
     #
     # @return [void]
     def warm_cache
-      results = Parallel.map(files) do |file|
-        lints = collect_lints(file, linter_selector, config)
-        [file, lints]
+      results = Parallel.map(sources) do |source|
+        lints = collect_lints(source, linter_selector, config)
+        [source.path, lints]
       end
       @cache = results.to_h
     end

data/lib/haml_lint/source.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module HamlLint
+  # Wrapper class representing a single target for HamlLint::Runner to run against, comprised of a file path to
+  # eventually read from, and an optional IO argument to override with.
+  class Source
+    # @return [String] File path associated with the given IO object.
+    attr_reader :path
+
+    # Wraps an optional IO object and file path to a source object.
+    #
+    # @param [String] path
+    # @param [IO] io
+    def initialize(path: nil, io: nil)
+      @path = path
+      @io = io
+    end
+
+    # @return [String] Contents of the given IO object.
+    def contents
+      @contents ||= @io&.read || File.read(path)
+    end
+  end
+end

data/lib/haml_lint/spec/shared_rubocop_autocorrect_context.rb

@@ -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/utils.rb

@@ -277,8 +277,9 @@ module HamlLint
       $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.57.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: haml_lint
 version: !ruby/object:Gem::Version
-  version: 0.53.0
+  version: 0.57.0
 platform: ruby
 authors:
 - Shane da Silva
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-08 00:00:00.000000000 Z
+date: 2024-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
@@ -153,6 +153,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 +177,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
@@ -199,7 +201,7 @@ homepage: https://github.com/sds/haml-lint
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -207,15 +209,15 @@ 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: 3.4.10
+signing_key:
 specification_version: 4
 summary: HAML lint tool
 test_files: []