danger-swiftformat 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e4ff2c06c4f47af744f1ecc4900ec266670fd93c20180b0aedd39a808f3c54c
-  data.tar.gz: 96433fecb5ba65121988850db61de14cd990d30f05146764e918766e006b7daf
+  metadata.gz: 4725bb4b3e493d619b7bcc38c909823aa6d014a31fe938341f8488a40690e8ce
+  data.tar.gz: 7ea2c85afac6d489fc255f0618e0e02002feba04e59f50df23374cab5c6e2a3b
 SHA512:
-  metadata.gz: '093e955e3ad8c198b162e557746ab18fc572ef5d99f856d0c054db05d402a1e4f1b48d3c4f6c39b5cc88d30fdc4e4fd05cefc3cd3bd64339c06a3146546aee28'
-  data.tar.gz: 29b8270dcc22adbd1e84c2dd128c0f5c5c4f60bd52349480cc8896087edfbc3abd1a9c0c7ad52b2a6571c5e863a3831e3b8ad4b1363410f3d448c12c5c66122b
+  metadata.gz: fb8be55f45b39b9b2a7f7adee5a1f4cfbfb87b029cf36a6cc2ca69a27885ce1a3c9009d9de687202e4e071dd8174f1ee623c3725570401c949add0f841ce162a
+  data.tar.gz: 8d78eb43d9e124cdd39b70521ac0b7583e17fa32851928cd72aeb9ab3d40bd3a6fb96536d797585e68d4ebfc8dfb657f949490502fb04e6d75dd8868419bf1a8

data/.rubocop.yml

@@ -150,3 +150,7 @@ PercentLiteralDelimiters:
 
 Security/YAMLLoad:
   Enabled: false
+
+Metrics/ModuleLength:
+  Exclude:
+    - "**/*_spec.rb"

data/.travis.yml

@@ -1,12 +1,15 @@
 language: ruby
-cache:
-  directories:
-    - bundle
+cache: bundler
+
+before_install:
+  - gem update --system
+  - gem install bundler
 
 rvm:
-  - 2.2.8
-  - 2.3.5
-  - 2.4.2
+  - 2.3.8
+  - 2.4.4
+  - 2.5.3
+  - 2.6.3
 
 script:
     - bundle exec rake spec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-swiftformat (0.4.0)
+    danger-swiftformat (0.5.0)
       danger-plugin-api (~> 1.0)
 
 GEM
@@ -19,7 +19,7 @@ GEM
     colored2 (3.1.2)
     cork (0.3.0)
       colored2 (~> 3.1)
-    danger (5.11.0)
+    danger (6.0.6)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
@@ -27,7 +27,8 @@ GEM
       faraday (~> 0.9)
       faraday-http-cache (~> 1.0)
       git (~> 1.5)
-      kramdown (~> 1.5)
+      kramdown (~> 2.0)
+      kramdown-parser-gfm (~> 1.0)
       no_proxy_fix
       octokit (~> 4.7)
       terminal-table (~> 1)
@@ -38,10 +39,10 @@ GEM
       multipart-post (>= 1.2, < 3)
     faraday-http-cache (1.3.1)
       faraday (~> 0.8)
-    ffi (1.9.25)
+    ffi (1.10.0)
     formatador (0.2.5)
     git (1.5.0)
-    guard (2.14.2)
+    guard (2.15.0)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (>= 1.0.12, < 2.0)
@@ -55,14 +56,16 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    jaro_winkler (1.5.1)
-    kramdown (1.17.0)
+    jaro_winkler (1.5.2)
+    kramdown (2.1.0)
+    kramdown-parser-gfm (1.0.1)
+      kramdown (~> 2.0)
     listen (3.1.5)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
       ruby_dep (~> 1.2)
     lumberjack (1.0.13)
-    method_source (0.9.0)
+    method_source (0.9.2)
     multipart-post (2.0.0)
     nap (1.1.0)
     nenv (0.3.0)
@@ -70,43 +73,43 @@ GEM
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    octokit (4.13.0)
+    octokit (4.14.0)
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
-    parallel (1.12.1)
-    parser (2.5.1.2)
+    parallel (1.17.0)
+    parser (2.6.2.1)
       ast (~> 2.4.0)
-    powerpack (0.1.2)
-    pry (0.11.3)
+    pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
+    psych (3.1.0)
     public_suffix (3.0.3)
     rainbow (3.0.0)
-    rake (12.3.1)
+    rake (12.3.2)
     rb-fsevent (0.10.3)
-    rb-inotify (0.9.10)
-      ffi (>= 0.5.0, < 2)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
       rspec-mocks (~> 3.8.0)
     rspec-core (3.8.0)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
