erb_lint 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed317d0bcb868320c088c8788e5b14ba9f8224aab3e6ae2e4952e34df8fdefc4
-  data.tar.gz: 21fe3cfccf4d30225d11fa2f397186b5274bbb8d1fe6ff5bf593ac225bb327a9
+  metadata.gz: 0eabdfa71b2841fc684663a79233451981e21fcffb175c3ae7a1e0bd8afdc8e4
+  data.tar.gz: c609b033d3354e27c938ef1972b1ac16c654b1900115bb4f6d6595c384d1cfb5
 SHA512:
-  metadata.gz: d281ca485b9763dc2d7e3b3297b429c2fa08f1f043e557b7a9ad9ab65c5e0e422d5ccabbd66f40e3da43088bc1b580dd9dab5213dca39a894a7b0da82c0e113c
-  data.tar.gz: 9907b4b4089693f5787c96b0e5cef7b1c9bd49b6831d6e6c42757fb69911a0905b395f468fab7c0339d3b0e166b6962d1a4db772476f669d659f6380e88a90c4
+  metadata.gz: f3686f39426c32119e8a725b8320143b31c48f98969bb6f0135827c5ff7c260d5674cfad5190c2bc75111fd5a76d881e47d7aa18b6b48f3f903f698719601623
+  data.tar.gz: 727473a64473dad0adb3912bc7f7b7e5c84d51c60374f72e93f380d378635848a240e8f1f3f16ec8f88874290e5e16821e8445b882c09cec4c78081db9eb2bda

data/lib/erb_lint/cli.rb

@@ -162,7 +162,7 @@ module ERBLint
         runner.run(processed_source)
         break unless autocorrect? && runner.offenses.any?
 
-        corrector = correct(processed_source, runner.offenses)
+        corrector = corrector(processed_source, runner.offenses)
         break if corrector.corrections.empty?
         break if processed_source.file_content == corrector.corrected_content
 
@@ -202,10 +202,8 @@ module ERBLint
       $stdin.binmode.read.force_encoding(Encoding::UTF_8)
     end
 
-    def correct(processed_source, offenses)
-      corrector = ERBLint::Corrector.new(processed_source, offenses)
-      failure!(corrector.diagnostics.join(", ")) if corrector.diagnostics.any?
-      corrector
+    def corrector(processed_source, offenses)
+      ERBLint::Corrector.new(processed_source, offenses)
     end
 
     def config_filename

data/lib/erb_lint/corrector.rb

@@ -7,6 +7,8 @@ module ERBLint
     def initialize(processed_source, offenses)
       @processed_source = processed_source
       @offenses = offenses
+      corrector = RuboCop::Cop::Corrector.new(@processed_source.source_buffer)
+      correct!(corrector)
       @corrected_content = corrector.rewrite
     end
 
@@ -16,22 +18,9 @@ module ERBLint
       end.compact
     end
 
-    def corrector
-      BASE.new(@processed_source.source_buffer, corrections)
-    end
-
-    if ::RuboCop::Version::STRING.to_f >= 0.87
-      require "rubocop/cop/legacy/corrector"
-      BASE = ::RuboCop::Cop::Legacy::Corrector
-
-      def diagnostics
-        []
-      end
-    else
-      BASE = ::RuboCop::Cop::Corrector
-
-      def diagnostics
-        corrector.diagnostics
+    def correct!(corrector)
+      corrections.each do |correction|
+        correction.call(corrector)
       end
     end
   end

data/lib/erb_lint/file_loader.rb

@@ -9,14 +9,8 @@ module ERBLint
       @base_path = base_path
     end
 
-    if RUBY_VERSION >= "2.6"
-      def yaml(filename)
-        YAML.safe_load(read_content(filename), permitted_classes: [Regexp, Symbol], filename: filename) || {}
-      end
-    else
-      def yaml(filename)
-        YAML.safe_load(read_content(filename), [Regexp, Symbol], [], false, filename) || {}
-      end
+    def yaml(filename)
+      YAML.safe_load(read_content(filename), permitted_classes: [Regexp, Symbol], filename: filename) || {}
     end
 
     private

data/lib/erb_lint/linters/rubocop.rb

