erb_lint 0.1.0 → 0.1.3

data/lib/erb_lint/linters/require_input_autocomplete.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,6 @@ module ERBLint
         "date",
         "datetime-local",
         "email",
-        "hidden",
         "month",
         "number",
         "password",
@@ -33,7 +32,6 @@ module ERBLint
         :text_field_tag,
         :utf8_enforcer_tag,
         :month_field_tag,
-        :hidden_field_tag,
         :number_field_tag,
         :password_field_tag,
         :search_field_tag,
@@ -56,8 +54,8 @@ module ERBLint
         parser.nodes_with_type(:tag).each do |tag_node|
           tag = BetterHtml::Tree::Tag.from_node(tag_node)
 
-          autocomplete_attribute = tag.attributes['autocomplete']
-          type_attribute = tag.attributes['type']
+          autocomplete_attribute = tag.attributes["autocomplete"]
+          type_attribute = tag.attributes["type"]
 
           next if !html_input_tag?(tag) || autocomplete_present?(autocomplete_attribute)
           next unless html_type_requires_autocomplete_attribute?(type_attribute)
@@ -65,7 +63,7 @@ module ERBLint
           add_offense(
             tag_node.to_a[1].loc,
             "Input tag is missing an autocomplete attribute. If no "\
-            "autocomplete behaviour is desired, use the value `off` or `nope`.",
+              "autocomplete behaviour is desired, use the value `off` or `nope`.",
             [autocomplete_attribute]
           )
         end
@@ -76,7 +74,7 @@ module ERBLint
       end
 
       def html_input_tag?(tag)
-        !tag.closing? && tag.name == 'input'
+        !tag.closing? && tag.name == "input"
       end
 
       def html_type_requires_autocomplete_attribute?(type_attribute)
@@ -99,7 +97,7 @@ module ERBLint
           add_offense(
             erb_node.loc,
             "Input field helper is missing an autocomplete attribute. If no "\
-            "autocomplete behaviour is desired, use the value `off` or `nope`.",
+              "autocomplete behaviour is desired, use the value `off` or `nope`.",
             [erb_node, send_node]
           )
         end
@@ -110,7 +108,7 @@ module ERBLint
       end
 
       def code_comment?(indicator_node)
-        indicator_node&.loc&.source == '#'
+        indicator_node&.loc&.source == "#"
       end
 
       def extract_ruby_node(source)

data/lib/erb_lint/linters/require_script_nonce.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
@@ -22,7 +22,7 @@ module ERBLint
       def find_html_script_tags(parser)
         parser.nodes_with_type(:tag).each do |tag_node|
           tag = BetterHtml::Tree::Tag.from_node(tag_node)
-          nonce_attribute = tag.attributes['nonce']
+          nonce_attribute = tag.attributes["nonce"]
 
           next if !html_javascript_tag?(tag) || nonce_present?(nonce_attribute)
 
@@ -40,16 +40,16 @@ module ERBLint
 
       def html_javascript_tag?(tag)
         !tag.closing? &&
-          (tag.name == 'script' && !html_javascript_type_attribute?(tag))
+          (tag.name == "script" && !html_javascript_type_attribute?(tag))
       end
 
       def html_javascript_type_attribute?(tag)
-        type_attribute = tag.attributes['type']
+        type_attribute = tag.attributes["type"]
 
         type_attribute &&
           type_attribute.value_node.present? &&
-          type_attribute.value_node.to_a[1] != 'text/javascript' &&
-          type_attribute.value_node.to_a[1] != 'application/javascript'
+          type_attribute.value_node.to_a[1] != "text/javascript" &&
+          type_attribute.value_node.to_a[1] != "application/javascript"
       end
 
       def find_rails_helper_script_tags(parser)
@@ -74,12 +74,12 @@ module ERBLint
 
       def tag_helper?(send_node)
         send_node&.method_name?(:javascript_tag) ||
-        send_node&.method_name?(:javascript_include_tag) ||
-        send_node&.method_name?(:javascript_pack_tag)
+          send_node&.method_name?(:javascript_include_tag) ||
+          send_node&.method_name?(:javascript_pack_tag)
       end
 
       def code_comment?(indicator_node)
