danger-rubocop 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad658f09ac619e760282d3c744fb30c479711f934919fa337561a890cc810348
-  data.tar.gz: f85f21294bdbf3e1878fab539fbc5d0edc8cdc4a6b47880af049b756693b33e4
+  metadata.gz: a3abbdb817a34c89263a3e43389e0ad1c241eceb220da6ff60d4171dbd82724b
+  data.tar.gz: 7790b03ff4cffe993a9e21ada5831169e55af7811bb06b2b6dc800ee0eab72c4
 SHA512:
-  metadata.gz: 85c71ea2747fab34cdc91ebf7183ff8d18100416e11338a6207f7fe7a31cce0763fc6e7af63f4aec5e0b687042d208a02e92d88599e71c47c867a0468e55b0cf
-  data.tar.gz: 0aec485ea365fd126af04967a0f8267ed268bce85a3ba5ca5fd6513cbe76222d7e76de73ba2fe442855af462966da72aacbc79fbce791a4912ae23184b0869d3
+  metadata.gz: a6532f9058d5f6f5db6fd27c1197b84966ef5e786fd9213c24974d618477c5f7eabfadb8f072585a3e6c413f08d2f67aa94610486c599e91fc8fc528e2a2d36e
+  data.tar.gz: c678e3db688d226c8d25c43bc895f046519b14751bb0b3b670b124ca8a90f884d9695b2fb936c98cd38ad7899127b4539d8eb3b9e4a39d622a23f758f9e27c34

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

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-ruby '>= 2.0'
+ruby '>= 2.6.0'
 
 gemspec
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-rubocop (0.7.0)
+    danger-rubocop (0.8.0)
       danger
       rubocop
 
@@ -10,7 +10,7 @@ GEM
   specs:
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.0)
+    ast (2.4.1)
     bacon (1.2.0)
     claide (1.0.3)
     claide-plugins (0.9.2)
@@ -21,27 +21,28 @@ GEM
     colored2 (3.1.2)
     cork (0.3.0)
       colored2 (~> 3.1)
-    danger (6.0.9)
+    danger (8.0.1)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
       cork (~> 0.1)
-      faraday (~> 0.9)
+      faraday (>= 0.9.0, < 2.0)
       faraday-http-cache (~> 2.0)
-      git (~> 1.5)
+      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.15.4)
+    faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
-    faraday-http-cache (2.0.0)
-      faraday (~> 0.8)
+    faraday-http-cache (2.2.0)
+      faraday (>= 0.8)
     ffi (1.9.10)
     formatador (0.2.5)
-    git (1.5.0)
+    git (1.7.0)
+      rchardet (~> 1.8)
     guard (2.14.0)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
@@ -56,8 +57,8 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    jaro_winkler (1.5.3)
-    kramdown (2.1.0)
+    kramdown (2.3.0)
+      rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
     listen (3.0.7)
@@ -77,11 +78,12 @@ GEM
     notiffany (0.1.0)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    octokit (4.14.0)
+    octokit (4.18.0)
+      faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
-    parallel (1.17.0)
-    parser (2.6.4.1)
+    parallel (1.19.1)
+    parser (2.7.1.3)
       ast (~> 2.4.0)
     prettybacon (0.0.2)
       bacon (~> 1.2)
@@ -89,12 +91,15 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    public_suffix (4.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)
@@ -108,13 +113,17 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.4.0)
     rspec-support (3.4.1)
-    rubocop (0.74.0)
-      jaro_winkler (~> 1.5.1)
+    rubocop (0.85.1)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
     ruby-progressbar (1.10.1)
     sawyer (0.8.2)
       addressable (>= 2.3.5)
@@ -124,8 +133,8 @@ GEM
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
     thor (0.19.1)
-    unicode-display_width (1.6.0)
-    yard (0.9.12)
+    unicode-display_width (1.7.0)
+    yard (0.9.20)
 
 PLATFORMS
   ruby
@@ -141,12 +150,12 @@ DEPENDENCIES
   mocha-on-bacon
   prettybacon
   pry
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.4)
   yard
 
 RUBY VERSION
-   ruby 2.3.1p112
+   ruby 2.6.0p0
 
 BUNDLED WITH
    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
