danger-shroud 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00edfafb1266b9496abe1346a20decc2625762cdbb14ce3ee11feb474dbf9773
-  data.tar.gz: 766eae63a08b0dd893b1dc00bcb07afb24a55b460f599fbb1aed2360d0f28f1e
+  metadata.gz: ef8bbfd7e32b3948a01570f48a893401eda640342e58fb4721c6da5dc66ea94e
+  data.tar.gz: 8b4d3599b8eb136074632beba3c18c900ffea7b9ebc0d75abcaf9b986724e0d9
 SHA512:
-  metadata.gz: 7805de3876afc42b9d3961a005038de0e27dc2bff08efddc701a4644c8c51d3e082574f93513923d15b4197b0cc7165ecfc50a36d767d9fb3980c45bb71591ec
-  data.tar.gz: 6e75b7bb5a229690307ecb4e0df6603b9f6a15e3319c243c0dcb8618f66d6f05b12c073972e66ec41d0f30552affb938ff23bf7739b5d09e29fbb3ffa1cff327
+  metadata.gz: af7c215e0fbaf9a39a6d7af965e3f322bb0a49fe9703782df35f74b016b4c7d5e081f14a769c9c4a0c70d6c9c48036124982b93ef59f5556dff43dbfa219a548
+  data.tar.gz: 31bc8ee27909c4164b77b276d69f9c8d30d49fb3e0ee32a4d60c64774e588a6a2d5c1fb0e17d145bd7dbc8867213de7f753dc92d1fccdec4ebcb8f7c5e8094d6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-shroud (0.0.4)
+    danger-shroud (0.0.5)
       danger-plugin-api (~> 1.0)
       nokogiri
 

data/README.md

@@ -1,6 +1,6 @@
 # danger-shroud
 
-A danger plugin for enforcing code coverage coverage via a Jacoco coverage reports.
+A danger plugin for enforcing code coverage coverage via a Kover or Jacoco coverage report.
 
 ![Shroud Banner Image](images/bannerImage.png)
 
@@ -12,7 +12,36 @@ Add this line to your application's Gemfile:
 gem 'danger-shroud'
 ```
 
-## Usage
+## Usage Kover
+
+Shroud depends on having a Kover coverage report generated for your project. For Android projects, [kotlinx-kover](https://github.com/Kotlin/kotlinx-kover) works well. 
+
+Running shroud with default values:
+
+```ruby
+# Report coverage of modified files, fail if either total 
+# project coverage or any modified file's coverage is under 90%
+shroud.reportKover 'Module Name', 'path/to/kover/report.xml'
+```
+
+Running shroud with custom coverage thresholds:
+
+```ruby
+# Report coverage of modified files, fail if total project coverage is under 80%,
+# or if any modified file's coverage is under 95%
+shroud.reportKover 'Module Name', 'path/to/kover/report.xml', 80, 95
+```
+
+Warn on builds instead of fail:
+
+```ruby
+# Report coverage of modified files the same as the above example, except the
+# builds will only warn instead of fail if below thresholds
+shroud.reportKover 'Module Name', 'path/to/kover/report.xml', 80, 95, false
+```
+
+
+## Usage Jacoco
 
 Shroud depends on having a Jacoco coverage report generated for your project. For Android projects, [jacoco-android-gradle-plugin](https://github.com/arturdm/jacoco-android-gradle-plugin) works well. 
 
@@ -21,7 +50,7 @@ Running shroud with default values:
 ```ruby
 # Report coverage of modified files, fail if either total 
 # project coverage or any modified file's coverage is under 90%
-shroud.report 'path/to/jacoco/report.xml'
+shroud.reportJacoco 'Module Name', 'path/to/jacoco/report.xml'
 ```
 
 Running shroud with custom coverage thresholds:
@@ -29,7 +58,7 @@ Running shroud with custom coverage thresholds:
 ```ruby
 # Report coverage of modified files, fail if total project coverage is under 80%,
 # or if any modified file's coverage is under 95%
-shroud.report 'path/to/jacoco/report.xml', 80, 95
+shroud.reportJacoco 'Module Name', 'path/to/jacoco/report.xml', 80, 95
 ```
 
 Warn on builds instead of fail:
@@ -37,7 +66,7 @@ Warn on builds instead of fail:
 ```ruby
 # Report coverage of modified files the same as the above example, except the
 # builds will only warn instead of fail if below thresholds
