erb_lint 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c54cf59770c0719d8cae0376d27a685ba2159d0e8884c00a472b0217d1ca2e6
-  data.tar.gz: c644e23a805c04e02daf4218f8548a167a90cc8d0b2bf0fd73acbbdbbaec237c
+  metadata.gz: 84ee5b7d05405468648ea7ea174c2f8f57ec1e56490873e1e89e1e9f618df585
+  data.tar.gz: 3f7db38955673a6218517c8a031c97a9aed5a03fe8a1a9ed11c631cc8aa920f7
 SHA512:
-  metadata.gz: '07718e5eed2bfb8246a529615c3950645c0d51e376475c6cea7eb60bedfc17af42c4f24f3aba7e8184e842087027b3c0e033afb6c1d01eceb5b84e7c0da8bb74'
-  data.tar.gz: 6bda3b3ad2b03a0812a6bb796c0f6f2d03545fcdc44a6130dc7e3b2135d523e8decb395e3fd7599d9121045c840585de3c4ced6c9c8fb642d1865d263e978dad
+  metadata.gz: e466a9178358d9400fa7a38cda19d1263efecaa1729391b1eea5c9dae2cf928686f97c5d84a0df85ba6774465f415ef94ec628cda8cc38834f2983fe525f41e7
+  data.tar.gz: 1f7cc9b5a8994d9378f70085d69e0012baa78c0da7896b366dfd32f894f05b4c3978c831eab31f6b209c9c4a42bfe36dcf0bb413a872a91a2bb22bfc79effc16

data/exe/erblint

@@ -3,7 +3,7 @@
 
 $LOAD_PATH.unshift("#{__dir__}/../lib")
 
-require 'erb_lint/cli'
+require "erb_lint/cli"
 
 cli = ERBLint::CLI.new
 exit(cli.run)

data/lib/erb_lint/all.rb

@@ -1,26 +1,26 @@
 # frozen_string_literal: true
 
-require 'rubocop'
+require "rubocop"
 
-require 'erb_lint'
-require 'erb_lint/corrector'
-require 'erb_lint/file_loader'
-require 'erb_lint/linter_config'
-require 'erb_lint/linter_registry'
-require 'erb_lint/linter'
-require 'erb_lint/offense'
-require 'erb_lint/processed_source'
-require 'erb_lint/runner_config'
-require 'erb_lint/runner'
-require 'erb_lint/stats'
-require 'erb_lint/reporter'
+require "erb_lint"
+require "erb_lint/corrector"
+require "erb_lint/file_loader"
+require "erb_lint/linter_config"
+require "erb_lint/linter_registry"
+require "erb_lint/linter"
+require "erb_lint/offense"
+require "erb_lint/processed_source"
+require "erb_lint/runner_config"
+require "erb_lint/runner"
+require "erb_lint/stats"
+require "erb_lint/reporter"
 
 # Load linters
-Dir[File.expand_path('linters/**/*.rb', __dir__)].each do |file|
+Dir[File.expand_path("linters/**/*.rb", __dir__)].each do |file|
   require file
 end
 
 # Load reporters
-Dir[File.expand_path('reporters/**/*.rb', __dir__)].each do |file|
+Dir[File.expand_path("reporters/**/*.rb", __dir__)].each do |file|
   require file
 end

data/lib/erb_lint/cli.rb

@@ -1,19 +1,19 @@
 # frozen_string_literal: true
 
-require 'erb_lint/all'
-require 'active_support'
-require 'active_support/inflector'
-require 'optparse'
-require 'psych'
-require 'yaml'
-require 'rainbow'
-require 'erb_lint/utils/severity_levels'
+require "erb_lint/all"
+require "active_support"
+require "active_support/inflector"
+require "optparse"
+require "psych"
+require "yaml"
+require "rainbow"
+require "erb_lint/utils/severity_levels"
 
 module ERBLint
   class CLI
     include Utils::SeverityLevels
 