@@ -50,6 +56,7 @@ The following keys are supported:
 * `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

@@ -18,11 +18,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'danger'
-  spec.add_dependency 'rubocop'
+  spec.add_dependency 'rubocop', '~> 0.83'
 
   # 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

@@ -35,6 +35,7 @@ module Danger
       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, only_report_new_offenses, config_path: config_path)
@@ -43,16 +44,16 @@ module Danger
       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, only_report_new_offenses, config_path: nil)
-      base_command = ['rubocop', '-f', 'json']
+      base_command = ['rubocop', '-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?
 
@@ -86,14 +87,14 @@ module Danger
            # Get start from diff.
            lineno = first_line.match(/\+(\d+),(\d+)/).captures.first.to_i
            diff.each_with_object([]) do |current_line, added_lines|
-             lineno += 1 unless current_line.start_with?('-')
              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"
@@ -102,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
@@ -117,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.7.0'.freeze
+  VERSION = '0.9.0'.freeze
 end

data/spec/danger_plugin_spec.rb

@@ -20,7 +20,7 @@ module Danger
               'offenses' => [
                 {
                   'message' => 'No.',
-                  'location' => { 'line' => 42 }
+                  'location' => { 'line' => 41 }
                 }
               ]
             }
@@ -79,7 +79,7 @@ module Danger
                 'offenses' => [
                   {
                     'message' => 'No.',
-                    'location' => { 'line' => 42 }
+                    'location' => { 'line' => 41 }
                   }
                 ]
               }
@@ -88,6 +88,27 @@ module Danger
         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
           {
@@ -96,6 +117,7 @@ module Danger
                 'path' => 'spec/fixtures/ruby_file.rb',
                 'offenses' => [
                   {
+                    'cop_name' => 'Syntax/WhetherYouShouldDoThat',
                     'message' => "Don't do that!",
                     'location' => { 'line' => 13 }
                   }
@@ -112,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 }
                   }
@@ -123,7 +146,7 @@ module Danger
 
         it 'handles a rubocop report for specified files' do
           allow(@rubocop).to receive(:`)
-            .with('bundle exec rubocop -f json --config path/to/rubocop.yml spec/fixtures/ruby_file.rb')
+            .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)
 
           # Do it
@@ -137,9 +160,25 @@ 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 --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', 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')
+            .with('bundle exec rubocop -f json --only-recognized-file-types spec/fixtures/ruby_file.rb')
             .and_return(response_ruby_file)
 
           # Do it
@@ -155,7 +194,7 @@ module Danger
 
         it 'appends --force-exclusion argument when force_exclusion is set' do
           allow(@rubocop).to receive(:`)
-            .with('bundle exec rubocop -f json --force-exclusion spec/fixtures/ruby_file.rb')
+            .with('bundle exec rubocop -f json --only-recognized-file-types --force-exclusion spec/fixtures/ruby_file.rb')
             .and_return(response_ruby_file)
 
           # Do it
@@ -175,7 +214,7 @@ module Danger
             .and_return(["spec/fixtures/another_ruby_file.rb"])
 
           allow(@rubocop).to receive(:`)
-            .with('bundle exec rubocop -f json spec/fixtures/another_ruby_file.rb')
+            .with('bundle exec rubocop -f json --only-recognized-file-types spec/fixtures/another_ruby_file.rb')
             .and_return(response_another_ruby_file)
 
           @rubocop.lint
@@ -191,7 +230,7 @@ module Danger
             .and_return(['spec/fixtures/ruby_file.rb'])
           allow(@rubocop.git).to receive(:added_files).and_return([])
           allow(@rubocop).to receive(:`)
-            .with('bundle exec rubocop -f json 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)
 
           @rubocop.lint
@@ -213,13 +252,13 @@ EOS
                 .and_return(['spec/fixtures/ruby_file.rb'])
               allow(@rubocop.git).to receive(:added_files).and_return([])
               allow(@rubocop).to receive(:`)
-                .with('bundle exec rubocop -f json 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)
 
               @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
 
@@ -229,13 +268,13 @@ EOS
                 .and_return(['spec/fixtures/ruby_file.rb'])
               allow(@rubocop.git).to receive(:added_files).and_return([])
               allow(@rubocop).to receive(:`)
-                .with('bundle exec rubocop -f json 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)
 
               @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
@@ -262,7 +301,7 @@ EOS
               .and_return(['spec/fixtures/ruby_file.rb'])
             allow(@rubocop.git).to receive(:added_files).and_return([])
             allow(@rubocop).to receive(:`)
-              .with('bundle exec rubocop -f json 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)
 
             expect(@rubocop).to receive(:fail).with(fail_msg)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-rubocop
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Ash Furrow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-19 00:00:00.000000000 Z
+date: 2020-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger
@@ -28,16 +28,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.83'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.83'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -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"