danger-jacoco 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d58e57b0d3fd8972b9be76af2a879df6357979d5
-  data.tar.gz: 4611c4a672001b5f02bb132a8754f4f6970e210e
+  metadata.gz: e8caafe32ed85b587ff05493d8787e293aaad3eb
+  data.tar.gz: fded83a5dbdae6209dd1986b761b9c861d6ccd01
 SHA512:
-  metadata.gz: 2bbe99c68f372abc2d609b31fb120d86403f5363d6699586b5d362562d1465982c131b3796571c0bae1e5fd16a531b363f0e6e36408fd5be29030b5a8caa96ba
-  data.tar.gz: 53d1670e45d8e653d99bf4987104d2b0b358d84ed2fe52d798555d909a1505d62c7f37c5e32672a8121cf1eb952201b8ea129aa2d8e0aec46c44363bd70d2373
+  metadata.gz: 7b91364232e571798fe45bf8b0911bd09fca607b3e6e1ca04a384052bdedd4b206251694cac69d376c9240633b72a5af119b31271be8411f1fa35199b83cdf42
+  data.tar.gz: 144d396fad44caa4ddc756139861a14bda5b3ee2f336772abaf7ff55a960bea795fe06fdf00abbaf3157d744e9f3b9a94bd96f99a272ef105f4482eceeb52323

data/.gitignore

@@ -1,3 +1,4 @@
 .DS_Store
 pkg
 .idea/
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Metrics/LineLength:
+  Max: 120
+Metrics/MethodLength:
+  Max: 20
+Metrics/AbcSize:
+  Max: 20

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-jacoco (0.0.3)
+    danger-jacoco (0.1.0)
       danger-plugin-api (~> 1.0)
       nokogiri-happymapper (~> 0.6)
 
@@ -20,7 +20,7 @@ GEM
     colored2 (3.1.2)
     cork (0.3.0)
       colored2 (~> 3.1)
-    danger (5.5.5)
+    danger (5.5.10)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
@@ -35,7 +35,7 @@ GEM
     danger-plugin-api (1.0.0)
       danger (> 2.0)
     diff-lcs (1.3)
-    faraday (0.13.1)
+    faraday (0.14.0)
       multipart-post (>= 1.2, < 3)
     faraday-http-cache (1.3.1)
       faraday (~> 0.8)
@@ -68,14 +68,14 @@ GEM
     nap (1.1.0)
     nenv (0.3.0)
     no_proxy_fix (0.1.2)
-    nokogiri (1.8.1)
+    nokogiri (1.8.2)
       mini_portile2 (~> 2.3.0)
     nokogiri-happymapper (0.6.0)
       nokogiri (~> 1.5)
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    octokit (4.7.0)
+    octokit (4.8.0)
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
     parallel (1.12.0)
@@ -85,7 +85,7 @@ GEM
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    public_suffix (3.0.1)
+    public_suffix (3.0.2)
     rainbow (2.2.2)
       rake
     rake (12.3.0)
@@ -140,4 +140,4 @@ DEPENDENCIES
   yard (~> 0.9)
 
 BUNDLED WITH
-   1.16.0
+   1.16.1

data/README.md

@@ -14,7 +14,9 @@ sudo gem install danger-jacoco
 Add 
 
 ```ruby
-jacoco.minimum_coverage_percentage=80
+jacoco.minimum_project_coverage_percentage = 50 # default 0
+jacoco.minimum_class_coverage_percentage = 75 # default 0
+jacoco.files_extension = [".java"] # default [".kt", ".java"]
 jacoco.report "path/to/jacoco.xml"
 ```
 

data/lib/jacoco/gem_version.rb

@@ -1,3 +1,3 @@
 module Jacoco
-  VERSION = '0.0.3'.freeze
+  VERSION = '0.1.0'.freeze
 end

data/lib/jacoco/plugin.rb

@@ -3,10 +3,18 @@ require 'jacoco/sax_parser'
 module Danger
   #
   # @see  Anton Malinskiy/danger-jacoco
-  # @tags jacoco, coverage, java, android
+  # @tags jacoco, coverage, java, android, kotlin
   #
   class DangerJacoco < Plugin
-    attr_accessor :minimum_coverage_percentage
+    attr_accessor :minimum_project_coverage_percentage
+    attr_accessor :minimum_class_coverage_percentage
+    attr_accessor :files_extension
+
+    def setup
+      @minimum_project_coverage_percentage = 0 unless minimum_project_coverage_percentage
+      @minimum_class_coverage_percentage = 0 unless minimum_class_coverage_percentage
+      @files_extension = ['.kt', '.java'] unless files_extension
+    end
 
     # Parses the xml output of jacoco to Ruby model classes
     # This is slow since it's basically DOM parsing
@@ -21,57 +29,96 @@ module Danger
     #
     # @path path to the xml output of jacoco
     # @delimiter git.modified_files returns full paths to the
