danger-shroud 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f975c92a31f10bca3fc2a6172d1a22234a54efb953ba177618eb57bcf5b41d4d
-  data.tar.gz: fc40d2e2393708e0d19716fc7adb9f9495c253756f7b623831217db663729b7c
+  metadata.gz: 234c6bbce9b759a9a8b744c477e5b0f90ab40d742830635a6ff284f85b1b1015
+  data.tar.gz: 21e54c40b94bdd7d4989516d5287279427888f07efc48475e6f754908f0b72c8
 SHA512:
-  metadata.gz: a39b278261fb7162d399b37ba70ae72522578e6a5438f48f90fef71e8cf9b8cc59fcf6cfa1285814d0ff93f14cffa48269dbd527dcfa9647abc9d81f1ebc9bd8
-  data.tar.gz: 2575bf0d9b1d91827e658565051e359808ed55bc7f6615e759084063fc5aebac9939e853ae8d45f58f50eb826e6238d14fc732ac60bb3d975fc4d358d0b2fc9e
+  metadata.gz: 4ad01b61dfe54625578c9e8b8b26f0520cffcee3d63e5f7275a1a45c332e503f4c2d0d254fb6619e35e9d20d51fc982d917e370be23668ed82f3293343b77fa5
+  data.tar.gz: c5403ff85b292d6ad451ae73998e9fff69e76c462e260bf4dd8d918bc519fb88ff1fc38bde541421b25145eabbf70e96a04ceb4b1f26559b91f2f7fb53d30ef4

data/.github/dependabot.yml

@@ -7,4 +7,4 @@ updates:
     open-pull-requests-limit: 0
     # Add/Remove reviewers here
     reviewers:
-      - "dperez37"
+      - "david-livefront"

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    danger-shroud (0.0.6)
+    danger-shroud (0.0.7)
       danger-plugin-api (~> 1.0)
       nokogiri
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.1)
+    addressable (2.8.4)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     claide (1.1.0)
@@ -20,12 +20,12 @@ GEM
     colored2 (3.1.2)
     cork (0.3.0)
       colored2 (~> 3.1)
-    danger (9.1.0)
+    danger (9.2.0)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
       cork (~> 0.1)
-      faraday (>= 0.9.0, < 2.0)
+      faraday (>= 0.9.0, < 3.0)
       faraday-http-cache (~> 2.0)
       git (~> 1.7)
       kramdown (~> 2.3)
@@ -36,34 +36,15 @@ GEM
     danger-plugin-api (1.0.0)
       danger (> 2.0)
     diff-lcs (1.5.0)
-    faraday (1.10.2)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0)
-      faraday-multipart (~> 1.0)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.0)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      faraday-retry (~> 1.0)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
     faraday-http-cache (2.4.1)
       faraday (>= 0.8)
-    faraday-httpclient (1.0.1)
-    faraday-multipart (1.0.4)
-      multipart-post (~> 2)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday-rack (1.0.0)
-    faraday-retry (1.0.3)
+    faraday-net_http (3.0.2)
     ffi (1.15.5)
     formatador (1.1.0)
-    git (1.12.0)
+    git (1.18.0)
       addressable (~> 2.8)
       rchardet (~> 1.8)
     guard (2.18.0)
@@ -90,16 +71,13 @@ GEM
       rb-inotify (>= 0.9.7)
     lumberjack (1.2.8)
     method_source (1.0.0)
-    mini_portile2 (2.8.0)
-    multipart-post (2.2.3)
+    mini_portile2 (2.8.1)
     nap (1.1.0)
     nenv (0.3.0)
     no_proxy_fix (0.1.2)
-    nokogiri (1.13.10)
+    nokogiri (1.14.3)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
-    nokogiri (1.13.10-arm64-darwin)
-      racc (~> 1.4)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
@@ -108,47 +86,47 @@ GEM
       sawyer (~> 0.9)
     open4 (1.3.4)
     parallel (1.22.1)
-    parser (3.1.3.0)
+    parser (3.2.2.0)
       ast (~> 2.4.1)