-        indicator_node&.loc&.source == '#'
+        indicator_node&.loc&.source == "#"
       end
 
       def extract_ruby_node(source)

data/lib/erb_lint/linters/right_trim.rb

@@ -8,7 +8,7 @@ module ERBLint
       include LinterRegistry
 
       class ConfigSchema < LinterConfig
-        property :enforced_style, accepts: ['-', '='], default: '-'
+        property :enforced_style, accepts: ["-", "="], default: "-"
       end
       self.config_schema = ConfigSchema
 

data/lib/erb_lint/linters/rubocop.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'better_html'
-require 'tempfile'
-require 'erb_lint/utils/offset_corrector'
+require "better_html"
+require "tempfile"
+require "erb_lint/utils/offset_corrector"
 
 module ERBLint
   module Linters
@@ -25,7 +25,7 @@ module ERBLint
         super
         @only_cops = @config.only
         custom_config = config_from_hash(@config.rubocop_config)
-        @rubocop_config = ::RuboCop::ConfigLoader.merge_with_default(custom_config, '')
+        @rubocop_config = ::RuboCop::ConfigLoader.merge_with_default(custom_config, "")
       end
 
       def run(processed_source)
@@ -37,6 +37,7 @@ module ERBLint
       if ::RuboCop::Version::STRING.to_f >= 0.87
         def autocorrect(_processed_source, offense)
           return unless offense.context
+
           rubocop_correction = offense.context[:rubocop_correction]
           return unless rubocop_correction
 
@@ -68,13 +69,13 @@ module ERBLint
 
       def inspect_content(processed_source, erb_node)
         indicator, _, code_node, = *erb_node
-        return if indicator&.children&.first == '#'
+        return if indicator&.children&.first == "#"
 
         original_source = code_node.loc.source
-        trimmed_source = original_source.sub(BLOCK_EXPR, '').sub(SUFFIX_EXPR, '')
+        trimmed_source = original_source.sub(BLOCK_EXPR, "").sub(SUFFIX_EXPR, "")
         alignment_column = code_node.loc.column
         offset = code_node.loc.begin_pos - alignment_column
-        aligned_source = "#{' ' * alignment_column}#{trimmed_source}"
+        aligned_source = "#{" " * alignment_column}#{trimmed_source}"
 
         source = rubocop_processed_source(aligned_source, processed_source.filename)
         return unless source.valid_syntax?
@@ -150,16 +151,17 @@ module ERBLint
           @rubocop_config,
           extra_details: true,
           display_cop_names: true,
+          autocorrect: true,
           auto_correct: true,
           stdin: "",
         )
       end
 
       def config_from_hash(hash)
-        inherit_from = hash&.delete('inherit_from')
+        inherit_from = hash&.delete("inherit_from")
         resolve_inheritance(hash, inherit_from)
 
-        tempfile_from('.erblint-rubocop', hash.to_yaml) do |tempfile|
+        tempfile_from(".erblint-rubocop", hash.to_yaml) do |tempfile|
           ::RuboCop::ConfigLoader.load_file(tempfile.path)
         end
       end
@@ -174,7 +176,7 @@ module ERBLint
       end
 
       def base_configs(inherit_from)
-        regex = URI::DEFAULT_PARSER.make_regexp(%w(http https))
+        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))

data/lib/erb_lint/linters/rubocop_text.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'rubocop'
+require_relative "rubocop"
 
 module ERBLint
   module Linters

data/lib/erb_lint/linters/self_closing_tag.rb

@@ -11,10 +11,8 @@ module ERBLint
       end
       self.config_schema = ConfigSchema
 
