danger-rubocop 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4913ce170fed65fbffcc48b48f612d1ee1c1614a
-  data.tar.gz: 307c2ba9850cd9e1e4977d19cb7b108e6ab8adb5
+  metadata.gz: 1978aa697df5bc21637aa6709902420c4609a3df
+  data.tar.gz: 421a0668ca419f70fc5d6be6f1e0b3f03ca84a33
 SHA512:
-  metadata.gz: dcde2c3010d6942fd8524fa87e14968ff20538b1cdfe1a3b893a1930e107682eca77d2de052d19e3e22b9a24338423c1d2c396aff02a78734cefef342be41a21
-  data.tar.gz: 7bc56b94ecd9224783c29ca91462878f083d6ade4aadf179a7f9007443271920baeced5febe784c76c3652ad31814e6d9384fbb459ba84f260116bf64351c3ff
+  metadata.gz: 49f783ea67d5843ed21746553d640477fab94fb03819118ae87adf3611ae22297a5eff61581b128e904f72535cd4b7d22296b37df6f130d4557f2763c0d8712d
+  data.tar.gz: c079dc452e654c4bcad9e630528e0b4013d641189e9823dd5521ae8cc15226e8a2e6d65c84973c55d1921aed6ae14276ef0931060be5305735a2f7eec8708cc4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-rubocop (0.1.0)
+    danger-rubocop (0.2.0)
       danger
       rubocop
 
@@ -12,17 +12,17 @@ GEM
     ast (2.3.0)
     bacon (1.2.0)
     claide (1.0.0)
-    claide-plugins (0.9.0)
-      cork (~> 0)
-      nap (~> 1.0)
+    claide-plugins (0.9.1)
+      cork
+      nap
       open4 (~> 1.3)
     coderay (1.1.1)
     colored (1.2)
     cork (0.1.0)
       colored (~> 1.2)
-    danger (0.10.1)
+    danger (2.1.0)
       claide (~> 1.0)
-      claide-plugins (~> 0.9)
+      claide-plugins (> 0.9.0)
       colored (~> 1.2)
       cork (~> 0.1)
       faraday (~> 0)
@@ -100,7 +100,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.4.0)
     rspec-support (3.4.1)
-    rubocop (0.41.2)
+    rubocop (0.42.0)
       parser (>= 2.3.1.1, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)

data/README.md

@@ -14,22 +14,30 @@ gem 'danger-rubocop'
 
 ## Usage
 
-The easiest way to use is just add this to your Dangerfile:
+Run Ruby files through Rubocop.
+Results are passed out as a table in markdown.
 
-```rb
+
+> Specifying custom config file.
+> ```ruby
 rubocop.lint
-```
+> ```
 
-That will lint any changed or added Ruby files in the PR.
+> Lint specific files in a folder, when they change
+> ```ruby
+public_files = (modified_files + added_files).select { |path| path.include?("/public/") }
+rubocop.lint public_files
+> ```
 
-You can also provide a list of files manually:
 
-```rb
-# Look through all changed ruby files
-rb_files = (modified_files + added_files).select { |f| f.end_with?(".rb") }
+#### Methods
+
+
+`lint(files: String)`
+
+ Runs Ruby files through Rubocop. Generates a `markdown` list of warnings.
+
 
-rubocop.run rb_files
-```
 
 ## License
 

data/lib/danger_plugin.rb

@@ -26,7 +26,6 @@ module Danger
     #
     def lint(files = nil)
       files_to_lint = files ? Dir.glob(files) : (git.modified_files + git.added_files)
-      files_to_lint.select! { |f| f.end_with? 'rb' }
 
       offending_files = rubocop(files_to_lint)
       return if offending_files.empty?
@@ -37,25 +36,26 @@ module Danger
     private
 
     def rubocop(files_to_lint)
