danger-shroud 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00edfafb1266b9496abe1346a20decc2625762cdbb14ce3ee11feb474dbf9773
-  data.tar.gz: 766eae63a08b0dd893b1dc00bcb07afb24a55b460f599fbb1aed2360d0f28f1e
+  metadata.gz: f975c92a31f10bca3fc2a6172d1a22234a54efb953ba177618eb57bcf5b41d4d
+  data.tar.gz: fc40d2e2393708e0d19716fc7adb9f9495c253756f7b623831217db663729b7c
 SHA512:
-  metadata.gz: 7805de3876afc42b9d3961a005038de0e27dc2bff08efddc701a4644c8c51d3e082574f93513923d15b4197b0cc7165ecfc50a36d767d9fb3980c45bb71591ec
-  data.tar.gz: 6e75b7bb5a229690307ecb4e0df6603b9f6a15e3319c243c0dcb8618f66d6f05b12c073972e66ec41d0f30552affb938ff23bf7739b5d09e29fbb3ffa1cff327
+  metadata.gz: a39b278261fb7162d399b37ba70ae72522578e6a5438f48f90fef71e8cf9b8cc59fcf6cfa1285814d0ff93f14cffa48269dbd527dcfa9647abc9d81f1ebc9bd8
+  data.tar.gz: 2575bf0d9b1d91827e658565051e359808ed55bc7f6615e759084063fc5aebac9939e853ae8d45f58f50eb826e6238d14fc732ac60bb3d975fc4d358d0b2fc9e

data/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    open-pull-requests-limit: 0
+    # Add/Remove reviewers here
+    reviewers:
+      - "dperez37"

data/.github/workflows/publish.yml

@@ -4,6 +4,9 @@ on:
   push:
     branches: [ "master" ]
 
+env:
+  RUBY_VERSION: 2.7.2
+
 jobs:
   build:
     name: Build + Publish
@@ -14,10 +17,10 @@ jobs:
 
     steps:
     - uses: actions/checkout@v3
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
+    - name: Set up Ruby ${{ env.RUBY_VERSION }}
+      uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.6.x
+        ruby-version: ${{ env.RUBY_VERSION }}
 
     - name: Publish to RubyGems
       run: |

data/Gemfile.lock

@@ -1,56 +1,78 @@
 PATH
   remote: .
   specs:
-    danger-shroud (0.0.4)
+    danger-shroud (0.0.6)
       danger-plugin-api (~> 1.0)
       nokogiri
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.0)
-    claide (1.0.3)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    claide (1.1.0)
     claide-plugins (0.9.2)
       cork
       nap
       open4 (~> 1.3)
-    coderay (1.1.2)
+    coderay (1.1.3)
     colored2 (3.1.2)
     cork (0.3.0)
       colored2 (~> 3.1)
-    danger (6.3.2)
+    danger (9.1.0)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
       cork (~> 0.1)
-      faraday (~> 0.9)
+      faraday (>= 0.9.0, < 2.0)
       faraday-http-cache (~> 2.0)
-      git (~> 1.6)
-      kramdown (~> 2.0)
+      git (~> 1.7)
+      kramdown (~> 2.3)
       kramdown-parser-gfm (~> 1.0)
       no_proxy_fix
-      octokit (~> 4.7)
-      terminal-table (~> 1)
+      octokit (~> 5.0)
+      terminal-table (>= 1, < 4)
     danger-plugin-api (1.0.0)
       danger (> 2.0)
-    diff-lcs (1.3)
-    faraday (0.17.3)
-      multipart-post (>= 1.2, < 3)
-    faraday-http-cache (2.0.0)
-      faraday (~> 0.8)
-    ffi (1.11.1)
-    formatador (0.2.5)
-    git (1.11.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)
+      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)
+    ffi (1.15.5)
+    formatador (1.1.0)
+    git (1.12.0)
+      addressable (~> 2.8)
       rchardet (~> 1.8)
-    guard (2.15.0)
+    guard (2.18.0)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (>= 1.0.12, < 2.0)
       nenv (~> 0.1)
       notiffany (~> 0.0)
-      pry (>= 0.9.12)
+      pry (>= 0.13.0)
       shellany (~> 0.0)
       thor (>= 0.18.1)
     guard-compat (1.2.1)
@@ -58,76 +80,87 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    jaro_winkler (1.5.2)
-    kramdown (2.3.1)
+    json (2.6.3)
+    kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
     listen (3.0.7)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9.7)
-    lumberjack (1.0.13)
-    method_source (0.9.2)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
     mini_portile2 (2.8.0)
-    multipart-post (2.1.1)
+    multipart-post (2.2.3)
     nap (1.1.0)
     nenv (0.3.0)
     no_proxy_fix (0.1.2)
-    nokogiri (1.13.6)
+    nokogiri (1.13.10)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
-    notiffany (0.1.1)
+    nokogiri (1.13.10-arm64-darwin)
+      racc (~> 1.4)
+    notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    octokit (4.18.0)
-      faraday (>= 0.9)
-      sawyer (~> 0.8.0, >= 0.5.3)
+    octokit (5.6.1)
+      faraday (>= 1, < 3)
+      sawyer (~> 0.9)
     open4 (1.3.4)
-    parallel (1.17.0)
-    parser (2.6.3.0)
-      ast (~> 2.4.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    public_suffix (4.0.6)
-    racc (1.6.0)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    rb-fsevent (0.10.3)
-    rb-inotify (0.10.0)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (5.0.1)
+    racc (1.6.1)
+    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)
     rexml (3.2.5)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.3)
+    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-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rubocop (0.71.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.40.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 3.1.2.1)
       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)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    ruby-progressbar (1.10.1)
-    sawyer (0.8.2)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    sawyer (0.9.2)
       addressable (>= 2.3.5)
-      faraday (> 0.8, < 2.0)
+      faraday (>= 0.17.3, < 3)
     shellany (0.0.1)
-    terminal-table (1.8.0)
-      unicode-display_width (~> 1.1, >= 1.1.1)
-    thor (0.20.3)
-    unicode-display_width (1.6.0)
-    yard (0.9.26)
+    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)
 
 PLATFORMS
   ruby
@@ -145,4 +178,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.2.7
+   2.3.18

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.6".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,11 +186,11 @@ 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
 
-      output << '> Codebase cunningly covered by count [Shroud 🧛](https://github.com/livefront/livefront-shroud-android/)'
+      output << '> Codebase cunningly covered by count [Shroud 🧛](https://github.com/livefront/danger-shroud)'
       markdown output
 
       # warn or fail if total coverage is under specified threshold

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-shroud
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - andrewhaisting
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-13 00:00:00.000000000 Z
+date: 2022-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -171,6 +171,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".github/workflows/ci.yml"
 - ".github/workflows/publish.yml"
 - ".gitignore"
@@ -208,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A danger plugin for enforcing code coverage via a Jacoco coverage report.