haml_lint 0.53.0 → 0.54.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49bb0bec15e96c047439560e80f83eaf6f4c3baec24a12b1f10248f1d2f347d3
-  data.tar.gz: 153f65eda76c5751bbae1d02fc49d0d4477f401bb273096ad9308868b9d21288
+  metadata.gz: b017823b15563d033480ee99317c4d0c007624b10ad2ed3b53c254c5686289c8
+  data.tar.gz: cf83ac415fb7749551466fcc0b23a5a2019bbecb99a67b2c54051a78523f1a33
 SHA512:
-  metadata.gz: a4d2c2682e7b12d9aaf8164054f3533c0667f5f6035bfbf5ef6bbb694a40f9a70d9d13a9aa56dabf27131be27e74d346c9eff642a65d0e2aac8992ebc1999fba
-  data.tar.gz: 343aee9ed9bf4a766640aabbbaf96af9a5c36261fb6e6943b9a0b9eadcb5c75bc5a15665cae30c3c4c8925b307ecca837130fb04cf1d14a74549978db235f60c
+  metadata.gz: 17ea23cce399f12712d0f73560553b82068e2ac3be9124c590bbea78948a330811402c15fd2b5f8cbc0b5e8e044bc044e69df78f2e05462580665db814298595
+  data.tar.gz: d619d3018e139b00ce539da9b9f7e1bfef644c71c8e102d146778c3c322770458a16feb89bb44a1a3699eadacc6038c7186407fc8361e6b354f0c4bdbb2dcd57

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/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($stdin, 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 File.new(file_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 an IO object
+  # containing haml code, as well as a file path.
+  class Source
+    # @return [String] File path associated with the given IO object.
+    attr_reader :path
+
+    # Wraps an IO object and file path to a source object.
+    #
+    # @param [IO] io
+    # @param [String] path
+    def initialize(io, path)
+      @io = io
+      @path = path
+    end
+
+    # @return [String] Contents of the given IO object.
+    def contents
+      @contents ||= @io.read
+    end
+  end
+end

data/lib/haml_lint/version.rb

@@ -2,5 +2,5 @@
 
 # Defines the gem version.
 module HamlLint
-  VERSION = '0.53.0'
+  VERSION = '0.54.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.54.0
 platform: ruby
 authors:
 - Shane da Silva
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-08 00:00:00.000000000 Z
+date: 2024-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
@@ -176,6 +176,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 +200,7 @@ homepage: https://github.com/sds/haml-lint
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -207,15 +208,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: []