danger-rubocop 0.11.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a25805f10b9265549f39e7efb812f9b940d317727b031a8546aaa34e87a6f57
-  data.tar.gz: 553e742ad2d0780f441a0bb443bcc24b18afd2d26a78fec7cb92b9f7b5abafe1
+  metadata.gz: 228bd1f2c8294e6ade21c5a33424af6ddfa0ceb08613f62ca22db33bdfecd212
+  data.tar.gz: cafedd57a18b594548ef05c3287fd96acbf9a5692306e291ad85f7cf3456e6ad
 SHA512:
-  metadata.gz: df8c319c5b617f7ee5e2698e0db2d2610eeac3007dc3b5d183261295608aaba1805ae496f3b70897a7570bc79f222ed8be6f1af6859d3a0b5d2f6090377a297c
-  data.tar.gz: 8611653f86ad51b236dd4f4b7104e4776c8748d30cfdbc47f70bad2e82580aff9e46b8b8726ccfd1261f48e719ac3459b123871864ca0ddda5ff87e86d5a06d2
+  metadata.gz: e30f4a47b31ce14a58e263da6a7d0cd80a81c016b989be786487393d60f45a131bbabf76f4dbbb08b22058331d1878ff30ddd917cceb3db1e34b5f3cb85fd039
+  data.tar.gz: 705e56f918fe479ee9633f513aaa9ce3396616456112be2d4fa2b1f9358b9c58c620f367ba8cedbb6159e5463d2bad2168e3fd1a949ff3477e6696b4fd24acc4

data/Gemfile.lock

@@ -52,7 +52,8 @@ GEM
     faraday-net_http_persistent (1.1.0)
     ffi (1.15.0)
     formatador (0.2.5)
-    git (1.8.1)
+    git (1.13.1)
+      addressable (~> 2.8)
       rchardet (~> 1.8)
     guard (2.16.2)
       formatador (>= 0.2.4)
@@ -107,7 +108,8 @@ GEM
       ffi (~> 1.0)
     rchardet (1.8.0)
     regexp_parser (2.1.1)
-    rexml (3.2.5)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -138,11 +140,12 @@ GEM
       addressable (>= 2.3.5)
       faraday (> 0.8, < 2.0)
     shellany (0.0.1)
+    strscan (3.1.0)
     terminal-table (3.0.1)
       unicode-display_width (>= 1.1.1, < 3)
     thor (1.1.0)
     unicode-display_width (2.0.0)
-    yard (0.9.26)
+    yard (0.9.36)
 
 PLATFORMS
   ruby

data/README.md

@@ -57,15 +57,17 @@ The following keys are supported:
   (this option will instruct rubocop to ignore the files that your rubocop config ignores,
   despite the plugin providing the list of files explicitly)
 * `inline_comment`: pass `true` to comment inline of the diffs.
+* `group_inline_comments`: pass `true` to group inline comments to be a single comment on each line with all issues for that line.
 * `fail_on_inline_comment`: pass `true` to use `fail` instead of `warn` on inline comment.
 * `report_severity`: pass `true` to use `fail` or `warn` based on Rubocop severity.
 * `report_danger`: pass true to report errors to Danger, and break CI.
+* `include_cop_names`: pass true to include cop names when reporting errors with `report_danger`.
 * `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."
 * `rubocop_cmd`: Allows you to change the rubocop executable that's invoked. This is used to support rubocop wrappers like [Standard](https://github.com/testdouble/standard/) by passing `standardrb` as the value.
-
+* `skip_bundle_exec`: When there is a `Gemfile` in the project, Rubocop will be executed using [Bundler](https://bundler.io). When `true`, this flag will force Rubocop to run without `bundle exec`.
 
 Passing `files` as only argument is also supported for backward compatibility.
 

data/lib/danger_plugin.rb

@@ -34,18 +34,22 @@ module Danger
       report_danger = config[:report_danger] || false
       only_report_new_offenses = config[:only_report_new_offenses] || false
       inline_comment = config[:inline_comment] || false
+      group_inline_comments = config[:group_inline_comments] || false
       fail_on_inline_comment = config[:fail_on_inline_comment] || false
       report_severity = config[:report_severity] || false
       include_cop_names = config[:include_cop_names] || false
       rubocop_cmd = config[:rubocop_cmd] || 'rubocop'
+      skip_bundle_exec = config[:skip_bundle_exec] || false
 
       files_to_lint = fetch_files_to_lint(files)
-      files_to_report = rubocop(files_to_lint, force_exclusion, only_report_new_offenses, cmd: rubocop_cmd, config_path: config_path)
+      files_to_report = rubocop(files_to_lint, force_exclusion, only_report_new_offenses, cmd: rubocop_cmd, config_path: config_path, skip_bundle_exec: skip_bundle_exec)
 
       return if files_to_report.empty?
-      return report_failures files_to_report if report_danger
+      return report_failures(files_to_report, include_cop_names: include_cop_names) if report_danger
 
-      if inline_comment
+      if inline_comment && group_inline_comments
+        add_grouped_violation_for_each_line(files_to_report, fail_on_inline_comment, report_severity, include_cop_names: include_cop_names)
+      elsif inline_comment
         add_violation_for_each_line(files_to_report, fail_on_inline_comment, report_severity, include_cop_names: include_cop_names)
       else
         markdown offenses_message(files_to_report, include_cop_names: include_cop_names)
@@ -54,12 +58,12 @@ module Danger
 
     private
 
-    def rubocop(files_to_lint, force_exclusion, only_report_new_offenses, cmd: 'rubocop', config_path: nil)
+    def rubocop(files_to_lint, force_exclusion, only_report_new_offenses, cmd: 'rubocop', config_path: nil, skip_bundle_exec: false)
       base_command = [cmd, '-f', 'json', '--only-recognized-file-types']
       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.join(' ')} #{files_to_lint}`
+      rubocop_output = `#{'bundle exec ' if File.exist?('Gemfile') && !skip_bundle_exec}#{base_command.join(' ')} #{files_to_lint}`
 
       return [] if rubocop_output.empty?
 
@@ -108,8 +112,7 @@ module Danger
         style: { border_i: '|' },
         rows: 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
+            offense_message = offense_message(offense, include_cop_names: include_cop_names)
             [file['path'], offense['location']['line'], offense_message]
           end
         end
@@ -117,10 +120,11 @@ module Danger
       message + table.split("\n")[1..-2].join("\n")
     end
 
-    def report_failures(offending_files)
+    def report_failures(offending_files, include_cop_names: false)
       offending_files.each do |file|
         file['offenses'].each do |offense|
-          fail "#{file['path']} | #{offense['location']['line']} | #{offense['message']}"
+          offense_message = offense_message(offense, include_cop_names: include_cop_names)
+          fail "#{file['path']} | #{offense['location']['line']} | #{offense_message}"
         end
       end
     end