-    DEFAULT_CONFIG_FILENAME = '.erb-lint.yml'
+    DEFAULT_CONFIG_FILENAME = ".erb-lint.yml"
     DEFAULT_LINT_ALL_GLOB = "**/*.html{+*,}.erb"
 
     class ExitWithFailure < RuntimeError; end
@@ -43,13 +43,14 @@ module ERBLint
       ensure_files_exist(lint_files)
 
       if enabled_linter_classes.empty?
-        failure!('no linter available with current configuration')
+        failure!("no linter available with current configuration")
       end
 
       @options[:format] ||= :multiline
       @options[:fail_level] ||= severity_level_for_name(:refactor)
       @stats.files = lint_files.size
       @stats.linters = enabled_linter_classes.size
+      @stats.autocorrectable_linters = enabled_linter_classes.count(&:support_autocorrect?)
 
       reporter = Reporter.create_reporter(@options[:format], @stats, autocorrect?)
       reporter.preview
@@ -145,7 +146,7 @@ module ERBLint
 
     def correct(processed_source, offenses)
       corrector = ERBLint::Corrector.new(processed_source, offenses)
-      failure!(corrector.diagnostics.join(', ')) if corrector.diagnostics.any?
+      failure!(corrector.diagnostics.join(", ")) if corrector.diagnostics.any?
       corrector
     end
 
@@ -183,7 +184,7 @@ module ERBLint
         else
           @files
             .map { |f| Dir.exist?(f) ? Dir[File.join(f, glob)] : f }
-            .map { |f| f.include?('*') ? Dir[f] : f }
+            .map { |f| f.include?("*") ? Dir[f] : f }
             .flatten
             .map { |f| File.expand_path(f, Dir.pwd) }
             .select { |filename| !excluded?(filename) }
@@ -232,22 +233,18 @@ module ERBLint
 
     def enabled_linter_classes
       @enabled_linter_classes ||= ERBLint::LinterRegistry.linters
-        .select { |klass| linter_can_run?(klass) && enabled_linter_names.include?(klass.simple_name.underscore) }
-    end
-
-    def linter_can_run?(klass)
-      !autocorrect? || klass.support_autocorrect?
+        .select { |klass| enabled_linter_names.include?(klass.simple_name.underscore) }
     end
 
     def relative_filename(filename)
-      filename.sub("#{File.expand_path('.', Dir.pwd)}/", '')
+      filename.sub("#{File.expand_path(".", Dir.pwd)}/", "")
     end
 
     def runner_config_override
       RunnerConfig.new(
         linters: {}.tap do |linters|
           ERBLint::LinterRegistry.linters.map do |klass|
-            linters[klass.simple_name] = { 'enabled' => enabled_linter_classes.include?(klass) }
+            linters[klass.simple_name] = { "enabled" => enabled_linter_classes.include?(klass) }
           end
         end
       )
@@ -283,10 +280,10 @@ module ERBLint
         end
 
         opts.on("--enable-linters LINTER[,LINTER,...]", Array,
-          "Only use specified linter", "Known linters are: #{known_linter_names.join(', ')}") do |linters|
+          "Only use specified linter", "Known linters are: #{known_linter_names.join(", ")}") do |linters|
           linters.each do |linter|
             unless known_linter_names.include?(linter)
-              failure!("#{linter}: not a valid linter name (#{known_linter_names.join(', ')})")
+              failure!("#{linter}: not a valid linter name (#{known_linter_names.join(", ")})")
             end
           end
           @options[:enabled_linters] = linters
@@ -296,7 +293,7 @@ module ERBLint
           parsed_severity = SEVERITY_CODE_TABLE[level.upcase.to_sym] || (SEVERITY_NAMES & [level.downcase]).first
 
           if parsed_severity.nil?
-            failure!("#{level}: not a valid failure level (#{SEVERITY_NAMES.join(', ')})")
+            failure!("#{level}: not a valid failure level (#{SEVERITY_NAMES.join(", ")})")
           end
           @options[:fail_level] = severity_level_for_name(parsed_severity)
         end
