danger-ktlint 0.0.1 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d6064a2a5865fbe5e26c05835cee98d7bee7ef27d23a0bc816bbd94ec23bf8d
-  data.tar.gz: ec0b2666a05c67e0a6cd27f284df443a64bdede1bf55e7b68d1609a6a91cb5ea
+  metadata.gz: 6235a09ed16dd6946883104ff3263e082b2dd263abfac576e75e91b93c4d6570
+  data.tar.gz: 0411f44e31da07ef57984910168a321c6900477ac3c7813d814ff422b75957df
 SHA512:
-  metadata.gz: c48682f515b4fc225ce08fc30c6e9b1d044f601a26c60d196a174b4304bc00ff0ed65c5a24f5bcbed78b1b92f2446dee91fa7553c0242b30dec2ba79fe631eef
-  data.tar.gz: 9cbd237f26685542822fbb6da1e7e058507205acc74f72cf78538d5b7991b37080bce0b2b1aa678ce43603104aadaec9c067667fab9d3bf597f28b1e6c377cee
+  metadata.gz: 987202cb3498fa937f394f66ca841662d943bdcab5dda877a8024fc9b3f531de429b81442cb1cdfde66c39b407e631c3ed347c456239195a7f69aeac13a9d037
+  data.tar.gz: 0c5e9e33fe77801329fa9a0daba9261d59804887c3e40021fd85e9f2f2c99e95ad0acc95a50b919a0c4f3b600bfeecf77cb1c14173bb49c95f6a21b8947b319b

data/.github/workflows/test.yml

@@ -0,0 +1,19 @@
+name: test
+
+on: [push]
+
+jobs:
+  test:
+    name: Run spec
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.1
+        bundler-cache: true
+    - name: Run spec
+      run: |
+        bundle exec rspec spec
+

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+## 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_lint = true` and `ktlint.report_file = '...'`
+
+## 0.0.3
+### Added
+- `limit` parameter to set the maximum number of comments of ktlint results.
+
+## 0.0.2
+### Added
+- Inline comment feature (`inline_mode: true` with ktlint.lint)
+
+## 0.0.1
+### Added
+- Run ktlint by ktlint.lint

data/README.md

@@ -1,25 +1,60 @@
 # 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
 
 ```ruby
-$ gem install danger-ktlint
+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/pinterest/ktlint/releases/download/$KTLINT_VERSION/ktlint && chmod a+x /usr/local/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)
+```
+
+### Options
+#### Set maximum number of comments of ktlint results
+
+Default is `nil`, all comments are sent.
+
+```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'
 ktlint.lint
 ```
 
