erb_lint 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b98507494f8af2a33e0e6fcbf28c48a2d91c78f42273a3cc6c1206578f3a55b0
-  data.tar.gz: c090a633a9d041a6d4d71bc292b1525b3a74dccd61311e0224bc1cbb0d8fea33
+  metadata.gz: f417b343f6b0b891bd095ba568b2d50e78bb7d619b637b3bf2d70f2607f990cc
+  data.tar.gz: 1c080ab44d8238ad32138babe65076626e82974a96a13a1f4041bf7b9568b6ec
 SHA512:
-  metadata.gz: b2ac77d88b7be36010d69c072e3ee72c370edefa1fc3b68135593b5b494da8b0f9eac79e9b5408d10155a007d94948ae6a4b3b279de2541be66f0576abc964a8
-  data.tar.gz: f0be6a75c5060b49a8b7c5e5a5d19adb3222fb580a11c2e2e488e5b83ada00db0c4daee25e99ba5538057c749f5937b80d25a96bda1ed967e6d1baeddf787965
+  metadata.gz: 407d4f4813eaef3b2247357e0af4373cf7511bd8162c5706bc951af05e8577a9584bd5d3dbd00d6dba98bb62aa9d5d58a36a2e484553f7e9ade6af3f95803881
+  data.tar.gz: 7e5fb9bdb8c0cd455279ef3a1c46df75704f6f53eea0ab2eb37b4ff2c5e8292a6ced137b0fbeb6e89c2382d5f1be3220d0e12c4889127cb6d430578f2dbe8945

data/lib/erb_lint/cli.rb

@@ -35,7 +35,11 @@ module ERBLint
       load_config
 
       if !@files.empty? && lint_files.empty?
-        failure!("no files found...\n")
+        if allow_no_files?
+          success!("no files found...\n")
+        else
+          failure!("no files found...\n")
+        end
       elsif lint_files.empty?
         failure!("no files found or given, specify files or config...\n#{option_parser}")
       end
@@ -50,6 +54,7 @@ module ERBLint
       @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
@@ -232,11 +237,7 @@ 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)
@@ -305,6 +306,10 @@ module ERBLint
           @options[:autocorrect] = config
         end
 
+        opts.on("--allow-no-files", "When no matching files found, exit successfully (default: false)") do |config|
+          @options[:allow_no_files] = config
+        end
+
         opts.on(
           "-sFILE",
           "--stdin FILE",
@@ -325,7 +330,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)
@@ -336,5 +341,9 @@ module ERBLint
     def stdin?
       @options[:stdin].present?
     end
+
+    def allow_no_files?
+      @options[:allow_no_files]
+    end
   end
 end

data/lib/erb_lint/corrector.rb

@@ -12,7 +12,7 @@ module ERBLint
 
     def corrections
       @corrections ||= @offenses.map do |offense|
-        offense.linter.autocorrect(@processed_source, offense)
+        offense.linter.autocorrect(@processed_source, offense) if offense.linter.class.support_autocorrect?
       end.compact
     end
 

data/lib/erb_lint/linter.rb

@@ -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

@@ -29,6 +29,7 @@ module ERBLint
       if (extra_keys = given_keys - allowed_keys).any?
         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/linters/allowed_script_type.rb

@@ -31,7 +31,7 @@ module ERBLint
             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
@@ -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/deprecated_classes.rb

@@ -59,6 +59,7 @@ module ERBLint
           tags(processed_source).each do |tag|
             class_value = tag.attributes["class"]&.value
             next unless class_value
+
             class_value.split(" ").each do |class_name|
               yielder.yield(class_name, tag.loc)
             end

data/lib/erb_lint/linters/hard_coded_string.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "set"
 require "better_html/tree/tag"
 require "active_support/core_ext/string/inflections"
@@ -83,6 +84,7 @@ 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: " %>")
@@ -100,6 +102,7 @@ module ERBLint
       def load_corrector
         corrector_name = @config["corrector"].fetch("name") { raise MissingCorrector }
         raise ForbiddenCorrector unless ALLOWED_CORRECTORS.include?(corrector_name)
+
         require @config["corrector"].fetch("path") { raise MissingCorrector }
 
         corrector_name.safe_constantize

data/lib/erb_lint/linters/no_javascript_tag_helper.rb

@@ -22,6 +22,7 @@ module ERBLint
           indicator_node, _, code_node, _ = *erb_node
           indicator = indicator_node&.loc&.source
           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

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(

data/lib/erb_lint/linters/require_input_autocomplete.rb

@@ -63,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
@@ -97,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

data/lib/erb_lint/linters/require_script_nonce.rb

@@ -74,8 +74,8 @@ 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)

data/lib/erb_lint/linters/rubocop.rb

@@ -13,6 +13,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 +25,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
 
@@ -37,6 +39,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
 
@@ -150,40 +153,20 @@ 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")
-        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

data/lib/erb_lint/linters/self_closing_tag.rb

@@ -37,6 +37,7 @@ module ERBLint
           end
 
           next unless @config.enforced_style == :never && tag.self_closing?
+
           end_solidus = tag_node.children.last
           add_offense(
             end_solidus.loc,

data/lib/erb_lint/linters/space_around_erb_tag.rb

@@ -16,6 +16,7 @@ module ERBLint
           indicator_node, ltrim, code_node, rtrim = *erb_node
           indicator = indicator_node&.loc&.source
           next if indicator == "#" || indicator == "%"
+
           code = code_node.children.first
 
           start_spaces = code.match(START_SPACES)&.captures&.first || ""
@@ -23,7 +24,7 @@ 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
@@ -31,7 +32,7 @@ module ERBLint
             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,7 +42,7 @@ 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
@@ -49,7 +50,7 @@ module ERBLint
             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

@@ -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/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,4 +1,5 @@
 # frozen_string_literal: true
+
 require "active_support/core_ext/class"
 require "active_support/core_ext/module/delegation"
 
@@ -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

data/lib/erb_lint/runner_config.rb

@@ -28,6 +28,7 @@ module ERBLint
       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
 

data/lib/erb_lint/runner_config_resolver.rb

@@ -28,6 +28,7 @@ module ERBLint
       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

data/lib/erb_lint/stats.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module ERBLint
   class Stats
     attr_accessor :ignored,
@@ -6,6 +7,7 @@ module ERBLint
       :corrected,
       :exceptions,
       :linters,
+      :autocorrectable_linters,
       :files,
       :processed_files
 
@@ -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

@@ -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

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

data/lib/erb_lint/utils/ruby_to_erb.rb

@@ -17,6 +17,7 @@ module ERBLint
 
         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

data/lib/erb_lint/version.rb

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

metadata

@@ -1,31 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: erb_lint
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Justin Chan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-28 00:00:00.000000000 Z
+date: 2022-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: better_html
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.7
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.7
-- !ruby/object:Gem::Dependency
-  name: html_tokenizer
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: better_html
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.7.1.4
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: smart_properties
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rainbow
+  name: smart_properties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -215,14 +201,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.20
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: ERB lint tool