danger-jacoco 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 41f06316cc4d1805a8a86dbd4957500b059b1a96
-  data.tar.gz: f03bd63af127ad7b93e4e284602451e6307e6f34
+SHA256:
+  metadata.gz: be717547463cb80933a9d0a26dc3c8d54e28ab790ee586f3c85ba008a05a32ac
+  data.tar.gz: 5d4c4871ab84ca86896e9c0bc87d65deb833222772bca6b94e189382402f6309
 SHA512:
-  metadata.gz: 472aaa07a8b9592fd940054882f52d03207cdc45a9d4703bda6fe087fd03f0da54a5409f0a2f8f1437cdb9b58b675a06ffbc97c8cb325a69c47275c51e7644e4
-  data.tar.gz: da9c29738c04da81dde72eda8320209339dbbb4b2f9a6f91cf4a61ae9f283439182fd64c8b2aa4a5e7a05716300d523c5e619815bcc7b7a10ba2d1d47ebaf8d6
+  metadata.gz: 28114a17c2544c7780a282edc04660756b0b4b3da8a49c87da7ddae43c71fadbf57f1cc7c887430a6bc3b77115be214e46f6116232ddcbe75b47ed9f4701a969
+  data.tar.gz: 4958daa6252fdccaf330c6b752cc1bc51a57cfa4988c72fbf6ef8815472ff11df11e212535a43c2f4a2bf367c7de541647b45f2093c89ad5bb4b1b1fa1204e74

data/.github/workflows/ci.yaml

@@ -0,0 +1,12 @@
+name: ci
+on: [push]
+jobs:
+  test:
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: '2.6.x'
+      - run: bundle install
+      - run: bundle exec rake spec

data/.github/workflows/release.yaml

@@ -0,0 +1,22 @@
+name: deploy-release
+on:
+  push:
+    tags: '*'
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: '2.6.x'
+      - run: bundle install
+      - run: bundle exec rake spec
+      - name: setup credentials
+        env:
+          RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
+        run: |
+          mkdir ~/.gem
+          echo -e "---\r\n:rubygems_api_key: $RUBYGEMS_API_KEY" > ~/.gem/credentials
+          chmod 0600 ~/.gem/credentials
+      - run: bundle exec rake release

data/README.md