@@ -2,7 +2,6 @@
 
 require "better_html"
 require "tempfile"
-require "erb_lint/utils/offset_corrector"
 
 module ERBLint
   module Linters
@@ -36,30 +35,14 @@ module ERBLint
         end
       end
 
-      if ::RuboCop::Version::STRING.to_f >= 0.87
-        def autocorrect(_processed_source, offense)
-          return unless offense.context
+      def autocorrect(_processed_source, offense)
+        return unless offense.context
 
-          rubocop_correction = offense.context[:rubocop_correction]
-          return unless rubocop_correction
+        rubocop_correction = offense.context[:rubocop_correction]
+        return unless rubocop_correction
 
-          lambda do |corrector|
-            corrector.import!(rubocop_correction, offset: offense.context[:offset])
-          end
-        end
-      else
-        def autocorrect(processed_source, offense)
-          return unless offense.context
-
-          lambda do |corrector|
-            passthrough = Utils::OffsetCorrector.new(
-              processed_source,
-              corrector,
-              offense.context[:offset],
-              offense.context[:bound_range],
-            )
-            offense.context[:rubocop_correction].call(passthrough)
-          end
+        lambda do |corrector|
+          corrector.import!(rubocop_correction, offset: offense.context[:offset])
         end
       end
 
@@ -85,39 +68,18 @@ module ERBLint
         activate_team(processed_source, source, offset, code_node, build_team)
       end
 
-      if ::RuboCop::Version::STRING.to_f >= 0.87
-        def activate_team(processed_source, source, offset, code_node, team)
-          report = team.investigate(source)
-          report.offenses.each do |rubocop_offense|
-            next if rubocop_offense.disabled?
+      def activate_team(processed_source, source, offset, code_node, team)
+        report = team.investigate(source)
+        report.offenses.each do |rubocop_offense|
+          next if rubocop_offense.disabled?
 
-            correction = rubocop_offense.corrector if rubocop_offense.corrected?
+          correction = rubocop_offense.corrector if rubocop_offense.corrected?
 
-            offense_range = processed_source
-              .to_source_range(rubocop_offense.location)
-              .offset(offset)
+          offense_range = processed_source
+            .to_source_range(rubocop_offense.location)
+            .offset(offset)
 
-            add_offense(rubocop_offense, offense_range, correction, offset, code_node.loc.range)
-          end
-        end
-      else
-        def activate_team(processed_source, source, offset, code_node, team)
-          team.inspect_file(source)
-          team.cops.each do |cop|
-            correction_offset = 0
-            cop.offenses.reject(&:disabled?).each do |rubocop_offense|
-              if rubocop_offense.corrected?
-                correction = cop.corrections[correction_offset]
-                correction_offset += 1
-              end
-
-              offense_range = processed_source
-                .to_source_range(rubocop_offense.location)
-                .offset(offset)
-
-              add_offense(rubocop_offense, offense_range, correction, offset, code_node.loc.range)
-            end
-          end
+          add_offense(rubocop_offense, offense_range, correction, offset, code_node.loc.range)
         end
       end
 

data/lib/erb_lint/linters/strict_locals.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module ERBLint
+  module Linters
+    # Enforces the use of strict locals in Rails view partial templates.
+    class StrictLocals < Linter
+      include LinterRegistry
+
+      STRICT_LOCALS_REGEX = /\s+locals:\s+\((.*)\)/
+
+      def initialize(file_loader, config)
+        super
+      end
+
+      def run(processed_source)
+        return unless processed_source.filename.match?(%r{(\A|.*/)_[^/\s]*\.html\.erb\z})
+
+        file_content = processed_source.file_content
+        return if file_content.empty?
+
+        strict_locals_node = processed_source.ast.descendants(:erb).find do |erb_node|
+          indicator_node, _, code_node, _ = *erb_node
+
+          indicator_node_str = indicator_node&.deconstruct&.last
+          next unless indicator_node_str == "#"
+
+          code_node_str = code_node&.deconstruct&.last
+
+          code_node_str.match(STRICT_LOCALS_REGEX)
+        end
+
+        unless strict_locals_node
+          add_offense(
+            processed_source.to_source_range(0...processed_source.file_content.size),
+            <<~EOF.chomp,
+              Missing strict locals declaration.
+              Add <%# locals: () %> at the top of the file to enforce strict locals.
+            EOF
+          )
+        end
+      end
+
+      def autocorrect(_processed_source, offense)
+        lambda do |corrector|
+          corrector.insert_before(offense.source_range, "<%# locals: () %>\n")
+        end
+      end
+    end
+  end
+end