@@ -128,8 +132,7 @@ module Danger
     def add_violation_for_each_line(offending_files, fail_on_inline_comment, report_severity, 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
+          offense_message = offense_message(offense, include_cop_names: include_cop_names)
           kargs = {
             file: file['path'],
             line: offense['location']['line']
@@ -145,6 +148,37 @@ module Danger
       end
     end
 
+    def add_grouped_violation_for_each_line(offending_files, fail_on_inline_comment, report_severity, include_cop_names: false)
+      grouped_offense_messages = Hash.new { |h, k| h[k] = [] }
+      offending_files.flat_map do |file|
+        file['offenses'].map do |offense|
+          offense_message = offense_message(offense, include_cop_names: include_cop_names)
+          kargs = {
+            file: file['path'],
+            line: offense['location']['line']
+          }
+          grouped_offense_messages[kargs] << offense_message
+        end
+      end
+
+      grouped_offense_messages.each do |kargs, offense_messages|
+        grouped_offense_message = if offense_messages.length > 1
+          "\n" + offense_messages.map do |offense_message|
+            "* #{offense_message}"
+          end.join("\n")
+        else
+          offense_messages[0]
+        end
+        if fail_on_inline_comment
+          fail(grouped_offense_message, **kargs)
+        elsif report_severity && %w[error fatal].include?(offense['severity'])
+          fail(grouped_offense_message, **kargs)
+        else
+          warn(grouped_offense_message, **kargs)
+        end
+      end
+    end
+
     def fetch_files_to_lint(files = nil)
       to_lint = if files.nil?
         # when files are renamed, git.modified_files contains the old name not the new one, so we need to do the convertion
@@ -155,5 +189,11 @@ module Danger
       end
       Shellwords.join(to_lint)
     end
+
+    def offense_message(offense, include_cop_names: false)
+      return offense['message'] unless include_cop_names
+
+      "#{offense['cop_name']}: #{offense['message']}"
+    end
   end
 end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module DangerRubocop
-  VERSION = '0.11.0'.freeze
+  VERSION = '0.13.0'.freeze
 end

data/spec/danger_plugin_spec.rb

@@ -299,7 +299,7 @@ EOS
           end
 
           context 'with fail_on_inline_comment option' do
-            it 'reports violations as line by line failures' do
+            before do
               allow(@rubocop.git).to receive(:modified_files)
                 .and_return(['spec/fixtures/ruby_file.rb'])
               allow(@rubocop.git).to receive(:added_files).and_return([])
@@ -307,64 +307,176 @@ EOS
               allow(@rubocop).to receive(:`)
                 .with('bundle exec rubocop -f json --only-recognized-file-types spec/fixtures/ruby_file.rb')
                 .and_return(response_ruby_file)
+            end
 
+            it 'reports violations as line by line failures' do
               @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, type: error }")
             end
-          end
-
-          context 'with report_severity option' do
-            context 'file with error' do
-              it 'reports violations by rubocop severity' do
-                allow(@rubocop.git).to receive(:added_files).and_return([])
-                allow(@rubocop.git).to receive(:modified_files)
-                  .and_return(["spec/fixtures/another_ruby_file.rb"])
-                allow(@rubocop.git).to receive(:renamed_files).and_return([])
 
-                allow(@rubocop).to receive(:`)
-                  .with('bundle exec rubocop -f json --only-recognized-file-types spec/fixtures/another_ruby_file.rb')
-                  .and_return(response_another_ruby_file)
+            it 'includes cop names when include_cop_names is set' do
+              @rubocop.lint(fail_on_inline_comment: true, inline_comment: true, include_cop_names: true)
 
-                @rubocop.lint(report_severity: true, inline_comment: true)
+              expect(@rubocop.violation_report[:errors].first.to_s)
+                .to eq("Violation Syntax/WhetherYouShouldDoThat: Don't do that! { sticky: false, file: spec/fixtures/ruby_file.rb, line: 13, type: error }")
+            end
+          end
 
-                expect(@rubocop.violation_report[:errors].first.to_s)
-                  .to eq("Violation Don't do that! { sticky: false, file: spec/fixtures/another_ruby_file.rb, line: 23, type: error }")
+          context 'with group_inline_comments' do
+            context 'with multiple violations on the same line' do
+              let(:response_ruby_file) do
+                {
+                  'files' => [
+                    {
+                      'path' => 'spec/fixtures/ruby_file.rb',
+                      'offenses' => [
+                        {
+                          'cop_name' => 'Syntax/WhetherYouShouldDoThat',
+                          'message' => "Don't do that!",
+                          'severity' => 'warning',
+                          'location' => { 'line' => 13 }
+                        },
+                        {
+                          'cop_name' => 'Syntax/WhetherYouShouldDoThat',
+                          'message' => "Also don't do that!",
+                          'severity' => 'warning',
+                          'location' => { 'line' => 13 }
+                        }
+                      ]
+                    }
+                  ]
+                }.to_json
               end
-            end
 
-            context 'file with warning' do
-              it 'reports violations by rubocop severity' do
-                allow(@rubocop.git).to receive(:added_files).and_return([])
+              it 'reports multiple violations grouped by line in a bulleted list' do
                 allow(@rubocop.git).to receive(:modified_files)
-                  .and_return(["spec/fixtures/ruby_file.rb"])
+                  .and_return(['spec/fixtures/ruby_file.rb'])
+                allow(@rubocop.git).to receive(:added_files).and_return([])
                 allow(@rubocop.git).to receive(:renamed_files).and_return([])
-
                 allow(@rubocop).to receive(:`)
                   .with('bundle exec rubocop -f json --only-recognized-file-types spec/fixtures/ruby_file.rb')
                   .and_return(response_ruby_file)
 
-                @rubocop.lint(report_severity: true, 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, type: warning }")
+                @rubocop.lint(inline_comment: true, group_inline_comments: true)
+
+                warning = @rubocop.violation_report[:warnings].first
+                expect(warning.file)
+                  .to eq("spec/fixtures/ruby_file.rb")
+                expect(warning.line)
+                  .to eq(13)
+                expect(warning.message)
+                  .to eq(
+                    <<~HEREDOC
+
+                      * Don't do that!
+                      * Also don't do that!
+                    HEREDOC
+                  .chomp
+                  )
               end
             end
-          end
 
-          context 'using standardrb cmd' do
-            it 'executes using the standardrb cmd' do
+            it 'reports single violations grouped by line as normal line by line warnings' do
+              allow(@rubocop.git).to receive(:modified_files)
+                .and_return(['spec/fixtures/ruby_file.rb'])
+              allow(@rubocop.git).to receive(:added_files).and_return([])
+              allow(@rubocop.git).to receive(:renamed_files).and_return([])
               allow(@rubocop).to receive(:`)
-                .with('bundle exec standardrb -f json --only-recognized-file-types --config path/to/rubocop.yml spec/fixtures/ruby_file.rb')
+                .with('bundle exec rubocop -f json --only-recognized-file-types spec/fixtures/ruby_file.rb')
                 .and_return(response_ruby_file)
 
-              # Do it
-              @rubocop.lint(files: 'spec/fixtures/ruby*.rb', rubocop_cmd: 'standardrb', config: 'path/to/rubocop.yml')
+              @rubocop.lint(inline_comment: true, group_inline_comments: true)
+
+              warning = @rubocop.violation_report[:warnings].first
+              expect(warning.file)
+                .to eq("spec/fixtures/ruby_file.rb")
+              expect(warning.line)
+                .to eq(13)
+              expect(warning.message)
+                .to eq("Don't do that!")
+            end
+          end
+        end
+
+        context 'with report_severity option' do
+          context 'file with error' do
+            it 'reports violations by rubocop severity' do
+              allow(@rubocop.git).to receive(:added_files).and_return([])
+              allow(@rubocop.git).to receive(:modified_files)
+                .and_return(["spec/fixtures/another_ruby_file.rb"])
+              allow(@rubocop.git).to receive(:renamed_files).and_return([])
+
+              allow(@rubocop).to receive(:`)
+                .with('bundle exec rubocop -f json --only-recognized-file-types spec/fixtures/another_ruby_file.rb')
+                .and_return(response_another_ruby_file)
+
+              @rubocop.lint(report_severity: true, inline_comment: true)
+
+              expect(@rubocop.violation_report[:errors].first.to_s)
+                .to eq("Violation Don't do that! { sticky: false, file: spec/fixtures/another_ruby_file.rb, line: 23, type: error }")
             end
           end
         end
 
+        context 'file with warning' do
+          it 'reports violations by rubocop severity' do
+            allow(@rubocop.git).to receive(:added_files).and_return([])
+            allow(@rubocop.git).to receive(:modified_files)
+              .and_return(["spec/fixtures/ruby_file.rb"])
+            allow(@rubocop.git).to receive(:renamed_files).and_return([])
+
+            allow(@rubocop).to receive(:`)
+              .with('bundle exec rubocop -f json --only-recognized-file-types spec/fixtures/ruby_file.rb')
+              .and_return(response_ruby_file)
+
+            @rubocop.lint(report_severity: true, 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, type: warning }")
+          end
+        end
+
+        context 'using standardrb cmd' do
+          it 'executes using the standardrb cmd' do
+            allow(@rubocop).to receive(:`)
+              .with('bundle exec standardrb -f json --only-recognized-file-types --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_cmd: 'standardrb', config: 'path/to/rubocop.yml')
+          end
+        end
+
+        context 'using Bundler' do
+          it 'uses `bundle exec` when there is a Gemfile' do
+            allow(@rubocop).to receive(:`)
+              .with('bundle exec rubocop -f json --only-recognized-file-types --config path/to/rubocop.yml spec/fixtures/ruby_file.rb')
+              .and_return(response_ruby_file)
+
+            @rubocop.lint(files: 'spec/fixtures/ruby*.rb', config: 'path/to/rubocop.yml')
+          end
+
+          it 'doesn\'t use `bundle exec` when there is no Gemfile' do
+            allow(File).to receive(:exist?).with('Gemfile').and_return(false)
+
+            allow(@rubocop).to receive(:`)
+              .with('rubocop -f json --only-recognized-file-types --config path/to/rubocop.yml spec/fixtures/ruby_file.rb')
+              .and_return(response_ruby_file)
+
+            @rubocop.lint(files: 'spec/fixtures/ruby*.rb', config: 'path/to/rubocop.yml')
+          end
+
+          it 'doesn\'t use `bundle exec` when there is a Gemfile but skip_bundle_exec is true' do
+            allow(@rubocop).to receive(:`)
+              .with('rubocop -f json --only-recognized-file-types --config path/to/rubocop.yml spec/fixtures/ruby_file.rb')
+              .and_return(response_ruby_file)
+
+            @rubocop.lint(files: 'spec/fixtures/ruby*.rb', config: 'path/to/rubocop.yml', skip_bundle_exec: true)
+          end
+        end
+
         describe 'a filename with special characters' do
           it 'is shell escaped' do
             modified_files = [
@@ -382,8 +494,7 @@ EOS
         end
 
         describe 'report to danger' do
-          let(:fail_msg) { %{spec/fixtures/ruby_file.rb | 13 | Don't do that!} }
-          it 'reports to danger' do
+          before do
             allow(@rubocop.git).to receive(:modified_files)
               .and_return(['spec/fixtures/ruby_file.rb'])
             allow(@rubocop.git).to receive(:added_files).and_return([])
@@ -391,10 +502,20 @@ EOS
             allow(@rubocop).to receive(:`)
               .with('bundle exec rubocop -f json --only-recognized-file-types spec/fixtures/ruby_file.rb')
               .and_return(response_ruby_file)
+          end
 
+          it 'reports to danger' do
+            fail_msg = %{spec/fixtures/ruby_file.rb | 13 | Don't do that!}
             expect(@rubocop).to receive(:fail).with(fail_msg)
             @rubocop.lint(report_danger: true)
           end
+
+          it 'includes cop names when include_cop_names is set' do
+            fail_msg = %{spec/fixtures/ruby_file.rb | 13 | Syntax/WhetherYouShouldDoThat: Don't do that!}
+
+            expect(@rubocop).to receive(:fail).with(fail_msg)
+            @rubocop.lint(report_danger: true, include_cop_names: true)
+          end
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-rubocop
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Ash Furrow
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-16 00:00:00.000000000 Z
+date: 2024-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger
@@ -192,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.13
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A Danger plugin for running Ruby files through Rubocop.