@@ -325,7 +322,7 @@ module ERBLint
 
     def format_options_help
       "Report offenses in the given format: "\
-      "(#{Reporter.available_formats.join(', ')}) (default: multiline)"
+        "(#{Reporter.available_formats.join(", ")}) (default: multiline)"
     end
 
     def invalid_format_error_message(given_format)

data/lib/erb_lint/corrector.rb

@@ -21,7 +21,7 @@ module ERBLint
     end
 
     if ::RuboCop::Version::STRING.to_f >= 0.87
-      require 'rubocop/cop/legacy/corrector'
+      require "rubocop/cop/legacy/corrector"
       BASE = ::RuboCop::Cop::Legacy::Corrector
 
       def diagnostics

data/lib/erb_lint/linter.rb

@@ -15,9 +15,9 @@ module ERBLint
       # `ERBLint::Linters::Compass::Bar.simple_name` #=> "Compass::Bar"
       def inherited(linter)
         super
-        linter.simple_name = if linter.name.start_with?('ERBLint::Linters::')
-          name_parts = linter.name.split('::')
-          name_parts[2..-1].join('::')
+        linter.simple_name = if linter.name.start_with?("ERBLint::Linters::")
+          name_parts = linter.name.split("::")
+          name_parts[2..-1].join("::")
         else
           linter.name
         end
@@ -46,7 +46,7 @@ module ERBLint
     end
 
     def excludes_file?(filename)
-      @config.excludes_file?(filename)
+      @config.excludes_file?(filename, @file_loader.base_path)
     end
 
     def run(_processed_source)

data/lib/erb_lint/linter_config.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'active_support'
-require 'smart_properties'
+require "active_support"
+require "smart_properties"
 
 module ERBLint
   class LinterConfig
@@ -27,8 +27,9 @@ module ERBLint
       allowed_keys = self.class.properties.keys.map(&:to_s)
       given_keys = config.keys
       if (extra_keys = given_keys - allowed_keys).any?
-        raise Error, "Given key is not allowed: #{extra_keys.join(', ')}"
+        raise Error, "Given key is not allowed: #{extra_keys.join(", ")}"
       end
+
       super(config)
     rescue SmartProperties::InitializationError => e
       raise Error, "The following properties are required to be set: #{e.properties}"
@@ -40,6 +41,7 @@ module ERBLint
       unless self.class.properties.key?(name)
         raise Error, "No such property: #{name}"
       end
+
       super
     end
 
@@ -51,9 +53,12 @@ module ERBLint
       end
     end
 
-    def excludes_file?(filename)
+    def excludes_file?(absolute_filename, base_path)
       exclude.any? do |path|
-        File.fnmatch?(path, filename)
+        return true if File.fnmatch?(path, absolute_filename)
+
+        relative_path = absolute_filename.delete_prefix("#{base_path}/")
+        File.fnmatch?(path, relative_path)
       end
     end
   end

data/lib/erb_lint/linter_registry.rb

@@ -3,7 +3,7 @@
 module ERBLint
   # Stores all linters available to the application.
   module LinterRegistry
-    CUSTOM_LINTERS_DIR = '.erb-linters'
+    CUSTOM_LINTERS_DIR = ".erb-linters"
     @loaded_linters = []
 
     class << self
@@ -27,7 +27,7 @@ module ERBLint
       end
 
       def load_custom_linters(directory = CUSTOM_LINTERS_DIR)
-        ruby_files = Dir.glob(File.expand_path(File.join(directory, '**', '*.rb')))
+        ruby_files = Dir.glob(File.expand_path(File.join(directory, "**", "*.rb")))
         ruby_files.each { |file| require file }
       end
     end

data/lib/erb_lint/linters/allowed_script_type.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'better_html'
-require 'better_html/tree/tag'
+require "better_html"
+require "better_html/tree/tag"
 
 module ERBLint
   module Linters
