haml_lint 0.63.0 → 0.64.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff5d0f872861912fb3f9ebb3dd05429f38302aff57e00aa91334a55fbde02029
-  data.tar.gz: c5c23f8563ffe272f090076522243069ad12a7db1d8af9c5eb498eea4e2f355e
+  metadata.gz: 73a515adb6ca4915d07c747133e7a657e04bd8d6a5c41cf5cd63a0adf3e03316
+  data.tar.gz: efb5d688d181d7906a28bef3f25b1080e1e38e2461d9343db554ed5a98037296
 SHA512:
-  metadata.gz: 7c36eee182a75b3917f263bd21dfdc4453b9a447682693739930ca8f703caf2aeb46fddae9fb8b47688c81bc21a29ad711182d837c2e6fe1e82cd54b8c1f4a17
-  data.tar.gz: 7d0f28064b25e97a12abad18ba0761a8230138ba784391a612ed63e79d64bf5eae9ca1d65b08600803a13870d47b3d75081d24e4487d10b3b9be8bc8b3770613
+  metadata.gz: 7a6c42a2be6709314fb8bff476e8a0ff80f0054895eeaa795b8fd741039a580bfb6ced6b0a45b293cdbe0641676a412909363b99f3638a5f8f4f5dd910de736a
+  data.tar.gz: 7165be1ef28719e4a08ad60a26aa6d0a8f8e1ca0507c5376cbfa776e813320fbb3fbd4357c7d74809393cd9c676ca009bab3d8d36b48770de7ffda4c680ed3a2

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 was read directly from `file` on-disk (rather than from stdin)
+    attr_reader :file_on_disk
+
     # @return [Boolean] true if source changes (from autocorrect) should be written to stdout instead of disk
     attr_reader :write_to_stdout
 
@@ -39,12 +42,14 @@ 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 :file_on_disk [Boolean] true if source was read straight from `file` on disk
     # @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]
+      @file_on_disk = options[:file_on_disk] && @file != STRING_SOURCE
       @source_was_changed = false
       process_source(source)
     end

data/lib/haml_lint/linter/rubocop.rb

@@ -20,11 +20,12 @@ module HamlLint
     class Runner < ::RuboCop::Runner
       attr_reader :offenses
 
-      def run(path, code, config:)
+      def run(haml_path, ruby_code, config:, allow_cache: false)
+        @allow_cache = allow_cache
         @offenses = []
-        @options[:stdin] = code
         @config_store.instance_variable_set(:@options_config, config)
-        super([path])
+        @options[:stdin] = ruby_code
+        super([haml_path])
       end
 
       def corrected_code
@@ -39,6 +40,20 @@ module HamlLint
       def file_finished(_file, offenses)
         @offenses = offenses
       end
+
+      # RuboCop caches results by taking a hash of the file contents & path, among other things.
+      # It disables its cache when working on file-content from stdin.
+      # Unfortunately we always use RuboCop's stdin, even when we're linting a file on-disk.
+      # So, override RuboCop::Runner#cached_run? so that it'll allow caching results, so long
+      # as haml-lint itself isn't being invoked with files on stdin.
+      def cached_run?
+        return false unless @allow_cache
+
+        @cached_run ||=
+          (@options[:cache] == 'true' ||
+          (@options[:cache] != 'false' && @config_store.for_pwd.for_all_cops['UseCache'])) &&
+          !@options[:auto_gen_config]
+      end
     end
 
     include LinterRegistry
@@ -227,7 +242,7 @@ module HamlLint
     # @param path [String] the path to tell RuboCop we are running
     # @return [Array<RuboCop::Cop::Offense>, String]
     def run_rubocop(rubocop_runner, ruby_code, path) # rubocop:disable Metrics
-      rubocop_runner.run(path, ruby_code, config: rubocop_config_for(path))
+      rubocop_runner.run(path, ruby_code, config: rubocop_config_for(path), allow_cache: @document&.file_on_disk)
 
       if ENV['HAML_LINT_INTERNAL_DEBUG'] == 'true'
         if rubocop_runner.offenses.empty?
@@ -298,6 +313,7 @@ module HamlLint
     end
 
     # rubocop:disable Style/MutableConstant
+    # Using BaseFormatter suppresses any default output
     DEFAULT_FLAGS = %w[--format RuboCop::Formatter::BaseFormatter]
     begin
       ::RuboCop::Options.new.parse(['--raise-cop-error'])
@@ -312,7 +328,6 @@ module HamlLint
     #
     # @return [Hash]
     def rubocop_options
-      # using BaseFormatter suppresses any default output
       flags = DEFAULT_FLAGS
       flags += ignored_cops_flags
       flags += rubocop_autocorrect_flags

data/lib/haml_lint/runner.rb

@@ -89,6 +89,7 @@ module HamlLint
       begin
         document = HamlLint::Document.new source.contents, file: source.path,
                                                            config: config,
+                                                           file_on_disk: !source.stdin?,
                                                            write_to_stdout: @autocorrect_stdout
       rescue HamlLint::Exceptions::ParseError => e
         return [HamlLint::Lint.new(HamlLint::Linter::Syntax.new(config), source.path,

data/lib/haml_lint/source.rb

@@ -20,5 +20,10 @@ module HamlLint
     def contents
       @contents ||= @io&.read || File.read(path)
     end
+
+    # @return [boolean] true if we're reading from stdin rather than a file path
+    def stdin?
+      !@io.nil?
+    end
   end
 end

data/lib/haml_lint/utils.rb

@@ -249,34 +249,6 @@ 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, prefix: nil, suffix: nil)
       regexp_code = parts.map { |c| Regexp.quote(c) }.join(join_regexp)
       regexp_code = "#{prefix}#{regexp_code}#{suffix}"

data/lib/haml_lint/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: haml_lint
 version: !ruby/object:Gem::Version
-  version: 0.63.0
+  version: 0.64.0
 platform: ruby
 authors:
 - Shane da Silva
 bindir: bin
 cert_chain: []
-date: 2025-06-24 00:00:00.000000000 Z
+date: 2025-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml