danger-rubocop 0.6.1 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 541340d181c21fb3a3c0f3ca5274df9a89610380ecf1572453cfbfd480e07f4a
-  data.tar.gz: 740f0a0e8da3d6c77c62a888984ec5636eddca707806c09674366bcc89aafe24
+  metadata.gz: bb5d7eb8397ac2e653dbb40f1d36578709c9167d1c58edcf03755317bae9a1d9
+  data.tar.gz: 29663b37df5566b315562381f690738a96fde57537be19a3aaa2c6ac9d227519
 SHA512:
-  metadata.gz: 2bde76c6fa48ecc75aa06805c5d04ed84504d15def8685e05ffd62cb1e50aa417fb55e536c621cb2cff0af1e93222652436462d7719f5d5aa39a5b2e4e8d32de
-  data.tar.gz: 909df7927367d9fc75389ffdfef64764ae38165828c82e40500667f167912d408000c03fcf6eb21241ec08c92add6dc4235ccfd4589b88fe1267925d9b335e2e
+  metadata.gz: 7786b81d1acd3476b3a64c672c9a1164bda1f427c29e1379a84bed948a6d46eb1dfe506d7b1316246d61c4a710508e1c15b5378fbaa51de111fd9aba78b6a0dc
+  data.tar.gz: e7e7aa14b45ad941d1be7a1e39f070a1f01e124c97e3eb2c099cd8934ca113018a834a5e51fa71b765a82807b3cbda1e6a25f4a7111cc50f89138be17df1048e

data/.circleci/config.yml

@@ -0,0 +1,30 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.6
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "Gemfile.lock" }}
+            # fallback to using the latest cache if no exact match is found
+            - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      - run:
+          name: run tests
+          command: bundle exec rake spec

data/Gemfile.lock

@@ -1,18 +1,18 @@
 PATH
   remote: .
   specs:
-    danger-rubocop (0.6.0)
+    danger-rubocop (0.8.1)
       danger
       rubocop
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
-    ast (2.3.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.1)
     bacon (1.2.0)
-    claide (1.0.2)
+    claide (1.0.3)
     claide-plugins (0.9.2)
       cork
       nap
@@ -21,26 +21,28 @@ GEM
     colored2 (3.1.2)
     cork (0.3.0)
       colored2 (~> 3.1)
-    danger (5.5.5)
+    danger (8.0.4)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
       cork (~> 0.1)
-      faraday (~> 0.9)
-      faraday-http-cache (~> 1.0)
-      git (~> 1)
-      kramdown (~> 1.5)
+      faraday (>= 0.9.0, < 2.0)
+      faraday-http-cache (~> 2.0)
+      git (~> 1.7)
+      kramdown (~> 2.0)
+      kramdown-parser-gfm (~> 1.0)
       no_proxy_fix
       octokit (~> 4.7)
       terminal-table (~> 1)
     diff-lcs (1.2.5)
-    faraday (0.13.1)
+    faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
-    faraday-http-cache (1.3.1)
-      faraday (~> 0.8)
+    faraday-http-cache (2.2.0)
+      faraday (>= 0.8)
     ffi (1.9.10)
     formatador (0.2.5)
-    git (1.3.0)
+    git (1.7.0)
+      rchardet (~> 1.8)
     guard (2.14.0)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
@@ -55,7 +57,10 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    kramdown (1.16.2)
+    kramdown (2.3.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
     listen (3.0.7)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9.7)
@@ -66,32 +71,35 @@ GEM
       metaclass (~> 0.0.1)
     mocha-on-bacon (0.2.2)
       mocha (>= 0.13.0)
-    multipart-post (2.0.0)
+    multipart-post (2.1.1)
     nap (1.1.0)
     nenv (0.3.0)
     no_proxy_fix (0.1.2)
     notiffany (0.1.0)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    octokit (4.8.0)
+    octokit (4.18.0)
+      faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
-    parallel (1.12.1)
-    parser (2.4.0.2)
-      ast (~> 2.3)
-    powerpack (0.1.1)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
     prettybacon (0.0.2)
       bacon (~> 1.2)
     pry (0.10.3)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    public_suffix (3.0.1)
+    public_suffix (4.0.5)
     rainbow (3.0.0)
-    rake (10.5.0)
+    rake (13.0.1)
     rb-fsevent (0.9.7)
     rb-inotify (0.9.7)
       ffi (>= 0.5.0)
+    rchardet (1.8.0)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
     rspec (3.4.0)
       rspec-core (~> 3.4.0)
       rspec-expectations (~> 3.4.0)
@@ -105,24 +113,28 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.4.0)
     rspec-support (3.4.1)
