simplecov 0.18.0.beta1 → 0.18.0

data/lib/simplecov/result_merger.rb

@@ -62,11 +62,17 @@ module SimpleCov
         results
       end
 
+      def merge_and_store(*results)
+        result = merge_results(*results)
+        store_result(result) if result
+        result
+      end
+
       # Merge two or more SimpleCov::Results into a new one with merged
       # coverage data and the command_name for the result consisting of a join
       # on all source result's names
       def merge_results(*results)
-        parsed_results = JSON.parse(JSON.dump(results.map(&:original_result)), :symbolize_names => true)
+        parsed_results = JSON.parse(JSON.dump(results.map(&:original_result)))
         combined_result = SimpleCov::Combine::ResultsCombiner.combine(*parsed_results)
         result = SimpleCov::Result.new(combined_result)
         # Specify the command name

data/lib/simplecov/simulate_coverage.rb

@@ -19,10 +19,10 @@ module SimpleCov
       lines = File.foreach(absolute_path)
 
       {
-        :lines => LinesClassifier.new.classify(lines),
+        "lines" => LinesClassifier.new.classify(lines),
         # we don't want to parse branches ourselves...
         # requiring files can have side effects and we don't want to trigger that
-        :branches => {}
+        "branches" => {}
       }
     end
   end

data/lib/simplecov/source_file/branch.rb

@@ -6,15 +6,15 @@ module SimpleCov
     # Representing single branch that has been detected in coverage report.
     # Give us support methods that handle needed calculations.
     class Branch
-      attr_reader :start_line, :end_line, :coverage
+      attr_reader :start_line, :end_line, :coverage, :type
 
       # rubocop:disable Metrics/ParameterLists
-      def initialize(start_line:, end_line:, coverage:, inline:, positive:)
+      def initialize(start_line:, end_line:, coverage:, inline:, type:)
         @start_line = start_line
         @end_line   = end_line
         @coverage   = coverage
         @inline     = inline
-        @positive   = positive
+        @type       = type
         @skipped    = false
       end
       # rubocop:enable Metrics/ParameterLists
@@ -23,19 +23,6 @@ module SimpleCov
         @inline
       end
 
-      def positive?
-        @positive
-      end
-
-      #
-      # Branch is negative
-      #
-      # @return [Boolean]
-      #
-      def negative?
-        !positive?
-      end
-
       #
       # Return true if there is relevant count defined > 0
       #
@@ -54,15 +41,6 @@ module SimpleCov
         !skipped? && coverage.zero?
       end
 
-      #
-      # Return the sign depends on branch is positive or negative
-      #
-      # @return [String]
-      #
-      def badge
-        positive? ? "+" : "-"
-      end
-
       # The line on which we want to report the coverage
       #
       # Usually we choose the line above the start of the branch (so that it shows up
@@ -99,7 +77,7 @@ module SimpleCov
       # @return [Array]
       #
       def report
-        [coverage, badge]
+        [type, coverage]
       end
     end
   end

data/lib/simplecov/source_file.rb

@@ -9,11 +9,11 @@ module SimpleCov
     # The full path to this source file (e.g. /User/colszowka/projects/simplecov/lib/simplecov/source_file.rb)
     attr_reader :filename
     # The array of coverage data received from the Coverage.result
-    attr_reader :coverage
+    attr_reader :coverage_data
 
-    def initialize(filename, coverage)
-      @filename = filename.to_s
-      @coverage = coverage
+    def initialize(filename, coverage_data)
+      @filename = filename
+      @coverage_data = coverage_data
     end
 
     # The path to this source file relative to the projects directory
@@ -29,6 +29,14 @@ module SimpleCov
     end
     alias source src
 
+    def coverage_statistics
+      @coverage_statistics ||=
+        {
+          **line_coverage_statistics,
+          **branch_coverage_statistics
+        }
+    end
+
     # Returns all source lines for this file as instances of SimpleCov::SourceFile::Line,
     # and thus including coverage data. Aliased as :source_lines
     def lines
