danger-ktlint 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99b078a476493453fd609f033e65c6cd20d695617fc8a8a3e6a9c8b0b7745f3f
-  data.tar.gz: bf60ceecd5cf172c879f80183933b55274a5f1261f00fa241ae56fa95e9f44ae
+  metadata.gz: fccc83b4c267453f15dbab68b15c2251de27eee1c89fbd7f47800f84f7528816
+  data.tar.gz: c97f5f1200761d40f806b18efd9bb29070914857656460935a3d1696198af6e9
 SHA512:
-  metadata.gz: 255316fb1e4627d772601a0fc40ab3d8faf67e35696f4433477ed431a3de010a203e5f9201902c9c98f046450546d2829a457d980ce9d887a65db6dd4dc6b7ef
-  data.tar.gz: 325c2fb3d73b05a9a4e8256c94accab75a8bdec4978d46d8b8ef1db6adea6947b776dcb1316be2271d6079f8f12347dcb02b13e4a600a546d4e6f67ce3dd98f3
+  metadata.gz: 14aa4af509079aa9ea8faabfc8a41e564fef09d1df5ec53d102898069ca3cdf1770ff9cb5bc3d1f0f484bdc1e08dd6e1ff68df5c2b7f8ad351a2f8f6588dad47
+  data.tar.gz: 34a20e7ec1eb556208a56fcd4c42b299a69ffd1a8fa9148888f87af6984aeeee043df9eb0ac5a9d75b10e05c02eb97290cff33d4004c9c8d5ca197678ae38aac

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Unreleased
 
+## 0.0.7
+
+- Support multiple ktlint result json.
+
 ## 0.0.6
 
 - Support GitLab and BitBucket server even if `inline_mode: false` is specified.

data/README.md

@@ -46,6 +46,8 @@ Default is false.
 ktlint.skip_lint = true
 # If skip_lint is specified, report_file must also be specified.
 ktlint.report_file = 'result.json'
+# If you use ktlint in multiple modules app, you can specify multiple ktlint result json.
+# ktlint.report_files_pattern = '**/result.json'
 ktlint.lint
 ```
 

data/lib/ktlint/gem_version.rb

@@ -1,3 +1,3 @@
 module Ktlint
-  VERSION = "0.0.6".freeze
+  VERSION = "0.0.7".freeze
 end

data/lib/ktlint/plugin.rb

@@ -17,7 +17,7 @@ module Danger
     # TODO: Lint all files if `filtering: false`
     attr_accessor :filtering
 
-    attr_accessor :skip_lint, :report_file
+    attr_accessor :skip_lint, :report_file, :report_files_pattern
 
     def limit
       @limit ||= nil
@@ -57,7 +57,7 @@ module Danger
 
     # Comment to a PR by ktlint result json
     #
-    # // Sample ktlint result
+    # // Sample single ktlint result
     # [
     #   {
     #     "file": "app/src/main/java/com/mataku/Model.kt",
@@ -71,20 +71,22 @@ module Danger
     # 		]
     # 	}
     # ]
-    def send_markdown_comment(results, targets)
+    def send_markdown_comment(ktlint_results, targets)
       catch(:loop_break) do
         count = 0
-        results.each do |result|
-          result['errors'].each do |error|
-            file_path = relative_file_path(result['file'])
-            next unless targets.include?(file_path)
-
-            message = "#{file_html_link(file_path, error['line'])}: #{error['message']}"
-            fail(message)
-            unless limit.nil?
-              count += 1
-              if count >= limit
-                throw(:loop_break)
+        ktlint_results.each do |ktlint_result|
+          ktlint_result.each do |result|
+            result['errors'].each do |error|
+              file_path = relative_file_path(result['file'])
+              next unless targets.include?(file_path)
+
+              message = "#{file_html_link(file_path, error['line'])}: #{error['message']}"
+              fail(message)
+              unless limit.nil?
+                count += 1
+                if count >= limit
+                  throw(:loop_break)
+                end
               end
             end
           end
@@ -92,20 +94,22 @@ module Danger
       end
     end
 
-    def send_inline_comments(results, targets)
+    def send_inline_comments(ktlint_results, targets)
       catch(:loop_break) do
         count = 0
-        results.each do |result|
-          result['errors'].each do |error|
-            file_path = relative_file_path(result['file'])
-            next unless targets.include?(file_path)
-            message = error['message']
-            line = error['line']
-            fail(message, file: result['file'], line: line)
-            unless limit.nil?
-              count += 1
-              if count >= limit
-                throw(:loop_break)
+        ktlint_results.each do |ktlint_result|
+          ktlint_result.each do |result|
+            result['errors'].each do |error|
+              file_path = relative_file_path(result['file'])
+              next unless targets.include?(file_path)
+              message = error['message']
+              line = error['line']
+              fail(message, file: result['file'], line: line)
+              unless limit.nil?
+                count += 1
+                if count >= limit
+                  throw(:loop_break)
+                end
               end
             end
           end
@@ -151,18 +155,10 @@ module Danger
     def ktlint_results(targets)
       if skip_lint
         # TODO: Allow XML
-        if report_file.nil? || report_file.empty?
-          fail("If skip_lint is specified, You must specify ktlint report json file with `ktlint.report_file=...` in your Dangerfile.")
-          return
-        end
-
-        unless File.exists?(report_file)
-          fail("Couldn't find ktlint result json file.\nYou must specify it with `ktlint.report_file=...` in your Dangerfile.")
-          return
-        end
-
-        File.open(report_file) do |f|
-          JSON.load(f)
+        ktlint_result_files.map do |file|
+          File.open(file) do |f|
+            JSON.load(f)
+          end
         end
       else
         unless ktlint_exists?
@@ -172,12 +168,22 @@ module Danger
 
         return if targets.empty?
 
-        JSON.parse(`ktlint #{targets.join(' ')} --reporter=json --relative`)
+        [JSON.parse(`ktlint #{targets.join(' ')} --reporter=json --relative`)]
       end
     end
 
     def supported_service?
       AVAILABLE_SERVICES.include?(danger.scm_provider.to_sym)
     end