-    rubocop (0.52.0)
+    rubocop (0.89.1)
       parallel (~> 1.10)
-      parser (>= 2.4.0.2, < 3.0)
-      powerpack (~> 0.1)
+      parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.3.0, < 1.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.9.0)
-    sawyer (0.8.1)
-      addressable (>= 2.3.5, < 2.6)
-      faraday (~> 0.8, < 1.0)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
+    ruby-progressbar (1.10.1)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
     shellany (0.0.1)
     slop (3.6.0)
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
     thor (0.19.1)
-    unicode-display_width (1.3.0)
-    yard (0.9.12)
+    unicode-display_width (1.7.0)
+    yard (0.9.20)
 
 PLATFORMS
   ruby
@@ -138,7 +150,7 @@ DEPENDENCIES
   mocha-on-bacon
   prettybacon
   pry
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.4)
   yard
 
@@ -146,4 +158,4 @@ RUBY VERSION
    ruby 2.3.1p112
 
 BUNDLED WITH
-   1.15.4
+   1.17.3

data/README.md

@@ -30,6 +30,12 @@ public_files = (git.modified_files + git.added_files).select { |path| path.inclu
 rubocop.lint public_files
 ```
 
+> Submit comments only for changed lines
+
+```ruby
+github.dismiss_out_of_range_messages
+rubocop.lint inline_comment: true
+```
 
 #### Methods
 
@@ -37,7 +43,7 @@ rubocop.lint public_files
 
 Runs Ruby files through Rubocop. Generates a `markdown` list of warnings.
 
-This method accepts configuration hash.
+This method accepts a configuration hash.
 The following keys are supported:
 
 * `files`: array of file names or glob patterns to determine files to lint
@@ -47,6 +53,10 @@ The following keys are supported:
 * `inline_comment`: pass `true` to comment inline of the diffs.
 * `fail_on_inline_comment`: pass `true` to use `fail` instead of `warn` on inline comment.
 * `report_danger`: pass true to report errors to Danger, and break CI.
+* `config`: path to the `.rubocop.yml` file.
+* `only_report_new_offenses`: pass `true` to only report offenses that are in current user's scope.
+   Note that this won't mark offenses for _Metrics/XXXLength_ if you add lines to an already existing scope.
+* `include_cop_names`: Prepends cop names to the output messages. Example: "Layout/EmptyLinesAroundBlockBody: Extra empty line detected at block body end."
 
 
 Passing `files` as only argument is also supported for backward compatibility.

data/danger-rubocop.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
 
   # General ruby development
   spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
 
   # For validating the plugin lints
   spec.add_development_dependency 'yard'

data/lib/danger_plugin.rb

@@ -30,40 +30,71 @@ module Danger
       config = config.is_a?(Hash) ? config : { files: config }
       files = config[:files]
       force_exclusion = config[:force_exclusion] || false
-
+      config_path = config[:config]
       report_danger = config[:report_danger] || false
+      only_report_new_offenses = config[:only_report_new_offenses] || false
       inline_comment = config[:inline_comment] || false
       fail_on_inline_comment = config[:fail_on_inline_comment] || false
+      include_cop_names = config[:include_cop_names] || false
 
       files_to_lint = fetch_files_to_lint(files)
-      files_to_report = rubocop(files_to_lint, force_exclusion)
+      files_to_report = rubocop(files_to_lint, force_exclusion, only_report_new_offenses, config_path: config_path)
 
       return if files_to_report.empty?
       return report_failures files_to_report if report_danger
 
       if inline_comment
-        add_violation_for_each_line(files_to_report, fail_on_inline_comment)
+        add_violation_for_each_line(files_to_report, fail_on_inline_comment, include_cop_names: include_cop_names)
       else
-        markdown offenses_message(files_to_report)
+        markdown offenses_message(files_to_report, include_cop_names: include_cop_names)
       end
-
     end
 
     private
 
-    def rubocop(files_to_lint, force_exclusion)
-      base_command = 'rubocop -f json'
-      base_command << ' --force-exclusion' if force_exclusion
+    def rubocop(files_to_lint, force_exclusion, only_report_new_offenses, config_path: nil)
+      base_command = ['rubocop', '-f', 'json']
+      base_command.concat(['--force-exclusion']) if force_exclusion
+      base_command.concat(['--config', config_path.shellescape]) unless config_path.nil?
 
-      rubocop_output = `#{'bundle exec ' if File.exist?('Gemfile')}#{base_command} #{files_to_lint}`
+      rubocop_output = `#{'bundle exec ' if File.exist?('Gemfile')}#{base_command.join(' ')} #{files_to_lint}`
 
       return [] if rubocop_output.empty?
 
-      JSON.parse(rubocop_output)['files']
-        .select { |f| f['offenses'].any? }
+      files = JSON.parse(rubocop_output)['files']
+
+      filter_out_offenses(files) if only_report_new_offenses
+
+      files.select { |f| f['offenses'].any? }
+    end
+
+    def filter_out_offenses(files)
+      files.each do |file|
+        added_lines = added_lines(file['path']).to_set
+        file['offenses'].select! do |offense|
+          added_lines.include?(offense['location']['line'])
+        end
+      end
+    end
+
+    def added_lines(path)
+      git.diff_for_file(path)
+         .patch
+         .split("\n@@")
+         .tap(&:shift)
+         .flat_map do |chunk|
+           first_line, *diff = chunk.split("\n")
+           # Get start from diff.
+           lineno = first_line.match(/\+(\d+),(\d+)/).captures.first.to_i
+           diff.each_with_object([]) do |current_line, added_lines|
+             added_lines << lineno if current_line.start_with?('+')
+             lineno += 1 unless current_line.start_with?('-')
+             added_lines
+           end
+         end
     end
 
-    def offenses_message(offending_files)
+    def offenses_message(offending_files, include_cop_names: false)
       require 'terminal-table'
 
       message = "### Rubocop violations\n\n"
@@ -72,7 +103,9 @@ module Danger
         style: { border_i: '|' },
         rows: offending_files.flat_map do |file|
           file['offenses'].map do |offense|
-            [file['path'], offense['location']['line'], offense['message']]
+            offense_message = offense['message']
+            offense_message = offense['cop_name'] + ': ' + offense_message if include_cop_names
+            [file['path'], offense['location']['line'], offense_message]
           end
         end
       ).to_s