@@ -60,44 +68,7 @@ module SimpleCov
 
     # Returns the number of relevant lines (covered + missed)
     def lines_of_code
-      covered_lines.size + missed_lines.size
-    end
-
-    def build_lines
-      coverage_exceeding_source_warn if coverage[:lines].size > src.size
-      lines = src.map.with_index(1) do |src, i|
-        SimpleCov::SourceFile::Line.new(src, i, coverage[:lines][i - 1])
-      end
-      process_skipped_lines(lines)
-    end
-
-    # no_cov_chunks is zero indexed to work directly with the array holding the lines
-    def no_cov_chunks
-      @no_cov_chunks ||= build_no_cov_chunks
-    end
-
-    def build_no_cov_chunks
-      no_cov_lines = src.map.with_index(1).select { |line, _index| LinesClassifier.no_cov_line?(line) }
-
-      warn "uneven number of nocov comments detected" if no_cov_lines.size.odd?
-
-      no_cov_lines.each_slice(2).map do |(_line_start, index_start), (_line_end, index_end)|
-        index_start..index_end
-      end
-    end
-
-    def process_skipped_lines(lines)
-      # the array the lines are kept in is 0-based whereas the line numbers in the nocov
-      # chunks are 1-based and are expected to be like this in other parts (and it's also
-      # arguably more understandable)
-      no_cov_chunks.each { |chunk| lines[(chunk.begin - 1)..(chunk.end - 1)].each(&:skipped!) }
-
-      lines
-    end
-
-    # Warning to identify condition from Issue #56
-    def coverage_exceeding_source_warn
-      warn "Warning: coverage data provided by Coverage [#{coverage[:lines].size}] exceeds number of lines in #{filename} [#{src.size}]"
+      coverage_statistics[:line]&.total
     end
 
     # Access SimpleCov::SourceFile::Line source lines by line number
@@ -107,27 +78,17 @@ module SimpleCov
 
     # The coverage for this file in percent. 0 if the file has no coverage lines
     def covered_percent
-      return 100.0 if no_lines?
-
-      return 0.0 if relevant_lines.zero?
-
-      Float(covered_lines.size * 100.0 / relevant_lines.to_f)
+      coverage_statistics[:line]&.percent
     end
 
     def covered_strength
-      return 0.0 if relevant_lines.zero?
-
-      (lines_strength / relevant_lines.to_f).round(1)
+      coverage_statistics[:line]&.strength
     end
 
     def no_lines?
       lines.length.zero? || (lines.length == never_lines.size)
     end
 
-    def lines_strength
-      lines.map(&:coverage).compact.reduce(:+)
-    end
-
     def relevant_lines
       lines.size - never_lines.size - skipped_lines.size
     end
@@ -143,16 +104,13 @@ module SimpleCov
     end
 
     def branches_coverage_percent
-      return 100.0 if no_branches?
-      return 0.0 if covered_branches.empty?
-
-      Float(covered_branches.size * 100.0 / total_branches.size.to_f)
+      coverage_statistics[:branch]&.percent
     end
 
     #
     # Return the relevant branches to source file
     def total_branches
-      covered_branches + missed_branches
+      @total_branches ||= covered_branches + missed_branches
     end
 
     #
@@ -161,14 +119,104 @@ module SimpleCov
       @branches_report ||= build_branches_report
     end
 