@@ -15,6 +15,13 @@ Add
 
 ```ruby
 jacoco.minimum_project_coverage_percentage = 50 # default 0
+jacoco.minimum_package_coverage_map = { # optional (default is empty)
+  'com/package/' => 55,
+  'com/package/more/specific/' => 15
+}
+jacoco.minimum_class_coverage_map = { # optional (default is empty)
+  'com/package/more/specific/ClassName' => 15
+}
 jacoco.minimum_class_coverage_percentage = 75 # default 0
 jacoco.files_extension = [".java"] # default [".kt", ".java"]
 jacoco.report("path/to/jacoco.xml", "http://jacoco-html-reports/")

data/lib/danger_jacoco.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'jacoco/gem_version'

data/lib/danger_plugin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jacoco/plugin'
 
 require 'jacoco/dom_parser'

data/lib/jacoco/dom_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jacoco
   # DOM parser for Jacoco report
   class DOMParser

data/lib/jacoco/gem_version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jacoco
-  VERSION = '0.1.4'.freeze
+  VERSION = '0.1.5'
 end

data/lib/jacoco/model/class.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'happymapper'
 require 'jacoco/model/counter'
 require 'jacoco/model/method'

data/lib/jacoco/model/counter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'happymapper'
 
 module Jacoco

data/lib/jacoco/model/group.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'happymapper'
 require 'jacoco/model/group'
 require 'jacoco/model/package'

data/lib/jacoco/model/line.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'happymapper'
 require 'jacoco/model/counter'
 require 'jacoco/model/method'

data/lib/jacoco/model/method.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'happymapper'
 require 'jacoco/model/counter'
 

data/lib/jacoco/model/package.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'happymapper'
 require 'jacoco/model/class'
 require 'jacoco/model/sourcefile'

data/lib/jacoco/model/report.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'happymapper'
 require 'jacoco/model/session_info'
 

data/lib/jacoco/model/session_info.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'happymapper'
 
 module Jacoco

data/lib/jacoco/model/sourcefile.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'happymapper'
 
 module Jacoco

data/lib/jacoco/plugin.rb

@@ -1,19 +1,36 @@
+# frozen_string_literal: true
+
 require 'jacoco/sax_parser'
 
 module Danger
+  # Verify code coverage inside your projects
+  # This is done using the jacoco output
+  # Results are passed out as a table in markdown
+  #
+  # @example Verify coverage
+  #          jacoco.minimum_project_coverage_percentage = 50
+  #
+  # @example Verify coverage per package
+  #          jacoco.minimum_package_coverage_map = { # optional (default is empty)
+  #           'com/package/' => 55,
+  #           'com/package/more/specific/' => 15
+  #          }
   #
   # @see  Anton Malinskiy/danger-jacoco
   # @tags jacoco, coverage, java, android, kotlin
   #
-  class DangerJacoco < Plugin
+  class DangerJacoco < Plugin # rubocop:disable Metrics/ClassLength
     attr_accessor :minimum_project_coverage_percentage
     attr_accessor :minimum_class_coverage_percentage
     attr_accessor :files_extension
+    attr_accessor :minimum_package_coverage_map
     attr_accessor :minimum_class_coverage_map
 
+    # Initialize the plugin with configured parameters or defaults
     def setup
       @minimum_project_coverage_percentage = 0 unless minimum_project_coverage_percentage
       @minimum_class_coverage_percentage = 0 unless minimum_class_coverage_percentage
+      @minimum_package_coverage_map = {} unless minimum_package_coverage_map
       @minimum_class_coverage_map = {} unless minimum_class_coverage_map
       @files_extension = ['.kt', '.java'] unless files_extension
     end
@@ -54,8 +71,8 @@ module Danger
       total_covered = total_coverage(path)
 
       report_markdown = "### JaCoCO Code Coverage #{total_covered[:covered]}% #{total_covered[:status]}\n"
-      report_markdown << "| Class | Covered | Meta | Status |\n"
-      report_markdown << "|:---|:---:|:---:|:---:|\n"
+      report_markdown += "| Class | Covered | Meta | Status |\n"
+      report_markdown += "|:---|:---:|:---:|:---:|\n"
       class_coverage_above_minimum = markdown_class(parser, report_markdown, report_url)
       markdown(report_markdown)
 
@@ -75,6 +92,7 @@ module Danger
       counter = coverage_counter(jacoco_class)
       coverage = (counter.covered.fdiv(counter.covered + counter.missed) * 100).floor
       required_coverage = minimum_class_coverage_map[jacoco_class.name]
+      required_coverage = package_coverage(jacoco_class.name) if required_coverage.nil?
       required_coverage = minimum_class_coverage_percentage if required_coverage.nil?
       status = coverage_status(coverage, required_coverage)
 
@@ -85,6 +103,20 @@ module Danger
       }
     end
 
+    # it returns the most suitable coverage by package name to class or nil
+    def package_coverage(class_name)
+      path = class_name
+      package_parts = class_name.split('/')
+      package_parts.reverse_each do |item|
+        size = item.size
+        path = path[0...-size]
+        coverage = minimum_package_coverage_map[path]
+        path = path[0...-1] unless path.empty?
+        return coverage unless coverage.nil?
+      end
+      nil
+    end
+
     # it returns an emoji for coverage status
     def coverage_status(coverage, minimum_percentage)
       if coverage < (minimum_percentage / 2) then ':skull:'
@@ -152,12 +184,11 @@ module Danger
 
     def report_link(class_name, report_url)
       if report_url.empty?
-          "`#{class_name}`"
-      else 
-          report_filepath = class_name.gsub(/\/(?=[^\/]*\/.)/, '.') + ".html"
-          "[`#{class_name}`](#{report_url + report_filepath})"
+        "`#{class_name}`"
+      else
+        report_filepath = class_name.gsub(%r{/(?=[^/]*/.)}, '.') + '.html'
+        "[`#{class_name}`](#{report_url + report_filepath})"
       end
     end
-
   end
 end

data/lib/jacoco/sax_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'nokogiri'
 
 module Jacoco

data/spec/jacoco_spec.rb

@@ -1,16 +1,21 @@
-require File.expand_path("../spec_helper", __FILE__)
+# frozen_string_literal: true
 
-module Danger
+# rubocop:disable LineLength
+
+# rubocop:disable BlockLength
+
+require File.expand_path('spec_helper', __dir__)
 
+module Danger
   describe Danger::DangerJacoco do
-    it "should be a plugin" do
+    it 'should be a plugin' do
       expect(Danger::DangerJacoco.new(nil)).to be_a Danger::Plugin
     end
 
     #
     # You should test your custom attributes and methods here
     #
-    describe "with Dangerfile" do
+    describe 'with Dangerfile' do
       before do
         @dangerfile = testing_dangerfile
         @my_plugin = @dangerfile.jacoco
@@ -20,25 +25,91 @@ module Danger
 
         allow(@dangerfile.git).to receive(:modified_files).and_return(modified_files)
         allow(@dangerfile.git).to receive(:added_files).and_return(added_files)
+      end
+
+      it :report do
+        path_a = "#{File.dirname(__FILE__)}/fixtures/output_a.xml"
+
+        @my_plugin.minimum_project_coverage_percentage = 50
+        @my_plugin.minimum_class_coverage_map = { 'com/example/CachedRepository' => 100 }
+
+        @my_plugin.report path_a
 
+        expect(@dangerfile.status_report[:errors]).to eq(['Total coverage of 32.9%. Improve this to at least 50%',
+                                                          'Class coverage is below minimum. Improve to at least 0%'])
+        expect(@dangerfile.status_report[:markdowns][0].message).to include('### JaCoCO Code Coverage 32.9% :warning:')
+        expect(@dangerfile.status_report[:markdowns][0].message).to include('| Class | Covered | Meta | Status |')
+        expect(@dangerfile.status_report[:markdowns][0].message).to include('|:---|:---:|:---:|:---:|')
+        expect(@dangerfile.status_report[:markdowns][0].message).to include('| `com/example/CachedRepository` | 50% | 100% | :warning: |')
       end
 
