danger-swiftlint 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96a0feb085a87d9319afbbd67f7e1e0dda30961f
-  data.tar.gz: c4d45699850bad5c113e0f49cd371dec1076bac4
+  metadata.gz: 2ab53ea91e7386c252bd97c2ed1eb870cc15cd49
+  data.tar.gz: 0005c7f2952722f6900127a316a2a92c57ba7aca
 SHA512:
-  metadata.gz: 284ee20ec49d083e571926ecfd67a027f468daa0c115ee841064fe58f20ac5319359c4b2592bc6c53b19cca3c013ff5806cf582e324ed7694fdc80ea2a5bb938
-  data.tar.gz: a646d759dccf4a08e9cb0cf8f109d0cf3388f52029ef6c1633ba6f5da4911df468f53042f9d4b929ade419858397c5c764de8f63c5a53b7eb955aca84a2fb477
+  metadata.gz: 07b86f7d1fcb2a48a328d79f97f22d7a8abbf20e3026b7c51704f20f8c6eddb978dea223bfbca99dbccb881deb2e829a16c3b5219ea2e9fd5f4050306c8c8ddf
+  data.tar.gz: 1ff32813a484950a474c56e0ba786842c6e9e592eb4f233eab459fb79291942c7692476d14d1b924351a08e1f7cae43fb81e4d05f59e28936dc96c263f101c10

data/Changelog.md

@@ -4,6 +4,10 @@
 
 - Nothing yet!
 
+## 0.3.0
+
+- Adds selective linting, now SwiftLint will only run on the PR added and modified files. See [#23](https://github.com/ashfurrow/danger-swiftlint/pull/23)
+
 ## 0.2.1
 
 - Adds support for specifying a directory in which to run SwiftLint. See [#19](https://github.com/ashfurrow/danger-swiftlint/pull/19).

data/Gemfile.lock

@@ -1,31 +1,40 @@
 PATH
   remote: .
   specs:
-    danger-swiftlint (0.1.2)
+    danger-swiftlint (0.3.0)
       danger
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.4.0)
+    addressable (2.5.0)
+      public_suffix (~> 2.0, >= 2.0.2)
     bacon (1.2.0)
-    claide (1.0.0)
+    claide (1.0.1)
+    claide-plugins (0.9.2)
+      cork
+      nap
+      open4 (~> 1.3)
     coderay (1.1.1)
     colored (1.2)
-    cork (0.1.0)
+    cork (0.2.0)
       colored (~> 1.2)
-    danger (0.8.5)
+    danger (4.0.3)
       claide (~> 1.0)
+      claide-plugins (>= 0.9.2)
       colored (~> 1.2)
       cork (~> 0.1)
-      faraday (~> 0)
+      faraday (~> 0.9)
+      faraday-http-cache (~> 1.0)
       git (~> 1)
+      kramdown (~> 1.5)
       octokit (~> 4.2)
-      redcarpet (~> 3.3)
       terminal-table (~> 1)
     diff-lcs (1.2.5)
-    faraday (0.9.2)
+    faraday (0.10.0)
       multipart-post (>= 1.2, < 3)
+    faraday-http-cache (1.3.1)
+      faraday (~> 0.8)
     ffi (1.9.10)
     formatador (0.2.5)
     git (1.3.0)
@@ -43,6 +52,7 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
+    kramdown (1.13.1)
     listen (3.0.7)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9.7)
@@ -54,23 +64,25 @@ 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)
+    octokit (4.6.2)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    open4 (1.3.4)
     prettybacon (0.0.2)
       bacon (~> 1.2)
     pry (0.10.3)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
+    public_suffix (2.0.4)
     rake (10.5.0)
     rb-fsevent (0.9.7)
     rb-inotify (0.9.7)
       ffi (>= 0.5.0)
-    redcarpet (3.3.4)
     rspec (3.4.0)
       rspec-core (~> 3.4.0)
       rspec-expectations (~> 3.4.0)
@@ -84,13 +96,15 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.4.0)
     rspec-support (3.4.1)
-    sawyer (0.7.0)
-      addressable (>= 2.3.5, < 2.5)
-      faraday (~> 0.8, < 0.10)
+    sawyer (0.8.1)
+      addressable (>= 2.3.5, < 2.6)
+      faraday (~> 0.8, < 1.0)
     shellany (0.0.1)
     slop (3.6.0)
-    terminal-table (1.6.0)
+    terminal-table (1.7.3)
+      unicode-display_width (~> 1.1.1)
     thor (0.19.1)
+    unicode-display_width (1.1.2)
 
 PLATFORMS
   ruby
@@ -110,4 +124,4 @@ DEPENDENCIES
   rspec (~> 3.4)
 
 BUNDLED WITH
-   1.12.5
+   1.13.1

data/README.md

@@ -12,6 +12,8 @@ Add this line to your Gemfile:
 gem 'danger-swiftlint'
 ```
 
+SwiftLint also needs to be installed before you run Danger, which you can do [via Homebrew](https://github.com/realm/SwiftLint#installation) or a [Brewfile](https://github.com/Homebrew/homebrew-bundle).
+
 ## Usage
 
 The easiest way to use is just add this to your Dangerfile:

data/lib/danger_plugin.rb

@@ -29,7 +29,7 @@ module Danger
     #          if nil, modified and added files from the diff will be used.
     # @return  [void]
     #
-    def lint_files
+    def lint_files(files=nil)
       # Installs SwiftLint if needed
       system "brew install swiftlint" unless swiftlint_installed?
 
@@ -39,33 +39,82 @@ module Danger
         return
       end
 
-      swiftlint_command = ""
-      swiftlint_command += "cd #{directory} && " if directory
-      swiftlint_command += "swiftlint lint --quiet --reporter json"
-      swiftlint_command += " --config #{config_file}" if config_file
-
-      require 'json'
-      result_json = JSON.parse(`(#{swiftlint_command})`).flatten
-
-      # Convert to swiftlint results
-      warnings = result_json.select do |results| 
-        results['severity'] == 'Warning'
-      end
-      errors = result_json.select do |results| 
-        results['severity'] == 'Error' 
-      end
-
-      message = ''
-
-      # We got some error reports back from swiftlint
-      if warnings.count > 0 || errors.count > 0
-        message = "### SwiftLint found issues\n\n"
+      require 'tempfile'
+      Tempfile.open('.swiftlint_danger.yml') do |temp_config_file|
+        on_the_fly_configuration_path = nil
+        excluded_dirs = []
+        if config_file
+          require 'yaml'
+          original_config = YAML.load_file(config_file)
+
+          danger_compatible_config = original_config
+          danger_compatible_config.tap { |hash| hash.delete('included') }
+
+          excluded_dirs = danger_compatible_config['excluded']
+            .map { |path| File.dirname(config_file) + '/' + path }
+            .select { |path| File.exists?(File.expand_path(path)) || Dir.exists?(File.expand_path(path)) }
+
+          File.write(temp_config_file.path, danger_compatible_config.to_yaml)
+
+          on_the_fly_configuration_path = temp_config_file.path
+        end
+
+        swiftlint_command = "swiftlint lint --quiet --reporter json"
+        swiftlint_command += " --config #{on_the_fly_configuration_path}" if on_the_fly_configuration_path
+
+        require 'json'
+
+        if directory
+          swiftlint_command = "cd #{directory} && #{swiftlint_command}" if directory
+
+          result_json = JSON.parse(`(#{swiftlint_command})`).flatten
+        else
+          # Either use files provided, or use the modified + added
+          swift_files = files ? Dir.glob(files) : (git.modified_files + git.added_files)
+
+          swift_files.select! do |line| line.end_with?(".swift") end
+
+          require 'find'
+          swift_files = swift_files.reject do |file|
+            found = false
+            excluded_dirs.each do |excluded_dir|
+              found = Find.find(File.expand_path(excluded_dir)).include?(File.expand_path(file))
+              break if found
+            end
+            found
+          end
+
+          # Make sure we don't fail when paths have spaces
+          swift_files = swift_files.map { |file| "\"#{file}\"" }
+
+          result_json = swift_files
+          .uniq
+          .collect { |f| `(#{swiftlint_command} --path #{f})`.strip }
+          .reject { |s| s == '' }
+          .map { |s| JSON.parse(s).flatten }
+          .flatten
+        end
+
+        # Convert to swiftlint results
+        warnings = result_json.select do |results| 
+          results['severity'] == 'Warning'
+        end
+        errors = result_json.select do |results| 
+          results['severity'] == 'Error' 
+        end
+
+        message = ''
+
+        # We got some error reports back from swiftlint
+        if warnings.count > 0 || errors.count > 0
+          message = "### SwiftLint found issues\n\n"
+        end
+
+        message << parse_results(warnings, 'Warnings') unless warnings.empty?
+        message << parse_results(errors, 'Errors') unless errors.empty?
+
+        markdown message unless message.empty?
       end
-
-      message << parse_results(warnings, 'Warnings') unless warnings.empty?
-      message << parse_results(errors, 'Errors') unless errors.empty?
-
-      markdown message unless message.empty?
     end
 
     # Parses swiftlint invocation results into a string

data/lib/version.rb

@@ -1,3 +1,3 @@
 module DangerSwiftlint
-  VERSION = "0.2.1".freeze
+  VERSION = "0.3.0".freeze
 end

data/spec/danger_plugin_spec.rb

@@ -26,9 +26,9 @@ module Danger
 
       it 'does not markdown an empty message' do
         allow(@swiftlint).to receive(:`)
-          .with('swiftlint lint --quiet --reporter json')
+          .with('swiftlint lint --quiet --reporter json --path "spec/fixtures/SwiftFile.swift"')
           .and_return('[]')
-        
+
         expect(@swiftlint.status_report[:markdowns].first).to be_nil
       end
 
@@ -38,16 +38,16 @@ module Danger
           allow(@swiftlint).to receive(:`).with("which swiftlint").and_return("/bin/wheverever/swiftlint")
 
           # Set up our stubbed JSON response
-          @swiftlint_response = '[{"reason": "Force casts should be avoided.", "file": "/User/me/this_repo/spec/fixtures/SwiftFile.swift", "line": 13, "severity": "Error" }]'
+          @swiftlint_response = '[{ "rule_id" : "force_cast", "reason" : "Force casts should be avoided.", "character" : 19, "file" : "/Users/me/this_repo/spec//fixtures/SwiftFile.swift", "severity" : "Error", "type" : "Force Cast", "line" : 13 }]'
         end
 
-        it 'handles a known SwiftLint report' do
-          allow(@swiftlint).to receive(:`).with('(swiftlint lint --quiet --reporter json)').and_return(@swiftlint_response)
+        it 'handles a known SwiftLint report with give files' do
+          allow(@swiftlint).to receive(:`).with('(swiftlint lint --quiet --reporter json --path "spec/fixtures/SwiftFile.swift")').and_return(@swiftlint_response)
 
           # Do it
-          @swiftlint.lint_files
+          @swiftlint.lint_files("spec/fixtures/*.swift")
 
-          output = @swiftlint.status_report[:markdowns].first
+          output = @swiftlint.status_report[:markdowns].first.to_s
 
           expect(output).to_not be_empty
 
@@ -57,21 +57,46 @@ module Danger
           expect(output).to include("SwiftFile.swift | 13 | Force casts should be avoided.")
         end
 
-        it 'handles no files' do
-          allow(@swiftlint).to receive(:`).with('(swiftlint lint --quiet --reporter json)').and_return(@swiftlint_response)
+        it 'handles no given files by looking up the git diff' do
+          allow(@swiftlint.git).to receive(:modified_files).and_return(['spec/fixtures/SwiftFile.swift'])
+          allow(@swiftlint.git).to receive(:added_files).and_return([])
+
+          allow(@swiftlint).to receive(:`).with('(swiftlint lint --quiet --reporter json --path "spec/fixtures/SwiftFile.swift")').and_return(@swiftlint_response)
 
           @swiftlint.lint_files
 
-          expect(@swiftlint.status_report[:markdowns].first).to_not be_empty
+          expect(@swiftlint.status_report[:markdowns].first.to_s).to_not be_empty
         end
 
-        it 'uses a config file' do
-          @swiftlint.config_file = 'some_config.yml'
-          allow(@swiftlint).to receive(:`).with('(swiftlint lint --quiet --reporter json --config some_config.yml)').and_return(@swiftlint_response)
+        it 'uses a config file generated on the fly by removing the "included" values from the given one' do
+          fake_temp_file = Tempfile.new('fake.yml')
 
-          @swiftlint.lint_files
+          begin
+            allow(Tempfile).to receive(:open) { |&block| block.call(fake_temp_file) }
+
+            @swiftlint.config_file = 'spec/fixtures/some_config.yml'
+
+            expect(YAML.load_file(@swiftlint.config_file)['included']).to_not be_nil
+
+            allow(@swiftlint).to receive(:`).with('(swiftlint lint --quiet --reporter json --config ' + fake_temp_file.path + ' --path "spec/fixtures/SwiftFile.swift")') do
+              # The tempfile lifetime is limited to the execution of the lint
+              # command, as such if we were to assert it after the command has
+              # run the file wouldn't exist anymore.
+              #
+              # By injecting the assertion here, whithin the method execution,
+              # we access the file while it still exists.
+              expect(YAML.load_file(fake_temp_file.path)['included']).to be_nil
+
+              @swiftlint_response
+            end
+
+            @swiftlint.lint_files("spec/fixtures/*.swift")
 
-          expect(@swiftlint.status_report[:markdowns].first).to_not be_empty
+            expect(@swiftlint.status_report[:markdowns].first.to_s).to_not be_empty
+          ensure
+            fake_temp_file.close
+            fake_temp_file.unlink
+          end
         end
 
         it 'uses a custom directory' do
@@ -80,7 +105,51 @@ module Danger
 
           @swiftlint.lint_files
 
-          expect(@swiftlint.status_report[:markdowns].first).to_not be_empty
+          expect(@swiftlint.status_report[:markdowns].first.to_s).to_not be_empty
+        end
+
+        it 'does not crash if JSON reporter returns an empty string rather than an object' do
+          # This can occurr if for some reson there is no file at the give path.
+          # In such a case SwiftLint will write to stderr:
+          #
+          #   Could not read contents of `path/to/file`
+          #   No lintable files found at path 'path/to/file'
+          #
+          # and exit with code 1.
+          #
+          # To our code this would simply look like an empty result, which
+          # would then become an empty string, which cannot be parsed into a
+          # JSON object.
+          response = ''
+          allow(@swiftlint).to receive(:`).with('(swiftlint lint --quiet --reporter json --path "spec/fixtures/SwiftFile.swift")').and_return(response)
+
+          @swiftlint.lint_files("spec/fixtures/*.swift")
+
+          output = @swiftlint.status_report[:markdowns].first.to_s
+
+          # If we get to this point then we haven't crashed, happy days
+          expect(output).to be_empty
+        end
+
+        it 'does not lint files in the excluded paths' do
+          allow(@swiftlint.git).to receive(:modified_files).and_return(['spec/fixtures/SwiftFile.swift', 'spec/fixtures/excluded_dir/SwiftFileThatShouldNotBeIncluded.swift'])
+          allow(@swiftlint.git).to receive(:added_files).and_return([])
+
+          fake_temp_file = Tempfile.new('fake.yml')
+
+          begin
+            allow(Tempfile).to receive(:open) { |&block| block.call(fake_temp_file) }
+
+            # The only call that should be received is this one, if @swiftlint
+            # will be called with any other param the test will fail
+            allow(@swiftlint).to receive(:`).with('(swiftlint lint --quiet --reporter json --config ' + fake_temp_file.path + ' --path "spec/fixtures/SwiftFile.swift")').and_return(@swiftlint_response)
+
+            @swiftlint.config_file = 'spec/fixtures/some_config.yml'
+            @swiftlint.lint_files
+          ensure
+            fake_temp_file.close
+            fake_temp_file.unlink
+          end
         end
       end
     end

data/spec/fixtures/excluded_dir/SwiftFileThatShouldNotBeIncluded.swift

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

data/spec/fixtures/some_config.yml

@@ -0,0 +1,8 @@
+disabled_rules:
+  - todo
+
+included:
+  - an/included/folder
+
+excluded:
+  - excluded_dir

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: danger-swiftlint
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Ash Furrow
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-23 00:00:00.000000000 Z
+date: 2017-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger
@@ -147,6 +147,8 @@ files:
 - lib/version.rb
 - spec/danger_plugin_spec.rb
 - spec/fixtures/SwiftFile.swift
+- spec/fixtures/excluded_dir/SwiftFileThatShouldNotBeIncluded.swift
+- spec/fixtures/some_config.yml
 - spec/spec_helper.rb
 homepage: https://github.com/ashfurrow/danger-swiftlint
 licenses:
@@ -168,11 +170,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A Danger plugin for linting Swift with SwiftLint.
 test_files:
 - spec/danger_plugin_spec.rb
 - spec/fixtures/SwiftFile.swift
+- spec/fixtures/excluded_dir/SwiftFileThatShouldNotBeIncluded.swift
+- spec/fixtures/some_config.yml
 - spec/spec_helper.rb