minitest-cc 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 848f6762978bb5db1d4bfb03e13ff466a9fc7111ee1525f5825a558863b026ae
-  data.tar.gz: fa59d3d0887831482fb6ea9ce737f841bd326d42808d3c3b89556f914657ba8d
+  metadata.gz: 3057b7420f4eb647e697cfa3e2fb9a0d9586665dfe577b1fc5f5552af8b7b6e8
+  data.tar.gz: 57173dbf03435603affd8e078faf958cbe53b227ffbc13e7989e37647e3e17f5
 SHA512:
-  metadata.gz: ff8cc42c16e7b0baad675f64f275a3435b8f990d43dff8ccca0288888625c3480b4e20584a2dcbb58f231c996ecefcd98609431a00eeaafdeba863afab8c9b96
-  data.tar.gz: 469ca5c033d2f4075207cd070758592b2d43248bf212eb0cd395b824b30c67b1a994a13f02d7e0078fb7e4ff12416c9ac8bcb87c1b98231fd37cbb102e844f66
+  metadata.gz: 72bb82508786ca90a692c3812d33a78147282fc2667fda08274feb43ba3dbd88759b079e46237aecdc2a572043de207e2a307f5b71e06ed6e6c814f491e62529
+  data.tar.gz: '08d491e36ad409f5b0e827b7631ee55d2aa7f1236fee5631a326bb279ffeecea36019517c04b1a669cdbaf3ae48d42314098d6dc9759a5445735256b65505239'

data/lib/minitest/cc/file_array.rb

@@ -6,35 +6,47 @@ module Minitest
     class FileArray < Array
       ##
       # Calculate the lines average of the self array
-      # @return [Integer] percent of lines executed
+      # @return [Float] percent of lines executed
       def lines_average
         lines = reduce(0) { |sum, v| sum + v.lines.to_i }
+
+        return 0.0 if lines.zero?
+
         lines_executed = reduce(0) { |sum, v| sum + v.lines_executed.to_i }
-        lines_executed * 100 / lines
-      rescue ZeroDivisionError
-        0
+        lines_executed * 100.0 / lines
       end
 
       ##
       # Calculate the branches average of the self array
-      # @return [Integer] percent of branches executed
+      # @return [Float] percent of branches executed
       def branches_average
         branches = reduce(0) { |sum, v| sum + v.branches.to_i }
+
+        return 0.0 if branches.zero?
+
         branches_executed = reduce(0) { |sum, v| sum + v.branches_executed.to_i }
-        branches_executed * 100 / branches
-      rescue ZeroDivisionError
-        0
+        branches_executed * 100.0 / branches
       end
 
       ##
       # Calculate the methods average of the self array
-      # @return [Integer] percent of methods executed
+      # @return [Float] percent of methods executed
       def methods_average
         methods = reduce(0) { |sum, v| sum + v.methods.to_i }
+
+        return 0.0 if methods.zero?
+
         methods_executed = reduce(0) { |sum, v| sum + v.methods_executed.to_i }
-        methods_executed * 100 / methods
+        methods_executed * 100.0 / methods
+      end
+
+      ##
+      # Calculate total average of coverage
+      # @return [Float] percent of coverage
+      def total_coverage_percent
+        (lines_average + branches_average + methods_average) / 3
       rescue ZeroDivisionError
-        0
+        0.0
       end
     end
   end

data/lib/minitest/cc/file_coverage.rb

@@ -114,7 +114,7 @@ module Minitest
       # @return [String] contains the information ready to print
       #
       def to_s
-        return "#{relative_path} : Not executed during the tests." unless tested
+        return "#{relative_path} : Not executed or tracked by cov." unless tested
 
         "#{relative_path}:\n" + to_s_lines + to_s_branches + to_s_methods
       end
@@ -126,7 +126,7 @@ module Minitest
       def to_s_lines
         return '' unless lines
 
-        "\tlines: #{lines_executed}/#{lines} #{lines_percent.to_s_color}%"
+        " - l: #{lines_executed}/#{lines} #{lines_percent.to_s_color}%"
       end
 
       ##
@@ -136,7 +136,7 @@ module Minitest
       def to_s_branches
         return '' unless branches
 
-        "\tbranches: #{branches_executed}/#{branches} #{branches_percent.to_s_color}%"
+        " - b: #{branches_executed}/#{branches} #{branches_percent.to_s_color}%"
       end
 
       ##
@@ -146,7 +146,7 @@ module Minitest
       def to_s_methods
         return '' unless methods
 
-        "\tmethods: #{methods_executed}/#{methods} #{methods_percent.to_s_color}%"
+        " - m: #{methods_executed}/#{methods} #{methods_percent.to_s_color}%"
       end
 
       ##
@@ -154,9 +154,9 @@ module Minitest
       # @return [Integer] percent of coverage. executed lines / total lines
       #
       def lines_percent
-        lines_executed * 100 / lines
-      rescue ZeroDivisionError
-        0
+        return 0.0 if lines.zero?
+
+        lines_executed * 100.0 / lines
       end
 
       ##
@@ -164,9 +164,9 @@ module Minitest
       # @return [Integer] percent of coverage. executed branches / total branches
       #
       def branches_percent
-        branches_executed * 100 / branches
-      rescue ZeroDivisionError
-        0
+        return 0.0 if branches.zero?
+
+        branches_executed * 100.0 / branches
       end
 
       ##
@@ -174,9 +174,9 @@ module Minitest
       # @return [Integer] percent of coverage. executed methods / total methods
       #
       def methods_percent
-        methods_executed * 100 / methods
-      rescue ZeroDivisionError
-        0
+        return 0.0 if methods.zero?
+
+        methods_executed * 100.0 / methods
       end
     end
   end

