danger-rubocop 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a25805f10b9265549f39e7efb812f9b940d317727b031a8546aaa34e87a6f57
-  data.tar.gz: 553e742ad2d0780f441a0bb443bcc24b18afd2d26a78fec7cb92b9f7b5abafe1
+  metadata.gz: e62c69c270c52a9db56563f52892f3e3f04ac0f154a70144f20ef66f2a5db517
+  data.tar.gz: 7db336caf7afd0d8574a66096ee0276b9e92f725d914e57e5720bfe6a83fc27a
 SHA512:
-  metadata.gz: df8c319c5b617f7ee5e2698e0db2d2610eeac3007dc3b5d183261295608aaba1805ae496f3b70897a7570bc79f222ed8be6f1af6859d3a0b5d2f6090377a297c
-  data.tar.gz: 8611653f86ad51b236dd4f4b7104e4776c8748d30cfdbc47f70bad2e82580aff9e46b8b8726ccfd1261f48e719ac3459b123871864ca0ddda5ff87e86d5a06d2
+  metadata.gz: e88de395cb97400f569e38461f45dfd978483bbaf42f048865b4e3f33fefb86632c5ca55f63796cb45a5f5947065200cb6e2bc35fcaa3f42c932c565de7d2cb8
+  data.tar.gz: c192a3cf0f8b3b199d2e6526c3df8f73c96cffed6cb683f7216dfd00ff9a2c92c83cac77bca63b28eabc215f26bae67c003737977ea112c62d2b73dcb4939c8f

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)

data/README.md

@@ -60,6 +60,7 @@ The following keys are supported:
 * `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.

data/lib/danger_plugin.rb

@@ -43,7 +43,7 @@ module Danger
       files_to_report = rubocop(files_to_lint, force_exclusion, only_report_new_offenses, cmd: rubocop_cmd, config_path: config_path)
 
       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
         add_violation_for_each_line(files_to_report, fail_on_inline_comment, report_severity, include_cop_names: include_cop_names)
@@ -108,8 +108,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 +116,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 +128,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']
@@ -155,5 +154,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.12.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,61 +307,70 @@ 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
+
+            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)
+
+              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
+        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([])
+        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)
+              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)
+              @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
+              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([])
+        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)
+            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)
+            @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
+            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)
+        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
+            # Do it
+            @rubocop.lint(files: 'spec/fixtures/ruby*.rb', rubocop_cmd: 'standardrb', config: 'path/to/rubocop.yml')
           end
         end
 
@@ -382,8 +391,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 +399,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.12.0
 platform: ruby
 authors:
 - Ash Furrow
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-16 00:00:00.000000000 Z
+date: 2023-10-01 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.