data/lib/erb_lint/utils/inline_configs.rb

@@ -4,11 +4,11 @@ module ERBLint
   module Utils
     class InlineConfigs
       def self.rule_disable_comment_for_lines?(rule, lines)
-        lines.match?(/# erblint:disable (?<rules>.*#{rule}).*/)
+        lines.match?(/# erb_?lint:disable (?<rules>.*#{rule}).*/)
       end
 
       def self.disabled_rules(line)
-        line.match(/# erblint:disable (?<rules>.*) %>/)&.named_captures&.fetch("rules")
+        line.match(/# erb_?lint:disable (?<rules>.*) %>/)&.named_captures&.fetch("rules")
       end
     end
   end

data/lib/erb_lint/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ERBLint
-  VERSION = "0.7.0"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erb_lint
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Justin Chan
 - Shopify Developers
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-16 00:00:00.000000000 Z
+date: 2025-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -179,6 +178,7 @@ files:
 - lib/erb_lint/linters/space_around_erb_tag.rb
 - lib/erb_lint/linters/space_in_html_tag.rb
 - lib/erb_lint/linters/space_indentation.rb
+- lib/erb_lint/linters/strict_locals.rb
 - lib/erb_lint/linters/trailing_whitespace.rb
 - lib/erb_lint/offense.rb
 - lib/erb_lint/processed_source.rb
@@ -194,7 +194,6 @@ files:
 - lib/erb_lint/stats.rb
 - lib/erb_lint/utils/block_map.rb
 - lib/erb_lint/utils/inline_configs.rb
-- lib/erb_lint/utils/offset_corrector.rb
 - lib/erb_lint/utils/ruby_to_erb.rb
 - lib/erb_lint/utils/severity_levels.rb
 - lib/erb_lint/version.rb
@@ -203,7 +202,6 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -218,8 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.21
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: ERB lint tool
 test_files: []

data/lib/erb_lint/utils/offset_corrector.rb

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-module ERBLint
-  module Utils
-    class OffsetCorrector
-      def initialize(processed_source, corrector, offset, bound_range)
-        @processed_source = processed_source
-        @corrector = corrector
-        @offset = offset
-        @bound_range = bound_range
-      end
-
-      def remove(range)
-        @corrector.remove(range_with_offset(range))
-      end
-
-      def insert_before(range, content)
-        @corrector.insert_before(range_with_offset(range), content)
-      end
-
-      def insert_after(range, content)
-        @corrector.insert_after(range_with_offset(range), content)
-      end
-
-      def replace(range, content)
-        @corrector.replace(range_with_offset(range), content)
-      end
-
-      def remove_preceding(range, size)
-        @corrector.remove_preceding(range_with_offset(range), size)
-      end
-
-      def remove_leading(range, size)
-        @corrector.remove_leading(range_with_offset(range), size)
-      end
-
-      def remove_trailing(range, size)
-        @corrector.remove_trailing(range_with_offset(range), size)
-      end
-
-      def range_with_offset(node_or_range)
-        range = to_range(node_or_range)
-
-        @processed_source.to_source_range(
-          bound(@offset + range.begin_pos)..bound(@offset + (range.end_pos - 1)),
-        )
-      end
-
-      def bound(pos)
-        pos.clamp(@bound_range.min, @bound_range.max)
-      end
-
-      private
-
-      def to_range(node_or_range)
-        case node_or_range
-        when ::RuboCop::AST::Node, ::Parser::Source::Comment
-          node_or_range.loc.expression
-        when ::Parser::Source::Range
-          node_or_range
-        else
-          raise TypeError,
-            "Expected a Parser::Source::Range, Comment or " \
-              "Rubocop::AST::Node, got #{node_or_range.class}"
-        end
-      end
-    end
-  end
-end