erb_lint 0.1.3 → 0.9.0

data/lib/erb_lint/linters/comment_syntax.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module ERBLint
+  module Linters
+    # Detects comment syntax that isn't valid ERB.
+    class CommentSyntax < Linter
+      include LinterRegistry
+
+      def initialize(file_loader, config)
+        super
+      end
+
+      def run(processed_source)
+        file_content = processed_source.file_content
+        return if file_content.empty?
+
+        processed_source.ast.descendants(:erb).each do |erb_node|
+          indicator_node, _, code_node, _ = *erb_node
+          next if code_node.nil?
+
+          indicator_node_str = indicator_node&.deconstruct&.last
+          next if indicator_node_str == "#"
+
+          code_node_str = code_node.deconstruct.last
+          next unless code_node_str.start_with?(" #")
+
+          range = find_range(erb_node, code_node_str)
+          source_range = processed_source.to_source_range(range)
+
+          correct_erb_tag = indicator_node_str == "=" ? "<%#=" : "<%#"
+
+          add_offense(
+            source_range,
+            <<~EOF.chomp,
+              Bad ERB comment syntax. Should be #{correct_erb_tag} without a space between.
+              Leaving a space between ERB tags and the Ruby comment character can cause parser errors.
+            EOF
+          )
+        end
+      end
+
+      def find_range(node, str)
+        match = node.loc.source.match(Regexp.new(Regexp.quote(str.strip)))
+        return unless match
+
+        range_begin = match.begin(0) + node.loc.begin_pos
+        range_end   = match.end(0) + node.loc.begin_pos
+        (range_begin...range_end)
+      end
+    end
+  end
+end

data/lib/erb_lint/linters/deprecated_classes.rb

@@ -49,7 +49,7 @@ module ERBLint
           process_nested_offenses(
             source: sub_source,
             offset: offset + content_node.loc.begin_pos,
-            parent_source: parent_source
+            parent_source: parent_source,
           )
         end
       end
@@ -99,7 +99,7 @@ module ERBLint
 
           add_offense(
             range,
-            format(message, class_name, violated_rule[:class_expr], suggestion)
+            format(message, class_name, violated_rule[:class_expr], suggestion),
           )
         end
       end

data/lib/erb_lint/linters/erb_safety.rb

@@ -26,7 +26,7 @@ module ERBLint
           tester.errors.each do |error|
             add_offense(
               error.location,
-              error.message
+              error.message,
             )
           end
         end

data/lib/erb_lint/linters/extra_newline.rb

@@ -15,7 +15,7 @@ module ERBLint
           add_offense(
             processed_source
               .to_source_range((matches.begin(index) + 2)...matches.end(index)),
-            "Extra blank line detected."
+            "Extra blank line detected.",
           )
         end
       end

data/lib/erb_lint/linters/final_newline.rb

@@ -29,22 +29,22 @@ module ERBLint
             add_offense(
               processed_source.to_source_range(file_content.size...file_content.size),
               "Missing a trailing newline at the end of the file.",
-              :insert
+              :insert,
             )
           else
             add_offense(
               processed_source.to_source_range(
-                (file_content.size - final_newline.size + 1)...file_content.size
+                (file_content.size - final_newline.size + 1)...file_content.size,
               ),
               "Remove multiple trailing newline at the end of the file.",
-              :remove
+              :remove,
             )
           end
         elsif !@new_lines_should_be_present && !final_newline.empty?
           add_offense(
             processed_source.to_source_range(match.begin(0)...match.end(0)),
             "Remove #{final_newline.size} trailing newline at the end of the file.",
-            :remove
+            :remove,
           )
         end
       end

data/lib/erb_lint/linters/hard_coded_string.rb

@@ -17,7 +17,7 @@ module ERBLint
       ALLOWED_CORRECTORS = ["I18nCorrector", "RuboCop::Corrector::I18n::HardCodedString"]
 
       NON_TEXT_TAGS = Set.new(["script", "style", "xmp", "iframe", "noembed", "noframes", "listing"])
