erb_lint 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba9ef5f8b8a251d649dd1cffba1094d770471a630d0fa66b402621883ea3b050
-  data.tar.gz: db969c9e8bacc58b20fa9ad568c98263225c8bbf41f2d32f1b5d9f44a4c58aab
+  metadata.gz: ed317d0bcb868320c088c8788e5b14ba9f8224aab3e6ae2e4952e34df8fdefc4
+  data.tar.gz: 21fe3cfccf4d30225d11fa2f397186b5274bbb8d1fe6ff5bf593ac225bb327a9
 SHA512:
-  metadata.gz: a1d9e86c1862a41bb8cc2d1ae520af38ced2390e3d06c3d9bc9550a434993de502167c87adf93a780fec7f87d4921e77367e8bf8c546bf59c6f88908d0208039
-  data.tar.gz: 468ef87d28e39aa2fb0166cdfc98bee1f1f7349d21a9a5e2c08a81f5aab47c067d1d440d6466cf28077f5d72984b9d0018bdc23af2e3b91a6127bfc46f850f5a
+  metadata.gz: d281ca485b9763dc2d7e3b3297b429c2fa08f1f043e557b7a9ad9ab65c5e0e422d5ccabbd66f40e3da43088bc1b580dd9dab5213dca39a894a7b0da82c0e113c
+  data.tar.gz: 9907b4b4089693f5787c96b0e5cef7b1c9bd49b6831d6e6c42757fb69911a0905b395f468fab7c0339d3b0e166b6962d1a4db772476f669d659f6380e88a90c4

data/exe/erb_lint

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+lib_path = File.expand_path("#{__dir__}/../lib")
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
+
+require "erb_lint/cli"
+
+cli = ERBLint::CLI.new
+exit(cli.run)

data/exe/erblint

@@ -1,9 +1,10 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-$LOAD_PATH.unshift("#{__dir__}/../lib")
+lib_path = File.expand_path("#{__dir__}/../lib")
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
 
-require "erb_lint/cli"
+require "rainbow"
 
-cli = ERBLint::CLI.new
-exit(cli.run)
+warn(Rainbow("Calling `erblint` is deprecated, please call the renamed executable `erb_lint` instead.").yellow)
+exec(File.join(__dir__, "erb_lint"), *ARGV)

data/lib/erb_lint/cache.rb

@@ -2,7 +2,7 @@
 
 module ERBLint
   class Cache
-    CACHE_DIRECTORY = ".erb-lint-cache"
+    CACHE_DIRECTORY = ".erb_lint_cache"
 
     def initialize(config, cache_dir = nil)
       @config = config

data/lib/erb_lint/cli.rb

@@ -13,7 +13,8 @@ module ERBLint
   class CLI
     include Utils::SeverityLevels
 
-    DEFAULT_CONFIG_FILENAME = ".erb-lint.yml"
+    DEPRECATED_CONFIG_FILENAME = ".erb-lint.yml"
+    DEFAULT_CONFIG_FILENAME = ".erb_lint.yml"
     DEFAULT_LINT_ALL_GLOB = "**/*.html{+*,}.erb"
 
     class ExitWithFailure < RuntimeError; end
@@ -87,7 +88,7 @@ module ERBLint
         rescue => e
           @stats.exceptions += 1
           puts "Exception occurred when processing: #{relative_filename(filename)}"
-          puts "If this file cannot be processed by erb-lint, " \
+          puts "If this file cannot be processed by erb_lint, " \
             "you can exclude it in your configuration file."
           puts e.message
           puts Rainbow(e.backtrace.join("\n")).red
@@ -215,6 +216,13 @@ module ERBLint
       if File.exist?(config_filename)
         config = RunnerConfig.new(file_loader.yaml(config_filename), file_loader)
         @config = RunnerConfig.default_for(config)
+      elsif File.exist?(DEPRECATED_CONFIG_FILENAME)
+        deprecation_message = "The config file has been renamed to `#{DEFAULT_CONFIG_FILENAME}` and " \
+          "`#{DEPRECATED_CONFIG_FILENAME}` is deprecated. " \
+          "Please rename your config file to `#{DEFAULT_CONFIG_FILENAME}`."
+        warn(Rainbow(deprecation_message).yellow)
+        config = RunnerConfig.new(file_loader.yaml(DEPRECATED_CONFIG_FILENAME), file_loader)
+        @config = RunnerConfig.default_for(config)
       else
         warn(Rainbow("#{config_filename} not found: using default config").yellow)
         @config = RunnerConfig.default

data/lib/erb_lint/linter_registry.rb

@@ -3,7 +3,8 @@
 module ERBLint
   # Stores all linters available to the application.
   module LinterRegistry
-    CUSTOM_LINTERS_DIR = ".erb-linters"
+    DEPRECATED_CUSTOM_LINTERS_DIR = ".erb-linters"
+    CUSTOM_LINTERS_DIR = ".erb_linters"
     @loaded_linters = []
 
     class << self
@@ -28,6 +29,15 @@ module ERBLint
 
       def load_custom_linters(directory = CUSTOM_LINTERS_DIR)
         ruby_files = Dir.glob(File.expand_path(File.join(directory, "**", "*.rb")))