+
+    def ktlint_result_files
+      if !report_file.nil? && !report_file.empty? && File.exists?(report_file)
+        [report_file]
+      elsif !report_files_pattern.nil? && !report_files_pattern.empty?
+        Dir.glob(report_files_pattern)
+      else
+        fail("Couldn't find ktlint result json file.\nYou must specify it with `ktlint.report_file=...` or `ktlint.report_files_pattern=...` in your Dangerfile.")
+      end
+    end
   end
 end

data/spec/fixtures/ktlint_result_2.json

@@ -0,0 +1,19 @@
+[
+	{
+		"file": "app/src/main/java/com/mataku/Model2.kt",
+		"errors": [
+			{
+				"line": 46,
+				"column": 1,
+				"message": "Unexpected blank line(s) before \"}\"",
+				"rule": "no-blank-line-before-rbrace"
+			},
+		  {
+				"line": 47,
+				"column": 1,
+				"message": "Unexpected blank line(s) before \"}\"",
+				"rule": "no-blank-line-before-rbrace"
+			}
+		]
+	}
+]

data/spec/ktlint_spec.rb

@@ -107,5 +107,46 @@ module Danger
         end
       end
     end
+
+    describe '#skip_lint' do
+      context 'skip_lint: true' do
+        before do
+          allow_any_instance_of(Danger::DangerfileGitPlugin).to receive(:added_files).and_return(['app/src/main/java/com/mataku/Model.kt'])
+          allow_any_instance_of(Danger::DangerfileGitPlugin).to receive(:modified_files).and_return([])
+          allow_any_instance_of(Danger::DangerfileGitHubPlugin).to receive(:html_link).with('app/src/main/java/com/mataku/Model.kt#L46').and_return("<a href='https://gitlab.com/mataku/android/blob/561827e46167077b5e53515b4b7349b8ae04610b/Model.kt'>Model.kt</a>")
+          allow_any_instance_of(Danger::DangerfileGitHubPlugin).to receive(:html_link).with('app/src/main/java/com/mataku/Model.kt#L47').and_return("<a href='https://gitlab.com/mataku/android/blob/561827e46167077b5e53515b4b7349b8ae04610b/Model.kt'>Model.kt</a>")
+ 
+          allow(plugin).to receive(:system).with('which ktlint > /dev/null 2>&1').and_return(true)
+          plugin.report_file = './spec/fixtures/ktlint_result.json'
+          plugin.skip_lint = true
+        end
+
+        it do
+          expect(plugin).not_to have_received(:system).with('which ktlint > /dev/null 2>&1')
+          plugin.lint(inline_mode: false)
+        end
+      end
+
+      context 'report_files_pattern is specified' do
+        before do
+          allow_any_instance_of(Danger::DangerfileGitPlugin).to receive(:added_files).and_return(['app/src/main/java/com/mataku/Model.kt', 'app/src/main/java/com/mataku/Model2.kt'])
+          allow_any_instance_of(Danger::DangerfileGitPlugin).to receive(:modified_files).and_return([])
+          allow_any_instance_of(Danger::DangerfileGitHubPlugin).to receive(:html_link).with('app/src/main/java/com/mataku/Model.kt#L46').and_return("<a href='https://gitlab.com/mataku/android/blob/561827e46167077b5e53515b4b7349b8ae04610b/Model.kt'>Model.kt</a>")
+          allow_any_instance_of(Danger::DangerfileGitHubPlugin).to receive(:html_link).with('app/src/main/java/com/mataku/Model.kt#L47').and_return("<a href='https://gitlab.com/mataku/android/blob/561827e46167077b5e53515b4b7349b8ae04610b/Model.kt'>Model.kt</a>")
+          allow_any_instance_of(Danger::DangerfileGitHubPlugin).to receive(:html_link).with('app/src/main/java/com/mataku/Model2.kt#L46').and_return("<a href='https://gitlab.com/mataku/android/blob/561827e46167077b5e53515b4b7349b8ae04610b/Model2.kt'>Model2.kt</a>")
+          allow_any_instance_of(Danger::DangerfileGitHubPlugin).to receive(:html_link).with('app/src/main/java/com/mataku/Model2.kt#L47').and_return("<a href='https://gitlab.com/mataku/android/blob/561827e46167077b5e53515b4b7349b8ae04610b/Model2.kt'>Model2.kt</a>")
+          #
+          allow(plugin).to receive(:system).with('which ktlint > /dev/null 2>&1').and_return(true)
+          plugin.report_files_pattern = "**/ktlint_result*.json"
+          plugin.skip_lint = true
+        end
+
+        it do
+          expect(plugin).not_to have_received(:system).with('which ktlint > /dev/null 2>&1')
+          plugin.lint(inline_mode: false)
+          expect(dangerfile.status_report[:errors].size).to eq(4)
+        end
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -76,5 +76,11 @@ def testing_dangerfile_for_gitlab
 end
 
 def dummy_ktlint_result
-  File.read(File.expand_path('../fixtures/ktlint_result.txt', __FILE__)).chomp
+  File.read(File.expand_path('../fixtures/ktlint_result.json', __FILE__)).chomp
 end
+
+def dummy_ktlint_result_2
+  File.read(File.expand_path('../fixtures/ktlint_result_2.json', __FILE__)).chomp
+end
+
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-ktlint
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - mataku
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-14 00:00:00.000000000 Z
+date: 2022-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -143,7 +143,8 @@ files:
 - lib/danger_plugin.rb
 - lib/ktlint/gem_version.rb
 - lib/ktlint/plugin.rb
-- spec/fixtures/ktlint_result.txt
+- spec/fixtures/ktlint_result.json
+- spec/fixtures/ktlint_result_2.json
 - spec/ktlint_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/mataku/danger-ktlint
@@ -170,6 +171,7 @@ signing_key:
 specification_version: 4
 summary: Lint kotlin files using ktlint command line interface.
 test_files:
-- spec/fixtures/ktlint_result.txt
+- spec/fixtures/ktlint_result.json
+- spec/fixtures/ktlint_result_2.json
 - spec/ktlint_spec.rb
 - spec/spec_helper.rb