danger-shroud 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c399c9f335e1085c0738bdaa0b7716a098bded9
-  data.tar.gz: 1a8ba220325d729e40b1ae22ef023bfec784a98d
+  metadata.gz: c1eff20316e8213762f00f08a21061b826248b77
+  data.tar.gz: 31fbfebf2a79e2f4919ba07efc4b0195b0411de2
 SHA512:
-  metadata.gz: 7b8f11f163a11e4c6c458bea0d4839f110006ab1d0934ed2db6a57abad7053cda715f7dcb284eae3425759aff33bbc4765d85fcb7aa67bbcda1064b954478ac8
-  data.tar.gz: f8c7b93791fd12e8de09b3c1fda46335b22b5063bfc022c5814c555647f4d0326c7d1233d805e3f32af9499d58b6814729e2591a8538af19a50c0c573cf3a062
+  metadata.gz: 134472c687cc1e2d7bf875d7b9670ed2e564e79f0819dad623b4cfddfc9c9a84a4aa19b503586491ff75630295b2dff1d0c8fb6bd9d73e68840dcebf0fa5f5de
+  data.tar.gz: 17a0c9cacddd7d68840f162fe400c5b56d20857c5e598f45fba9f9f2fd40d1b4df43bc987580825095ad6472bf0efddc1128c7b563c4ea752645557e6302ea58

data/.travis.yml

@@ -3,10 +3,13 @@ cache:
   directories:
     - bundle
 
+install:
+  - gem install bundler
+  - bundle install
+
 rvm:
-  - 2.0
-  - 2.1.3
   - 2.3.1
 
 script:
-    - bundle exec rake spec
+    - bundle exec rake spec
+    - bundle exec danger plugins lint

data/Gemfile.lock

@@ -1,16 +1,17 @@
 PATH
   remote: .
   specs:
-    danger-shroud (0.0.1)
+    danger-shroud (0.0.3)
       danger-plugin-api (~> 1.0)
+      nokogiri
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.0)
-    claide (1.0.2)
+    claide (1.0.3)
     claide-plugins (0.9.2)
       cork
       nap
@@ -19,14 +20,14 @@ GEM
     colored2 (3.1.2)
     cork (0.3.0)
       colored2 (~> 3.1)
-    danger (6.0.9)
+    danger (6.3.2)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
       cork (~> 0.1)
       faraday (~> 0.9)
       faraday-http-cache (~> 2.0)
-      git (~> 1.5)
+      git (~> 1.6)
       kramdown (~> 2.0)
       kramdown-parser-gfm (~> 1.0)
       no_proxy_fix
@@ -35,13 +36,14 @@ GEM
     danger-plugin-api (1.0.0)
       danger (> 2.0)
     diff-lcs (1.3)
-    faraday (0.15.4)
+    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.5.0)
+    git (1.6.0)
+      rchardet (~> 1.8)
     guard (2.15.0)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
@@ -70,12 +72,13 @@ GEM
     nap (1.1.0)
     nenv (0.3.0)
     no_proxy_fix (0.1.2)
-    nokogiri (1.10.3)
+    nokogiri (1.10.9)
       mini_portile2 (~> 2.4.0)
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    octokit (4.14.0)
+    octokit (4.18.0)
+      faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
     parallel (1.17.0)
@@ -84,12 +87,13 @@ GEM
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    public_suffix (3.1.0)
+    public_suffix (4.0.3)
     rainbow (3.0.0)
     rake (10.5.0)
     rb-fsevent (0.10.3)
     rb-inotify (0.10.0)
       ffi (~> 1.0)
