erb_lint 0.0.30 → 0.0.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b136922bb523d860a4167f2ee6a896c332bf083bbf88fcb30ea983cd28ad1ed5
-  data.tar.gz: 145bd0a1217c31f9e4ccd7221548fef987910c4f026c221fb89fa65b8834d7d7
+  metadata.gz: 1bec7519ea346d89eb70e485c59015ea8faae7f4c85f4e3b450a4f8853eaa9b5
+  data.tar.gz: dba705708221bc3b5a71c57d6d9cbf1db2f7c8afbfaa7ed45fc63e71433383b5
 SHA512:
-  metadata.gz: f3bba6099a1aaf0402d046d0f6acc0a7e17af7d0ca1a05883ae9b6016cf79d141f54976974e5a7035b60cb257f123434c49447c870fdda0a699d1ae62de158cb
-  data.tar.gz: fdab81ad466f3407ca177f60fe727ed7c760c82448d5ba009722fc04175c89f28dc9b43875a90c4c75df600eef0607c7aa7fbdca1da85d1f262cf970cec9cab0
+  metadata.gz: 770cd1f544b749a7210949b1221ec4401349cb30bf9a171c1b7677c3d051f9887e264d62e1c8b86c5b09c593bc96b24b867a35b2bf11f4dfe2d8a17f54332d5c
+  data.tar.gz: ae1f2c592fba2fce5a70eb0620024c49cdca3173388791036bb9e2ed56b3b0cbdf3e6361c0b68c94fc222640aba5422c6fd5c15d8691fa019d0a9cfc038e96a3

data/lib/erb_lint.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'rubocop'
+
 require 'erb_lint/corrector'
 require 'erb_lint/file_loader'
 require 'erb_lint/linter_config'

data/lib/erb_lint/cli.rb

@@ -33,15 +33,16 @@ module ERBLint
     end
 
     def run(args = ARGV)
-      load_options(args)
-      @files = args.dup
+      dupped_args = args.dup
+      load_options(dupped_args)
+      @files = dupped_args
 
       load_config
 
       if !@files.empty? && lint_files.empty?
-        success!("no files found...\n")
+        failure!("no files found...\n")
       elsif lint_files.empty?
-        success!("no files given...\n#{option_parser}")
+        failure!("no files found or given, specify files or config...\n#{option_parser}")
       end
 
       ensure_files_exist(lint_files)
@@ -54,9 +55,12 @@ module ERBLint
         "#{enabled_linter_classes.size} #{'autocorrectable ' if autocorrect?}linters..."
       puts
 
+      runner = ERBLint::Runner.new(file_loader, @config)
+
       lint_files.each do |filename|
+        runner.clear_offenses
         begin
-          run_with_corrections(filename)
+          run_with_corrections(runner, filename)
         rescue => e
           @stats.exceptions += 1
           puts "Exception occured when processing: #{relative_filename(filename)}"
@@ -101,11 +105,9 @@ module ERBLint
       @options[:autocorrect]
     end
 
-    def run_with_corrections(filename)
+    def run_with_corrections(runner, filename)
       file_content = File.read(filename, encoding: Encoding::UTF_8)
 
-      runner = ERBLint::Runner.new(file_loader, @config)
-
       7.times do
         processed_source = ERBLint::ProcessedSource.new(filename, file_content)
         runner.run(processed_source)
@@ -148,14 +150,15 @@ module ERBLint
     def load_config
       if File.exist?(config_filename)
         config = RunnerConfig.new(file_loader.yaml(config_filename), file_loader)
-        @config = RunnerConfig.default.merge(config)
+        @config = RunnerConfig.default_for(config)
       else
         warn(Rainbow("#{config_filename} not found: using default config").yellow)
         @config = RunnerConfig.default
       end
-      @config.merge!(runner_config_override)
     rescue Psych::SyntaxError => e
       failure!("error parsing config: #{e.message}")
+    ensure
+      @config.merge!(runner_config_override)
     end
 
     def file_loader
@@ -167,17 +170,22 @@ module ERBLint
     end
 
     def lint_files