@@ -13,7 +13,7 @@ module ERBLint
 
       class ConfigSchema < LinterConfig
         property :allowed_types, accepts: array_of?(String),
-          default: -> { ['text/javascript'] }
+          default: -> { ["text/javascript"] }
         property :allow_blank, accepts: [true, false], default: true, reader: :allow_blank?
         property :disallow_inline_scripts, accepts: [true, false], default: false, reader: :disallow_inline_scripts?
       end
@@ -24,19 +24,19 @@ module ERBLint
         parser.nodes_with_type(:tag).each do |tag_node|
           tag = BetterHtml::Tree::Tag.from_node(tag_node)
           next if tag.closing?
-          next unless tag.name == 'script'
+          next unless tag.name == "script"
 
           if @config.disallow_inline_scripts?
             name_node = tag_node.to_a[1]
             add_offense(
               name_node.loc,
               "Avoid using inline `<script>` tags altogether. "\
-              "Instead, move javascript code into a static file."
+                "Instead, move javascript code into a static file."
             )
             next
           end
 
-          type_attribute = tag.attributes['type']
+          type_attribute = tag.attributes["type"]
           type_present = type_attribute.present? && type_attribute.value_node.present?
 
           if !type_present && !@config.allow_blank?
@@ -50,8 +50,8 @@ module ERBLint
             add_offense(
               type_attribute.loc,
               "Avoid using #{type_attribute.value.inspect} as type for `<script>` tag. "\
-              "Must be one of: #{@config.allowed_types.join(', ')}"\
-              "#{' (or no type attribute)' if @config.allow_blank?}."
+                "Must be one of: #{@config.allowed_types.join(", ")}"\
+                "#{" (or no type attribute)" if @config.allow_blank?}."
             )
           end
         end
@@ -59,6 +59,7 @@ module ERBLint
 
       def autocorrect(_processed_source, offense)
         return unless offense.context
+
         lambda do |corrector|
           type_attribute, = *offense.context
           if type_attribute.nil?

data/lib/erb_lint/linters/closing_erb_tag_indent.rb