-shroud.report 'path/to/jacoco/report.xml', 80, 95, false
+shroud.reportJacoco 'Module Name', 'path/to/jacoco/report.xml', 80, 95, false
 ```
 
 

data/lib/shroud/gem_version.rb

@@ -1,3 +1,3 @@
 module Shroud
-  VERSION = "0.0.4".freeze
+  VERSION = "0.0.5".freeze
 end

data/lib/shroud/plugin.rb

@@ -2,33 +2,53 @@ require 'nokogiri'
 
 module Danger
 
-  # Parse a Jacoco report to enforce code coverage on CI. Results are passed out as a table in markdown.
+  # Parse a Kover or Jacoco report to enforce code coverage on CI. Results are passed out as a table in markdown.
   #
-  # Shroud depends on having a Jacoco coverage report generated for your project. For Android projects, 
-  # [jacoco-android-gradle-plugin](https://github.com/arturdm/jacoco-android-gradle-plugin) works well. 
+  # Shroud depends on having a Kover or Jacoco coverage report generated for your project.
   #
-  # @example Running shroud with default values
+  #
+  # @example Running Shroud with default values for Kover
   #
   #          # Report coverage of modified files, fail if either total project coverage
   #          # or any modified file's coverage is under 90%
-  #          shroud.report 'path/to/jacoco/report.xml'
+  #          shroud.reportKover 'Project Name', 'path/to/kover/report.xml'
   #
-  # @example Running shroud with custom coverage thresholds
+  # @example Running Shroud with custom coverage thresholds for Kover
   #
   #          # Report coverage of modified files, fail if total project coverage is under 80%,
   #          # or if any modified file's coverage is under 95%
-  #          shroud.report 'path/to/jacoco/report.xml', 80, 95
+  #          shroud.reportKover 'Project Name', 'path/to/kover/report.xml', 80, 95
   #
-  # @example Warn on builds instead of fail
+  # @example Warn on builds instead of fail for Kover
   #
   #          # Report coverage of modified files the same as the above example, except the
   #          # builds will only warn instead of fail if below thresholds
-  #          shroud.report 'path/to/jacoco/report.xml', 80, 95, false
+  #          shroud.reportKover 'Project Name', 'path/to/kover/report.xml', 80, 95, false
+  #
+  # @example Running Shroud with default values for Jacoco
+  #
+  #          # Report coverage of modified files, fail if either total project coverage
+  #          # or any modified file's coverage is under 90%
+  #          shroud.reportJacoco 'Project Name', 'path/to/jacoco/report.xml'
+  #
+  # @example Running Shroud with custom coverage thresholds for Jacoco
+  #
+  #          # Report coverage of modified files, fail if total project coverage is under 80%,
+  #          # or if any modified file's coverage is under 95%
+  #          shroud.reportJacoco 'Project Name', 'path/to/jacoco/report.xml', 80, 95
+  #
+  # @example Warn on builds instead of fail for Jacoco
+  #
+  #          # Report coverage of modified files the same as the above example, except the
+  #          # builds will only warn instead of fail if below thresholds
+  #          shroud.reportJacoco 'Project Name', 'path/to/jacoco/report.xml', 80, 95, false
   #          
-  # @tags android, jacoco, coverage
+  # @tags android, kover, jacoco, coverage
   #
   class DangerShroud < Plugin
 
+    # <b>DEPRECATED:</b> Please use <tt>reportJacoco</tt> or <tt>reportKover</tt> instead.
+    #
     # Report coverage on diffed files, as well as overall coverage.
     #
     # @param   [String] file
@@ -48,8 +68,63 @@ module Danger
     #
     # @return  [void]
     def report(file, totalProjectThreshold = 90, modifiedFileThreshold = 90, failIfUnderThreshold = true)
+      warn "[DEPRECATION] `report` is deprecated.  Please use `reportJacoco` or `reportKover` instead."
+      reportJacoco('Project', file, totalProjectThreshold = 90, modifiedFileThreshold = 90, failIfUnderThreshold = true)
+    end
+
+    # Report coverage on diffed files, as well as overall coverage.
+    #
+    # @param   [String] moduleName
+    #          the display name of the project or module
+    #
+    # @param   [String] file
+    #          file path to a Jacoco xml coverage report.
+    #
+    # @param   [Integer] totalProjectThreshold
+    #          defines the required percentage of total project coverage for a passing build.
+    #          default 90.
+    #
+    # @param   [Integer] modifiedFileThreshold
+    #          defines the required percentage of files modified in a PR for a passing build.
+    #          default 90.
+    #
+    # @param   [Boolean] failIfUnderThreshold
+    #          if true, will fail builds that are under the provided thresholds. if false, will only warn.
+    #          default true.
+    #
+    # @return  [void]
+    def reportJacoco(moduleName, file, totalProjectThreshold = 90, modifiedFileThreshold = 90, failIfUnderThreshold = true)
+      internalReport('Jacoco', moduleName, file, totalProjectThreshold, modifiedFileThreshold, failIfUnderThreshold)
+    end
+
+    # Report coverage on diffed files, as well as overall coverage.
+    #
+    # @param   [String] moduleName
+    #          the display name of the project or module
+    #
+    # @param   [String] file
+    #          file path to a Kover xml coverage report.
+    #
+    # @param   [Integer] totalProjectThreshold
+    #          defines the required percentage of total project coverage for a passing build.
+    #          default 90.
+    #
+    # @param   [Integer] modifiedFileThreshold
+    #          defines the required percentage of files modified in a PR for a passing build.
+    #          default 90.
+    #
+    # @param   [Boolean] failIfUnderThreshold
+    #          if true, will fail builds that are under the provided thresholds. if false, will only warn.
+    #          default true.
+    #
+    # @return  [void]
+    def reportKover(moduleName, file, totalProjectThreshold = 90, modifiedFileThreshold = 90, failIfUnderThreshold = true)
+      internalReport('Kover', moduleName, file, totalProjectThreshold, modifiedFileThreshold, failIfUnderThreshold)
+    end
+
+    private def internalReport(reportType, moduleName, file, totalProjectThreshold, modifiedFileThreshold, failIfUnderThreshold)
       raise "Please specify file name." if file.empty?
-      raise "No jacoco xml report found at #{file}" unless File.exist? file
+      raise "No #{reportType} xml report found at #{file}" unless File.exist? file
       rawXml = File.read(file)
       parsedXml = Nokogiri::XML.parse(rawXml)
       totalInstructionCoverage = parsedXml.xpath("/report/counter[@type='INSTRUCTION']")
@@ -62,8 +137,8 @@ module Danger
       touchedFileNames = @dangerfile.git.modified_files.map { |file| File.basename(file) }
       touchedFileNames += @dangerfile.git.added_files.map { |file| File.basename(file) }
 
-      # used to later report files that were modified but not included in the jacoco report
-      fileNamesNotInJacocoReport = []
+      # used to later report files that were modified but not included in the report
+      fileNamesNotInReport = []
 
       # hash for keeping track of coverage per filename: {filename => coverage percent}
       touchedFilesHash = {}
@@ -80,16 +155,16 @@ module Danger
           end
           touchedFilesHash[touchedFileName] = (covered.to_f / (missed + covered)) * 100
         else
-          fileNamesNotInJacocoReport << touchedFileName
+          fileNamesNotInReport << touchedFileName
         end
       end
 
       puts "Here are unreported files"
-      puts fileNamesNotInJacocoReport.to_s
+      puts fileNamesNotInReport.to_s
       puts "Here is the touched files coverage hash"
       puts touchedFilesHash
 
-      output = "## 🧛 Project Code Coverage: **`#{'%.2f' % coveragePercent}%`**\n"
+      output = "## 🧛 #{moduleName} Code Coverage: **`#{'%.2f' % coveragePercent}%`**\n"
 
       output << "### Coverage of Modified Files:\n"
       output << "File | Coverage\n"
@@ -111,7 +186,7 @@ module Danger
       end
 
       output << "### Modified Files Not Found In Coverage Report:\n"
-      fileNamesNotInJacocoReport.sort.each do |unreportedFileName| 
+      fileNamesNotInReport.sort.each do |unreportedFileName| 
         output << "#{unreportedFileName}\n"
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-shroud
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - andrewhaisting
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-13 00:00:00.000000000 Z
+date: 2022-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api