+      it 'test with package coverage' do
+        path_a = "#{File.dirname(__FILE__)}/fixtures/output_a.xml"
 
-      it :report do
+        @my_plugin.minimum_project_coverage_percentage = 50
+        @my_plugin.minimum_package_coverage_map = { 'com/example/' => 70 }
+
+        @my_plugin.report path_a
+
+        expect(@dangerfile.status_report[:markdowns][0].message).to include('| `com/example/CachedRepository` | 50% | 70% | :warning: |')
+      end
+
+      it 'test with bigger overlapped package coverage' do
         path_a = "#{File.dirname(__FILE__)}/fixtures/output_a.xml"
 
         @my_plugin.minimum_project_coverage_percentage = 50
-        @my_plugin.minimum_class_coverage_map = { "com/example/CachedRepository" => 100}
+        @my_plugin.minimum_package_coverage_map = {
+          'com/example/' => 70,
+          'com/' => 90
+        }
 
         @my_plugin.report path_a
 
-        expect(@dangerfile.status_report[:errors]).to eq(["Total coverage of 32.9%. Improve this to at least 50%",
-                                                          "Class coverage is below minimum. Improve to at least 0%"])
-        expect(@dangerfile.status_report[:markdowns][0].message).to include("### JaCoCO Code Coverage 32.9% :warning:")
-        expect(@dangerfile.status_report[:markdowns][0].message).to include("| Class | Covered | Meta | Status |")
-        expect(@dangerfile.status_report[:markdowns][0].message).to include("|:---|:---:|:---:|:---:|")
-        expect(@dangerfile.status_report[:markdowns][0].message).to include("| `com/example/CachedRepository` | 50% | 100% | :warning: |")
+        expect(@dangerfile.status_report[:markdowns][0].message).to include('| `com/example/CachedRepository` | 50% | 70% | :warning: |')
+      end
+
+      it 'test with lower overlapped package coverage' do
+        path_a = "#{File.dirname(__FILE__)}/fixtures/output_a.xml"
 
+        @my_plugin.minimum_project_coverage_percentage = 50
+        @my_plugin.minimum_package_coverage_map = {
+          'com/example/' => 77,
+          'com/' => 30
+        }
+
+        @my_plugin.report path_a
+
+        expect(@dangerfile.status_report[:markdowns][0].message).to include('| `com/example/CachedRepository` | 50% | 77% | :warning: |')
+      end
+
+      it 'test with overlapped package coverage and bigger class coverage' do
+        path_a = "#{File.dirname(__FILE__)}/fixtures/output_a.xml"
+
+        @my_plugin.minimum_project_coverage_percentage = 50
+        @my_plugin.minimum_package_coverage_map = {
+          'com/example/' => 77,
+          'com/' => 30
+        }
+        @my_plugin.minimum_class_coverage_map = { 'com/example/CachedRepository' => 100 }
+
+        @my_plugin.report path_a
+
+        expect(@dangerfile.status_report[:markdowns][0].message).to include('| `com/example/CachedRepository` | 50% | 100% | :warning: |')
+      end
+
+      it 'test with overlapped package coverage and lowwer class coverage' do
+        path_a = "#{File.dirname(__FILE__)}/fixtures/output_a.xml"
+
+        @my_plugin.minimum_project_coverage_percentage = 50
+        @my_plugin.minimum_package_coverage_map = {
+          'com/example/' => 90,
+          'com/' => 85
+        }
+        @my_plugin.minimum_class_coverage_map = { 'com/example/CachedRepository' => 80 }
+
+        @my_plugin.report path_a
+
+        expect(@dangerfile.status_report[:markdowns][0].message).to include('| `com/example/CachedRepository` | 50% | 80% | :warning: |')
       end
 
       it 'adds a link to report' do
@@ -49,10 +120,11 @@ module Danger
 
         @my_plugin.report(path_a, 'http://test.com/')
 
-        expect(@dangerfile.status_report[:markdowns][0].message).to include("| [`com/example/CachedRepository`](http://test.com/com.example/CachedRepository.html) | 50% | 80% | :warning: |")
-
+        expect(@dangerfile.status_report[:markdowns][0].message).to include('| [`com/example/CachedRepository`](http://test.com/com.example/CachedRepository.html) | 50% | 80% | :warning: |')
       end
-    
     end
   end
 end
+
+# rubocop:enable LineLength
+# rubocop:enable BlockLength

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 require 'pathname'
-ROOT = Pathname.new(File.expand_path('../../', __FILE__))
+ROOT = Pathname.new(File.expand_path('..', __dir__))
 $LOAD_PATH.unshift((ROOT + 'lib').to_s)
 $LOAD_PATH.unshift((ROOT + 'spec').to_s)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-jacoco
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Anton Malinskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-12 00:00:00.000000000 Z
+date: 2019-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -171,6 +171,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yaml"
+- ".github/workflows/release.yaml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -217,8 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A longer description of danger-jacoco.