-      if @options[:lint_all]
-        pattern = File.expand_path(DEFAULT_LINT_ALL_GLOB, Dir.pwd)
-        Dir[pattern].select { |filename| !excluded?(filename) }
-      else
-        @files
-          .map { |f| Dir.exist?(f) ? Dir[File.join(f, DEFAULT_LINT_ALL_GLOB)] : f }
-          .map { |f| f.include?('*') ? Dir[f] : f }
-          .flatten
-          .map { |f| File.expand_path(f, Dir.pwd) }
-          .select { |filename| !excluded?(filename) }
-      end
+      @lint_files ||=
+        if @options[:lint_all]
+          pattern = File.expand_path(glob, Dir.pwd)
+          Dir[pattern].select { |filename| !excluded?(filename) }
+        else
+          @files
+            .map { |f| Dir.exist?(f) ? Dir[File.join(f, glob)] : f }
+            .map { |f| f.include?('*') ? Dir[f] : f }
+            .flatten
+            .map { |f| File.expand_path(f, Dir.pwd) }
+            .select { |filename| !excluded?(filename) }
+        end
+    end
+
+    def glob
+      @config.to_hash["glob"] || DEFAULT_LINT_ALL_GLOB
     end
 
     def excluded?(filename)
@@ -250,7 +258,7 @@ module ERBLint
           end
         end
 
-        opts.on("--lint-all", "Lint all files matching #{DEFAULT_LINT_ALL_GLOB}") do |config|
+        opts.on("--lint-all", "Lint all files matching configured glob [default: #{DEFAULT_LINT_ALL_GLOB}]") do |config|
           @options[:lint_all] = config
         end
 
@@ -268,7 +276,7 @@ module ERBLint
           @options[:enabled_linters] = linters
         end
 
-        opts.on("--autocorrect", "Correct offenses that can be corrected automatically (default: false)") do |config|
+        opts.on("-a", "--autocorrect", "Correct offenses automatically if possible (default: false)") do |config|
           @options[:autocorrect] = config
         end
 

data/lib/erb_lint/corrector.rb

@@ -17,11 +17,22 @@ module ERBLint
     end
 
     def corrector
-      RuboCop::Cop::Corrector.new(@processed_source.source_buffer, corrections)
+      BASE.new(@processed_source.source_buffer, corrections)
     end
 
-    def diagnostics
-      corrector.diagnostics
+    if ::RuboCop::Version::STRING.to_f >= 0.87
+      require 'rubocop/cop/legacy/corrector'
+      BASE = ::RuboCop::Cop::Legacy::Corrector
+
+      def diagnostics
+        []
+      end
+    else
+      BASE = ::RuboCop::Cop::Corrector
+
+      def diagnostics
+        corrector.diagnostics
+      end
     end
   end
 end

data/lib/erb_lint/file_loader.rb

@@ -9,8 +9,14 @@ module ERBLint
       @base_path = base_path
     end
 
-    def yaml(filename)
-      YAML.safe_load(read_content(filename), [Regexp, Symbol], [], false, filename) || {}
+    if RUBY_VERSION >= "2.6"
+      def yaml(filename)
+        YAML.safe_load(read_content(filename), permitted_classes: [Regexp, Symbol], filename: filename) || {}
+      end
+    else
+      def yaml(filename)
+        YAML.safe_load(read_content(filename), [Regexp, Symbol], [], false, filename) || {}
+      end
     end
 
     private

data/lib/erb_lint/linters/hard_coded_string.rb

@@ -63,7 +63,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])
+        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: ' %>')
       rescue MissingCorrector, MissingI18nLoadPath

data/lib/erb_lint/linters/no_javascript_tag_helper.rb

@@ -1,5 +1,6 @@
 # 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'

data/lib/erb_lint/linters/rubocop.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'better_html'
-require 'rubocop'
 require 'tempfile'
 require 'erb_lint/utils/offset_corrector'
 
@@ -26,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)
@@ -35,17 +34,29 @@ module ERBLint
         end
       end
 
-      def autocorrect(processed_source, offense)
-        return unless offense.context
-
-        lambda do |corrector|
-          passthrough = Utils::OffsetCorrector.new(
-            processed_source,
-            corrector,
-            offense.context[:offset],
-            offense.context[:bound_range],
-          )
-          offense.context[:rubocop_correction].call(passthrough)
+      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
+
+          lambda do |corrector|
+            corrector.import!(rubocop_correction, offset: offense.context[:offset])
+          end
+        end
+      else
+        def autocorrect(processed_source, offense)
+          return unless offense.context
+
+          lambda do |corrector|
+            passthrough = Utils::OffsetCorrector.new(
+              processed_source,
+              corrector,
+              offense.context[:offset],
+              offense.context[:bound_range],
+            )
+            offense.context[:rubocop_correction].call(passthrough)
+          end
         end
       end
 
