minitest-cc 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69641587074cb1ab7a76d64441ca7adc6d712c29a4464c26ea1479b84249b07f
-  data.tar.gz: 87bdd0b9a441e27e1f3d027f45bd24c36e615987190aa96a76a28c27fec06214
+  metadata.gz: 5f0eeacbc8612187f1e09acf48af6bbe01dc408ae645fc34baff37d469791f93
+  data.tar.gz: 0b8dc1f33f412392782265b63919b305d1d5f9154327242d627769225aff3d42
 SHA512:
-  metadata.gz: f645fa0afe130223c8bc8dbfb15cd55e2b35b6f50e69c5acf59304ebcc3d6db9d2905bcf6c0173593ee906ccb5fcaa15e184c377d20cc968d644806d4a36f320
-  data.tar.gz: 41c92382fb9de187dfbcf40dcc37d7151ca81ff97ceff1c8afa21426f4700f1d0942e5c4d82712818743d6ff4f2301742edcc17ba7366d1d0758673cf1d573e5
+  metadata.gz: 5807504cf8912e3253123e166fd961cbdceb403d9e4cf7ddaf3a03620b2355070358ddf678b7d75fc8fba676ea5fa8d6072daf7cea3c91127ab7f1c4467477cb
+  data.tar.gz: 5e825e40992f750669825a5d823f5fcc68ceec3aa420c4d37b813c9b45f6b16062f80eb7e1e5c741785bfc5094cddcc7cd57a4f2e86c3ca50fb09e2331435bec

data/lib/minitest/cc/file_coverage.rb

@@ -4,26 +4,55 @@ module Minitest
   module Cc
     # model for a file
     class FileCoverage
+      #
       # @return [String] the name of the file with extension
+      #
       attr_accessor :name
+
+      #
       # @return [String] the absolute path to the file
+      #
       attr_accessor :path
+
+      #
       # @return [String] the relative path to the file
+      #
       attr_accessor :relative_path
+
+      #
       # @return [Boolean] if this was tested or not.
       #  this indicate if the file was tracked by coverage or not
+      #
       attr_accessor :tested
+
+      #
       # @return [Integer] total lines of the file
+      #
       attr_accessor :lines
+
+      #
       # @return [Integer] total lines executed of the file
+      #
       attr_accessor :lines_executed
+
+      #
       # @return [Integer] total branches of the file
+      #
       attr_accessor :branches
+
+      #
       # @return [Integer] total branches executed of the file
+      #
       attr_accessor :branches_executed
+
+      #
       # @return [Integer] total methods of the file
+      #
       attr_accessor :methods
+
+      #
       # @return [Integer] total methods executed of the file
+      #
       attr_accessor :methods_executed
 
       ##
@@ -31,6 +60,7 @@ module Minitest
       # @param path [String] full path to the file
       # @param relative_path [String] relative path to the file
       # @param result [Hash] object with the result of the coverage for the file
+      #
       def initialize(path, relative_path, result = nil)
         @path = path
         @relative_path = relative_path
@@ -42,6 +72,7 @@ module Minitest
       ##
       # Set the results of the coverage into the object variables
       # @param result [Hash] object with the result of the coverage
+      #
       def from_result(result)
         @lines, @lines_executed = count_lines(result) unless result[:lines].nil?
         @branches, @branches_executed = count_branches(result) unless result[:branches].nil?
@@ -52,6 +83,7 @@ module Minitest
       # count total lines and executed lines
       # @param result [Hash] object with the result of the coverage
       # @return [Array] Array with two values: First: the total lines. Second: the lines executed
+      #
       def count_lines(result)
         [result[:lines].count { |n| n.is_a? Integer }, result[:lines].count { |n| n.is_a?(Integer) && n != 0 }]
       end
@@ -60,6 +92,7 @@ module Minitest
       # count total branches and executed branches
       # @param result [Hash] object with the result of the coverage
       # @return [Array] Array with two values: First: the total branches. Second: the branches executed