-    pry (0.14.1)
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
     public_suffix (5.0.1)
-    racc (1.6.1)
+    racc (1.6.2)
     rainbow (3.1.1)
     rake (13.0.6)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     rchardet (1.8.0)
-    regexp_parser (2.6.1)
+    regexp_parser (2.8.0)
     rexml (3.2.5)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
       rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.0)
+    rspec-core (3.12.1)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.0)
+    rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.0)
+    rspec-mocks (3.12.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.40.0)
+    rubocop (1.50.2)
       json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.23.0, < 2.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.24.0)
-      parser (>= 3.1.1.0)
-    ruby-progressbar (1.11.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
     sawyer (0.9.2)
       addressable (>= 2.3.5)
@@ -157,10 +135,8 @@ GEM
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
     thor (1.2.1)
-    unicode-display_width (2.3.0)
-    webrick (1.7.0)
-    yard (0.9.28)
-      webrick (~> 1.7.0)
+    unicode-display_width (2.4.2)
+    yard (0.9.34)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,3 +1,14 @@
+
+- [danger-shroud](#danger-shroud)
+  - [Installation](#installation)
+  - [Usage Kover](#usage-kover)
+    - [Parameters](#parameters)
+    - [Examples](#examples)
+  - [Usage Jacoco](#usage-jacoco)
+    - [Parameters](#parameters-1)
+    - [Examples](#examples-1)
+  - [Development](#development)
+
 # danger-shroud
 
 A danger plugin for enforcing code coverage coverage via a Kover or Jacoco coverage report.
@@ -16,6 +27,21 @@ gem 'danger-shroud'
 
 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. 
 
+### Parameters
+
+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 '`
+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`
+failIfUnderProjectThreshold | Boolean | if true, will fail builds that are under the provided thresholds. if false, will only warn. | default `true`
+failIfUnderFileThreshold | Boolean | if true, will fail builds that are under the provided thresholds. if false, will only warn. | default `true`
+
+### Examples
+
 Running shroud with default values:
 
 ```ruby
@@ -36,13 +62,27 @@ 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
+# builds will only warn instead of fail if below project thresholds
+shroud.reportKover 'Module Name', 'path/to/kover/report.xml', 80, 95, false, false
 ```
 
-
 ## Usage Jacoco
 
+### Parameters
+
+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 '`
+file | String | file path to a Kover 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`
+failIfUnderProjectThreshold | Boolean | if true, will fail builds that are under the provided thresholds. if false, will only warn. | default `true`
+failIfUnderFileThreshold | Boolean | if true, will fail builds that are under the provided thresholds. if false, will only warn. | default `true`
+
+### Examples
+
 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. 
 
 Running shroud with default values:
@@ -66,12 +106,9 @@ 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 'Module Name', 'path/to/jacoco/report.xml', 80, 95, false
+shroud.reportJacoco 'Module Name', 'path/to/jacoco/report.xml', 80, 95, false, false
 ```
 
-
-
-
 ## Development
 
 1. Clone this repo

data/lib/shroud/gem_version.rb

@@ -1,3 +1,3 @@
 module Shroud
-  VERSION = "0.0.6".freeze
+  VERSION = "0.0.7".freeze
 end

data/lib/shroud/plugin.rb

@@ -23,7 +23,7 @@ module Danger
   #
   #          # 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 'Project Name', 'path/to/kover/report.xml', 80, 95, false
+  #          shroud.reportKover 'Project Name', 'path/to/kover/report.xml', 80, 95, false, false
   #
   # @example Running Shroud with default values for Jacoco
   #
@@ -41,7 +41,7 @@ module Danger
   #
   #          # 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
+  #          shroud.reportJacoco 'Project Name', 'path/to/jacoco/report.xml', 80, 95, false, false
   #          
   # @tags android, kover, jacoco, coverage
   #
@@ -62,14 +62,18 @@ module Danger
     #          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.
+    # @param   [Boolean] failIfUnderProjectThreshold
+    #          if true, will fail builds that are under the provided thresholds for the overall project. If false, will only warn.
+    #          default true.
+    #
+    # @param   [Boolean] failIfUnderFileThreshold
+    #          if true, will fail builds that are under the provided thresholds per file. If false, will only warn.
     #          default true.
     #
     # @return  [void]
-    def report(file, totalProjectThreshold = 90, modifiedFileThreshold = 90, failIfUnderThreshold = true)
+    def report(file, totalProjectThreshold = 90, modifiedFileThreshold = 90, failIfUnderProjectThreshold = true, failIfUnderFileThreshold = failIfUnderProjectThreshold)
       warn "[DEPRECATION] `report` is deprecated.  Please use `reportJacoco` or `reportKover` instead."
-      reportJacoco('Project', file, totalProjectThreshold = 90, modifiedFileThreshold = 90, failIfUnderThreshold = true)
+      reportJacoco('Project', file, totalProjectThreshold = 90, modifiedFileThreshold = 90, failIfUnderProjectThreshold, failIfUnderFileThreshold)
     end
 
     # Report coverage on diffed files, as well as overall coverage.
@@ -88,13 +92,17 @@ module Danger
     #          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.
+    # @param   [Boolean] failIfUnderProjectThreshold
+    #          if true, will fail builds that are under the provided thresholds for the overall project. If false, will only warn.
+    #          default true.
+    #
+    # @param   [Boolean] failIfUnderFileThreshold
+    #          if true, will fail builds that are under the provided thresholds per file. 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)
+    def reportJacoco(moduleName, file, totalProjectThreshold = 90, modifiedFileThreshold = 90, failIfUnderProjectThreshold = true, failIfUnderFileThreshold = false)
+      internalReport('Jacoco', moduleName, file, totalProjectThreshold, modifiedFileThreshold, failIfUnderProjectThreshold, failIfUnderFileThreshold)
     end
 
     # Report coverage on diffed files, as well as overall coverage.
@@ -113,16 +121,20 @@ module Danger
     #          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.
+    # @param   [Boolean] failIfUnderProjectThreshold
+    #          if true, will fail builds that are under the provided thresholds for the overall project. If false, will only warn.
+    #          default true.
+    #
+    # @param   [Boolean] failIfUnderFileThreshold
+    #          if true, will fail builds that are under the provided thresholds per file. 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)
+    def reportKover(moduleName, file, totalProjectThreshold = 90, modifiedFileThreshold = 90, failIfUnderProjectThreshold = true, failIfUnderFileThreshold = failIfUnderProjectThreshold)
+      internalReport('Kover', moduleName, file, totalProjectThreshold, modifiedFileThreshold, failIfUnderProjectThreshold, failIfUnderFileThreshold)
     end
 
-    private def internalReport(reportType, moduleName, file, totalProjectThreshold, modifiedFileThreshold, failIfUnderThreshold)
+    private def internalReport(reportType, moduleName, file, totalProjectThreshold, modifiedFileThreshold, failIfUnderProjectThreshold, failIfUnderFileThreshold)
       raise "Please specify file name." if file.empty?
       raise "No #{reportType} xml report found at #{file}" unless File.exist? file
       rawXml = File.read(file)
@@ -177,7 +189,7 @@ module Danger
         # warn or fail if under specified file threshold:
         if (coveragePercent < modifiedFileThreshold)
           warningMessage = "Uh oh! #{fileName} is under #{modifiedFileThreshold}% coverage!"
-          if (failIfUnderThreshold)
+          if (failIfUnderFileThreshold)
             fail warningMessage
           else 
             warn warningMessage
@@ -196,7 +208,7 @@ module Danger
       # warn or fail if total coverage is under specified threshold
       if (coveragePercent < totalProjectThreshold)
         totalCoverageWarning = "Uh oh! Your project is under #{totalProjectThreshold}% coverage!"
-        if (failIfUnderThreshold) 
+        if (failIfUnderProjectThreshold) 
           fail totalCoverageWarning
         else 
           warn totalCoverageWarning

metadata

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