@@ -62,22 +73,23 @@ module ERBLint
         original_source = code_node.loc.source
         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}"
 
         source = rubocop_processed_source(aligned_source, processed_source.filename)
         return unless source.valid_syntax?
 
-        team = build_team
-        team.inspect_file(source)
-        team.cops.each do |cop|
-          correction_offset = 0
-          cop.offenses.reject(&:disabled?).each do |rubocop_offense|
-            if rubocop_offense.corrected?
-              correction = cop.corrections[correction_offset]
-              correction_offset += 1
-            end
+        activate_team(processed_source, source, offset, code_node, build_team)
+      end
+
+      if ::RuboCop::Version::STRING.to_f >= 0.87
+        def activate_team(processed_source, source, offset, code_node, team)
+          report = team.investigate(source)
+          report.offenses.each do |rubocop_offense|
+            next if rubocop_offense.disabled?
+
+            correction = rubocop_offense.corrector if rubocop_offense.corrected?
 
-            offset = code_node.loc.begin_pos - alignment_column
             offense_range = processed_source
               .to_source_range(rubocop_offense.location)
               .offset(offset)
@@ -85,6 +97,25 @@ module ERBLint
             add_offense(rubocop_offense, offense_range, correction, offset, code_node.loc.range)
           end
         end
+      else
+        def activate_team(processed_source, source, offset, code_node, team)
+          team.inspect_file(source)
+          team.cops.each do |cop|
+            correction_offset = 0
+            cop.offenses.reject(&:disabled?).each do |rubocop_offense|
+              if rubocop_offense.corrected?
+                correction = cop.corrections[correction_offset]
+                correction_offset += 1
+              end
+
+              offense_range = processed_source
+                .to_source_range(rubocop_offense.location)
+                .offset(offset)
+
+              add_offense(rubocop_offense, offense_range, correction, offset, code_node.loc.range)
+            end
+          end
+        end
       end
 
       def tempfile_from(filename, content)
@@ -97,7 +128,7 @@ module ERBLint
       end
 
       def rubocop_processed_source(content, filename)
