danger-ktlint 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d6064a2a5865fbe5e26c05835cee98d7bee7ef27d23a0bc816bbd94ec23bf8d
-  data.tar.gz: ec0b2666a05c67e0a6cd27f284df443a64bdede1bf55e7b68d1609a6a91cb5ea
+  metadata.gz: 9214f9181e86cf209334e8b1f571ba7feb327b6b155aab65cabfb10897c05b82
+  data.tar.gz: fe8ee017fd08f7571245f150a8b41c79961dd132d38ce05058972dab8ca484c0
 SHA512:
-  metadata.gz: c48682f515b4fc225ce08fc30c6e9b1d044f601a26c60d196a174b4304bc00ff0ed65c5a24f5bcbed78b1b92f2446dee91fa7553c0242b30dec2ba79fe631eef
-  data.tar.gz: 9cbd237f26685542822fbb6da1e7e058507205acc74f72cf78538d5b7991b37080bce0b2b1aa678ce43603104aadaec9c067667fab9d3bf597f28b1e6c377cee
+  metadata.gz: 358a13a92ee3b69c3ec2202a1eac4a830b38beedd225cf2669ec4a2893cd551176a7e8e08b02e45a5010f30ad8ed294e001f763501b4218969376174c69caacc
+  data.tar.gz: 77e4e6084228c7cf2f08bc4c44f9475188125e29af700798b665ef8ed7c8050674507d68b028894a346db5b09117ad0ac34ddd3116136cbc095dd36bc81a4878

data/README.md

@@ -1,6 +1,6 @@
 # danger-ktlint
 
-Lint kotlin files using ktlint command lint interface.
+Lint kotlin files only changed files in a pull request using ktlint command lint interface.
 
 ## Installation
 
@@ -10,11 +10,20 @@ $ gem install danger-ktlint
 
 ## Usage
 
-You need to install `ktlint` command first, see: https://ktlint.github.io/#getting-started.
+You need to install `ktlint` command and set as executable first, see: https://ktlint.github.io/#getting-started.
+
+```bash
+# Example
+$ curl --output /usr/local/bin/ktlint -sL https://github.com/shyiko/ktlint/releases/download/$KTLINT_VERSION/ktlint && chmod a+x /usr/loca/bin/ktlint
+```
+
+Add this to Dangerfile.
 
 ```ruby
-# Dangerfile
 ktlint.lint
+
+# If you want inline comments, specify `ktlint.lint` with `inline_mode: true`
+ktlint.lint(inline_mode: true)
 ```
 
 ## TODO

data/lib/ktlint/gem_version.rb

@@ -1,3 +1,3 @@
 module Ktlint
-  VERSION = "0.0.1".freeze
+  VERSION = "0.0.2".freeze
 end

data/lib/ktlint/plugin.rb

@@ -10,7 +10,7 @@ module Danger
     # Skip lint task if files changed are empty
     # @return [void]
     # def lint(inline_mode: false)
-    def lint
+    def lint(inline_mode: false)
       unless ktlint_exists?
         fail("Couldn't find ktlint command. Install first.")
         return
@@ -22,12 +22,29 @@ module Danger
       results = JSON.parse(`ktlint #{targets.join(' ')} --reporter=json --relative`)
       return if results.empty?
 
-      # if inline_mode
-        # TODO: Send inline comment
-      # else
-      send_markdown_comment(results)
+      if inline_mode
+        send_inline_comments(results)
+      else
+        send_markdown_comment(results)
+      end
     end
 
+    # Comment to a PR by ktlint result json
+    #
+    # // Sample ktlint result
+    # [
+    #   {
+    #     "file": "app/src/main/java/com/mataku/Model.kt",
+    # 		"errors": [
+    # 			{
+    # 				"line": 46,
+    # 				"column": 1,
+    # 				"message": "Unexpected blank line(s) before \"}\"",
+    # 				"rule": "no-blank-line-before-rbrace"
+    # 			}
+    # 		]
+    # 	}
+    # ]
     def send_markdown_comment(results)
       results.each {|result|
         result['errors'].each {|error|
@@ -38,6 +55,17 @@ module Danger
       }
     end
 
+    def send_inline_comments(results)
+      results.each do |result|
+        result['errors'].each do |error|
+          file = result['file']
+          message = error['message']
+          line = error['line']
+          fail(message, file: result['file'], line: line)
+        end
+      end
+    end
+
     def target_files(changed_files)
       changed_files.select do |file|
         file.end_with?('.kt')

data/spec/ktlint_spec.rb

@@ -38,6 +38,18 @@ module Danger
           expect(dangerfile.status_report[:errors].size).to eq(1)
         end
       end
+
+      context 'Ktlint issues were found with inline_mode: true' do
+        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)
+        end
+
+        it 'Sends inline comment' do
+          plugin.lint(inline_mode: true)
+          expect(dangerfile.status_report[:errors].size).to eq(1)
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-ktlint
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - mataku
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-12 00:00:00.000000000 Z
+date: 2018-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api