danger-rubocop 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1515e5372954585820a9828937bbe1e1a8ca0470
-  data.tar.gz: 6f22b296591432eb9c56b6b051b79a562be4be14
+  metadata.gz: 4913ce170fed65fbffcc48b48f612d1ee1c1614a
+  data.tar.gz: 307c2ba9850cd9e1e4977d19cb7b108e6ab8adb5
 SHA512:
-  metadata.gz: 4de4b1c3f7c5a1c9251f0df992510fceecfbe7aba0488ba47d8b4a714ca7bf9b58a4f97ec83f7b283619dada7975ba8ec2939cdea5e6d4b8c3d91a51198d6e87
-  data.tar.gz: 9d3bd307bbefd545498b37b8cacae97427b55a6b7e90e09d8d46c451bebc4fd813cca090e8682e4adbcb8cfca5157357f99c5b674c3eafea98a80cff0eb9570a
+  metadata.gz: dcde2c3010d6942fd8524fa87e14968ff20538b1cdfe1a3b893a1930e107682eca77d2de052d19e3e22b9a24338423c1d2c396aff02a78734cefef342be41a21
+  data.tar.gz: 7bc56b94ecd9224783c29ca91462878f083d6ade4aadf179a7f9007443271920baeced5febe784c76c3652ad31814e6d9384fbb459ba84f260116bf64351c3ff

data/Gemfile

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-rubocop (0.0.1)
+    danger-rubocop (0.1.0)
       danger
       rubocop
 
@@ -12,15 +12,21 @@ GEM
     ast (2.3.0)
     bacon (1.2.0)
     claide (1.0.0)
+    claide-plugins (0.9.0)
+      cork (~> 0)
+      nap (~> 1.0)
+      open4 (~> 1.3)
     coderay (1.1.1)
     colored (1.2)
     cork (0.1.0)
       colored (~> 1.2)
-    danger (0.8.3)
+    danger (0.10.1)
       claide (~> 1.0)
+      claide-plugins (~> 0.9)
       colored (~> 1.2)
       cork (~> 0.1)
       faraday (~> 0)
+      faraday-http-cache (~> 1.0)
       git (~> 1)
       octokit (~> 4.2)
       redcarpet (~> 3.3)
@@ -28,6 +34,8 @@ GEM
     diff-lcs (1.2.5)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
+    faraday-http-cache (1.3.0)
+      faraday (~> 0.8)
     ffi (1.9.10)
     formatador (0.2.5)
     git (1.3.0)
@@ -56,12 +64,14 @@ GEM
     mocha-on-bacon (0.2.2)
       mocha (>= 0.13.0)
     multipart-post (2.0.0)
+    nap (1.1.0)
     nenv (0.3.0)
     notiffany (0.1.0)
       nenv (~> 0.1)
       shellany (~> 0.0)
     octokit (4.3.0)
       sawyer (~> 0.7.0, >= 0.5.3)
+    open4 (1.3.4)
     parser (2.3.1.2)
       ast (~> 2.2)
     powerpack (0.1.1)
@@ -90,7 +100,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.4.0)
     rspec-support (3.4.1)