+
+        deprecated_ruby_files = Dir.glob(File.expand_path(File.join(DEPRECATED_CUSTOM_LINTERS_DIR, "**", "*.rb")))
+        if deprecated_ruby_files.any?
+          deprecation_message = "The '#{DEPRECATED_CUSTOM_LINTERS_DIR}' directory for custom linters is deprecated. " \
+            "Please rename it to '#{CUSTOM_LINTERS_DIR}'"
+          warn(Rainbow(deprecation_message).yellow)
+          ruby_files.concat(deprecated_ruby_files)
+        end
+
         ruby_files.each { |file| require file }
       end
     end

data/lib/erb_lint/linters/hard_coded_string.rb

@@ -41,6 +41,8 @@ module ERBLint
         " ",
         " ",
         "×",
+        "«",
+        "»",
       ])
 
       class ConfigSchema < LinterConfig

data/lib/erb_lint/linters/rubocop.rb

@@ -154,7 +154,7 @@ module ERBLint
       end
 
       def build_team
-        ::RuboCop::Cop::Team.new(
+        ::RuboCop::Cop::Team.mobilize(
           cop_classes,
           @rubocop_config,
           extra_details: true,

data/lib/erb_lint/reporters/junit_reporter.rb

@@ -1,111 +1,62 @@
 # frozen_string_literal: true
 
-require "rexml/document"
-require "rexml/formatters/pretty"
-
 module ERBLint
   module Reporters
     class JunitReporter < Reporter
+      ESCAPE_MAP = {
+        '"' => "&quot;",
+        "'" => "&apos;",
+        "<" => "&lt;",
+        ">" => "&gt;",
+        "&" => "&amp;",
+      }.freeze
+
+      PROPERTIES = [
+        ["erb_lint_version", ERBLint::VERSION],
+        ["ruby_engine", RUBY_ENGINE],
+        ["ruby_version", RUBY_VERSION],
+        ["ruby_patchlevel", RUBY_PATCHLEVEL.to_s],
+        ["ruby_platform", RUBY_PLATFORM],
+      ].freeze
+
       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)
+        puts %(<?xml version="1.0" encoding="UTF-8"?>)
+        puts %(<testsuite name="erblint" tests="#{@stats.processed_files.size}" failures="#{@stats.found}">)
 
-        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)
+        puts %(  <properties>)
+        PROPERTIES.each do |key, value|
+          puts %(    <property name="#{xml_escape(key)}" value="#{xml_escape(value)}"/>)
+        end
+        puts %(  </properties>)
 
         processed_files.each do |filename, offenses|
+          filename_escaped = xml_escape(filename)
           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))
+            puts %(  <testcase name="#{filename_escaped}" file="#{filename_escaped}"/>)
+          else
+            offenses.each do |offense|
+              type = offense.simple_name
+              message = "#{type}: #{offense.message}"
+              body = "#{message} at #{filename}:#{offense.line_number}:#{offense.column}"
+
+              puts %(  <testcase name="#{filename_escaped}" file="#{filename_escaped}" lineno="#{offense.line_number}">)
+              puts %(    <failure message="#{xml_escape(message)}" type="#{xml_escape(type)}">)
+              puts %(      #{xml_escape(body)})
+              puts %(    </failure>)
+              puts %(  </testcase>)
+            end
           end
         end
 
-        testsuite_element
+        puts %(</testsuite>)
       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)
+      private
 
-        failure_element
+      def xml_escape(string)
+        string.gsub(Regexp.union(ESCAPE_MAP.keys), ESCAPE_MAP)
       end
     end
   end

data/lib/erb_lint/runner_config_resolver.rb

@@ -37,7 +37,7 @@ module ERBLint
 
     def resolve_inheritance_from_gems(hash, gems)
       (gems || {}).each_pair do |gem_name, config_path|
-        raise(ArgumentError, "can't inherit configuration from the erb-lint gem") if gem_name == "erb-lint"
+        raise(ArgumentError, "can't inherit configuration from the erb_lint gem") if gem_name == "erb_lint"
 
         hash["inherit_from"] = Array(hash["inherit_from"])
         Array(config_path).reverse_each do |path|

data/lib/erb_lint/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: erb_lint
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Justin Chan
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-01 00:00:00.000000000 Z
+date: 2024-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -141,10 +141,12 @@ description: ERB Linter tool.
 email:
 - ruby@shopify.com
 executables:
+- erb_lint
 - erblint
 extensions: []
 extra_rdoc_files: []
 files:
+- exe/erb_lint
 - exe/erblint
 - lib/erb_lint.rb
 - lib/erb_lint/all.rb
@@ -196,7 +198,7 @@ files:
 - lib/erb_lint/utils/ruby_to_erb.rb
 - lib/erb_lint/utils/severity_levels.rb
 - lib/erb_lint/version.rb
-homepage: https://github.com/Shopify/erb-lint
+homepage: https://github.com/Shopify/erb_lint
 licenses:
 - MIT
 metadata:
@@ -216,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.21
 signing_key:
 specification_version: 4
 summary: ERB lint tool