danger-ktlint 0.0.4 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1f250c93c48f9c5b8a9eb7aee96760b0f7ca668be636aeaeddfac263f87a242
-  data.tar.gz: d40bed8d74888a9555fd5bb4e7619281ff38422ecc35064d4fa59f0a39e0e20e
+  metadata.gz: fccc83b4c267453f15dbab68b15c2251de27eee1c89fbd7f47800f84f7528816
+  data.tar.gz: c97f5f1200761d40f806b18efd9bb29070914857656460935a3d1696198af6e9
 SHA512:
-  metadata.gz: 5e819fdad3eb22599362768654c65e1657652b653d6a6268791f63aa26c03feed6fc3dab9c4dd061883d3094ecb4cbf9b704fb603122fbbe1f1cc26477b88e99
-  data.tar.gz: 817b35c9e78fce50d690c3c56b605d5bfa3e609a7b32785516001eb407e286934d6126a236c736912f153a8c04479da3945ff9b5c07135acf339545c8ccfded6
+  metadata.gz: 14aa4af509079aa9ea8faabfc8a41e564fef09d1df5ec53d102898069ca3cdf1770ff9cb5bc3d1f0f484bdc1e08dd6e1ff68df5c2b7f8ad351a2f8f6588dad47
+  data.tar.gz: 34a20e7ec1eb556208a56fcd4c42b299a69ffd1a8fa9148888f87af6984aeeee043df9eb0ac5a9d75b10e05c02eb97290cff33d4004c9c8d5ca197678ae38aac

data/CHANGELOG.md

@@ -1,7 +1,23 @@
+## Unreleased
+
+## 0.0.7
+
+- Support multiple ktlint result json.
+
+## 0.0.6
+
+- Support GitLab and BitBucket server even if `inline_mode: false` is specified.
+
+## 0.0.5
+
+### Fixed
+
+- Fixed to not check ktlint binary even when skip_task is specified.
+
 ## 0.0.4
 
 ### Added
-- ktlint task can be skipped by specifing `ktlint.skip_task = true` and `ktlint.report_file = '...'`
+- ktlint task can be skipped by specifing `ktlint.skip_lint = true` and `ktlint.report_file = '...'`
 
 ## 0.0.3
 ### Added

data/README.md

@@ -12,6 +12,8 @@ gem install danger-ktlint
 
 You need to install `ktlint` command and set as executable first, see: https://ktlint.github.io/#getting-started.
 
+If you want to skip ktlint task, for example to only comment on the results of ktlint, no need to install ktlint. See https://github.com/mataku/danger-ktlint#skip-ktlint-task.
+
 ```bash
 # Example
 curl --output /usr/local/bin/ktlint -sL https://github.com/pinterest/ktlint/releases/download/$KTLINT_VERSION/ktlint && chmod a+x /usr/local/bin/ktlint
@@ -31,11 +33,24 @@ ktlint.lint
 
 Default is `nil`, all comments are sent.
 
-```bash
+```shell
 ktlint.limit = 3
 ktlint.lint
 ```
 
