erb_lint 0.3.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bd25c794b1028b09ecec8ce3b5e77600d36364d59b85f2e4b24a18d6bb08853
-  data.tar.gz: e41f353e930401a024d880fc6973beb1e462f2f5372edb094523eacde0030d72
+  metadata.gz: 98ba7a87f348e584502a9e4810f9311329c04aeddf34af0b05a37702648b495e
+  data.tar.gz: 8728892a4c09fcbdbddb60316b911bf73ce099cc04e9ac10534b76f8aa6708a5
 SHA512:
-  metadata.gz: 94ed5b3479803ff2b51af6390c0e39c2fb37ef98e23fc2523ac204b638d8ff043665926081794ff27d77a60faae8ee7747cb4ef3d04125b7b3f7c2ae55ea268f
-  data.tar.gz: 9b423110f202bb9728ec57dbd60f04aa86e2901ecfa915d9ddc49fd58fac27b3daddea78780612c3f474ece4c41c01977bea72ad8353a9a113d5cee8c4a51914
+  metadata.gz: 8d01f3c07ddebb9482ee744c69df6e799b4c0cb06bd24ffd7939f3d86e612a4f1bb2d5b4040c8505d7c8f8e9cceaecaabcca7dc03cab6ea5f23e73f10e098345
+  data.tar.gz: '080398f6522352b669bf21ea1fbdd8850b7b6b8dcef60493d8349fbfeb98eceeefc77c15442cad339612e83c5056d5498a286046c3a3749a73428661c962b695'

data/lib/erb_lint/cli.rb

@@ -69,6 +69,7 @@ module ERBLint
 
       @options[:format] ||= :multiline
       @options[:fail_level] ||= severity_level_for_name(:refactor)
+      @options[:disable_inline_configs] ||= false
       @stats.files = lint_files.size
       @stats.linters = enabled_linter_classes.size
       @stats.autocorrectable_linters = enabled_linter_classes.count(&:support_autocorrect?)
@@ -76,7 +77,7 @@ module ERBLint
       reporter = Reporter.create_reporter(@options[:format], @stats, autocorrect?)
       reporter.preview
 
-      runner = ERBLint::Runner.new(file_loader, @config)
+      runner = ERBLint::Runner.new(file_loader, @config, @options[:disable_inline_configs])
       file_content = nil
 
       lint_files.each do |filename|
@@ -221,7 +222,7 @@ module ERBLint
     rescue Psych::SyntaxError => e
       failure!("error parsing config: #{e.message}")
     ensure
-      @config.merge!(runner_config_override)
+      @config&.merge!(runner_config_override)
     end
 
     def file_loader
@@ -374,6 +375,10 @@ module ERBLint
           @options[:allow_no_files] = config
         end
 
+        opts.on("--disable-inline-configs", "Report all offenses while ignoring inline disable comments") do
+          @options[:disable_inline_configs] = true
+        end
+
         opts.on(
           "-sFILE",
           "--stdin FILE",

data/lib/erb_lint/linter.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "erb_lint/utils/inline_configs"
+
 module ERBLint
   # Defines common functionality available to all linters.
   class Linter
@@ -53,6 +55,13 @@ module ERBLint
       raise NotImplementedError, "must implement ##{__method__}"
     end
 
+    def run_and_update_offense_status(processed_source, enable_inline_configs = true)
+      run(processed_source)
+      if @offenses.any? && enable_inline_configs
+        update_offense_status(processed_source)
+      end
+    end
+
     def add_offense(source_range, message, context = nil, severity = nil)
       @offenses << Offense.new(self, source_range, message, context, severity)
     end
@@ -60,5 +69,22 @@ module ERBLint
     def clear_offenses
       @offenses = []
     end
+
+    private
+
+    def update_offense_status(processed_source)
+      @offenses.each do |offense|
+        offense_line_range = offense.source_range.line_range
+        offense_lines = source_for_line_range(processed_source, offense_line_range)
+
+        if Utils::InlineConfigs.rule_disable_comment_for_lines?(self.class.simple_name, offense_lines)
+          offense.disabled = true
+        end
+      end
+    end
+
+    def source_for_line_range(processed_source, line_range)
+      processed_source.source_buffer.source_lines[line_range.first - 1..line_range.last - 1].join
+    end
   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,7 @@ module ERBLint
         " ",
         " ",
         " ",
+        "×",
       ])
 
       class ConfigSchema < LinterConfig