-        RuboCop::ProcessedSource.new(
+        ::RuboCop::ProcessedSource.new(
           content,
           @rubocop_config.target_ruby_version,
           filename
@@ -106,15 +137,15 @@ module ERBLint
 
       def cop_classes
         if @only_cops.present?
-          selected_cops = RuboCop::Cop::Cop.all.select { |cop| cop.match?(@only_cops) }
-          RuboCop::Cop::Registry.new(selected_cops)
+          selected_cops = ::RuboCop::Cop::Cop.all.select { |cop| cop.match?(@only_cops) }
+          ::RuboCop::Cop::Registry.new(selected_cops)
         else
-          RuboCop::Cop::Registry.new(RuboCop::Cop::Cop.all)
+          ::RuboCop::Cop::Registry.new(::RuboCop::Cop::Cop.all)
         end
       end
 
       def build_team
-        RuboCop::Cop::Team.new(
+        ::RuboCop::Cop::Team.new(
           cop_classes,
           @rubocop_config,
           extra_details: true,
@@ -129,7 +160,7 @@ module ERBLint
         resolve_inheritance(hash, inherit_from)
 
         tempfile_from('.erblint-rubocop', hash.to_yaml) do |tempfile|
-          RuboCop::ConfigLoader.load_file(tempfile.path)
+          ::RuboCop::ConfigLoader.load_file(tempfile.path)
         end
       end
 
@@ -137,7 +168,7 @@ module ERBLint
         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)
+            hash[k] = hash.key?(k) ? ::RuboCop::ConfigLoader.merge(v, hash[k]) : v if v.is_a?(Hash)
           end
         end
       end
@@ -146,7 +177,7 @@ module ERBLint
         regex = URI::DEFAULT_PARSER.make_regexp(%w(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))
+            ::RuboCop::ConfigLoader.load_file(::RuboCop::RemoteConfig.new(base_name, Dir.pwd))
           else
             config_from_hash(@file_loader.yaml(base_name))
           end

data/lib/erb_lint/linters/rubocop_text.rb

@@ -28,9 +28,9 @@ module ERBLint
       end
 
       def cop_classes
-        selected_cops = RuboCop::Cop::Cop.all.select { |cop| cop.match?(@only_cops) }
+        selected_cops = ::RuboCop::Cop::Cop.all.select { |cop| cop.match?(@only_cops) }
 
-        RuboCop::Cop::Registry.new(selected_cops)
+        ::RuboCop::Cop::Registry.new(selected_cops)
       end
     end
   end

data/lib/erb_lint/runner_config.rb

@@ -45,24 +45,30 @@ module ERBLint
     end
 
     class << self
-      def default
+      def default(default_enabled: nil)
+        default_enabled = default_enabled.nil? ? true : default_enabled
         new(
           linters: {
-            AllowedScriptType: { enabled: true },
-            ClosingErbTagIndent: { enabled: true },
-            ExtraNewline: { enabled: true },
-            FinalNewline: { enabled: true },
-            NoJavascriptTagHelper: { enabled: true },
-            ParserErrors: { enabled: true },
-            RightTrim: { enabled: true },
-            SelfClosingTag: { enabled: true },
-            SpaceAroundErbTag: { enabled: true },
-            SpaceIndentation: { enabled: true },
-            SpaceInHtmlTag: { enabled: true },
-            TrailingWhitespace: { enabled: true },
+            AllowedScriptType: { enabled: default_enabled },
+            ClosingErbTagIndent: { enabled: default_enabled },
+            ExtraNewline: { enabled: default_enabled },
+            FinalNewline: { enabled: default_enabled },
+            NoJavascriptTagHelper: { enabled: default_enabled },
+            ParserErrors: { enabled: default_enabled },
+            RightTrim: { enabled: default_enabled },
+            SelfClosingTag: { enabled: default_enabled },
+            SpaceAroundErbTag: { enabled: default_enabled },
+            SpaceIndentation: { enabled: default_enabled },
+            SpaceInHtmlTag: { enabled: default_enabled },
+            TrailingWhitespace: { enabled: default_enabled },
           },
         )
       end
+
+      def default_for(config)
+        default_linters_enabled = config.to_hash.dig("EnableDefaultLinters")
+        default(default_enabled: default_linters_enabled).merge(config)
+      end
     end
 
     private

data/lib/erb_lint/utils/offset_corrector.rb

@@ -38,7 +38,9 @@ module ERBLint
         @corrector.remove_trailing(range_with_offset(range), size)
       end
 
-      def range_with_offset(range)
+      def range_with_offset(node_or_range)
+        range = to_range(node_or_range)
+
         @processed_source.to_source_range(
           bound(@offset + range.begin_pos)..bound(@offset + (range.end_pos - 1))
         )
@@ -50,6 +52,21 @@ module ERBLint
           @bound_range.max,
         ].min
       end
+
+      private
+
+      def to_range(node_or_range)
+        case node_or_range
+        when ::RuboCop::AST::Node, ::Parser::Source::Comment
+          node_or_range.loc.expression
+        when ::Parser::Source::Range
+          node_or_range
+        else
+          raise TypeError,
+            'Expected a Parser::Source::Range, Comment or ' \
+                        "Rubocop::AST::Node, got #{node_or_range.class}"
+        end
+      end
     end
   end
 end

data/lib/erb_lint/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ERBLint
-  VERSION = '0.0.30'
+  VERSION = '0.0.35'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erb_lint
 version: !ruby/object:Gem::Version
-  version: 0.0.30
+  version: 0.0.35
 platform: ruby
 authors:
 - Justin Chan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-01 00:00:00.000000000 Z
+date: 2020-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: better_html
@@ -44,14 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.51'
+        version: '0.79'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.51'
+        version: '0.79'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.1.4
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-shopify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ERB Linter tool.
 email:
 - justin.the.c@gmail.com
@@ -167,7 +195,8 @@ files:
 homepage: https://github.com/Shopify/erb-lint
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -176,7 +205,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="