@@ -25,7 +25,7 @@ module ERBLint
             add_offense(
               code_node.loc.end.adjust(begin_pos: -end_spaces.size),
               "Remove newline before `%>` to match start of tag.",
-              ' '
+              " "
             )
           elsif start_with_newline && !end_with_newline
             add_offense(
@@ -39,7 +39,7 @@ module ERBLint
               add_offense(
                 code_node.loc.end.adjust(begin_pos: -current_indent.size),
                 "Indent `%>` on column #{erb_node.loc.column} to match start of tag.",
-                ' ' * erb_node.loc.column
+                " " * erb_node.loc.column
               )
             end
           end

data/lib/erb_lint/linters/deprecated_classes.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'better_html'
-require 'better_html/parser'
+require "better_html"
+require "better_html/parser"
 
 module ERBLint
   module Linters
@@ -11,7 +11,7 @@ module ERBLint
 
       class RuleSet
         include SmartProperties
-        property :suggestion, accepts: String, default: ''
+        property :suggestion, accepts: String, default: ""
         property :deprecated, accepts: LinterConfig.array_of?(String), default: -> { [] }
       end
 
@@ -57,9 +57,10 @@ module ERBLint
       def class_name_with_loc(processed_source)
         Enumerator.new do |yielder|
           tags(processed_source).each do |tag|
-            class_value = tag.attributes['class']&.value
+            class_value = tag.attributes["class"]&.value
             next unless class_value
-            class_value.split(' ').each do |class_name|
+
+            class_value.split(" ").each do |class_name|
               yielder.yield(class_name, tag.loc)
             end
           end
@@ -69,7 +70,7 @@ module ERBLint
       def text_tags_content(processed_source)
         Enumerator.new do |yielder|
           script_tags(processed_source)
-            .select { |tag| tag.attributes['type']&.value == 'text/html' }
+            .select { |tag| tag.attributes["type"]&.value == "text/html" }
             .each do |tag|
               index = processed_source.ast.to_a.find_index(tag.node)
               next_node = processed_source.ast.to_a[index + 1]
@@ -80,7 +81,7 @@ module ERBLint
       end
 
       def script_tags(processed_source)
-        tags(processed_source).select { |tag| tag.name == 'script' }
+        tags(processed_source).select { |tag| tag.name == "script" }
       end
 
       def tags(processed_source)

data/lib/erb_lint/linters/erb_safety.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'better_html'
-require 'better_html/test_helper/safe_erb_tester'
+require "better_html"
+require "better_html/test_helper/safe_erb_tester"
 
 module ERBLint
   module Linters

data/lib/erb_lint/linters/extra_newline.rb

@@ -22,7 +22,7 @@ module ERBLint
 
       def autocorrect(_processed_source, offense)
         lambda do |corrector|
-          corrector.replace(offense.source_range, '')
+          corrector.replace(offense.source_range, "")
         end
       end
     end

data/lib/erb_lint/linters/final_newline.rb

@@ -28,7 +28,7 @@ module ERBLint
           if final_newline.empty?
             add_offense(
               processed_source.to_source_range(file_content.size...file_content.size),
-              'Missing a trailing newline at the end of the file.',
+              "Missing a trailing newline at the end of the file.",
               :insert
             )
           else
@@ -36,7 +36,7 @@ module ERBLint
               processed_source.to_source_range(
                 (file_content.size - final_newline.size + 1)...file_content.size
               ),
-              'Remove multiple trailing newline at the end of the file.',
+              "Remove multiple trailing newline at the end of the file.",
               :remove
             )
           end

data/lib/erb_lint/linters/hard_coded_string.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
+
 require "set"
-require 'better_html/tree/tag'
-require 'active_support/core_ext/string/inflections'
+require "better_html/tree/tag"
+require "active_support/core_ext/string/inflections"
 
 module ERBLint
   module Linters
@@ -13,37 +14,37 @@ module ERBLint
       MissingCorrector = Class.new(StandardError)
       MissingI18nLoadPath = Class.new(StandardError)
 