@@ -96,7 +97,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_unused_disable.rb

@@ -0,0 +1,45 @@
+# 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/offense.rb

@@ -15,6 +15,7 @@ module ERBLint
       @message = message
       @context = context
       @severity = severity
+      @disabled = false
     end
 
     def to_cached_offense_hash
@@ -44,6 +45,12 @@ module ERBLint
       line_range.begin
     end
 
+    attr_writer :disabled
+
+    def disabled?
+      @disabled
+    end
+
     def column
       source_range.column
     end

data/lib/erb_lint/reporters/junit_reporter.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require "rexml/document"
+require "rexml/formatters/pretty"
+
+module ERBLint
+  module Reporters
+    class JunitReporter < Reporter
+      def preview; end
+
+      def show
+        xml = create_junit_xml
+        formatted_xml_string = StringIO.new
+        REXML::Formatters::Pretty.new.write(xml, formatted_xml_string)
+        puts formatted_xml_string.string
+      end
+
+      private
+
+      CONTEXT = {
+        prologue_quote: :quote,
+        attribute_quote: :quote,
+      }
+
+      def create_junit_xml
+        # create prologue
+        xml = REXML::Document.new(nil, CONTEXT)
+        xml << REXML::XMLDecl.new("1.0", "UTF-8")
+
+        xml.add_element(create_testsuite_element)
+
+        xml
+      end
+
+      def create_testsuite_element
+        tests = stats.processed_files.size
+        failures = stats.found
+        testsuite_element = REXML::Element.new("testsuite", nil, CONTEXT)
+        testsuite_element.add_attribute("name", "erblint")
+        testsuite_element.add_attribute("tests", tests.to_s)
+        testsuite_element.add_attribute("failures", failures.to_s)
+
+        testsuite_element.add_element(create_properties)
+
+        processed_files.each do |filename, offenses|
+          if offenses.empty?
+            testcase_element = REXML::Element.new("testcase", nil, CONTEXT)
+            testcase_element.add_attribute("name", filename.to_s)
+            testcase_element.add_attribute("file", filename.to_s)
+
+            testsuite_element.add_element(testcase_element)
+          end
+
+          offenses.each do |offense|
+            testsuite_element.add_element(create_testcase(filename, offense))
+          end
+        end
+
+        testsuite_element
+      end
+
+      def create_properties
+        properties_element = REXML::Element.new("properties", nil, CONTEXT)
+
+        [
+          ["erb_lint_version", ERBLint::VERSION],
+          ["ruby_engine", RUBY_ENGINE],
+          ["ruby_version", RUBY_VERSION],
+          ["ruby_patchlevel", RUBY_PATCHLEVEL.to_s],
+          ["ruby_platform", RUBY_PLATFORM],
+        ].each do |property_attribute|
+          properties_element.add_element(create_property(*property_attribute))
+        end
+
+        properties_element
+      end
+
+      def create_property(name, value)
+        property_element = REXML::Element.new("property")
+        property_element.add_attribute("name", name)
+        property_element.add_attribute("value", value)
+
+        property_element
+      end
+
+      def create_testcase(filename, offense)
+        testcase_element = REXML::Element.new("testcase", nil, CONTEXT)
+        testcase_element.add_attribute("name", filename.to_s)
+        testcase_element.add_attribute("file", filename.to_s)
+        testcase_element.add_attribute("lineno", offense.line_number.to_s)
+
+        testcase_element.add_element(create_failure(filename, offense))
+
+        testcase_element
+      end
+
+      def create_failure(filename, offense)
+        message = offense.message
+        type = offense.simple_name
+
+        failure_element = REXML::Element.new("failure", nil, CONTEXT)
+        failure_element.add_attribute("message", "#{type}: #{message}")
+        failure_element.add_attribute("type", type.to_s)
+
+        cdata_element = REXML::CData.new("#{type}: #{message} at #{filename}:#{offense.line_number}:#{offense.column}")
+        failure_element.add_text(cdata_element)
+
+        failure_element
+      end
+    end
+  end
+end

data/lib/erb_lint/runner.rb

@@ -5,15 +5,19 @@ module ERBLint
   class Runner
     attr_reader :offenses
 
