danger-ktlint 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6235a09ed16dd6946883104ff3263e082b2dd263abfac576e75e91b93c4d6570
-  data.tar.gz: 0411f44e31da07ef57984910168a321c6900477ac3c7813d814ff422b75957df
+  metadata.gz: 99b078a476493453fd609f033e65c6cd20d695617fc8a8a3e6a9c8b0b7745f3f
+  data.tar.gz: bf60ceecd5cf172c879f80183933b55274a5f1261f00fa241ae56fa95e9f44ae
 SHA512:
-  metadata.gz: 987202cb3498fa937f394f66ca841662d943bdcab5dda877a8024fc9b3f531de429b81442cb1cdfde66c39b407e631c3ed347c456239195a7f69aeac13a9d037
-  data.tar.gz: 0c5e9e33fe77801329fa9a0daba9261d59804887c3e40021fd85e9f2f2c99e95ad0acc95a50b919a0c4f3b600bfeecf77cb1c14173bb49c95f6a21b8947b319b
+  metadata.gz: 255316fb1e4627d772601a0fc40ab3d8faf67e35696f4433477ed431a3de010a203e5f9201902c9c98f046450546d2829a457d980ce9d887a65db6dd4dc6b7ef
+  data.tar.gz: 325c2fb3d73b05a9a4e8256c94accab75a8bdec4978d46d8b8ef1db6adea6947b776dcb1316be2271d6079f8f12347dcb02b13e4a600a546d4e6f67ce3dd98f3

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## Unreleased
+
+## 0.0.6
+
+- Support GitLab and BitBucket server even if `inline_mode: false` is specified.
+
 ## 0.0.5
 
 ### Fixed

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
@@ -55,6 +57,8 @@ See [CHANGELOG.md](https://github.com/mataku/danger-ktlint/blob/master/CHANGELOG
 
 - filtering: false (default: filtering: true behavior)
 - 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.5".freeze
+  VERSION = "0.0.6".freeze
 end

data/lib/ktlint/plugin.rb

@@ -1,11 +1,19 @@
+# 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
 
@@ -29,6 +37,10 @@ module Danger
     # @return [void]
     # def lint(inline_mode: false)
     def lint(inline_mode: false)
+      unless supported_service?
+        raise UnsupportedServiceError.new
+      end
+
       targets = target_files(git.added_files + git.modified_files)
 
       results = ktlint_results(targets)
@@ -66,8 +78,8 @@ module Danger
           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']}"
+
+            message = "#{file_html_link(file_path, error['line'])}: #{error['message']}"
             fail(message)
             unless limit.nil?
               count += 1
@@ -87,7 +99,6 @@ module Danger
           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)
@@ -115,6 +126,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
@@ -150,5 +175,9 @@ module Danger
         JSON.parse(`ktlint #{targets.join(' ')} --reporter=json --relative`)
       end
     end
+
+    def supported_service?
+      AVAILABLE_SERVICES.include?(danger.scm_provider.to_sym)
+    end
   end
 end

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

data/spec/spec_helper.rb

@@ -46,24 +46,35 @@ 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
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-ktlint
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - mataku
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-21 00:00:00.000000000 Z
+date: 2022-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -165,7 +165,7 @@ 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.