danger-rubocop 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0344fb238b0dd6aeb32bf763745f599e46dd5176
-  data.tar.gz: 2653083d32aa0f8a7d1452fa5a81b674981ea479
+  metadata.gz: 2a006c7c8dafc7fa51b8fe5aff38764b20502b4c
+  data.tar.gz: be9b290a729911dc21cc8a947ac75f22c739f800
 SHA512:
-  metadata.gz: 4fdb6286385ef2fc18a1cc37c3330d2719022d598e823be29ce35506a1d8307fb9fb02d2c3a55c6ee381e642880ba4d78193e5660b279d4a203d139d3aeafd78
-  data.tar.gz: 73e00649f3542c68ca1116f569b3fd996954428df566ced153394a3b70cd96d5349abfe14658c5844ae4f543faead71cf4ee51f0c79dbd88db2082f915279576
+  metadata.gz: cba8556356a8f29cf276cd88a0ce8e4ddd31870b0a6056bab8e0295a84a922e174b40fb636c2bd7381baf742f6111e46fc5cb2f7d4821d38dceff8db5bc6756c
+  data.tar.gz: 2e691ab029fa2145137dd7bdde399595ae8a2f6c7fde332f1d028cc1ad71c4b24cb84409e2d378a2401e30fced437c803dbb9fcecfaeba61f2963e16f848c510

data/README.md

@@ -19,15 +19,16 @@ Results are passed out as a table in markdown.
 
 
 > Specifying custom config file.
-> ```ruby
+```ruby
 rubocop.lint
-> ```
+```
 
 > Lint specific files in a folder, when they change
-> ```ruby
-public_files = (modified_files + added_files).select { |path| path.include?("/public/") }
+
+```ruby
+public_files = (git.modified_files + git.added_files).select { |path| path.include?("/public/") }
 rubocop.lint public_files
-> ```
+```
 
 
 #### Methods

data/danger-rubocop.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/ashfurrow/danger-rubocop'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.files         = `git ls-files`.split($/)
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 

data/lib/danger_plugin.rb

@@ -1,3 +1,5 @@
+require 'shellwords'
+
 module Danger
   # Run Ruby files through Rubocop.
   # Results are passed out as a table in markdown.
@@ -24,23 +26,26 @@ module Danger
     #          from the diff will be used.
     # @return  [void]
     #
-    def lint(files = nil)
+    def lint(config = nil)
+      config = config.is_a?(Hash) ? config : { files: config }
+      files = config[:files]
+      force_exclusion = config[:force_exclusion] || false
+
       files_to_lint = fetch_files_to_lint(files)
+      files_to_report = rubocop(files_to_lint, force_exclusion)
 
-      return if offending_files.empty?
+      return if files_to_report.empty?
 
-      markdown offenses_message(offending_files)
-    end
-    
-    def offending_files(files = nil)
-      files_to_lint = fetch_files_to_lint(files)
-      rubocop(files_to_lint)
+      markdown offenses_message(files_to_report)
     end
 
     private
 
-    def rubocop(files_to_lint)
-      rubocop_output = `#{'bundle exec ' if File.exist?('Gemfile')}rubocop -f json #{files_to_lint.join(' ')}`
+    def rubocop(files_to_lint, force_exclusion)
+      base_command = 'rubocop -f json'
+      base_command << ' --force-exclusion' if force_exclusion
+
+      rubocop_output = `#{'bundle exec ' if File.exist?('Gemfile')}#{base_command} #{files_to_lint}`
 
       JSON.parse(rubocop_output)['files']
         .select { |f| f['offenses'].any? }
@@ -61,9 +66,10 @@ module Danger
       ).to_s
       message + table.split("\n")[1..-2].join("\n")
     end
-    
+
     def fetch_files_to_lint(files = nil)
-      @files_to_lint ||= (files ? Dir.glob(files) : (git.modified_files + git.added_files))
+      to_lint = (files ? Dir.glob(files) : (git.modified_files + git.added_files))
+      Shellwords.join(to_lint)
     end
   end
 end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module DangerRubocop
-  VERSION = '0.4.0'.freeze
+  VERSION = '0.4.1'.freeze
 end

data/spec/danger_plugin_spec.rb

@@ -50,6 +50,22 @@ module Danger
             .with('bundle exec rubocop -f json spec/fixtures/ruby_file.rb')
             .and_return(response_ruby_file)
 
+          # Do it
+          @rubocop.lint(files: 'spec/fixtures/ruby*.rb')
+
+          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   | 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')
+            .and_return(response_ruby_file)
+
           # Do it
           @rubocop.lint('spec/fixtures/ruby*.rb')
 
@@ -61,6 +77,22 @@ module Danger
           expect(output).to include("spec/fixtures/ruby_file.rb | 13   | Don't do that!")
         end
 
+        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')
+            .and_return(response_ruby_file)
+
+          # Do it
+          @rubocop.lint(files: 'spec/fixtures/ruby*.rb', force_exclusion: 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   | 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)
@@ -96,6 +128,21 @@ module Danger
 EOS
           expect(@rubocop.status_report[:markdowns].first.message).to eq(formatted_table.chomp)
         end
+
+        describe 'a filename with special characters' do
+          it 'is shell escaped' do
+            modified_files = [
+              'spec/fixtures/shellescape/ruby_file_with_parens_(abc).rb',
+              'spec/fixtures/shellescape/ruby_file with spaces.rb',
+              'spec/fixtures/shellescape/ruby_file\'with_quotes.rb'
+            ]
+            allow(@rubocop.git).to receive(:modified_files)
+              .and_return(modified_files)
+            allow(@rubocop.git).to receive(:added_files).and_return([])
+
+            expect { @rubocop.lint }.not_to raise_error
+          end
+        end
       end
     end
   end

data/spec/fixtures/shellescape/ruby_file with spaces.rb

@@ -0,0 +1 @@
+# This file intentional left blank-ish.

data/spec/fixtures/shellescape/ruby_file'with_quotes.rb

@@ -0,0 +1 @@
+# This file intentional left blank-ish.

data/spec/fixtures/shellescape/ruby_file_with_parens_(abc).rb

@@ -0,0 +1 @@
+# This file intentional left blank-ish.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-rubocop
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Ash Furrow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-27 00:00:00.000000000 Z
+date: 2017-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger
@@ -169,6 +169,9 @@ files:
 - lib/version.rb
 - spec/danger_plugin_spec.rb
 - spec/fixtures/ruby_file.rb
+- spec/fixtures/shellescape/ruby_file with spaces.rb
+- spec/fixtures/shellescape/ruby_file'with_quotes.rb
+- spec/fixtures/shellescape/ruby_file_with_parens_(abc).rb
 - spec/spec_helper.rb
 homepage: https://github.com/ashfurrow/danger-rubocop
 licenses:
@@ -190,11 +193,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: A Danger plugin for running Ruby files through Rubocop.
 test_files:
 - spec/danger_plugin_spec.rb
 - spec/fixtures/ruby_file.rb
+- spec/fixtures/shellescape/ruby_file with spaces.rb
+- spec/fixtures/shellescape/ruby_file'with_quotes.rb
+- spec/fixtures/shellescape/ruby_file_with_parens_(abc).rb
 - spec/spec_helper.rb