+    rspec-expectations (3.8.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
-    rubocop (0.59.0)
+    rubocop (0.67.2)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
+      psych (>= 3.1.0)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
+      unicode-display_width (>= 1.4.0, < 1.6)
     ruby-progressbar (1.10.0)
     ruby_dep (1.5.0)
     sawyer (0.8.1)
@@ -115,9 +118,9 @@ GEM
     shellany (0.0.1)
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
-    thor (0.20.0)
-    unicode-display_width (1.4.0)
-    yard (0.9.16)
+    thor (0.20.3)
+    unicode-display_width (1.5.0)
+    yard (0.9.19)
 
 PLATFORMS
   ruby

data/README.md

@@ -8,7 +8,7 @@ This plugin is heavily inspired by [danger-swiftlint].
 
 Add this line to your Gemfile:
 
-    require 'danger-swiftformat'
+    gem 'danger-swiftformat'
 
 [SwiftFormat] also needs to be installed before you run Danger.
 
@@ -22,6 +22,8 @@ swiftformat.check_format
 
 By default, danger-swiftformat will check added and modified files.
 
+## Options and parameters
+
 If you want errors to fail Danger, you can use the `fail_on_error` option:
 
 ```ruby
@@ -40,6 +42,16 @@ You can specify additional `swiftformat` arguments using the `additional_args` p
 swiftformat.additional_args = "--indent tab --self insert"
 ```
 
+By default, `danger-swiftformat` will run on any modified or created file ending in `.swift`. If you'd like to exclude
+certain directories or files such as `Pods`, you can use the `exclude` parameter:
+
+```ruby
+swiftformat.exclude = %w(Pods/** Carthage/** Sources/Nope.swift **/*_autogenerated.swift)
+```
+
+The `exclude` option takes an array of glob patterns; you can find additional documentation on the patterns
+[here](https://ruby-doc.org/core-2.6.3/File.html#method-c-fnmatch).
+
 ## Development
 
 1. Clone this repo

data/lib/swiftformat/gem_version.rb

@@ -1,3 +1,3 @@
 module Swiftformat
-  VERSION = "0.4.0".freeze
+  VERSION = "0.5.0".freeze
 end

data/lib/swiftformat/plugin.rb

@@ -19,6 +19,16 @@ module Danger
     # @return [String]
     attr_accessor :additional_args
 
+    # Additional message to be appended the report
+    #
+    # @return [String]
+    attr_accessor :additional_message
+
+    # An array of file and directory paths to exclude
+    #
+    # @return [Array<String]
+    attr_accessor :exclude
+
     # Runs swiftformat
     #
     # @param [Boolean] fail_on_error
@@ -48,6 +58,11 @@ module Danger
       results[:errors].each do |error|
         message << "| #{error[:file].gsub(Dir.pwd + '/', '')} | #{error[:rules].join(', ')} |\n"
       end
+
+      unless additional_message.nil?
+        message << "\n" << additional_message
+      end
+
       markdown message
 
       if fail_on_error
@@ -61,8 +76,11 @@ module Danger
     def find_swift_files
       files = (git.modified_files - git.deleted_files) + git.added_files
 
+      @exclude = %w() if @exclude.nil?
+
       files
         .select { |file| file.end_with?(".swift") }
+        .reject { |file| @exclude.any? { |glob| File.fnmatch(glob, file) } }
         .uniq
         .sort
     end

data/lib/swiftformat/swiftformat.rb

@@ -41,7 +41,7 @@ module Danger
       }
     end
 
-    ERRORS_REGEX = /rules applied:(.*)\n.*updated (.*)$/
+    ERRORS_REGEX = /rules applied:(.*)\n.*updated (.*)$/.freeze
 
     def errors(output)
       errors = []
@@ -56,7 +56,7 @@ module Danger
       errors
     end
 
-    RUNTIME_REGEX = /.*swiftformat completed.*(.+\..+)s/
+    RUNTIME_REGEX = /.*swiftformat completed.*(.+\..+)s/.freeze
 
     def run_time(output)
       if RUNTIME_REGEX.match(output)

data/spec/swiftformat/plugin_spec.rb

@@ -54,6 +54,48 @@ module Danger
         end
       end
 
+      context "with additional_message" do
+        let(:additional_message) { "I'm the additional message." }
+        let(:error_output) { { errors: [{ file: "Modified.swift", rules: %w(firstRule secondRule) }], stats: { run_time: "0.16s" } } }
+
+        it "should include the additional message in the report" do
+          allow(@sut.git).to receive(:added_files).and_return(["Added.swift"])
+          allow(@sut.git).to receive(:modified_files).and_return(["Modified.swift"])
+          allow(@sut.git).to receive(:deleted_files).and_return(["Deleted.swift"])
+          allow_any_instance_of(SwiftFormat).to receive(:installed?).and_return(true)
+          allow_any_instance_of(SwiftFormat).to receive(:check_format).with(%w(Added.swift Modified.swift), nil).and_return(error_output)
+          @sut.additional_message = additional_message
+          @sut.check_format(fail_on_error: true)
+
+          status = @sut.status_report
+          markdown = status[:markdowns].first.message
+          expect(markdown).to include(additional_message)
+        end
+      end
+
+      context "with exclude" do
+        let(:exclude) { %w(**/Modified.swift Pods/** Carthage/** **/*_autogenerated.swift) }
+        let(:success_output) { { errors: [], stats: { run_time: "0.08s" } } }
+
+        it "should filter the files passed to swiftformat" do
+          allow(@sut.git).to receive(:added_files).and_return(%w(Added.swift Pods/Test.swift Carthage/SQLite.swift Sources/Module/JSONParsing_autogenerated.swift))
+          allow(@sut.git).to receive(:modified_files).and_return(["Source/Modified.swift"])
+          allow(@sut.git).to receive(:deleted_files).and_return(["Deleted.swift"])
+          allow_any_instance_of(SwiftFormat).to receive(:installed?).and_return(true)
+          allow_any_instance_of(SwiftFormat).to receive(:check_format)
+            .with(%w(Added.swift), nil)
+            .and_return(success_output)
+
+          @sut.exclude = exclude
+
+          @sut.check_format(fail_on_error: true)
+
+          status = @sut.status_report
+          expect(status[:errors]).to be_empty
+          expect(status[:markdowns]).to be_empty
+        end
+      end
+
       describe "#check_format" do
         let(:success_output) { { errors: [], stats: { run_time: "0.08s" } } }
         let(:error_output) { { errors: [{ file: "Modified.swift", rules: %w(firstRule secondRule) }], stats: { run_time: "0.16s" } } }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-swiftformat
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Vincent Garrigues
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-04 00:00:00.000000000 Z
+date: 2019-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -198,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A danger plugin for checking Swift formatting using SwiftFormat.