+#### Skip ktlint task
+
+Default is false.
+
+```shell
+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
+```
+
 ## CHANGELOG
 
 See [CHANGELOG.md](https://github.com/mataku/danger-ktlint/blob/master/CHANGELOG.md).
@@ -43,7 +58,9 @@ See [CHANGELOG.md](https://github.com/mataku/danger-ktlint/blob/master/CHANGELOG
 ## TODO
 
 - filtering: false (default: filtering: true behavior)
-- XML report_file (Currently only JSON is supported.)
+- Allow plain or html report_file (Currently only JSON is supported.)
+- Install ktlint and use it if ktlint binary does not exist
+- Support for services other than GitHub
 
 ## Development
 

data/lib/ktlint/gem_version.rb

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

data/lib/ktlint/plugin.rb

@@ -1,15 +1,23 @@
+# frozen_string_literal: true
+
 require 'json'
 
 module Danger
   class DangerKtlint < Plugin
-    
-    class UnexpectedLimitTypeError < StandardError
+    class UnexpectedLimitTypeError < StandardError; end
+
+    class UnsupportedServiceError < StandardError
+      def initialize(message = 'Unsupported service! Currently supported services are GitHub, GitLab and BitBucket server.')
+        super(message)
+      end
     end
 
+    AVAILABLE_SERVICES = [:github, :gitlab, :bitbucket_server]
+
     # 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
@@ -29,9 +37,8 @@ module Danger
     # @return [void]
     # def lint(inline_mode: false)
     def lint(inline_mode: false)
-      unless ktlint_exists?
-        fail("Couldn't find ktlint command. Install first.")
-        return
+      unless supported_service?
+        raise UnsupportedServiceError.new
       end
 
       targets = target_files(git.added_files + git.modified_files)
@@ -50,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",
@@ -64,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)
-            file = "#{file_path}#L#{error['line']}"
-            message = "#{github.html_link(file)}: #{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
@@ -85,21 +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
@@ -120,6 +130,20 @@ module Danger
 
     private
 
+    def file_html_link(file_path, line_number)
+      file = if danger.scm_provider == :github
+               "#{file_path}#L#{line_number}"
+             else
+               file_path
+             end
+      scm_provider_klass.html_link(file)
+    end
+
+    # `eval` may be dangerous, but it does not accept any input because it accepts only defined as danger.scm_provider
+    def scm_provider_klass
+      @scm_provider_klass ||= eval(danger.scm_provider.to_s)
+    end
+
     def pwd
       @pwd ||= `pwd`.chomp
     end
@@ -131,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?
@@ -152,7 +168,21 @@ 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

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

@@ -11,6 +11,7 @@ module Danger
 
     before do
       allow_any_instance_of(Kernel).to receive(:`).with('pwd').and_return('/home/mataku')
+      allow_any_instance_of(Kernel).to receive(:`).with('which less').and_return(0)
     end
 
     describe '#lint' do
@@ -55,6 +56,22 @@ module Danger
           expect(dangerfile.status_report[:errors].size).to eq(2)
         end
       end
+
+      context 'GitLab' do
+        let(:dangerfile) { testing_dangerfile_for_gitlab }
+
+        before do
+          allow_any_instance_of(Kernel).to receive(:system).with('which ktlint > /dev/null 2>&1').and_return(true)
+          allow_any_instance_of(Kernel).to receive(:`).with('ktlint app/src/main/java/com/mataku/Model.kt --reporter=json --relative').and_return(dummy_ktlint_result)
+          allow_any_instance_of(Danger::DangerfileGitLabPlugin).to receive(:html_link).with('app/src/main/java/com/mataku/Model.kt').and_return("<a href='https://gitlab.com/mataku/android/blob/561827e46167077b5e53515b4b7349b8ae04610b/Model.kt'>Model.kt</a>")
+          allow_any_instance_of(Danger::DangerfileGitLabPlugin).to receive(:html_link).with('app/src/main/java/com/mataku/Model.kt').and_return("<a href='https://gitlab.com/mataku/android/blob/561827e46167077b5e53515b4b7349b8ae04610b/Model.kt'>Model.kt</a>")
+        end
+
+        it do
+          plugin.lint
+          expect(dangerfile.status_report[:errors].size).to eq(2)
+        end
+      end
     end
 
     describe '#limit' do
@@ -66,7 +83,7 @@ module Danger
 
       context 'integer value is set to limit' do
         it 'raises no errors' do
-          expect { plugin.limit = 1 }.not_to raise_error(DangerKtlint::UnexpectedLimitTypeError)
+          expect { plugin.limit = 1 }.not_to raise_error
         end
       end
     end
@@ -90,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

@@ -46,24 +46,41 @@ def testing_ui
 end
 # rubocop:enable Lint/NestedMethodDefinition
 
-# Example environment (ENV) that would come from
-# 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",
+    "BITRISE_PULL_REQUEST" => "4",
+    "BITRISE_IO" => "true",
+    "GIT_REPOSITORY_URL" => "git@github.com:artsy/eigen",
     "DANGER_GITHUB_API_TOKEN" => "123sbdq54erfsd3422gdfio"
   }
 end
 
+def testing_env_for_gitlab
+  {
+    "BITRISE_PULL_REQUEST" => "4",
+    "BITRISE_IO" => "true",
+    "GIT_REPOSITORY_URL" => "git@gitlab.com:artsy/eigen",
+    "DANGER_GITLAB_API_TOKEN" => "123sbdq54erfsd3422gdfio"
+  }
+end
+
 # A stubbed out Dangerfile for use in tests
 def testing_dangerfile
   env = Danger::EnvironmentManager.new(testing_env)
   Danger::Dangerfile.new(env, testing_ui)
 end
 
+def testing_dangerfile_for_gitlab
+  env = Danger::EnvironmentManager.new(testing_env_for_gitlab)
+  Danger::Dangerfile.new(env, testing_ui)
+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.4
+  version: 0.0.7
 platform: ruby
 authors:
 - mataku
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-20 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
@@ -165,11 +166,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.32
 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