-      SELF_CLOSING_TAGS = %w(
-        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|
@@ -26,7 +24,7 @@ module ERBLint
             add_offense(
               start_solidus.loc,
               "Tag `#{tag.name}` is a void element, it must not start with `</`.",
-              ''
+              ""
             )
           end
 
@@ -34,16 +32,17 @@ module ERBLint
             add_offense(
               tag_node.loc.end.offset(-1),
               "Tag `#{tag.name}` is self-closing, it must end with `/>`.",
-              '/'
+              "/"
             )
           end
 
           next unless @config.enforced_style == :never && tag.self_closing?
+
           end_solidus = tag_node.children.last
           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

@@ -15,7 +15,8 @@ module ERBLint
         processed_source.ast.descendants(:erb).each do |erb_node|
           indicator_node, ltrim, code_node, rtrim = *erb_node
           indicator = indicator_node&.loc&.source
-          next if indicator == '#' || indicator == '%'
+          next if indicator == "#" || indicator == "%"
+
           code = code_node.children.first
 
           start_spaces = code.match(START_SPACES)&.captures&.first || ""
@@ -23,15 +24,15 @@ module ERBLint
             add_offense(
               code_node.loc.resize(start_spaces.size),
               "Use 1 space after `<%#{indicator}#{ltrim&.loc&.source}` "\
-              "instead of #{start_spaces.size} space#{'s' if start_spaces.size > 1}.",
-              ' '
+                "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}` "\
-              "instead of #{start_spaces.count("\n")}.",
+                "instead of #{start_spaces.count("\n")}.",
               "#{lines.first}\n#{lines.last}"
             )
           end
@@ -41,15 +42,15 @@ module ERBLint
             add_offense(
               code_node.loc.end.adjust(begin_pos: -end_spaces.size),
               "Use 1 space before `#{rtrim&.loc&.source}%>` "\
-              "instead of #{end_spaces.size} space#{'s' if start_spaces.size > 1}.",
-              ' '
+                "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}%>` "\
-              "instead of #{end_spaces.count("\n")}.",
+                "instead of #{end_spaces.count("\n")}.",
               "#{lines.first}\n#{lines.last}"
             )
           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
 
@@ -60,24 +60,24 @@ module ERBLint
 
       def single_space(processed_source, range, accept_newline: false)
         chars = processed_source.file_content[range]
-        return if chars == ' '
+        return if chars == " "
 
         newlines = chars.include?("\n")
-        expected = newlines && accept_newline ? "\n#{chars.split("\n", -1).last}" : ' '
+        expected = newlines && accept_newline ? "\n#{chars.split("\n", -1).last}" : " "
         non_space = chars.match(/([^[[:space:]]])/m)
 
         if non_space && !non_space.captures.empty?
           add_offense(
             processed_source.to_source_range(range),
             "Non-whitespace character(s) detected: "\
-              "#{non_space.captures.map(&:inspect).join(', ')}.",
+              "#{non_space.captures.map(&:inspect).join(", ")}.",
             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
             )
@@ -85,7 +85,7 @@ module ERBLint
         else
           add_offense(
             processed_source.to_source_range(range),
-            "#{chars.empty? ? 'No' : 'Extra'} space detected where there should be a single space.",
+            "#{chars.empty? ? "No" : "Extra"} space detected where there should be a single space.",
             expected
           )
         end
@@ -98,6 +98,7 @@ module ERBLint
           no_space(processed_source, equal.loc.end_pos...value.loc.begin_pos) if equal && value
 
           next if index >= attributes.children.size - 1
+
           next_attribute = attributes.children[index + 1]
 
           single_space_or_newline(

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
 

data/lib/erb_lint/linters/trailing_whitespace.rb

@@ -25,7 +25,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/offense.rb

@@ -9,6 +9,7 @@ module ERBLint
       unless source_range.is_a?(Parser::Source::Range)
         raise ArgumentError, "expected Parser::Source::Range for arg 2"
       end
+
       @linter = linter
       @source_range = source_range
       @message = message

data/lib/erb_lint/reporter.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
-require 'active_support/core_ext/class'
-require 'active_support/core_ext/module/delegation'
+
+require "active_support/core_ext/class"
+require "active_support/core_ext/module/delegation"
 
 module ERBLint
   class Reporter
@@ -34,6 +35,7 @@ module ERBLint
     private
 
     attr_reader :stats, :autocorrect
+
     delegate :processed_files, to: :stats
   end
 end

data/lib/erb_lint/reporters/compact_reporter.rb

@@ -4,8 +4,7 @@ module ERBLint
   module Reporters
     class CompactReporter < Reporter
       def preview
-        puts "Linting #{stats.files} files with "\
-          "#{stats.linters} #{'autocorrectable ' if autocorrect}linters..."
+        puts "#{linting} #{stats.files} files with #{linters}..."
       end
 
       def show
@@ -21,6 +20,14 @@ module ERBLint
 
       private
 
+      def linting
+        "Linting" + (autocorrect ? " and autocorrecting" : "")
+      end
+
+      def linters
+        "#{stats.linters} linters" + (autocorrect ? " (#{stats.autocorrectable_linters} autocorrectable)" : "")
+      end
+
       def format_offense(filename, offense)
         [
           "#{filename}:",

data/lib/erb_lint/reporters/multiline_reporter.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative "compact_reporter"
 
 module ERBLint
@@ -9,7 +10,7 @@ module ERBLint
       def format_offense(filename, offense)
         <<~EOF
 
-          #{offense.message}#{Rainbow(' (not autocorrected)').red if autocorrect}
+          #{offense.message}#{Rainbow(" (not autocorrected)").red if autocorrect}
           In file: #{filename}:#{offense.line_number}
         EOF
       end

data/lib/erb_lint/runner.rb

@@ -8,7 +8,7 @@ module ERBLint
     def initialize(file_loader, config)
       @file_loader = file_loader
       @config = config || RunnerConfig.default
-      raise ArgumentError, 'expect `config` to be a RunnerConfig instance' unless @config.is_a?(RunnerConfig)
+      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? }
       @linters = linter_classes.map do |linter_class|

data/lib/erb_lint/runner_config.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'erb_lint/runner_config_resolver'
+require "erb_lint/runner_config_resolver"
 
 module ERBLint
   class RunnerConfig
@@ -9,7 +9,7 @@ module ERBLint
     def initialize(config = nil, file_loader = nil)
       @config = (config || {}).dup.deep_stringify_keys
 
-      resolver.resolve_inheritance_from_gems(@config, @config.delete('inherit_gem'))
+      resolver.resolve_inheritance_from_gems(@config, @config.delete("inherit_gem"))
       resolver.resolve_inheritance(@config, file_loader) if file_loader
       @config.delete("inherit_from")
     end
@@ -24,15 +24,16 @@ module ERBLint
       elsif klass.is_a?(Class) && klass <= ERBLint::Linter
         klass.simple_name
       else
-        raise ArgumentError, 'expected String or linter class'
+        raise ArgumentError, "expected String or linter class"
       end
       linter_klass = LinterRegistry.find_by_name(klass_name)
       raise Error, "#{klass_name}: linter not found (is it loaded?)" unless linter_klass
+
       linter_klass.config_schema.new(config_hash_for_linter(klass_name))
     end
 
     def global_exclude
-      @config['exclude'] || []
+      @config["exclude"] || []
     end
 
     def merge(other_config)
@@ -75,13 +76,13 @@ module ERBLint
     private
 
     def linters_config
-      @config['linters'] || {}
+      @config["linters"] || {}
     end
 
     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"] ||= []
+      config_hash["exclude"].concat(global_exclude) if config_hash["exclude"].is_a?(Array)
       config_hash
     end
 

data/lib/erb_lint/runner_config_resolver.rb

@@ -24,10 +24,11 @@
 module ERBLint
   class RunnerConfigResolver
     def resolve_inheritance(hash, file_loader)
-      inherited_files = Array(hash['inherit_from'])
+      inherited_files = Array(hash["inherit_from"])
       base_configs(file_loader, inherited_files).reverse_each do |base_config|
         base_config.each do |k, v|
           next unless v.is_a?(Hash)
+
           v = v.deep_merge(hash[k]) if hash.key?(k)
           hash[k] = v
         end
@@ -36,12 +37,12 @@ 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'])
+        hash["inherit_from"] = Array(hash["inherit_from"])
         Array(config_path).reverse_each do |path|
           # Put gem configuration first so local configuration overrides it.
-          hash['inherit_from'].unshift(gem_config_path(gem_name, path))
+          hash["inherit_from"].unshift(gem_config_path(gem_name, path))
         end
       end
     end

data/lib/erb_lint/stats.rb

@@ -1,13 +1,15 @@
 # frozen_string_literal: true
+
 module ERBLint
   class Stats
     attr_accessor :ignored,
-                  :found,
-                  :corrected,
-                  :exceptions,
-                  :linters,
-                  :files,
-                  :processed_files
+      :found,
+      :corrected,
+      :exceptions,
+      :linters,
+      :autocorrectable_linters,
+      :files,
+      :processed_files
 
     def initialize(
       ignored: 0,
@@ -15,6 +17,7 @@ module ERBLint
       corrected: 0,
       exceptions: 0,
       linters: 0,
+      autocorrectable_linters: 0,
       files: 0,
       processed_files: {}
     )
@@ -23,6 +26,7 @@ module ERBLint
       @corrected = corrected
       @exceptions = exceptions
       @linters = linters
+      @autocorrectable_linters = autocorrectable_linters
       @files = files
       @processed_files = processed_files
     end

data/lib/erb_lint/utils/block_map.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'better_html/ast/node'
-require 'better_html/test_helper/ruby_node'
+require "better_html/ast/node"
+require "better_html/test_helper/ruby_node"
 
 module ERBLint
   module Utils
@@ -194,6 +194,7 @@ module ERBLint
 
       def find_entry(range)
         return unless range
+
         @entries.find do |entry|
           entry.contains_ruby_range?(Range.new(range.begin_pos, range.end_pos))
         end

data/lib/erb_lint/utils/offset_corrector.rb

@@ -63,8 +63,8 @@ module ERBLint
           node_or_range
         else
           raise TypeError,
-            'Expected a Parser::Source::Range, Comment or ' \
-                        "Rubocop::AST::Node, got #{node_or_range.class}"
+            "Expected a Parser::Source::Range, Comment or " \
+              "Rubocop::AST::Node, got #{node_or_range.class}"
         end
       end
     end

data/lib/erb_lint/utils/ruby_to_erb.rb

@@ -9,14 +9,15 @@ module ERBLint
         def html_options_to_tag_attributes(hash_node)
           hash_node.children.map do |pair_node|
             key_node, value_node = *pair_node
-            key = ruby_to_erb(key_node, '=') { |s| s.tr('_', '-') }
-            value = ruby_to_erb(value_node, '=') { |s| escape_quote(s) }
-            [key, "\"#{value}\""].join('=')
-          end.join(' ')
+            key = ruby_to_erb(key_node, "=") { |s| s.tr("_", "-") }
+            value = ruby_to_erb(value_node, "=") { |s| escape_quote(s) }
+            [key, "\"#{value}\""].join("=")
+          end.join(" ")
         end
 
         def ruby_to_erb(node, indicator = nil, &block)
           return node if node.nil? || node.is_a?(String)
+
           case node.type
           when :str, :sym
             s = node.children.first.to_s
@@ -43,7 +44,7 @@ module ERBLint
         end
 
         def escape_quote(str)
-          str.gsub('"', '"')
+          str.gsub('"', """)
         end
       end
     end

data/lib/erb_lint/utils/severity_levels.rb

@@ -3,10 +3,10 @@
 module ERBLint
   module Utils
     module SeverityLevels
-      SEVERITY_NAMES = %i[info refactor convention warning error fatal].freeze
+      SEVERITY_NAMES = [:info, :refactor, :convention, :warning, :error, :fatal].freeze
 
       SEVERITY_CODE_TABLE = { I: :info, R: :refactor, C: :convention,
-                              W: :warning, E: :error, F: :fatal }.freeze
+                              W: :warning, E: :error, F: :fatal, }.freeze
 
       def severity_level_for_name(name)
         SEVERITY_NAMES.index(name || :error) + 1