-      ALLOWED_CORRECTORS = %w(
-        I18nCorrector
-        RuboCop::Corrector::I18n::HardCodedString
-      )
-
-      NON_TEXT_TAGS = Set.new(%w(script style xmp iframe noembed noframes listing))
-      BLACK_LISTED_TEXT = Set.new(%w(
-         
-        &
-        <
-        >
-        "
-        ©
-        ®
-        ™
-        …
-        —
-        •
-        “
-        ”
-        ‘
-        ’
-        ←
-        →
-        ↓
-        ↑
-      ))
+      ALLOWED_CORRECTORS = ["I18nCorrector", "RuboCop::Corrector::I18n::HardCodedString"]
+
+      NON_TEXT_TAGS = Set.new(["script", "style", "xmp", "iframe", "noembed", "noframes", "listing"])
+      TEXT_NOT_ALLOWED = Set.new([
+        " ",
+        "&",
+        "<",
+        ">",
+        """,
+        "©",
+        "®",
+        "™",
+        "…",
+        "—",
+        "•",
+        "“",
+        "”",
+        "‘",
+        "’",
+        "←",
+        "→",
+        "↓",
+        "↑",
+        " ",
+        " ",
+        " ",
+      ])
 
       class ConfigSchema < LinterConfig
         property :corrector, accepts: Hash, required: false, default: -> { {} }
-        property :i18n_load_path, accepts: String, required: false, default: ''
+        property :i18n_load_path, accepts: String, required: false, default: ""
       end
       self.config_schema = ConfigSchema
 
@@ -83,9 +84,10 @@ module ERBLint
         string = offense.source_range.source
         return unless (klass = load_corrector)
         return unless 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)
-        corrector.autocorrect(tag_start: '<%= ', tag_end: ' %>')
+        corrector.autocorrect(tag_start: "<%= ", tag_end: " %>")
       rescue MissingCorrector, MissingI18nLoadPath
         nil
       end
@@ -93,20 +95,21 @@ module ERBLint
       private
 
       def check_string?(str)
-        string = str.gsub(/\s*/, '')
-        string.length > 1 && !BLACK_LISTED_TEXT.include?(string)
+        string = str.gsub(/\s*/, "")
+        string.length > 1 && !TEXT_NOT_ALLOWED.include?(string)
       end
 
       def load_corrector
-        corrector_name = @config['corrector'].fetch('name') { raise MissingCorrector }
+        corrector_name = @config["corrector"].fetch("name") { raise MissingCorrector }
         raise ForbiddenCorrector unless ALLOWED_CORRECTORS.include?(corrector_name)
-        require @config['corrector'].fetch('path') { raise MissingCorrector }
+
+        require @config["corrector"].fetch("path") { raise MissingCorrector }
 
         corrector_name.safe_constantize
       end
 
       def corrector_i18n_load_path
-        @config['corrector'].fetch('i18n_load_path') { raise MissingI18nLoadPath }
+        @config["corrector"].fetch("i18n_load_path") { raise MissingI18nLoadPath }
       end
 
       def non_text_tag?(processed_source, text_node)

data/lib/erb_lint/linters/no_javascript_tag_helper.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'better_html'
-require 'better_html/ast/node'
-require 'better_html/test_helper/ruby_node'
-require 'erb_lint/utils/block_map'
-require 'erb_lint/utils/ruby_to_erb'
+require "better_html"
+require "better_html/ast/node"
+require "better_html/test_helper/ruby_node"
+require "erb_lint/utils/block_map"
+require "erb_lint/utils/ruby_to_erb"
 
 module ERBLint
   module Linters
@@ -21,7 +21,8 @@ module ERBLint
         parser.ast.descendants(:erb).each do |erb_node|
           indicator_node, _, code_node, _ = *erb_node
           indicator = indicator_node&.loc&.source
-          next if indicator == '#'
+          next if indicator == "#"
+
           source = code_node.loc.source
 
           ruby_node =
@@ -31,13 +32,14 @@ module ERBLint
               nil
             end
           next unless ruby_node
+
           send_node = ruby_node.descendants(:send).first
           next unless send_node&.method_name?(:javascript_tag)
 
           add_offense(
             erb_node.loc,
             "Avoid using 'javascript_tag do' as it confuses tests "\
-            "that validate html, use inline <script> instead",
+              "that validate html, use inline <script> instead",
             [erb_node, send_node]
           )
         end
@@ -63,10 +65,10 @@ module ERBLint
         return unless (0..2).cover?(argument_nodes.size)
 
         script_content = unless argument_nodes.first&.type?(:hash)
-          Utils::RubyToERB.ruby_to_erb(argument_nodes.first, '==')
+          Utils::RubyToERB.ruby_to_erb(argument_nodes.first, "==")
         end
         arguments = if argument_nodes.last&.type?(:hash)
-          ' ' + Utils::RubyToERB.html_options_to_tag_attributes(argument_nodes.last)
+          " " + Utils::RubyToERB.html_options_to_tag_attributes(argument_nodes.last)
         end
 
         return if end_node && script_content

data/lib/erb_lint/linters/partial_instance_variable.rb

@@ -8,7 +8,7 @@ module ERBLint
 
       def run(processed_source)
         instance_variable_regex = /\s@\w+/
-        return unless processed_source.filename.match?(/.*_.*.erb\z/) &&
+        return unless processed_source.filename.match?(%r{(\A|.*/)_[^/\s]*\.html\.erb\z}) &&
           processed_source.file_content.match?(instance_variable_regex)
 
         add_offense(