-    ## Related to source file branches statistics
+    #
+    # Select the covered branches
+    # Here we user tree schema because some conditions like case may have additional
+    # else that is not in declared inside the code but given by default by coverage report
+    #
+    # @return [Array]
+    #
+    def covered_branches
+      @covered_branches ||= branches.select(&:covered?)
+    end
+
+    #
+    # Select the missed branches with coverage equal to zero
+    #
+    # @return [Array]
+    #
+    def missed_branches
+      @missed_branches ||= branches.select(&:missed?)
+    end
+
+    def branches_for_line(line_number)
+      branches_report.fetch(line_number, [])
+    end
+
+    #
+    # Check if any branches missing on given line number
+    #
+    # @param [Integer] line_number
+    #
+    # @return [Boolean]
+    #
+    def line_with_missed_branch?(line_number)
+      branches_for_line(line_number).select { |_type, count| count.zero? }.any?
+    end
+
+  private
+
+    # no_cov_chunks is zero indexed to work directly with the array holding the lines
+    def no_cov_chunks
+      @no_cov_chunks ||= build_no_cov_chunks
+    end
+
+    def build_no_cov_chunks
+      no_cov_lines = src.map.with_index(1).select { |line, _index| LinesClassifier.no_cov_line?(line) }
+
+      warn "uneven number of nocov comments detected" if no_cov_lines.size.odd?
+
+      no_cov_lines.each_slice(2).map do |(_line_start, index_start), (_line_end, index_end)|
+        index_start..index_end
+      end
+    end
+
+    def build_lines
+      coverage_exceeding_source_warn if coverage_data["lines"].size > src.size
+      lines = src.map.with_index(1) do |src, i|
+        SimpleCov::SourceFile::Line.new(src, i, coverage_data["lines"][i - 1])
+      end
+      process_skipped_lines(lines)
+    end
+
+    def process_skipped_lines(lines)
+      # the array the lines are kept in is 0-based whereas the line numbers in the nocov
+      # chunks are 1-based and are expected to be like this in other parts (and it's also
+      # arguably more understandable)
+      no_cov_chunks.each { |chunk| lines[(chunk.begin - 1)..(chunk.end - 1)].each(&:skipped!) }
+
+      lines
+    end
+
+    def lines_strength
+      lines.map(&:coverage).compact.reduce(:+)
+    end
+
+    # Warning to identify condition from Issue #56
+    def coverage_exceeding_source_warn
+      warn "Warning: coverage data provided by Coverage [#{coverage_data['lines'].size}] exceeds number of lines in #{filename} [#{src.size}]"
+    end
+
+    #
+    # Build full branches report
+    # Root branches represent the wrapper of all condition state that
+    # have inside the branches
+    #
+    # @return [Hash]
+    #
+    def build_branches_report
+      branches.reject(&:skipped?).each_with_object({}) do |branch, coverage_statistics|
+        coverage_statistics[branch.report_line] ||= []
+        coverage_statistics[branch.report_line] << branch.report
+      end
+    end
 
     #
     # Call recursive method that transform our static hash to array of objects
     # @return [Array]
     #
     def build_branches
-      coverage_branch_data = coverage.fetch(:branches, {})
+      coverage_branch_data = coverage_data.fetch("branches", {})
       branches = coverage_branch_data.flat_map do |condition, coverage_branches|
         build_branches_from(condition, coverage_branches)
       end
@@ -187,7 +235,7 @@ module SimpleCov
     end
 
     # Since we are dumping to and loading from JSON, and we have arrays as keys those
-    # don't make their way back to us intact e.g. just as a string or a symbol (currently keys are symbolized).
+    # don't make their way back to us intact e.g. just as a string
     #
     # We should probably do something different here, but as it stands these are
     # our data structures that we write so eval isn't _too_ bad.
@@ -199,9 +247,8 @@ module SimpleCov
       # put them through here.
       return structure if structure.is_a?(Array)
 
-      # as of right now the keys are still symbolized
       # rubocop:disable Security/Eval
-      eval structure.to_s
+      eval structure
       # rubocop:enable Security/Eval
     end
 
@@ -211,103 +258,43 @@ module SimpleCov
       #     [:then, 4, 6, 6, 6, 10]
       #
       # which is [type, id, start_line, start_col, end_line, end_col]
-      condition_type, condition_id, condition_start_line, * = restore_ruby_data_structure(condition)
+      _condition_type, _condition_id, condition_start_line, * = restore_ruby_data_structure(condition)
 
-      branches
-        .map { |branch_data, hit_count| [restore_ruby_data_structure(branch_data), hit_count] }
-        .reject { |branch_data, _hit_count| ignore_branch?(branch_data, condition_type, condition_start_line) }
-        .map { |branch_data, hit_count| build_branch(branch_data, hit_count, condition_start_line, condition_id) }
+      branches.map do |branch_data, hit_count|
+        branch_data = restore_ruby_data_structure(branch_data)
+        build_branch(branch_data, hit_count, condition_start_line)
+      end
     end
 