-      TEXT_NOT_ALLOWED = Set.new([
+      NO_TRANSLATION_NEEDED = Set.new([
         " ",
         "&",
         "<",
@@ -40,6 +40,9 @@ module ERBLint
         " ",
         " ",
         " ",
+        "×",
+        "«",
+        "»",
       ])
 
       class ConfigSchema < LinterConfig
@@ -66,7 +69,7 @@ module ERBLint
 
           add_offense(
             source_range,
-            message(source_range.source)
+            message(source_range.source),
           )
         end
       end
@@ -83,7 +86,7 @@ module ERBLint
       def autocorrect(processed_source, offense)
         string = offense.source_range.source
         return unless (klass = load_corrector)
-        return unless string.strip.length > 1
+        return if string.strip.length <= 1
 
         node = ::RuboCop::AST::StrNode.new(:str, [string])
         corrector = klass.new(node, processed_source.filename, corrector_i18n_load_path, offense.source_range)
@@ -96,7 +99,7 @@ module ERBLint
 
       def check_string?(str)
         string = str.gsub(/\s*/, "")
-        string.length > 1 && !TEXT_NOT_ALLOWED.include?(string)
+        string.length > 1 && !NO_TRANSLATION_NEEDED.include?(string)
       end
 
       def load_corrector

data/lib/erb_lint/linters/no_javascript_tag_helper.rb

@@ -38,9 +38,9 @@ module ERBLint
 
           add_offense(
             erb_node.loc,
-            "Avoid using 'javascript_tag do' as it confuses tests "\
+            "Avoid using 'javascript_tag do' as it confuses tests " \
               "that validate html, use inline <script> instead",
-            [erb_node, send_node]
+            [erb_node, send_node],
           )
         end
       end
@@ -82,8 +82,10 @@ module ERBLint
           corrector.replace(end_node.loc, end_content)
         elsif script_content
           script_content = "\n//<![CDATA[\n#{script_content}\n//]]>\n" if @config.correction_style == :cdata
-          corrector.replace(begin_node.loc,
-            "<script#{arguments}>#{script_content}</script>")
+          corrector.replace(
+            begin_node.loc,
+            "<script#{arguments}>#{script_content}</script>",
+          )
         end
       rescue Utils::RubyToERB::Error, Utils::BlockMap::ParseError
         nil

data/lib/erb_lint/linters/no_unused_disable.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "erb_lint/utils/inline_configs"
+
+module ERBLint
+  module Linters
+    # Checks for unused disable comments.
+    class NoUnusedDisable < Linter
+      include LinterRegistry
+
+      def run(processed_source, offenses)
+        disabled_rules_and_line_number = {}
+
+        processed_source.source_buffer.source_lines.each_with_index do |line, index|
+          rule_disables = Utils::InlineConfigs.disabled_rules(line)
+          next unless rule_disables
+
+          rule_disables.split(",").each do |rule|
+            disabled_rules_and_line_number[rule.strip] =
+              (disabled_rules_and_line_number[rule.strip] ||= []).push(index + 1)
+          end
+        end
+
+        offenses.each do |offense|
+          rule_name = offense.linter.class.simple_name
+          line_numbers = disabled_rules_and_line_number[rule_name]
+          next unless line_numbers
+
+          line_numbers.reject do |line_number|
+            if (offense.source_range.line_span.first..offense.source_range.line_span.last).include?(line_number)
+              disabled_rules_and_line_number[rule_name].delete(line_number)
+            end
+          end
+        end
+
+        disabled_rules_and_line_number.each do |rule, line_numbers|
+          line_numbers.each do |line_number|
+            add_offense(
+              processed_source.source_buffer.line_range(line_number),
+              "Unused erblint:disable comment for #{rule}",
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/erb_lint/linters/parser_errors.rb

@@ -9,7 +9,7 @@ module ERBLint
         processed_source.parser.parser_errors.each do |error|
           add_offense(
             error.loc,
-            "#{error.message} (at #{error.loc.source})"
+            "#{error.message} (at #{error.loc.source})",
           )
         end
       end

data/lib/erb_lint/linters/partial_instance_variable.rb

@@ -13,9 +13,9 @@ module ERBLint
 
         add_offense(
           processed_source.to_source_range(
-            processed_source.file_content =~ instance_variable_regex..processed_source.file_content.size
+            processed_source.file_content =~ instance_variable_regex..processed_source.file_content.size,
           ),
-          "Instance variable detected in partial."
+          "Instance variable detected in partial.",
         )
       end
     end

data/lib/erb_lint/linters/require_input_autocomplete.rb

@@ -62,9 +62,9 @@ module ERBLint
 
           add_offense(
             tag_node.to_a[1].loc,
-            "Input tag is missing an autocomplete attribute. If no "\
+            "Input tag is missing an autocomplete attribute. If no " \
               "autocomplete behaviour is desired, use the value `off` or `nope`.",
-            [autocomplete_attribute]
+            [autocomplete_attribute],
           )
         end
       end
@@ -96,9 +96,9 @@ module ERBLint
 
           add_offense(
             erb_node.loc,
-            "Input field helper is missing an autocomplete attribute. If no "\
+            "Input field helper is missing an autocomplete attribute. If no " \
               "autocomplete behaviour is desired, use the value `off` or `nope`.",
-            [erb_node, send_node]
+            [erb_node, send_node],
           )
         end
       end

data/lib/erb_lint/linters/require_script_nonce.rb

@@ -29,7 +29,7 @@ module ERBLint
           add_offense(
             tag_node.to_a[1].loc,
             "Missing a nonce attribute. Use request.content_security_policy_nonce",
-            [nonce_attribute]
+            [nonce_attribute],
           )
         end
       end
@@ -67,7 +67,7 @@ module ERBLint
           add_offense(
             erb_node.loc,
             "Missing a nonce attribute. Use nonce: true",
-            [erb_node, send_node]
+            [erb_node, send_node],
           )
         end
       end

data/lib/erb_lint/linters/right_trim.rb

@@ -19,7 +19,7 @@ module ERBLint
 
           add_offense(
             trim_node.loc,
-            "Prefer #{@config.enforced_style}%> instead of #{trim_node.loc.source}%> for trimming on the right."
+            "Prefer #{@config.enforced_style}%> instead of #{trim_node.loc.source}%> for trimming on the right.",
           )
         end
       end

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
@@ -13,6 +12,7 @@ module ERBLint
       class ConfigSchema < LinterConfig
         property :only, accepts: array_of?(String)
         property :rubocop_config, accepts: Hash, default: -> { {} }
+        property :config_file_path, accepts: String
       end
 
       self.config_schema = ConfigSchema
@@ -24,7 +24,8 @@ module ERBLint
       def initialize(file_loader, config)
         super
         @only_cops = @config.only
-        custom_config = config_from_hash(@config.rubocop_config)
+        custom_config = config_from_path(@config.config_file_path) if @config.config_file_path
+        custom_config ||= config_from_hash(@config.rubocop_config)
         @rubocop_config = ::RuboCop::ConfigLoader.merge_with_default(custom_config, "")
       end
 
@@ -34,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
 
@@ -83,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
 
@@ -129,24 +93,30 @@ module ERBLint
       end
 
       def rubocop_processed_source(content, filename)
-        ::RuboCop::ProcessedSource.new(
+        source = ::RuboCop::ProcessedSource.new(
           content,
           @rubocop_config.target_ruby_version,
-          filename
+          filename,
         )
+        if ::RuboCop::Version::STRING.to_f >= 1.38
+          registry = RuboCop::Cop::Registry.global
+          source.registry = registry
+          source.config = @rubocop_config
+        end
+        source
       end
 
       def cop_classes
         if @only_cops.present?
-          selected_cops = ::RuboCop::Cop::Cop.all.select { |cop| cop.match?(@only_cops) }
+          selected_cops = ::RuboCop::Cop::Registry.all.select { |cop| cop.match?(@only_cops) }
           ::RuboCop::Cop::Registry.new(selected_cops)
         else
-          ::RuboCop::Cop::Registry.new(::RuboCop::Cop::Cop.all)
+          ::RuboCop::Cop::Registry.new(::RuboCop::Cop::Registry.all)
         end
       end
 
       def build_team
-        ::RuboCop::Cop::Team.new(
+        ::RuboCop::Cop::Team.mobilize(
           cop_classes,
           @rubocop_config,
           extra_details: true,
@@ -158,34 +128,13 @@ module ERBLint
       end
 
       def config_from_hash(hash)
-        inherit_from = hash&.delete("inherit_from")
-        resolve_inheritance(hash, inherit_from)
-
         tempfile_from(".erblint-rubocop", hash.to_yaml) do |tempfile|
-          ::RuboCop::ConfigLoader.load_file(tempfile.path)
+          config_from_path(tempfile.path)
         end
       end
 
-      def resolve_inheritance(hash, inherit_from)
-        base_configs(inherit_from)
-          .reverse_each do |base_config|
-          base_config.each do |k, v|
-            hash[k] = hash.key?(k) ? ::RuboCop::ConfigLoader.merge(v, hash[k]) : v if v.is_a?(Hash)
-          end
-        end
-      end
-
-      def base_configs(inherit_from)
-        regex = URI::DEFAULT_PARSER.make_regexp(["http", "https"])
-        configs = Array(inherit_from).compact.map do |base_name|
-          if base_name =~ /\A#{regex}\z/
-            ::RuboCop::ConfigLoader.load_file(::RuboCop::RemoteConfig.new(base_name, Dir.pwd))
-          else
-            config_from_hash(@file_loader.yaml(base_name))
-          end
-        end
-
-        configs.compact
+      def config_from_path(path)
+        ::RuboCop::ConfigLoader.load_file(path)
       end
 
       def add_offense(rubocop_offense, offense_range, correction, offset, bound_range)

data/lib/erb_lint/linters/rubocop_text.rb

@@ -10,6 +10,7 @@ module ERBLint
       class ConfigSchema < LinterConfig
         property :only, accepts: array_of?(String)
         property :rubocop_config, accepts: Hash
+        property :config_file_path, accepts: String
       end
 
       self.config_schema = ConfigSchema
@@ -28,7 +29,7 @@ module ERBLint
       end
 
       def cop_classes
-        selected_cops = ::RuboCop::Cop::Cop.all.select { |cop| cop.match?(@only_cops) }
+        selected_cops = ::RuboCop::Cop::Registry.all.select { |cop| cop.match?(@only_cops) }
 
         ::RuboCop::Cop::Registry.new(selected_cops)
       end

data/lib/erb_lint/linters/self_closing_tag.rb

@@ -11,8 +11,25 @@ module ERBLint
       end
       self.config_schema = ConfigSchema
 
-      SELF_CLOSING_TAGS = ["area", "base", "br", "col", "command", "embed", "hr", "input", "keygen", "link",
-                           "menuitem", "meta", "param", "source", "track", "wbr", "img",]
+      SELF_CLOSING_TAGS = [
+        "area",
+        "base",
+        "br",
+        "col",
+        "command",
+        "embed",
+        "hr",
+        "input",
+        "keygen",
+        "link",
+        "menuitem",
+        "meta",
+        "param",
+        "source",
+        "track",
+        "wbr",
+        "img",
+      ]
 
       def run(processed_source)
         processed_source.ast.descendants(:tag).each do |tag_node|
@@ -24,7 +41,7 @@ module ERBLint
             add_offense(
               start_solidus.loc,
               "Tag `#{tag.name}` is a void element, it must not start with `</`.",
-              ""
+              "",
             )
           end
 
@@ -32,7 +49,7 @@ module ERBLint
             add_offense(
               tag_node.loc.end.offset(-1),
               "Tag `#{tag.name}` is self-closing, it must end with `/>`.",
-              "/"
+              "/",
             )
           end
 
@@ -42,7 +59,7 @@ module ERBLint
           add_offense(
             end_solidus.loc,
             "Tag `#{tag.name}` is a void element, it must end with `>` and not `/>`.",
-            ""
+            "",
           )
         end
       end

data/lib/erb_lint/linters/space_around_erb_tag.rb

@@ -23,17 +23,17 @@ module ERBLint
           if start_spaces.size != 1 && !start_spaces.include?("\n")
             add_offense(
               code_node.loc.resize(start_spaces.size),
-              "Use 1 space after `<%#{indicator}#{ltrim&.loc&.source}` "\
+              "Use 1 space after `<%#{indicator}#{ltrim&.loc&.source}` " \
                 "instead of #{start_spaces.size} space#{"s" if start_spaces.size > 1}.",
-              " "
+              " ",
             )
           elsif start_spaces.count("\n") > 1
             lines = start_spaces.split("\n", -1)
             add_offense(
               code_node.loc.resize(start_spaces.size),
-              "Use 1 newline after `<%#{indicator&.loc&.source}#{ltrim&.loc&.source}` "\
+              "Use 1 newline after `<%#{indicator&.loc&.source}#{ltrim&.loc&.source}` " \
                 "instead of #{start_spaces.count("\n")}.",
-              "#{lines.first}\n#{lines.last}"
+              "#{lines.first}\n#{lines.last}",
             )
           end
 
@@ -41,17 +41,17 @@ module ERBLint
           if end_spaces.size != 1 && !end_spaces.include?("\n")
             add_offense(
               code_node.loc.end.adjust(begin_pos: -end_spaces.size),
-              "Use 1 space before `#{rtrim&.loc&.source}%>` "\
+              "Use 1 space before `#{rtrim&.loc&.source}%>` " \
                 "instead of #{end_spaces.size} space#{"s" if start_spaces.size > 1}.",
-              " "
+              " ",
             )
           elsif end_spaces.count("\n") > 1
             lines = end_spaces.split("\n", -1)
             add_offense(
               code_node.loc.end.adjust(begin_pos: -end_spaces.size),
-              "Use 1 newline before `#{rtrim&.loc&.source}%>` "\
+              "Use 1 newline before `#{rtrim&.loc&.source}%>` " \
                 "instead of #{end_spaces.count("\n")}.",
-              "#{lines.first}\n#{lines.last}"
+              "#{lines.first}\n#{lines.last}",
             )
           end
         end

data/lib/erb_lint/linters/space_in_html_tag.rb

@@ -50,7 +50,7 @@ module ERBLint
         add_offense(
           processed_source.to_source_range(range),
           "Extra space detected where there should be no space.",
-          ""
+          "",
         )
       end
 
@@ -69,24 +69,24 @@ module ERBLint
         if non_space && !non_space.captures.empty?
           add_offense(
             processed_source.to_source_range(range),
-            "Non-whitespace character(s) detected: "\
+            "Non-whitespace character(s) detected: " \
               "#{non_space.captures.map(&:inspect).join(", ")}.",
-            expected
+            expected,
           )
         elsif newlines && accept_newline
           if expected != chars
             add_offense(
               processed_source.to_source_range(range),
-              "#{chars.empty? ? "No" : "Extra"} space detected where there should be "\
+              "#{chars.empty? ? "No" : "Extra"} space detected where there should be " \
                 "a single space or a single line break.",
-              expected
+              expected,
             )
           end
         else
           add_offense(
             processed_source.to_source_range(range),
             "#{chars.empty? ? "No" : "Extra"} space detected where there should be a single space.",
-            expected
+            expected,
           )
         end
       end
@@ -103,7 +103,7 @@ module ERBLint
 
           single_space_or_newline(
             processed_source,
-            attribute.loc.end_pos...next_attribute.loc.begin_pos
+            attribute.loc.end_pos...next_attribute.loc.begin_pos,
           )
         end
       end

data/lib/erb_lint/linters/space_indentation.rb

@@ -23,7 +23,7 @@ module ERBLint
             add_offense(
               processed_source.to_source_range(document_pos...(document_pos + spaces.length)),
               "Indent with spaces instead of tabs.",
-              spaces.gsub("\t", " " * @config.tab_width)
+              spaces.gsub("\t", " " * @config.tab_width),
             )
           end