danger-ktlint 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9214f9181e86cf209334e8b1f571ba7feb327b6b155aab65cabfb10897c05b82
-  data.tar.gz: fe8ee017fd08f7571245f150a8b41c79961dd132d38ce05058972dab8ca484c0
+  metadata.gz: 60e18440651f2b42cb1d710fa157ee9391aa80894dd1e31bf2b43a7198cb80e3
+  data.tar.gz: b507278d2b29a2361afe704699c17c12373adb2ad82d91e7b44e44aec35dc77e
 SHA512:
-  metadata.gz: 358a13a92ee3b69c3ec2202a1eac4a830b38beedd225cf2669ec4a2893cd551176a7e8e08b02e45a5010f30ad8ed294e001f763501b4218969376174c69caacc
-  data.tar.gz: 77e4e6084228c7cf2f08bc4c44f9475188125e29af700798b665ef8ed7c8050674507d68b028894a346db5b09117ad0ac34ddd3116136cbc095dd36bc81a4878
+  metadata.gz: cd061ab55bbc11530c44686f8d1d872363428624fa63065e8e2631d8f703da7d853f1abb7692bd1e8dcf65e2bb38831cd70de2d4da45c05ba2385c8a9148668d
+  data.tar.gz: 8e28ec29136da819926e73dc6e5263fb9150455caf15cffb29b6ea98cf888bd742ad660ac4466a6a96ca62cf4da0738d4981dd9d79ee4eb48c5331a0ffa76c88

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## 0.3.0
+### Added
+- `limit` parameter to set the maximum number of comments of ktlint results.
+
+## 0.2.0
+### Added
+- Inline comment feature (`inline_mode: true` with ktlint.lint)
+
+## 0.1.0
+### Added
+- Run ktlint by ktlint.lint

data/README.md

@@ -14,7 +14,7 @@ You need to install `ktlint` command and set as executable first, see: https://k
 
 ```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
+$ 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.
@@ -26,6 +26,21 @@ ktlint.lint
 ktlint.lint(inline_mode: true)
 ```
 
+### Options
+#### Set maximum number of comments of ktlint results
+
+Default is `nil`, all comments are sent.
+
+```bash
+ktlint.limit = 3
+ktlint.lint
+```
+
+
+## CHANGELOG
+
+See [CHANGELOG.md](https://github.com/mataku/danger-ktlint/blob/master/CHANGELOG.md).
+
 ## TODO
 
 - filtering: false (default: filtering: true behavior)

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.2".freeze
+  VERSION = "0.0.3".freeze
 end

data/lib/ktlint/plugin.rb

@@ -2,9 +2,25 @@ require 'json'
 
 module Danger
   class DangerKtlint < Plugin
+    
+    class UnexpectedLimitTypeError < StandardError
+    end
+
     # TODO: Lint all files if `filtering: false`
     attr_accessor :filtering
 
+    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
@@ -46,22 +62,40 @@ module Danger
     # 	}
     # ]
     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)
-        }
-      }
+      catch(:loop_break) do
+        count = 0
+        results.each do |result|
+          result['errors'].each do |error|
+            file = "#{result['file']}#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_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)
+      catch(:loop_break) do
+        count = 0
+        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)
+            unless limit.nil?
+              count += 1
+              if count >= limit
+                throw(:loop_break)
+              end
+            end
+          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

@@ -31,11 +31,12 @@ 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
 
@@ -47,7 +48,41 @@ module Danger
 
         it 'Sends inline comment' do
           plugin.lint(inline_mode: true)
-          expect(dangerfile.status_report[:errors].size).to eq(1)
+          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.2
+  version: 0.0.3
 platform: ruby
 authors:
 - mataku
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-13 00:00:00.000000000 Z
+date: 2020-06-13 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
@@ -160,6 +132,7 @@ files:
 - ".circleci/config.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -192,8 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Lint kotlin files using ktlint command line interface.