-    # changed files. We need to get the java class from this path to check the
+    # changed files. We need to get the class from this path to check the
     # Jacoco report,
     #
-    # e.g. src/java/com/example/SomeClass.java -> com/example/SomeClass
+    # e.g. src/java/com/example/SomeJavaClass.java -> com/example/SomeJavaClass
+    # e.g. src/kotlin/com/example/SomeKotlinClass.kt -> com/example/SomeKotlinClass
     #
     # The default value supposes that you're using gradle structure,
-    # that is your path to java source files is something like
+    # that is your path to source files is something like
     #
-    # blah/blah/java/slashed_package/Source.java
+    # Java => blah/blah/java/slashed_package/Source.java
+    # Kotlin => blah/blah/kotlin/slashed_package/Source.kt
     #
-    def report(path, delimiter = '/java/')
+    def report(path, delimiter = %r{\/java\/|\/kotlin\/})
+      setup
       classes = classes(delimiter)
 
       parser = Jacoco::SAXParser.new(classes)
       Nokogiri::XML::SAX::Parser.new(parser).parse(File.open(path))
 
-      parser.classes.each do |jacoco_class|
-        # Check which metrics are available
-        report_class(jacoco_class)
-      end
+      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"
+      markdown_class(parser, report_markdown)
+      markdown(report_markdown)
+
+      return if total_covered[:covered] >= minimum_project_coverage_percentage
+
+      # fail danger if total coveraged is smaller than minimum_project_coverage_percentage
+      covered = total_covered[:covered]
+      raise("Total coverage of #{covered}%. Improve this to as least #{minimum_project_coverage_percentage} %")
     end
 
+    # Select modified and added files in this PR
     def classes(delimiter)
       git = @dangerfile.git
       affected_files = git.modified_files + git.added_files
-      affected_files.select { |file| file.end_with? '.java' }
-                    .map { |file| extract_class(file, delimiter) }
+      affected_files.select { |file| files_extension.reduce(false) { |state, el| state || file.end_with?(el) } }
+                    .map { |file| file.split('.').first.split(delimiter)[1] }
     end
 
+    # It returns a specific class code coverage and an emoji status as well
     def report_class(jacoco_class)
       counters       = jacoco_class.counters
       branch_counter = counters.detect { |e| e.type.eql? 'BRANCH' }
       line_counter   = counters.detect { |e| e.type.eql? 'LINE' }
       counter        = branch_counter.nil? ? line_counter : branch_counter
+      coverage = (counter.covered.fdiv(counter.covered + counter.missed) * 100).floor
+      status = coverage_status(coverage, minimum_class_coverage_percentage)
 
-      report_counter(counter, jacoco_class)
+      {
+        covered: coverage,
+        status: status
+      }
     end
 
-    def report_counter(counter, jacoco_class)
-      covered  = counter.covered
-      missed   = counter.missed
-      coverage = (covered.fdiv(covered + missed) * 100).floor
+    # it returns an emoji for coverage status
+    def coverage_status(coverage, minimum_percentage)
+      if coverage < (minimum_percentage / 2) then ':skull:'
+      elsif coverage < minimum_percentage then ':warning:'
+      else ':white_check_mark:'
+      end
+    end
+
+    # It returns total of project code coverage and an emoji status as well
+    def total_coverage(report_path)
+      jacoco_report = Nokogiri::XML(File.open(report_path))
 
-      return unless coverage < minimum_coverage_percentage
+      report = jacoco_report.xpath('report/counter').select { |item| item['type'] == 'INSTRUCTION' }
+      missed_instructions = report.first['missed'].to_f
+      covered_instructions = report.first['covered'].to_f
+      total_instructions = missed_instructions + covered_instructions
+      covered_percentage = (covered_instructions * 100 / total_instructions).round(2)
+      coverage_status = coverage_status(covered_percentage, minimum_project_coverage_percentage)
 
-      fail("#{jacoco_class.name} has coverage of #{coverage}%. " \
-              "Improve this to at least #{minimum_coverage_percentage}%")
+      {
+        covered: covered_percentage,
+        status: coverage_status
+      }
     end
 
-    def extract_class(file, java_path_delimiter)
-      file[0, file.length - 5].split(java_path_delimiter)[1]
+    private
+
+    def markdown_class(parser, report_markdown)
+      parser.classes.each do |jacoco_class| # Check metrics for each classes
+        rp = report_class(jacoco_class)
+        ln = "| `#{jacoco_class.name}` | #{rp[:covered]}% | #{minimum_class_coverage_percentage}% | #{rp[:status]} |\n"
+        report_markdown << ln
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-jacoco
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Anton Malinskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-05 00:00:00.000000000 Z
+date: 2018-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -172,6 +172,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -218,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: A longer description of danger-jacoco.