-    rubocop (0.41.1)
+    rubocop (0.41.2)
       parser (>= 2.3.1.1, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
@@ -105,6 +115,7 @@ GEM
     terminal-table (1.6.0)
     thor (0.19.1)
     unicode-display_width (1.1.0)
+    yard (0.9.5)
 
 PLATFORMS
   ruby
@@ -122,6 +133,10 @@ DEPENDENCIES
   pry
   rake (~> 10.0)
   rspec (~> 3.4)
+  yard
+
+RUBY VERSION
+   ruby 2.3.1p112
 
 BUNDLED WITH
    1.12.5

data/Guardfile

@@ -3,8 +3,8 @@
 
 # To run, use `bundle exec guard`.
 
-guard :rspec, cmd: "bundle exec rspec" do
-  require "guard/rspec/dsl"
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
   dsl = Guard::RSpec::Dsl.new(self)
 
   # Feel free to open issues for suggestions and improvements

data/README.md

@@ -17,7 +17,7 @@ gem 'danger-rubocop'
 The easiest way to use is just add this to your Dangerfile:
 
 ```rb
-rubocop.run
+rubocop.lint
 ```
 
 That will lint any changed or added Ruby files in the PR.
@@ -25,7 +25,7 @@ That will lint any changed or added Ruby files in the PR.
 You can also provide a list of files manually:
 
 ```rb
-# Look through all changed Markdown files
+# Look through all changed ruby files
 rb_files = (modified_files + added_files).select { |f| f.end_with?(".rb") }
 
 rubocop.run rb_files
@@ -33,4 +33,4 @@ rubocop.run rb_files
 
 ## License
 
-MIT
+MIT

data/Rakefile

@@ -1,13 +1,6 @@
 require 'bundler/gem_tasks'
-require "rspec/core/rake_task"
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
-
-task :spec do
-  Rake::Task['specs'].invoke
-end
-
-task :default => :spec
-

data/circle.yml

@@ -0,0 +1,3 @@
+machine:
+  ruby:
+    version: "2.2.5"

data/danger-rubocop.gemspec

@@ -6,14 +6,14 @@ require 'version'
 Gem::Specification.new do |spec|
   spec.name          = 'danger-rubocop'
   spec.version       = DangerRubocop::VERSION
-  spec.authors       = ['Ash Furrow']
-  spec.email         = ['ash@ashfurrow.com']
-  spec.description   = %q{A Danger plugin for running Ruby files through Rubocop.}
-  spec.summary       = %q{A Danger plugin for running Ruby files through Rubocop.}
+  spec.author        = 'Ash Furrow'
+  spec.email         = 'ash@ashfurrow.com'
+  spec.description   = 'A Danger plugin for running Ruby files through Rubocop.'
+  spec.summary       = 'A Danger plugin for running Ruby files through Rubocop.'
   spec.homepage      = 'https://github.com/ashfurrow/danger-rubocop'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
@@ -24,20 +24,22 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake', '~> 10.0'
 
+  # For validating the plugin lints
+  spec.add_development_dependency 'yard'
+
   #  Testing support
-  spec.add_development_dependency "rspec", '~> 3.4'
+  spec.add_development_dependency 'rspec', '~> 3.4'
 
   # Makes testing easy via `bundle exec guard`
-  spec.add_development_dependency "guard", '~> 2.14'
-  spec.add_development_dependency "guard-rspec", '~> 4.7'
-  
+  spec.add_development_dependency 'guard', '~> 2.14'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+
   # If you want to work on older builds of ruby
-  spec.add_development_dependency "listen", '3.0.7'
+  spec.add_development_dependency 'listen', '3.0.7'
 
   # This gives you the chance to run a REPL inside your test
-  # via 
+  # via
   #    binding.pry
   # This will stop test execution and let you inspect the results
-  spec.add_development_dependency "pry"
-
+  spec.add_development_dependency 'pry'
 end

data/lib/danger_plugin.rb

@@ -1,44 +1,61 @@
 module Danger
-
   # Run Ruby files through Rubocop.
   # Results are passed out as a table in markdown.
   #
   # @example Specifying custom config file.
   #
-  #          rubocop.run
+  #          rubocop.lint
+  #
+  # @example Lint specific files in a folder, when they change
+  #
+  #  public_files = (modified_files + added_files).select { |path| path.include?("/public/") }
+  #  rubocop.lint public_files
+  #
   #
   # @see  Moya/Aeryn
   # @tags ruby, rubocop, linter
   #
   class DangerRubocop < Plugin
-
-    # Runs Ruby files through Rubocop. Generates a `markdown` list of warnings. 
+    # Runs Ruby files through Rubocop. Generates a `markdown` list of warnings.
     #
     # @param   [String] files
-    #          A globbed string which should return the files that you want to 
-    #          run through, defaults to nil. If nil, modified and added files 
+    #          A globbed string which should return the files that you want to
+    #          run through, defaults to nil. If nil, modified and added files
     #          from the diff will be used.
     # @return  [void]
     #
-    def run(files=nil)
-      files_to_lint = files ? Dir.glob(files) : (modified_files + added_files)
+    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' }
-      rubocop_results = files_to_lint.map { |f| JSON.parse(`bundle exec rubocop -f json #{f}`)['files'] }.flatten
-      offending_files = rubocop_results.select { |f| f['offenses'].count > 0 }
 
+      offending_files = rubocop(files_to_lint)
       return if offending_files.empty?
 
-      message = '### Rubocop violations'
-      message << 'File | Line | Reason |\n'
-      message << '| --- | ----- | ----- |\n'  
+      markdown offenses_message(offending_files)
+    end
 
-      offending_files.each do |f|
-        f['offenses'].each do |o|
-          message << "#{f['path']} | #{o['location']['line']} | #{o['message']} \n"
-        end
+    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 }
+    end
 
-      markdown message
+    def offenses_message(offending_files)
+      require 'terminal-table'
+
+      message = "### Rubocop violations\n\n"
+      message + Terminal::Table.new(
+        headings: %w(File Line Reason),
+        rows: offending_files.flat_map do |file|
+          file['offenses'].map do |offense|
+            [file['path'], offense['location']['line'], offense['message']]
+          end
+        end
+      ).to_s
     end
   end
 end

data/lib/version.rb

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

data/spec/danger_plugin_spec.rb