+      #
       def count_branches(result)
         [
           result[:branches].values.reduce(0) { |sum, v| sum + v.size },
@@ -71,6 +104,7 @@ module Minitest
       # count total methods and executed methods
       # @param result [Hash] object with the result of the coverage
       # @return [Array] Array with two values: First: the total methods. Second: the methods executed
+      #
       def count_methods(result)
         [result[:methods].length, result[:methods].values.reject(&:zero?).count]
       end
@@ -78,20 +112,47 @@ module Minitest
       ##
       # Transform the object to a readable string
       # @return [String] contains the information ready to print
+      #
       def to_s
-        if tested
-          str = "#{relative_path}: \n lines: #{lines_executed}/#{lines} #{lines_percent}%"
-          str += "\tbranches: #{branches_executed}/#{branches} #{branches_percent}%" if branches
-          str += "\tmethods: #{methods_executed}/#{methods} #{methods_percent}%" if methods
-          str
-        else
-          "#{relative_path} : Not executed during the tests."
-        end
+        return "#{relative_path} : Not executed or tracked by cov." unless tested
+
+        "#{relative_path}:\n" + to_s_lines + to_s_branches + to_s_methods
+      end
+
+      ##
+      # Transform lines information to string
+      # @return [String] contains information of lines with percent in color
+      #
+      def to_s_lines
+        return '' unless lines
+
+        " - l: #{lines_executed}/#{lines} #{lines_percent.to_s_color}%"
+      end
+
+      ##
+      # Transform branches information to string
+      # @return [String] contains information of branches with percent in color
+      #
+      def to_s_branches
+        return '' unless branches
+
+        " - b: #{branches_executed}/#{branches} #{branches_percent.to_s_color}%"
+      end
+
+      ##
+      # Transform methods information to string
+      # @return [String] contains information of methods with percent in color
+      #
+      def to_s_methods
+        return '' unless methods
+
+        " - m: #{methods_executed}/#{methods} #{methods_percent.to_s_color}%"
       end
 
       ##
       # Calculate the percent of coverage lines
       # @return [Integer] percent of coverage. executed lines / total lines
+      #
       def lines_percent
         lines_executed * 100 / lines
       rescue ZeroDivisionError
@@ -101,6 +162,7 @@ module Minitest
       ##
       # Calculate the percent of coverage branches
       # @return [Integer] percent of coverage. executed branches / total branches
+      #
       def branches_percent
         branches_executed * 100 / branches
       rescue ZeroDivisionError
@@ -110,6 +172,7 @@ module Minitest
       ##
       # Calculate the percent of coverage methods
       # @return [Integer] percent of coverage. executed methods / total methods
+      #
       def methods_percent
         methods_executed * 100 / methods
       rescue ZeroDivisionError

data/lib/minitest/cc/reporter.rb

@@ -1,23 +1,16 @@
 # frozen_string_literal: true
 
-require 'minitest'
-
 module Minitest
   module Cc
     # Reporter class extend of Minitest Reporter
-    # this get 5 important methods from the parent
-    # but we use only 2
     class Reporter < Minitest::AbstractReporter
-      ##
-      # Executed in the beginin of the minitest run
-      def start
-        Cc.start_coverage
-      end
-
       ##
       # 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.0'
+    VERSION = '0.2.0'
   end
 end

data/lib/minitest/cc.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'coverage'
+require 'minitest'
+
 require_relative 'cc/version'
 require_relative 'cc/reporter'
 require_relative 'cc/file_coverage'
@@ -9,6 +12,8 @@ module Minitest
   # Main module of the plugin
   # @author Andres
   module Cc
+    MODES = %i[lines branches methods].freeze
+
     @results = []
     @files = FileArray.new
 
@@ -30,35 +35,46 @@ 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
-        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
+        case cc_mode
+        when :per_file
+          @files.each { |f| puts f.to_s }
+        else
+          puts resume
+        end
       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))
@@ -77,11 +93,44 @@ module Minitest
       end
 
       ##
-      # compose the string with resume of averages
+      # compose the string with resume of cc
       # @return [String] String with averages
       def resume
-        "lines: #{@files.lines_average}% branches: #{@files.branches_average}% methods: #{@files.methods_average}%"
+        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
       end
     end
   end
 end
+
+class String # :nodoc:
+  def red
+    "\e[31m#{self}\e[0m"
+  end
+
+  def green
+    "\e[32m#{self}\e[0m"
+  end
+
+  def yellow
+    "\e[33m#{self}\e[0m"
+  end
+end
+
+class Integer # :nodoc:
+  def to_s_color
+    case self
+    when 1..33
+      to_s.red
+    when 34..66
+      to_s.yellow
+    when 67..100
+      to_s.green
+    else
+      to_s
+    end
+  end
+end

data/lib/minitest/cc_plugin.rb

@@ -1,17 +1,11 @@
 # frozen_string_literal: true
 
-require 'coverage'
-require 'minitest'
 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
-  rescue StandardError
-    puts 'The coverage plugin cannot be initialized.'
+    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.0
+  version: 0.2.0
 platform: ruby
 authors:
 - a-chacon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-29 00:00:00.000000000 Z
+date: 2022-07-05 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.