-    def build_branch(branch_data, hit_count, condition_start_line, condition_id)
-      type, id, start_line, _start_col, end_line, _end_col = branch_data
+    def build_branch(branch_data, hit_count, condition_start_line)
+      type, _id, start_line, _start_col, end_line, _end_col = branch_data
 
       SourceFile::Branch.new(
-        # rubocop these are keyword args please let me keep them, thank you
-        # rubocop:disable Style/HashSyntax
         start_line: start_line,
         end_line:   end_line,
         coverage:   hit_count,
         inline:     start_line == condition_start_line,
-        positive:   positive_branch?(condition_id, id, type)
-        # rubocop:enable Style/HashSyntax
+        type:       type
       )
     end
 
-    def ignore_branch?(branch_data, condition_type, condition_start_line)
-      branch_type = branch_data[0]
-      branch_start_line = branch_data[2]
-
-      # branch coverage always reports case to be with an else branch even when
-      # there is no else branch to be covered, it's noticable by the reported start
-      # line being the same as that of the condition/case
-      condition_type == :case &&
-        branch_type == :else &&
-        condition_start_line == branch_start_line
-    end
-
-    #
-    # Branch is positive or negative.
-    # For `case` conditions, `when` always supposed as positive branch.
-    # For `if, else` conditions:
-    # coverage returns matrices ex: [:if, 0,..] => {[:then, 1,..], [:else, 2,..]},
-    # positive branch always has id equals to condition id incremented by 1.
-    #
-    # @return [Boolean]
-    #
-    def positive_branch?(condition_id, branch_id, branch_type)
-      return true if branch_type == :when
-
-      branch_id == (1 + condition_id)
+    def line_coverage_statistics
+      {
+        line: CoverageStatistics.new(
+          total_strength: lines_strength,
+          covered:  covered_lines.size,
+          missed:   missed_lines.size
+        )
+      }
     end
 
-    #
-    # Select the covered branches
-    # Here we user tree schema because some conditions like case may have additional
-    # else that is not in declared inside the code but given by default by coverage report
-    #
-    # @return [Array]
-    #
-    def covered_branches
-      @covered_branches ||= branches.select(&:covered?)
-    end
-
-    #
-    # Select the missed branches with coverage equal to zero
-    #
-    # @return [Array]
-    #
-    def missed_branches
-      @missed_branches ||= branches.select(&:missed?)
-    end
-
-    def branches_for_line(line_number)
-      branches_report.fetch(line_number, [])
-    end
-
-    #
-    # Check if any branches missing on given line number
-    #
-    # @param [Integer] line_number
-    #
-    # @return [Boolean]
-    #
-    def line_with_missed_branch?(line_number)
-      branches_for_line(line_number).select { |count, _sign| count.zero? }.any?
-    end
-
-    #
-    # Build full branches report
-    # Root branches represent the wrapper of all condition state that
-    # have inside the branches
-    #
-    # @return [Hash]
-    #
-    def build_branches_report
-      branches.reject(&:skipped?).each_with_object({}) do |branch, coverage_statistics|
-        coverage_statistics[branch.report_line] ||= []
-        coverage_statistics[branch.report_line] << branch.report
-      end
+    def branch_coverage_statistics
+      {
+        branch: CoverageStatistics.new(
+          covered: covered_branches.size,
+          missed:  missed_branches.size
+        )
+      }
     end
   end
 end

data/lib/simplecov/useless_results_remover.rb

@@ -2,7 +2,7 @@
 
 module SimpleCov
   #
-  # Selection the files that related to working scope directory of SimpleCov
+  # Select the files that related to working scope directory of SimpleCov
   #
   module UselessResultsRemover
     ROOT_REGX = /\A#{Regexp.escape(SimpleCov.root + File::SEPARATOR)}/io.freeze

data/lib/simplecov/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SimpleCov
-  VERSION = "0.18.0.beta1"
+  VERSION = "0.18.0"
 end