-    def initialize(file_loader, config)
+    def initialize(file_loader, config, disable_inline_configs = false)
       @file_loader = file_loader
       @config = config || RunnerConfig.default
       raise ArgumentError, "expect `config` to be a RunnerConfig instance" unless @config.is_a?(RunnerConfig)
 
-      linter_classes = LinterRegistry.linters.select { |klass| @config.for_linter(klass).enabled? }
+      linter_classes = LinterRegistry.linters.select do |klass|
+        @config.for_linter(klass).enabled? && klass != ERBLint::Linters::NoUnusedDisable
+      end
       @linters = linter_classes.map do |linter_class|
         linter_class.new(@file_loader, @config.for_linter(linter_class))
       end
+      @no_unused_disable = nil
+      @disable_inline_configs = disable_inline_configs
       @offenses = []
     end
 
@@ -21,18 +25,43 @@ module ERBLint
       @linters
         .reject { |linter| linter.excludes_file?(processed_source.filename) }
         .each do |linter|
-        linter.run(processed_source)
+        linter.run_and_update_offense_status(processed_source, enable_inline_configs?)
         @offenses.concat(linter.offenses)
       end
+      report_unused_disable(processed_source)
+      @offenses = @offenses.reject(&:disabled?)
     end
 
     def clear_offenses
       @offenses = []
       @linters.each(&:clear_offenses)
+      @no_unused_disable&.clear_offenses
     end
 
     def restore_offenses(offenses)
       @offenses.concat(offenses)
     end
+
+    private
+
+    def enable_inline_configs?
+      !@disable_inline_configs
+    end
+
+    def no_unused_disable_enabled?
+      LinterRegistry.linters.include?(ERBLint::Linters::NoUnusedDisable) &&
+        @config.for_linter(ERBLint::Linters::NoUnusedDisable).enabled?
+    end
+
+    def report_unused_disable(processed_source)
+      if no_unused_disable_enabled? && enable_inline_configs?
+        @no_unused_disable = ERBLint::Linters::NoUnusedDisable.new(
+          @file_loader,
+          @config.for_linter(ERBLint::Linters::NoUnusedDisable)
+        )
+        @no_unused_disable.run(processed_source, @offenses)
+        @offenses.concat(@no_unused_disable.offenses)
+      end
+    end
   end
 end

data/lib/erb_lint/runner_config.rb

@@ -83,7 +83,7 @@ module ERBLint
     def config_hash_for_linter(klass_name)
       config_hash = linters_config[klass_name] || {}
       config_hash["exclude"] ||= []
-      config_hash["exclude"].concat(global_exclude) if config_hash["exclude"].is_a?(Array)
+      config_hash["exclude"].concat(global_exclude).uniq! if config_hash["exclude"].is_a?(Array)
       config_hash
     end
 

data/lib/erb_lint/utils/inline_configs.rb

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

data/lib/erb_lint/version.rb

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

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: erb_lint
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Justin Chan
+- Shopify Developers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-10 00:00:00.000000000 Z
+date: 2023-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -138,7 +139,7 @@ dependencies:
         version: '0'
 description: ERB Linter tool.
 email:
-- justin.the.c@gmail.com
+- ruby@shopify.com
 executables:
 - erblint
 extensions: []
@@ -164,6 +165,7 @@ files:
 - lib/erb_lint/linters/final_newline.rb
 - lib/erb_lint/linters/hard_coded_string.rb
 - lib/erb_lint/linters/no_javascript_tag_helper.rb
+- lib/erb_lint/linters/no_unused_disable.rb
 - lib/erb_lint/linters/parser_errors.rb
 - lib/erb_lint/linters/partial_instance_variable.rb
 - lib/erb_lint/linters/require_input_autocomplete.rb
@@ -181,12 +183,14 @@ files:
 - lib/erb_lint/reporter.rb
 - lib/erb_lint/reporters/compact_reporter.rb
 - lib/erb_lint/reporters/json_reporter.rb
+- lib/erb_lint/reporters/junit_reporter.rb
 - lib/erb_lint/reporters/multiline_reporter.rb
 - lib/erb_lint/runner.rb
 - lib/erb_lint/runner_config.rb
 - lib/erb_lint/runner_config_resolver.rb
 - 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
@@ -211,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.18
 signing_key: 
 specification_version: 4
 summary: ERB lint tool