data/lib/minitest/cc/reporter.rb

@@ -7,7 +7,10 @@ module Minitest
       ##
       # Executed in the final of the minitest run
       def report
+        Cc.peek_result
         Cc.summary
+      rescue StandardError => e
+        puts "\n\n[!] cc extension has problem for generate the report: #{e}"
       end
     end
   end

data/lib/minitest/cc/version.rb

@@ -3,6 +3,6 @@
 module Minitest
   module Cc
     # plugin version
-    VERSION = '0.1.2'
+    VERSION = '1.0.0'
   end
 end

data/lib/minitest/cc.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'coverage'
 require 'minitest'
 
 require_relative 'cc/version'
@@ -11,6 +12,8 @@ module Minitest
   # Main module of the plugin
   # @author Andres
   module Cc
+    MODES = %i[lines branches methods].freeze
+
     @results = []
     @files = FileArray.new
 
@@ -32,38 +35,47 @@ module Minitest
     # @return [Array] mode of the coverage, this array could contain:
     #   :lines, :branches, :methods
     cattr_accessor :coverage_mode
-    self.coverage_mode = %i[
-      lines
-      branches
-      methods
-    ]
+    self.coverage_mode = MODES
 
     class << self
       ##
       # Start the coverage process
       # @see https://runebook.dev/en/docs/ruby/coverage Coverage blog post explaining the use
       # @see https://ruby-doc.org/stdlib-2.7.6/libdoc/coverage/rdoc/Coverage.html Documentation of the module
+      # @deprecated Use {#self.start(*args)} instead.
       def start_coverage
-        require 'coverage'
-        Coverage.start(coverage_mode.collect { |m| [m, true] }.to_h)
+        Coverage.start(@coverage_mode.collect { |m| [m, true] }.to_h)
+      end
+
+      ##
+      # start coverage process
+      # this method recive the arguments direct and not depend on set coverage mode before start
+      # @see https://runebook.dev/en/docs/ruby/coverage Coverage blog post explaining the use
+      # @see https://ruby-doc.org/stdlib-2.7.6/libdoc/coverage/rdoc/Coverage.html Documentation of the module
+      #
+      def start(*args)
+        @coverage_mode = args.collect(&:to_sym).select { |a| MODES.include? a } unless args.empty?
+        Coverage.start(@coverage_mode.collect { |m| [m, true] }.to_h)
       end
 
       ##
-      # Print the results after the runs
+      # Print results after the runs
+      #
       def summary
-        @results = Coverage.peek_result
-        list_files
         puts "\n\n# Coverage:\n\n"
-        @files.each { |f| puts f.to_s } if cc_mode == :per_file
-        puts resume if cc_mode == :resume
-        puts
-      rescue NameError
-        puts "\n\n[!] cc extension is installed but was not started."
+        case cc_mode
+        when :per_file
+          @files.each { |f| puts f.to_s }
+        else
+          puts resume
+        end
+        puts "\nAverage: #{@files.total_coverage_percent.round(2).to_s_color}%"
       end
 
       ##
       # This method populate the FileArray variable with results
-      def list_files
+      def peek_result
+        @results = Coverage.result
         Dir.glob(tracked_files.each { |f| File.expand_path(f) }).each do |d|
           full_path = File.expand_path(d)
           @files << FileCoverage.new(full_path, d, result_for_file(full_path))
@@ -82,13 +94,13 @@ module Minitest
       end
 
       ##
-      # compose the string with resume of averages
+      # compose the string with resume of cc
       # @return [String] String with averages
       def resume
         str = ''
-        str += "lines: #{@files.lines_average.to_s_color}%\t" if coverage_mode.include? :lines
-        str += "branches: #{@files.branches_average.to_s_color}%\t" if coverage_mode.include? :branches
-        str += "methods: #{@files.methods_average.to_s_color}%\t" if coverage_mode.include? :methods
+        str += "Lines: #{@files.lines_average.round(2).to_s_color}%\t" if coverage_mode.include? :lines
+        str += "Branches: #{@files.branches_average.round(2).to_s_color}%\t" if coverage_mode.include? :branches
+        str += "Methods: #{@files.methods_average.round(2).to_s_color}%\t" if coverage_mode.include? :methods
         str
       end
     end
@@ -109,14 +121,14 @@ class String # :nodoc:
   end
 end
 
-class Integer # :nodoc:
+class Float # :nodoc:
   def to_s_color
     case self
-    when 1..33
+    when 1.0..33.0
       to_s.red
-    when 34..66
+    when 33.1..66.0
       to_s.yellow
-    when 67..100
+    when 66.1..100.0
       to_s.green
     else
       to_s

data/lib/minitest/cc_plugin.rb

@@ -5,9 +5,7 @@ require 'minitest/cc'
 # Minitest module
 module Minitest
   # Init method called from minitest
-  # it start the plugin
   def self.plugin_cc_init(_options)
-    # insert ower reporter to minitest reporters
-    reporter << Minitest::Cc::Reporter.new
+    reporter << Minitest::Cc::Reporter.new if Coverage.running?
   end
 end

metadata

@@ -1,17 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: minitest-cc
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - a-chacon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-01 00:00:00.000000000 Z
+date: 2023-04-12 00:00:00.000000000 Z
 dependencies: []
-description: 'Plugin for minitest, provide a minimal information of code coverage
-  to your test output. '
+description: 'Plugin for minitest. It provides minimal information about code coverage. '
 email:
 - andres.ch@protonmail.com
 executables: []
@@ -41,14 +40,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.3
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Minitest plugin, add code coverage metrics.