pronto-rubocop 0.10.0 → 0.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '061479d3c9326adbd73af0ee8e79c5a1f46ed3aa8f8ea8dfa7b7946a899e4aff'
-  data.tar.gz: 22ab34372429508f391103d663cb462650fac8c08110771ff897400a22662a42
+  metadata.gz: 9966d2906f3d406926909048fe99e8814afa4b58e4a54963553652a1d502092b
+  data.tar.gz: d8be4f7a23e51f8c98debc7a41440289f34b2b11c3a52ae7af5507e8e628ff70
 SHA512:
-  metadata.gz: c921d367340e6b725fd6f5c057c0d7ba3fbdab8b03f1ea5a56a559a6336ca646fca67f0f4f6467822db4c300779a015565fb48cf099bf22a38a549f6af8f846e
-  data.tar.gz: f1711fd2fb7c1bdd9c2374307879eb91e3af059928668a92864def3fea788f3f884075c08b9416623e770aa6309b13a6088d0308a4451047ee5ef529dea55647
+  metadata.gz: a69bc7d7de258f3bfe7b000b5d7a0c1dde7fa1075d0d665d7e695cf325fe6c4ff771178c7bc70b24c77175361fbd0320d33daa6d68415ee529efd3446c9b778f
+  data.tar.gz: 32042282d15f1e5b65c34efb771918f19a6db84dbcc4e6ce8d04dd54b21dee5131bc5f4a6893832eb30b2fe99ffff07ba021a338c0dbc999b57c9dd2ebc02d90

data/.github/CODEOWNERS

@@ -0,0 +1,3 @@
+# Order is important. The last matching pattern takes the most precedence.
+# Default owners for everything in the repo.
+* @prontolabs/core

data/.github/workflows/checks.yml

@@ -0,0 +1,46 @@
+name: Checks
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+  workflow_dispatch:
+  schedule:
+    - cron: '0 6 * * 1' # 6am every Monday
+
+jobs:
+  unit_tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['2.4', '2.5', '2.6', '2.7', '3.0']
+        rubocop: ['0.63.1', '0.81.0', '0.84.0', '0.85.0', '0.86.0', '0.87.0', '< 1.0', '1.0.0', '1.29.1', '1.30.0', '< 2.0']
+        include:
+          - ruby: '2.3'
+            rubocop: '0.63.1'
+          - ruby: '2.3'
+            rubocop: '0.81.0'
+        exclude:
+          - ruby: '2.4'
+            rubocop: '1.29.1'
+          - ruby: '2.4'
+            rubocop: '1.30.0'
+          - ruby: '2.5'
+            rubocop: '1.29.1'
+          - ruby: '2.5'
+            rubocop: '1.30.0'
+      fail-fast: false
+    steps:
+    - uses: actions/checkout@v2
+    - name: use specific rubocop version
+      run: echo "gem 'rubocop', '${{ matrix.rubocop }}'" > Gemfile.local
+    - name: use specific rubocop-ast version (if required)
+      if: matrix.rubocop == '0.84.0' || matrix.rubocop == '0.85.0'
+      run: echo "gem 'rubocop-ast', '< 0.7.0'" >> Gemfile.local
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: rake spec
+      run: bundle exec rake spec

data/README.md