@@ -5,7 +5,7 @@ module Danger
     it 'is a plugin' do
       expect(Danger::DangerRubocop < Danger::Plugin).to be_truthy
     end
-    
+
     describe 'with Dangerfile' do
       before do
         @dangerfile = testing_dangerfile
@@ -16,13 +16,13 @@ module Danger
         before do
           # Set up our stubbed JSON response
           response = {
-            "files" => [
+            'files' => [
               {
-                "path": "ruby_file.rb",
-                "offenses" => [
+                'path' => 'ruby_file.rb',
+                'offenses' => [
                   {
-                    "message" => "Don't do that!",
-                    "location" => {"line": 13}
+                    'message' => "Don't do that!",
+                    'location' => { 'line' => 13 }
                   }
                 ]
               }
@@ -32,27 +32,32 @@ module Danger
         end
 
         it 'handles a known rubocop report' do
-          allow(@rubocop).to receive(:`).with('bundle exec rubocop -f json spec/fixtures/ruby_file.rb').and_return(@rubocop_response)
+          allow(@rubocop).to receive(:`)
+            .with('bundle exec rubocop -f json spec/fixtures/ruby_file.rb')
+            .and_return(@rubocop_response)
 
           # Do it
-          @rubocop.run("spec/fixtures/*.rb")
+          @rubocop.lint('spec/fixtures/*.rb')
 
           output = @rubocop.status_report[:markdowns].first
 
           expect(output).to_not be_empty
 
           # A title
-          expect(output).to include("Rubocop violations")
+          expect(output).to include('Rubocop violations')
           # A warning
-          expect(output).to include("ruby_file.rb | 13 | Don't do that!")
+          expect(output).to include("ruby_file.rb | 13   | Don't do that!")
         end
 
         it 'handles no files' do
-          allow(@rubocop).to receive(:modified_files).and_return(['spec/fixtures/ruby_file.rb'])
-          allow(@rubocop).to receive(:added_files).and_return([])          
-          allow(@rubocop).to receive(:`).with('bundle exec rubocop -f json spec/fixtures/ruby_file.rb').and_return(@rubocop_response)
+          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')
+            .and_return(@rubocop_response)
 
-          @rubocop.run
+          @rubocop.lint
 
           expect(@rubocop.status_report[:markdowns].first).to_not be_empty
         end

data/spec/spec_helper.rb

@@ -1,11 +1,11 @@
 require 'pathname'
 
 ROOT = Pathname.new(File.expand_path('../../', __FILE__))
-$:.unshift((ROOT + 'lib').to_s)
-$:.unshift((ROOT + 'spec').to_s)
+$LOAD_PATH.unshift((ROOT + 'lib').to_s)
+$LOAD_PATH.unshift((ROOT + 'spec').to_s)
 
 RSpec.configure do |config|
- # Use color in STDOUT
+  # Use color in STDOUT
   config.color = true
 end
 
@@ -29,11 +29,11 @@ end
 # running a PR on TravisCI
 def testing_env
   {
-    "HAS_JOSH_K_SEAL_OF_APPROVAL" => "true",
-    "TRAVIS_PULL_REQUEST" => "800",
-    "TRAVIS_REPO_SLUG" => "artsy/eigen",
-    "TRAVIS_COMMIT_RANGE" => "759adcbd0d8f...13c4dc8bb61d",
-    "DANGER_GITHUB_API_TOKEN" => "123sbdq54erfsd3422gdfio"
+    'HAS_JOSH_K_SEAL_OF_APPROVAL' => 'true',
+    'TRAVIS_PULL_REQUEST' => '800',
+    'TRAVIS_REPO_SLUG' => 'artsy/eigen',
+    'TRAVIS_COMMIT_RANGE' => '759adcbd0d8f...13c4dc8bb61d',
+    'DANGER_GITHUB_API_TOKEN' => '123sbdq54erfsd3422gdfio'
   }
 end
 
@@ -41,4 +41,4 @@ end
 def testing_dangerfile
   env = Danger::EnvironmentManager.new(testing_env)
   Danger::Dangerfile.new(env, testing_ui)
-end
+end

metadata

@@ -1,111 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: danger-rubocop
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ash Furrow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-05 00:00:00.000000000 Z
+date: 2016-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.4'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.14'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.7'
 - !ruby/object:Gem::Dependency
@@ -126,30 +140,30 @@ dependencies:
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: A Danger plugin for running Ruby files through Rubocop.
-email:
-- ash@ashfurrow.com
+email: ash@ashfurrow.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - Gemfile
 - Gemfile.lock
 - Guardfile
 - LICENSE
 - README.md
 - Rakefile
+- circle.yml
 - danger-rubocop.gemspec
 - lib/danger_plugin.rb
 - lib/version.rb
@@ -166,12 +180,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []