danger-rubocop 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b288b71917f30ef97bf3fc0c1f8724b46a88e7df67b892b6150c61c17a7de98
-  data.tar.gz: 0cfe9c4bab2641bca6fcc424d1fe696880b1707c6d95090f0daf3329c7dd1abf
+  metadata.gz: fc7db75b5f4eff3caf643f1c9cc45c5d9014e8361351b8868fb79a2082618507
+  data.tar.gz: 0bbc72b3cd32ad873d8137717ea82a0ed5fd630dbda61d46433c5cd4b5bf50a6
 SHA512:
-  metadata.gz: f47e4da17133f200a872614aecafed97f9ea9cd7461e46c8389fbea70f9f8ebccc74d4910ac228b76caa90f8d112a553939741c98a61c5e073d135dae7330ef4
-  data.tar.gz: 70268a8ab1c21d2b68ea5a4455177998562322cc3cf5d2d9b1decf710085bec6fd162bada84d1727420665d8ce49fa29afa0479921bd460775cffa76d7aa0d3b
+  metadata.gz: 272cbd2cdefced6ef5a1f0de44251ec358bbd37522c73035104294d320a0c0defdd95598bec5ce3973435c006b4583121a01f562e693dc699ed1c427ea5fbd18
+  data.tar.gz: 78750720159477b7db8d97a6d963f0443b16839785387682597aa4058e75a692132a09674516f02a561c6f228c4d21760498a4eb193dd53137a2eafc820db530

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

@@ -91,7 +91,7 @@ GEM
       slop (~> 3.4)
     public_suffix (4.0.1)
     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)
@@ -141,7 +141,7 @@ DEPENDENCIES
   mocha-on-bacon
   prettybacon
   pry
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.4)
   yard
 

data/README.md

@@ -43,7 +43,7 @@ rubocop.lint inline_comment: true
 
 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
@@ -56,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

@@ -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

@@ -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,9 +44,9 @@ 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
 
@@ -93,7 +94,7 @@ module Danger
          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.1'.freeze
+  VERSION = '0.7.2'.freeze
 end

data/spec/danger_plugin_spec.rb

@@ -117,6 +117,7 @@ module Danger
                 'path' => 'spec/fixtures/ruby_file.rb',
                 'offenses' => [
                   {
+                    'cop_name' => 'Syntax/WhetherYouShouldDoThat',
                     'message' => "Don't do that!",
                     'location' => { 'line' => 13 }
                   }
@@ -133,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 }
                   }
@@ -158,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')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-rubocop
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Ash Furrow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-21 00:00:00.000000000 Z
+date: 2020-04-16 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.6
 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"