@@ -87,11 +120,13 @@ module Danger
       end
     end
 
-    def add_violation_for_each_line(offending_files, fail_on_inline_comment)
+    def add_violation_for_each_line(offending_files, fail_on_inline_comment, include_cop_names: false)
       offending_files.flat_map do |file|
         file['offenses'].map do |offense|
+          offense_message = offense['message']
+          offense_message = offense['cop_name'] + ': ' + offense_message if include_cop_names
           arguments = [
-            offense['message'],
+            offense_message,
             {
               file: file['path'],
               line: offense['location']['line']

data/lib/version.rb

@@ -1,3 +1,3 @@
 module DangerRubocop
-  VERSION = '0.6.1'.freeze
+  VERSION = '0.8.1'.freeze
 end

data/spec/danger_plugin_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../spec_helper', __FILE__)
+require File.expand_path('spec_helper', __dir__)
 
 module Danger
   describe DangerRubocop do
@@ -12,6 +12,103 @@ module Danger
         @rubocop = testing_dangerfile.rubocop
       end
 
+      describe "#filter_out_offenses" do
+        let(:files_within_pr) do
+          [
+            {
+              'path' => 'lib/version.rb',
+              'offenses' => [
+                {
+                  'message' => 'No.',
+                  'location' => { 'line' => 41 }
+                }
+              ]
+            }
+          ]
+        end
+
+        let(:files_outside_pr) do
+          [
+            {
+              'path' => 'lib/version.rb',
+              'offenses' => [
+                {
+                  'message' => 'No.',
+                  'location' => { 'line' => 20 }
+                }
+              ]
+            }
+          ]
+        end
+        subject { @rubocop }
+
+        before do
+          allow(@rubocop.git).to receive(:diff_for_file).with('lib/version.rb') do
+            instance_double('Git::Diff::DiffFile', patch: <<~DIFF)
+            diff --git a/lib/version.rb b/lib/version.rb
+            index 66d3a986..5e8074a8 100644
+            --- a/lib/version.rb
+            +++ b/lib/version.rb
+            @@ -32,4 +40,3 @@
+             line 1
+            -removed
+            -line 2 old version
+            +line 2 with offense
+             line 3
+            DIFF
+          end
+        end
+
+        it 'filters out offenses not in the pr' do
+          p described_class
+          expect(subject.send(:filter_out_offenses, files_outside_pr)).to eq(
+            [
+              {
+                'path' => 'lib/version.rb',
+                'offenses' => []
+              }
+            ]
+          )
+        end
+
+        it 'keeps offenses in the pr' do
+          expect(subject.send(:filter_out_offenses, files_within_pr.dup)).to eq(
+            [
+              {
+                'path' => 'lib/version.rb',
+                'offenses' => [
+                  {
+                    'message' => 'No.',
+                    'location' => { 'line' => 41 }
+                  }
+                ]
+              }
+            ]
+          )
+        end
+      end
+
+      describe :added_lines do
+        before do
+          allow(@rubocop.git).to receive(:diff_for_file).with('SAMPLE') do
+            instance_double('Git::Diff::DiffFile', patch: <<~DIFF)
+            diff --git a/SAMPLE b/SAMPLE
+            new file mode 100644
+            index 0000000..7bba8c8
+            --- /dev/null
+            +++ b/SAMPLE
+            @@ -0,0 +1,2 @@
+            +line 1
+            +line 2
+            DIFF
+          end
+        end
+
+        it 'handles git diff' do
+          expect(@rubocop.send(:added_lines, 'SAMPLE')).to eq([1, 2])
+        end
+      end
+
       describe :lint_files do
         let(:response_ruby_file) do
           {
@@ -20,6 +117,7 @@ module Danger
                 'path' => 'spec/fixtures/ruby_file.rb',
                 'offenses' => [
                   {
+                    'cop_name' => 'Syntax/WhetherYouShouldDoThat',
                     'message' => "Don't do that!",
                     'location' => { 'line' => 13 }
                   }
@@ -36,6 +134,7 @@ module Danger
                 'path' => 'spec/fixtures/another_ruby_file.rb',
                 'offenses' => [
                   {
+                    'cop_name' => 'Syntax/WhetherYouShouldDoThat',
                     'message' => "Don't do that!",
                     'location' => { 'line' => 23 }
                   }
@@ -47,11 +146,11 @@ module Danger
 
         it 'handles a rubocop report for specified files' do
           allow(@rubocop).to receive(:`)
-            .with('bundle exec rubocop -f json spec/fixtures/ruby_file.rb')
+            .with('bundle exec rubocop -f json --config path/to/rubocop.yml spec/fixtures/ruby_file.rb')
             .and_return(response_ruby_file)
 
           # Do it
-          @rubocop.lint(files: 'spec/fixtures/ruby*.rb')
+          @rubocop.lint(files: 'spec/fixtures/ruby*.rb', config: 'path/to/rubocop.yml')
 
           output = @rubocop.status_report[:markdowns].first.message
 
@@ -61,6 +160,22 @@ module Danger
           expect(output).to include("spec/fixtures/ruby_file.rb | 13   | Don't do that!")
         end
 
+        it 'includes cop names when include_cop_names is set' do
+          allow(@rubocop).to receive(:`)
+            .with('bundle exec rubocop -f json --config path/to/rubocop.yml spec/fixtures/ruby_file.rb')
+            .and_return(response_ruby_file)
+
+          # Do it
+          @rubocop.lint(files: 'spec/fixtures/ruby*.rb', config: 'path/to/rubocop.yml', include_cop_names:  true)
+
+          output = @rubocop.status_report[:markdowns].first.message
+
+          # A title
+          expect(output).to include('Rubocop violations')
+          # A warning
+          expect(output).to include("spec/fixtures/ruby_file.rb | 13   | Syntax/WhetherYouShouldDoThat: Don't do that!")
+        end
+
         it 'handles a rubocop report for specified files (legacy)' do
           allow(@rubocop).to receive(:`)
             .with('bundle exec rubocop -f json spec/fixtures/ruby_file.rb')
@@ -143,7 +258,7 @@ EOS
               @rubocop.lint(inline_comment: true)
 
               expect(@rubocop.violation_report[:warnings].first.to_s)
-                .to eq("Violation Don't do that! { sticky: false, file: spec/fixtures/ruby_file.rb, line: 13 }")
+                .to eq("Violation Don't do that! { sticky: false, file: spec/fixtures/ruby_file.rb, line: 13, type: warning }")
             end
           end
 
@@ -159,7 +274,7 @@ EOS
               @rubocop.lint(fail_on_inline_comment: true, inline_comment: true)
 
               expect(@rubocop.violation_report[:errors].first.to_s)
-                .to eq("Violation Don't do that! { sticky: false, file: spec/fixtures/ruby_file.rb, line: 13 }")
+                .to eq("Violation Don't do that! { sticky: false, file: spec/fixtures/ruby_file.rb, line: 13, type: error }")
             end
           end
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-rubocop
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.8.1
 platform: ruby
 authors:
 - Ash Furrow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-21 00:00:00.000000000 Z
+date: 2020-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -156,6 +156,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - Gemfile
 - Gemfile.lock
@@ -163,7 +164,6 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- circle.yml
 - danger-rubocop.gemspec
 - lib/danger_plugin.rb
 - lib/version.rb
@@ -192,8 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: A Danger plugin for running Ruby files through Rubocop.

data/circle.yml

@@ -1,3 +0,0 @@
-machine:
-  ruby:
-    version: "2.2.5"