-      rubocop_results = files_to_lint.flat_map do |f|
-        prefix = File.exist?('Gemfile') ? 'bundle exec' : ''
-        JSON.parse(`#{prefix} rubocop -f json #{f}`)['files']
-      end
-      rubocop_results.select { |f| f['offenses'].count > 0 }
+      rubocop_output = `#{'bundle exec ' if File.exist?('Gemfile')}rubocop -f json`
+
+      JSON.parse(rubocop_output)['files']
+        .select { |f| files_to_lint.include?(f['path']) && f['offenses'].any? }
     end
 
     def offenses_message(offending_files)
       require 'terminal-table'
 
       message = "### Rubocop violations\n\n"
-      message + Terminal::Table.new(
+      table = Terminal::Table.new(
         headings: %w(File Line Reason),
+        style: { border_i: '|' },
         rows: offending_files.flat_map do |file|
           file['offenses'].map do |offense|
             [file['path'], offense['location']['line'], offense['message']]
           end
         end
       ).to_s
+      message + table.split("\n")[1..-2].join("\n")
     end
   end
 end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module DangerRubocop
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/spec/danger_plugin_spec.rb

@@ -18,26 +18,35 @@ module Danger
           response = {
             'files' => [
               {
-                'path' => 'ruby_file.rb',
+                'path' => 'spec/fixtures/ruby_file.rb',
                 'offenses' => [
                   {
                     'message' => "Don't do that!",
                     'location' => { 'line' => 13 }
                   }
                 ]
+              },
+              {
+                'path' => 'spec/fixtures/another_ruby_file.rb',
+                'offenses' => [
+                  {
+                    'message' => "Don't do that!",
+                    'location' => { 'line' => 23 }
+                  }
+                ]
               }
             ]
           }
           @rubocop_response = response.to_json
         end
 
-        it 'handles a known rubocop report' do
+        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')
             .and_return(@rubocop_response)
 
           # Do it
-          @rubocop.lint('spec/fixtures/*.rb')
+          @rubocop.lint('spec/fixtures/ruby*.rb')
 
           output = @rubocop.status_report[:markdowns].first
 
@@ -46,20 +55,44 @@ module Danger
           # A title
           expect(output).to include('Rubocop violations')
           # A warning
-          expect(output).to include("ruby_file.rb | 13   | Don't do that!")
+          expect(output).to include("spec/fixtures/ruby_file.rb | 13   | Don't do that!")
+        end
+
+        it 'handles a rubocop report for files changed in the PR' 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).to receive(:`)
+            .with('bundle exec rubocop -f json')
+            .and_return(@rubocop_response)
+
+          @rubocop.lint
+
+          output = @rubocop.status_report[:markdowns].first
+
+          expect(output).to_not be_empty
+          expect(output).to include('Rubocop violations')
+          expect(output).to include("spec/fixtures/another_ruby_file.rb | 23   | Don't do that!")
         end
 
-        it 'handles no files' do
+        it 'is formatted as a markdown table' 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).to receive(:`)
-            .with('bundle exec rubocop -f json spec/fixtures/ruby_file.rb')
+            .with('bundle exec rubocop -f json')
             .and_return(@rubocop_response)
 
           @rubocop.lint
 
-          expect(@rubocop.status_report[:markdowns].first).to_not be_empty
+          formatted_table = <<-EOS
+### Rubocop violations\n
+| File                       | Line | Reason         |
+|----------------------------|------|----------------|
+| spec/fixtures/ruby_file.rb | 13   | Don't do that! |
+EOS
+          expect(@rubocop.status_report[:markdowns].first).to eq(formatted_table.chomp)
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-rubocop
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ash Furrow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-23 00:00:00.000000000 Z
+date: 2016-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger
@@ -190,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: A Danger plugin for running Ruby files through Rubocop.
@@ -198,3 +198,4 @@ test_files:
 - spec/danger_plugin_spec.rb
 - spec/fixtures/ruby_file.rb
 - spec/spec_helper.rb
+has_rdoc: