danger-shroud 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9dc7c91737f9342eb62d48933887ac740b95cdb422497c7329a5a1e51214e59
-  data.tar.gz: e0e5805f272abc2dbc075871face1e3cb6cbf46a48a38f45f4823cc514c045d7
+  metadata.gz: e76505148c06d2624f1b063fe49f1ef0d93c94397d5db2b2039ef58721c80028
+  data.tar.gz: ca287f69c9d77b1412c6da11bb974b658b5e7e0a21aaddfc40aaad5b5f4810d6
 SHA512:
-  metadata.gz: 2f77902e316f4d2b96a2e27254586eeebf2bef8863a2893e0faa3246a064a5ed7072b3ae10f1420d916074c422ff931d8fb6eecc917d90c73ffd88ddf13d238d
-  data.tar.gz: 62890a17e53b620a7648e654d09b3c7a838cf6920d42ab40c61ba9d887ad2d9afc888e6a9e2d70cf3fe90c44ab28f7f4fdf307c78e66728d980ee5e9fd2fa57a
+  metadata.gz: c0a9e47d64b7686d1f18aec40135ace0757dd55013ac313229788cfac1de48f1c83289a438a47e6726fe61902a294f7c01ccc9258edf07992270f66c013b0db3
+  data.tar.gz: 0a7b43e9a7287b3a29b0a3a6bdcd0a594db1331471b0ab4b2b731e3c85efcbd92cfbbdff80414d211da3951b3d2cb5eddfc574dd45f34c33a86a2c0fb29f2f5f

data/CHANGELOG.md

@@ -4,6 +4,11 @@ Change Log
 Version Next
 ----------------------------
 
+Version 2.1.0
+----------------------------
+* Filters touched files by module
+* Hides modules from report output when they have no changed files.
+
 Version 2.0.0
 ----------------------------
 * Upgrade to Ruby 3.1.0

data/Gemfile.lock

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

data/README.md

@@ -1,6 +1,7 @@
 
 - [danger-shroud](#danger-shroud)
   - [Installation](#installation)
+  - [Configuration](#configuration)
   - [Usage Kover](#usage-kover)
     - [Parameters](#parameters)
     - [Examples](#examples)
@@ -24,6 +25,12 @@ Add this line to your application's Gemfile:
 gem 'danger-shroud'
 ```
 
+## Configuration
+
+Shroud will default to using the filepath of your coverage report to determine which module the reported files belong to. This assumes that your Jacoco or Kover configuration will output to the default `build/reports/` directory when generating reports.
+
+If you have a custom configuration that outputs the reports somewhere else, you can provide the module's path with the `moduleDirectory` parameter. This allows the plugin to accurately determine the module in which a file is located by matching it to the file's path prefix. A custom report location that does not have a `moduleDirectory` specified may result in files being reported in modules they do not belong to.
+
 ## 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. 
@@ -35,6 +42,7 @@ You can use the following parameters to control how shroud operates:
 | Param                       | Type    | Description                                                                                 | Example                      |
 |-----------------------------|---------|---------------------------------------------------------------------------------------------|------------------------------|
 | moduleName                  | String  | the display name of the project or module.                                                  | `'Module Name '`             |
+| moduleDirectory             | String, nil  | file path to the module to specify its location when its report `file` outputs to a custom directory.                     | default `nil`.               |
 | file                        | String  | file path to a Kover xml coverage report.                                                   | `'path/to/kover/report.xml'` |
 | totalProjectThreshold       | Integer | defines the required percentage of total project coverage for a passing build.              | default `90`                 |
 | modifiedFileThreshold       | Integer | defines the required percentage of files modified in a PR for a passing build.              | default `90`                 |
@@ -49,7 +57,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.reportKover moduleName: 'Module Name', file: 'path/to/kover/report.xml'
+shroud.reportKover moduleName: 'Module Name', file: 'module/build/reports/kover/report.xml'
 ```
 
 Running shroud with custom coverage thresholds:
@@ -57,7 +65,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.reportKover moduleName: 'Module Name', file: 'path/to/kover/report.xml', totalProjectThreshold: 80, modifiedFileThreshold: 95
+shroud.reportKover moduleName: 'Module Name', file: 'module/build/reports/kover/report.xml', totalProjectThreshold: 80, modifiedFileThreshold: 95
 ```
 
 Warn on builds instead of fail:
@@ -65,7 +73,15 @@ 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 project thresholds
-shroud.reportKover moduleName: 'Module Name', file: 'path/to/kover/report.xml', totalProjectThreshold: 80, modifiedFileThreshold: 95, failIfUnderProjectThreshold: false, failIfUnderFileThreshold: false
+shroud.reportKover moduleName: 'Module Name', file: 'module/build/reports/kover/report.xml', totalProjectThreshold: 80, modifiedFileThreshold: 95, failIfUnderProjectThreshold: false, failIfUnderFileThreshold: false
+```
+
+Running shroud with a Kover report file in a custom directory:
+
+```ruby
+# Report coverage of modified files, specifying an explicit path to the module
+# when the coverage report won't be inside of its `build/reports/` directory
+shroud.reportKover moduleName: 'Module Name', moduleDirectory: 'module/', file: 'custom/path/to/kover/report.xml'
 ```
 
 ## Usage Jacoco
@@ -77,6 +93,7 @@ You can use the following parameters to control how shroud operates:
 | Param                       | Type    | Description                                                                                 | Example                       |
 |-----------------------------|---------|---------------------------------------------------------------------------------------------|-------------------------------|
 | moduleName                  | String  | the display name of the project or module.                                                  | `'Module Name '`              |
+| moduleDirectory             | String, nil  | file path to the module to specify its location when its report `file` outputs to a custom directory.                     | default `nil`.                |
 | file                        | String  | file path to a Jacoco xml coverage report.                                                  | `'path/to/jacoco/report.xml'` |
 | totalProjectThreshold       | Integer | defines the required percentage of total project coverage for a passing build.              | default `90`                  |
 | modifiedFileThreshold       | Integer | defines the required percentage of files modified in a PR for a passing build.              | default `90`                  |
@@ -93,7 +110,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.reportJacoco moduleName: 'Module Name', file: 'path/to/jacoco/report.xml'
+shroud.reportJacoco moduleName: 'Module Name', file: 'project/module/reports/jacoco/report.xml'
 ```
 
 Running shroud with custom coverage thresholds:
@@ -101,7 +118,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.reportJacoco moduleName: 'Module Name', file: 'path/to/jacoco/report.xml', totalProjectThreshold: 80, modifiedFileThreshold: 95
+shroud.reportJacoco moduleName: 'Module Name', file: 'module/reports/jacoco/report.xml', totalProjectThreshold: 80, modifiedFileThreshold: 95
 ```
 
 Warn on builds instead of fail:
@@ -109,7 +126,15 @@ 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.reportJacoco moduleName: 'Module Name', file: 'path/to/jacoco/report.xml', totalProjectThreshold: 80, modifiedFileThreshold: 95, failIfUnderProjectThreshold: false, failIfUnderFileThreshold: false
+shroud.reportJacoco moduleName: 'Module Name', file: 'module/reports/jacoco/report.xml', totalProjectThreshold: 80, modifiedFileThreshold: 95, failIfUnderProjectThreshold: false, failIfUnderFileThreshold: false
+```
+
+Running shroud with a Jacoco report file in a custom directory:
+
+```ruby
+# Report coverage of modified files, specifying an explicit path to the module
+# when the coverage report won't be inside of its `build/reports/` directory
+shroud.reportKover moduleName: 'Module Name', moduleDirectory: 'module/', file: 'custom/path/to/jacoco/report.xml'
 ```
 
 ## Development

data/lib/shroud/gem_version.rb

@@ -1,3 +1,3 @@
 module Shroud
-  VERSION = "2.0.0".freeze
+  VERSION = "2.1.0".freeze
 end

data/lib/shroud/plugin.rb

@@ -68,7 +68,11 @@ module Danger
     # Report coverage on diffed files, as well as overall coverage.
     #
     # @param   [String] moduleName
-    #          the display name of the project or module
+    #          the display name of the project or module.
+    #
+    # @param   [String, nil] moduleDirectory
+    #          file path to the module to specify its location when its report `file` outputs to a custom directory.
+    #          default nil.
     #
     # @param   [String] file
     #          file path to a Jacoco xml coverage report.
@@ -96,6 +100,7 @@ module Danger
     # @return  [void]
     def reportJacoco(
       moduleName:,
+      moduleDirectory: nil,
       file:,
       totalProjectThreshold: 90,
       modifiedFileThreshold: 90,
@@ -106,6 +111,7 @@ module Danger
       internalReport(
         reportType: 'Jacoco',
         moduleName: moduleName,
+        moduleDirectory: moduleDirectory,
         file: file,
         totalProjectThreshold: totalProjectThreshold,
         modifiedFileThreshold: modifiedFileThreshold,
@@ -118,7 +124,11 @@ module Danger
     # Report coverage on diffed files, as well as overall coverage.
     #
     # @param   [String] moduleName
-    #          the display name of the project or module
+    #          the display name of the project or module.
+    #
+    # @param   [String, nil] moduleDirectory
+    #          file path to the module to specify its location when its report `file` outputs to a custom directory.
+    #          default nil.
     #
     # @param   [String] file
     #          file path to a Kover xml coverage report.
@@ -146,6 +156,7 @@ module Danger
     # @return  [void]
     def reportKover(
       moduleName:,
+      moduleDirectory: nil,
       file:,
       totalProjectThreshold: 90,
       modifiedFileThreshold: 90,
@@ -156,6 +167,7 @@ module Danger
       internalReport(
         reportType: 'Kover',
         moduleName: moduleName,
+        moduleDirectory: moduleDirectory,
         file: file,
         totalProjectThreshold: totalProjectThreshold,
         modifiedFileThreshold: modifiedFileThreshold,
@@ -168,6 +180,7 @@ module Danger
     private def internalReport(
       reportType:,
       moduleName:,
+      moduleDirectory:,
       file:,
       totalProjectThreshold:,
       modifiedFileThreshold:,
@@ -187,9 +200,17 @@ module Danger
       total = missed + covered
       coveragePercent = (covered / total.to_f) * 100
 
-      # get array of files names touched by this PR (modified + added)
-      touchedFileNames = @dangerfile.git.modified_files.map { |file| File.basename(file) }
-      touchedFileNames += @dangerfile.git.added_files.map { |file| File.basename(file) }
+      # if we are provided an explicit path to the module directory, use that.
+      # the default location for a Kover or Jacoco report is in the build directory of the module.
+      # if we're in the build directory then we can determine the module's file path for sorting.
+      modulePath = moduleDirectory || (file.include?('/build/') ? file.split('/build/').first + '/' : nil)
+
+      # get array of files names within the specified module touched by this PR (modified + added).
+      # if we have the path of the module, use that to filter the files, otherwise fallback to
+      # the previous behavior when it can't be determined.
+      touchedFileNames = (@dangerfile.git.modified_files + @dangerfile.git.added_files)
+        .select { |path| modulePath.nil? || path.start_with?(modulePath) }
+        .map { |path| File.basename(path) }
 
       # used to later report files that were modified but not included in the report
       fileNamesNotInReport = []
@@ -213,6 +234,11 @@ module Danger
         end
       end
 
+      # don't output anything when the module has no touched files
+      if (touchedFilesHash.empty?)
+        return
+      end
+
       puts "Here are unreported files"
       puts fileNamesNotInReport.to_s
       puts "Here is the touched files coverage hash"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-shroud
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - andrewhaisting
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-26 00:00:00.000000000 Z
+date: 2026-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api