+## CHANGELOG
+
+See [CHANGELOG.md](https://github.com/mataku/danger-ktlint/blob/master/CHANGELOG.md).
+
 ## TODO
 
 - filtering: false (default: filtering: true behavior)
+- Allow plain or html report_file (Currently only JSON is supported.)
 
 ## Development
 

data/danger-ktlint.gemspec

@@ -21,29 +21,18 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'danger-plugin-api', '~> 1.0'
 
   # General ruby development
-  spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake'
 
   # Testing support
   spec.add_development_dependency 'rspec', '~> 3.4'
 
   # Linting code and docs
   spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "yard"
 
   # Makes testing easy via `bundle exec guard`
   spec.add_development_dependency 'guard', '~> 2.14'
   spec.add_development_dependency 'guard-rspec', '~> 4.7'
 
-  # If you want to work on older builds of ruby
-  spec.add_development_dependency 'listen', '3.0.7'
-
-  # This gives you the chance to run a REPL inside your tests
-  # via:
-  #
-  #    require 'pry'
-  #    binding.pry
-  #
-  # This will stop test execution and let you inspect the results
   spec.add_development_dependency 'pry'
 end

data/lib/ktlint/gem_version.rb

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

data/lib/ktlint/plugin.rb

@@ -2,40 +2,104 @@ require 'json'
 
 module Danger
   class DangerKtlint < Plugin
+    
+    class UnexpectedLimitTypeError < StandardError
+    end
+
     # TODO: Lint all files if `filtering: false`
     attr_accessor :filtering
 
+    attr_accessor :skip_lint, :report_file
+
+    def limit
+      @limit ||= nil
+    end
+
+    def limit=(limit)
+      if limit != nil && limit.integer?
+        @limit = limit
+      else
+        raise UnexpectedLimitTypeError
+      end
+    end
+
     # Run ktlint task using command line interface
     # Will fail if `ktlint` is not installed
     # Skip lint task if files changed are empty
     # @return [void]
     # def lint(inline_mode: false)
-    def lint
-      unless ktlint_exists?
-        fail("Couldn't find ktlint command. Install first.")
+    def lint(inline_mode: false)
+      targets = target_files(git.added_files + git.modified_files)
+
+      results = ktlint_results(targets)
+      if results.nil? || results.empty?
         return
       end
 
-      targets = target_files(git.added_files + git.modified_files)
-      return if targets.empty?
-
-      results = JSON.parse(`ktlint #{targets.join(' ')} --reporter=json --relative`)
-      return if results.empty?
+      if inline_mode
+        send_inline_comments(results, targets)
+      else
+        send_markdown_comment(results, targets)
+      end
+    end
 
-      # if inline_mode
-        # TODO: Send inline comment
-      # else
-      send_markdown_comment(results)
+    # 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, 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)
+              end
+            end
+          end
+        end
+      end
     end
 
-    def send_markdown_comment(results)
-      results.each {|result|
-        result['errors'].each {|error|
-          file = "#{result['file']}#L#{error['line']}"
-          message = "#{github.html_link(file)} has linter issue: #{error['message']}"
-          fail(message)
-        }
-      }
+    def send_inline_comments(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)
+              end
+            end
+          end
+        end
+      end
     end
 
     def target_files(changed_files)
@@ -44,10 +108,47 @@ module Danger
       end
     end
 
+    # Make it a relative path so it can compare it to git.added_files
+    def relative_file_path(file_path)
+      file_path.gsub(/#{pwd}\//, '')
+    end
+
     private
 
+    def pwd
+      @pwd ||= `pwd`.chomp
+    end
+
     def ktlint_exists?
       system 'which ktlint > /dev/null 2>&1' 
     end
+
+    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)
+        end
+      else
+        unless ktlint_exists?
+          fail("Couldn't find ktlint command. Install first.")
+          return
+        end
+
+        return if targets.empty?
+
+        JSON.parse(`ktlint #{targets.join(' ')} --reporter=json --relative`)
+      end
+    end
   end
 end

data/spec/fixtures/ktlint_result.txt

@@ -7,6 +7,12 @@
 				"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

@@ -9,6 +9,10 @@ module Danger
       expect(Danger::DangerKtlint.new(nil)).to be_a Danger::Plugin
     end
 
+    before do
+      allow_any_instance_of(Kernel).to receive(:`).with('pwd').and_return('/home/mataku')
+    end
+
     describe '#lint' do
       before do
         allow_any_instance_of(Danger::DangerfileGitPlugin).to receive(:added_files).and_return(['app/src/main/java/com/mataku/Model.kt'])
@@ -31,11 +35,58 @@ module Danger
           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::DangerfileGitHubPlugin).to receive(:html_link).with('app/src/main/java/com/mataku/Model.kt#L46').and_return("<a href='https://github.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://github.com/mataku/android/blob/561827e46167077b5e53515b4b7349b8ae04610b/Model.kt'>Model.kt</a>")
         end
 
         it 'Sends markdown comment' do
           plugin.lint
-          expect(dangerfile.status_report[:errors].size).to eq(1)
+          expect(dangerfile.status_report[:errors].size).to eq(2)
+        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(2)
+        end
+      end
+    end
+
+    describe '#limit' do
+      context 'expected limit value is set' do
+        it 'raises UnexpectedLimitTypeError' do
+          expect { plugin.limit = nil }.to raise_error(DangerKtlint::UnexpectedLimitTypeError)
+        end
+      end
+
+      context 'integer value is set to limit' do
+        it 'raises no errors' do
+          expect { plugin.limit = 1 }.not_to raise_error(DangerKtlint::UnexpectedLimitTypeError)
+        end
+      end
+    end
+
+    describe '#send_markdown_comment' do
+      let(:limit) { 1 } 
+
+      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(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)
+        plugin.limit = limit
+      end
+
+      context 'limit is set' do
+        it 'equals number of ktlint results to limit' do
+          plugin.lint(inline_mode: true)
+          expect(dangerfile.status_report[:errors].size).to eq(limit)
         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.5
 platform: ruby
 authors:
 - mataku
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-11-12 00:00:00.000000000 Z
+date: 2021-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -80,20 +80,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -122,20 +108,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.7'
-- !ruby/object:Gem::Dependency
-  name: listen
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.0.7
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.0.7
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -157,9 +129,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -177,7 +150,7 @@ homepage: https://github.com/mataku/danger-ktlint
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -192,9 +165,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Lint kotlin files using ktlint command line interface.
 test_files:

data/.circleci/config.yml

@@ -1,27 +0,0 @@
-version: 2
-jobs:
-  build:
-    docker:
-      - image: ruby:2.5.3
-    steps:
-      - checkout
-      - restore_cache:
-          keys:
-            - v1-dependencies-{{ checksum "Gemfile.lock" }}
-              # fallback to using the latest cache if no exact match is found
-            - v1-dependencies-
-      
-      - run:
-          name: Install Dependencies
-          command: |
-            bundle install --jobs=4 --path vendor/bundle
-      
-      - save_cache:
-          paths: 
-          - vendor/bundle
-          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
-
-      - run:
-          name: Run RSpec
-          command: |
-            bundle exec rspec