+    rchardet (1.8.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -130,12 +134,8 @@ DEPENDENCIES
   guard (~> 2.14)
   guard-rspec (~> 4.7)
   listen (= 3.0.7)
-  nokogiri
   pry
   rake (~> 10.0)
   rspec (~> 3.4)
   rubocop
   yard
-
-BUNDLED WITH
-   1.16.1

data/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 Andrew Haisting
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -1,23 +1,52 @@
 # danger-shroud
 
-Danger plugin for reporting jacoco coverage reports to Danger.
+A danger plugin for enforcing code coverage coverage via a Jacoco coverage reports.
+
+![Shroud Banner Image](images/bannerImage.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'danger-shroud'
+```
 
 ## Usage
 
-    Methods and attributes from this plugin are available in
-    your `Dangerfile` under the `shroud` namespace.
+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:
+
+```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'
+```
+
+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
+```
+
+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
+```
+
+
+
 
 ## Development
 
 1. Clone this repo
 2. Run `bundle install` to setup dependencies.
 3. Run `bundle exec rake spec` to run the tests.
-
-## TODO
-
-- [ ] Write real README
-- [ ] Add paramater for failing project threshold
-- [ ] Add paramater for failing modified file threshold
-- [ ] Add shroud to bridge
-- [ ] Write tests
-- [ ] Make public, released as a regular ol' gem
+4. Use `bundle exec guard` to automatically have tests run as you make changes.
+5. Make your changes.

data/danger-shroud.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
   spec.version       = Shroud::VERSION
   spec.authors       = ['andrewhaisting']
   spec.email         = ['ahaisting@gmail.com']
-  spec.description   = %q{Report test coverage on Android PRs.}
-  spec.summary       = %q{Shroud is a danger plugin that parses a jacococo coverage report to display on your team's PRs.}
-  spec.homepage      = 'https://github.com/andrewhaisting/danger-shroud'
+  spec.description   = %q{Enforce Jacoco code coverage on CI.}
+  spec.summary       = %q{A danger plugin for enforcing code coverage via a Jacoco coverage report.}
+  spec.homepage      = 'https://github.com/livefront/livefront-shroud-android'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)

data/lib/shroud/gem_version.rb

@@ -1,3 +1,3 @@
 module Shroud
-  VERSION = "0.0.2".freeze
+  VERSION = "0.0.3".freeze
 end

data/lib/shroud/plugin.rb

@@ -1,27 +1,53 @@
 require 'nokogiri'
 
 module Danger
-  # This is your plugin class. Any attributes or methods you expose here will
-  # be available from within your Dangerfile.
+
+  # Parse a 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. 
+  #
+  # @example Running shroud with default values
+  #
+  #          # 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'
+  #
+  # @example Running shroud with custom coverage thresholds
   #
-  # To be published on the Danger plugins site, you will need to have
-  # the public interface documented. Danger uses [YARD](http://yardoc.org/)
-  # for generating documentation from your plugin source, and you can verify
-  # by running `danger plugins lint` or `bundle exec rake spec`.
+  #          # 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
   #
-  # You should replace these comments with a public description of your library.
+  # @example Warn on builds instead of fail
+  #
+  #          # 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
+  #          
+  # @tags android, jacoco, coverage
   #
   class DangerShroud < Plugin
 
-    # Report coverage on diffed files, as well as overall coverage. 
-    # 
-    # file should reference a jacoco xml coverage report.
-    # totalProjectThreshold defines the threshold at which a warning will be emitted on total project coverage. deafult 0.
-    # modifiedFileThreshold defines the threshold at which a warning will be emitted on each modified file's coverage. default 0.
-    # failIfUnderThreshold when set to true will fail builds that fall under the above thresholds. default is false, which will warn.
+    # Report coverage on diffed files, as well as overall coverage.
+    #
+    # @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 report(file, totalProjectThreshold = 0, modifiedFileThreshold = 0, failIfUnderThreshold = false)
+    # @return  [void]
+    def report(file, totalProjectThreshold = 90, modifiedFileThreshold = 90, failIfUnderThreshold = true)
       raise "Please specify file name." if file.empty?
       raise "No jacoco xml report found at #{file}" unless File.exist? file
       rawXml = File.read(file)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-shroud
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - andrewhaisting
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-19 00:00:00.000000000 Z
+date: 2020-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -164,7 +164,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Report test coverage on Android PRs.
+description: Enforce Jacoco code coverage on CI.
 email:
 - ahaisting@gmail.com
 executables: []
@@ -176,16 +176,18 @@ files:
 - Gemfile
 - Gemfile.lock
 - Guardfile
+- LICENSE
 - README.md
 - Rakefile
 - danger-shroud.gemspec
+- images/bannerImage.png
 - lib/danger_plugin.rb
 - lib/danger_shroud.rb
 - lib/shroud/gem_version.rb
 - lib/shroud/plugin.rb
 - spec/shroud_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/andrewhaisting/danger-shroud
+homepage: https://github.com/livefront/livefront-shroud-android
 licenses:
 - MIT
 metadata: {}
@@ -208,8 +210,7 @@ rubyforge_project:
 rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: Shroud is a danger plugin that parses a jacococo coverage report to display
-  on your team's PRs.
+summary: A danger plugin for enforcing code coverage via a Jacoco coverage report.
 test_files:
 - spec/shroud_spec.rb
 - spec/spec_helper.rb