@@ -1,12 +1,54 @@
-# Pronto runner for Rubocop
+# Pronto runner for RuboCop
 
 [![Code Climate](https://codeclimate.com/github/prontolabs/pronto-rubocop.png)](https://codeclimate.com/github/prontolabs/pronto-rubocop)
 [![Build Status](https://travis-ci.org/prontolabs/pronto-rubocop.svg?branch=master)](https://travis-ci.org/prontolabs/pronto-rubocop)
 [![Gem Version](https://badge.fury.io/rb/pronto-rubocop.png)](http://badge.fury.io/rb/pronto-rubocop)
 
-Pronto runner for [Rubocop](https://github.com/bbatsov/rubocop), ruby code analyzer. [What is Pronto?](https://github.com/prontolabs/pronto)
+Pronto runner for [RuboCop](https://github.com/bbatsov/rubocop), ruby code
+analyzer. [What is Pronto?](https://github.com/prontolabs/pronto)
 
 ## Configuration
 
-Configuring Rubocop via .rubocop.yml will work just fine with pronto-rubocop.
-You can also specify a custom `.rubocop.yml` location with the environment variable `RUBOCOP_CONFIG`
+Configuring RuboCop via `.rubocop.yml` will work just fine with
+`pronto-rubocop`.
+
+You can also specify a custom `.rubocop.yml` location with the environment
+variable `RUBOCOP_CONFIG`.
+
+You can also provide additional configuration via `.pronto.yml`:
+
+```yml
+rubocop:
+  # Map of RuboCop severity level to Pronto severity level
+  severities:
+    refactor: info
+    warning: error
+
+  # Enable suggestions
+  suggestions: true
+```
+
+## Suggestions
+
+When suggestions are enabled, the messages will include a line suggesting
+what to change, using [GitHub's](https://twitter.com/wa7son/status/1052326282900443137)
+syntax on Pull Request reviews, that can be approved in one click right from
+the Pull Request.
+
+For example:
+
+![GitHub screenshot with suggestion](https://user-images.githubusercontent.com/132/50402757-1bd75b80-0799-11e9-809f-8b8a23ed33f6.png)
+
+## RuboCop versions
+
+If you need to use RuboCop v0.84.0 or v0.85.x, you'll need to ensure that
+you've also need to add `gem 'rubocop-ast', '< 0.7.0'` to your Gemfile as
+these were the first versions to use rubocop-ast, and unfortunately the
+dependency was loose enough that rubocop-ast versions >= 0.7.0 were allowed,
+which causes `require 'rubocop'` to fail with
+```
+  NoMethodError:
+    undefined method `join' for #<Set: {:==, :===, :!=, :<=, :>=, :>, :<}>
+  in rubocop-0.84.0/lib/rubocop/cop/style/redundant_conditional.rb:57:in `<class:RedundantConditional>'
+```
+This is due to https://github.com/rubocop-hq/rubocop-ast/issues/22

data/lib/pronto/rubocop/offense_line.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+module Pronto
+  class Rubocop < Runner
+    class OffenseLine
+      def initialize(patch_cop, offense, line)
+        @patch_cop = patch_cop
+        @offense = offense
+        @line = line
+      end
+
+      def message
+        Message.new(path, line, level, message_text, nil, Pronto::Rubocop)
+      end
+
+      private
+
+      attr_reader :patch_cop, :offense, :line
+
+      def path
+        line.patch.delta.new_file[:path]
+      end
+
+      def processed_source
+        patch_cop.processed_source
+      end
+
+      def message_text
+        return offense.message unless suggestion_text
+
+        "#{offense.message}\n\n```suggestion\n#{suggestion_text}```"
+      end
+
+      def suggestion_text
+        return unless patch_cop.runner.pronto_rubocop_config['suggestions']
+        return if corrections_count.zero?
+        return if differing_lines_count != corrections_count
+
+        @suggestion_text ||= corrected_lines[offense.line - 1]
+      end
+
+      def corrected_lines
+        @corrected_lines ||= corrector.rewrite.lines
+      end
+
+      def differing_lines_count
+        original_lines.each_with_index.count do |line, index|
+          line != corrected_lines[index]
+        end
+      end
+
+      def original_lines
+        processed_source.lines.join("\n").lines
+      end
+
+      if ::RuboCop::Cop::Team.respond_to?(:mobilize) && ::RuboCop::Cop::Team.public_method_defined?(:investigate)
+        # rubocop >= 0.87.0 has both mobilize and public investigate method
+        MOBILIZE = :mobilize
+        # rubocop 1.30.0 renamed from auto_correct to autocorrect
+        AUTOCORRECT = Gem::Version.new(::RuboCop::Version::STRING) >= Gem::Version.new("1.30.0") ? :autocorrect : :auto_correct
+
+        def report
+          @report ||= autocorrect_team.investigate(processed_source).cop_reports.first
+        end
+
+        def corrector
+          report.corrector
+        end
+
+        def corrections_count
+          # Some lines may contain more than one offense
+          report.offenses.map(&:line).uniq.size
+        end
+      else
+        # rubocop 0.85.x and 0.86.0 have mobilize, older versions don't
+        MOBILIZE = ::RuboCop::Cop::Team.respond_to?(:mobilize) ? :mobilize : :new
+        AUTOCORRECT = :auto_correct
+
+        def corrector
+          @corrector ||= begin
+            autocorrect_team.inspect_file(processed_source)
+            corrector = RuboCop::Cop::Corrector.new(processed_source.buffer)
+            corrector.corrections.concat(autocorrect_team.cops.first.corrections)
+            corrector
+          end
+        end
+
+        def corrections_count
+          @corrections_count ||= corrector.corrections.count
+        end
+      end
+
+      def autocorrect_team
+        @autocorrect_team ||=
+          ::RuboCop::Cop::Team.send(MOBILIZE,
+                                    ::RuboCop::Cop::Registry.new([cop_class]),
+                                    patch_cop.rubocop_config,
+                                    **{ AUTOCORRECT => true, stdin: true })
+      end
+
+      def cop_class
+        patch_cop.registry.find_by_cop_name(offense.cop_name)
+      end
+
+      def level
+        severities.fetch(offense.severity.name)
+      end
+
+      def severities
+        @severities ||= DEFAULT_SEVERITIES.merge(config_severities)
+      end
+
+      def config_severities
+        patch_cop
+          .runner
+          .pronto_rubocop_config
+          .fetch('severities', {})
+          .map { |k, v| [k.to_sym, v.to_sym] }
+          .to_h
+      end
+
+      DEFAULT_SEVERITIES = {
+        info: :info,
+        refactor: :warning,
+        convention: :warning,
+        warning: :warning,
+        error: :error,
+        fatal: :fatal
+      }.freeze
+
+      private_constant :DEFAULT_SEVERITIES
+    end
+  end
+end

data/lib/pronto/rubocop/patch_cop.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 module Pronto
   class Rubocop < Runner
     class PatchCop
+      attr_reader :runner
+
       def initialize(patch, runner)
         @patch = patch
         @runner = runner
@@ -9,21 +13,40 @@ module Pronto
       def messages
         return [] unless valid?
 
-        offences.map do |offence|
+        offenses.flat_map do |offense|
           patch
             .added_lines
-            .select { |line| line.new_lineno == offence.line }
-            .map { |line| new_message(offence, line) }
+            .select { |line| line.new_lineno == offense.line }
+            .map { |line| OffenseLine.new(self, offense, line).message }
+        end
+      end
+
+      def processed_source
+        @processed_source ||= ::RuboCop::ProcessedSource.from_file(
+          path,
+          rubocop_config.target_ruby_version
+        )
+      end
+
+      def registry
+        @registry ||= ::RuboCop::Cop::Registry.new(RuboCop::Cop::Cop.all)
+      end
+
+      def rubocop_config
+        @rubocop_config ||= begin
+          store = ::RuboCop::ConfigStore.new
+          store.for(path)
         end
       end
 
       private
 
-      attr_reader :patch, :runner
+      attr_reader :patch
 
       def valid?
-        return false if config.file_to_exclude?(path)
-        return true if config.file_to_include?(path)
+        return false if rubocop_config.file_to_exclude?(path)
+        return true if rubocop_config.file_to_include?(path)
+
         true
       end
 
@@ -31,15 +54,7 @@ module Pronto
         @path ||= patch.new_file_full_path.to_s
       end
 
-      def config
-        @config ||= begin
-          store = ::RuboCop::ConfigStore.new
-          store.options_config = ENV['RUBOCOP_CONFIG'] if ENV['RUBOCOP_CONFIG']
-          store.for(path)
-        end
-      end
-
-      def offences
+      def offenses
         team
           .inspect_file(processed_source)
           .sort
@@ -47,32 +62,13 @@ module Pronto
       end
 
       def team
-        @team ||= ::RuboCop::Cop::Team.new(registry, config)
-      end
-
-      def registry
-        @registry ||= ::RuboCop::Cop::Registry.new(RuboCop::Cop::Cop.all)
-      end
-
-      def processed_source
-        @processed_source ||=
-          ::RuboCop::ProcessedSource.from_file(path, config.target_ruby_version)
-      end
-
-      def new_message(offence, line)
-        path = line.patch.delta.new_file[:path]
-        level = level(offence.severity.name)
-
-        Message.new(path, line, level, offence.message, nil, runner.class)
-      end
-
-      def level(severity)
-        case severity
-        when :refactor, :convention
-          :warning
-        when :warning, :error, :fatal
-          severity
-        end
+        @team ||=
+          if ::RuboCop::Cop::Team.respond_to?(:mobilize)
+            # rubocop v0.85.0 and later
+            ::RuboCop::Cop::Team.mobilize(registry, rubocop_config)
+          else
+            ::RuboCop::Cop::Team.new(registry, rubocop_config)
+          end
       end
     end
   end

data/lib/pronto/rubocop/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Pronto
   module RubocopVersion
-    VERSION = '0.10.0'.freeze
+    VERSION = '0.11.2'
   end
 end

data/lib/pronto/rubocop.rb

@@ -1,14 +1,20 @@
+# frozen_string_literal: true
+
 require 'pronto'
 require 'rubocop'
 require 'pronto/rubocop/patch_cop'
+require 'pronto/rubocop/offense_line'
 
 module Pronto
   class Rubocop < Runner
     def run
       ruby_patches
-        .select { |patch| patch.additions > 0 }
-        .map { |patch| PatchCop.new(patch, self).messages }
-        .flatten
+        .select { |patch| patch.additions.positive? }
+        .flat_map { |patch| PatchCop.new(patch, self).messages }
+    end
+
+    def pronto_rubocop_config
+      @pronto_rubocop_config ||= Pronto::ConfigFile.new.to_h['rubocop'] || {}
     end
   end
 end

data/pronto-rubocop.gemspec

@@ -1,6 +1,6 @@
-# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 
-$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 require 'pronto/rubocop/version'
 require 'English'
 
@@ -32,8 +32,8 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = ['LICENSE', 'README.md']
   s.require_paths = ['lib']
 
-  s.add_runtime_dependency('rubocop', '~> 0.50', '>= 0.49.1')
-  s.add_runtime_dependency('pronto', '~> 0.10.0')
+  s.add_runtime_dependency('pronto', '~> 0.11.0')
+  s.add_runtime_dependency('rubocop', '>= 0.63.1', '< 2.0')
   s.add_development_dependency('rake', '~> 12.0')
   s.add_development_dependency('rspec', '~> 3.4')
   s.add_development_dependency('rspec-its', '~> 1.2')

metadata

@@ -1,49 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: pronto-rubocop
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.2
 platform: ruby
 authors:
 - Mindaugas Mozūras
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-03 00:00:00.000000000 Z
+date: 2022-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: pronto
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.49.1
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.49.1
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
-  name: pronto
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -94,9 +94,12 @@ extra_rdoc_files:
 - LICENSE
 - README.md
 files:
+- ".github/CODEOWNERS"
+- ".github/workflows/checks.yml"
 - LICENSE
 - README.md
 - lib/pronto/rubocop.rb
+- lib/pronto/rubocop/offense_line.rb
 - lib/pronto/rubocop/patch_cop.rb
 - lib/pronto/rubocop/version.rb
 - pronto-rubocop.gemspec
@@ -119,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Pronto runner for Rubocop, ruby code analyzer