123456789_123456789_123456789_123456789_123456789_

Module: SimpleCov::Formatter::HTMLFormatter::CoverageHelpers

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In:
Defined in: lib/simplecov/formatter/html_formatter/coverage_helpers.rb

Overview

Helpers for rendering coverage bars, cells, and summaries in ERB templates.

Instance Method Summary

Instance Method Details

#append_branch_attrs(pairs, source_file) (private)

[ GitHub ]

  
# File 'lib/simplecov/formatter/html_formatter/coverage_helpers.rb', line 88

def append_branch_attrs(pairs, source_file)
  return unless branch_coverage?

  pairs["covered-branches"] = source_file.covered_branches.count
  pairs["total-branches"] = source_file.total_branches.count
end

#append_method_attrs(pairs, source_file) (private)

[ GitHub ]

  
# File 'lib/simplecov/formatter/html_formatter/coverage_helpers.rb', line 95

def append_method_attrs(pairs, source_file)
  return unless method_coverage?

  pairs["covered-methods"] = source_file.covered_methods.count
  pairs["total-methods"] = source_file.methods.count
end

#build_data_attr_pairs(source_file) (private)

[ GitHub ]

  
# File 'lib/simplecov/formatter/html_formatter/coverage_helpers.rb', line 80

def build_data_attr_pairs(source_file)
  covered = source_file.covered_lines.count
  pairs = {"covered-lines" => covered, "relevant-lines" => covered + source_file.missed_lines.count}
  append_branch_attrs(pairs, source_file)
  append_method_attrs(pairs, source_file)
  pairs
end

#coverage_bar(pct)

[ GitHub ]

  
# File 'lib/simplecov/formatter/html_formatter/coverage_helpers.rb', line 8

def coverage_bar(pct)
  css = coverage_css_class(pct)
  width = Kernel.format("%.1f", pct.floor(1))
  fill = %(<div class="coverage-bar__fill coverage-bar__fill--#{css}" style="width: #{width}%"></div>)
  %(<div class="bar-sizer"><div class="coverage-bar">#{fill}</div></div>)
end

#coverage_cell_attrs(pct, type, totals) (private)

[ GitHub ]

  
# File 'lib/simplecov/formatter/html_formatter/coverage_helpers.rb', line 75

def coverage_cell_attrs(pct, type, totals)
  css = coverage_css_class(pct)
  totals ? totals_cell_attrs(type, css) : regular_cell_attrs(pct, type, css)
end

#coverage_cells(pct, covered, total, type:, totals: false)

[ GitHub ]

  
# File 'lib/simplecov/formatter/html_formatter/coverage_helpers.rb', line 15

def coverage_cells(pct, covered, total, type:, totals: false)
  cov_cls, num_cls, den_cls, order = coverage_cell_attrs(pct, type, totals)
  pct_str = Kernel.format("%.2f", pct.floor(2))
  bar_and_pct = %(<div class="coverage-cell">#{coverage_bar(pct)}<span class="coverage-pct">#{pct_str}%</span></div>)
  %(<td class="#{cov_cls}"#{order}>#{bar_and_pct}</td>) +
    %(<td class="#{num_cls}">#{fmt(covered)}/</td>) +
    %(<td class="#{den_cls}">#{fmt(total)}</td>)
end

#coverage_header_cells(label, type, covered_label, total_label)

[ GitHub ]

  
# File 'lib/simplecov/formatter/html_formatter/coverage_helpers.rb', line 24

def coverage_header_cells(label, type, covered_label, total_label)
  <<~HTML
    <th class="cell--coverage">
      <div class="th-with-filter">
        <span class="th-label">#{label}</span>
        <div class="col-filter__coverage">
          <select class="col-filter__op" data-type="#{type}"><option value="lt">&lt;</option><option value="lte" selected>&le;</option><option value="eq">=</option><option value="gte">&ge;</option><option value="gt">&gt;</option></select>
          <span class="col-filter__pct-wrap"><input type="number" class="col-filter__value" min="0" max="100" data-type="#{type}" value="100" step="any"></span>
        </div>
      </div>
    </th>
    <th class="cell--numerator">#{covered_label}</th>
    <th class="cell--denominator">#{total_label}</th>
  HTML
end

#coverage_summary(source_file, show_method_toggle: false)

[ GitHub ]

  
# File 'lib/simplecov/formatter/html_formatter/coverage_helpers.rb', line 50

def coverage_summary(source_file, show_method_toggle: false)
  stats = source_file.coverage_statistics
  _summary = {
    line: stats[:line],
    branch: stats[:branch],
    method: stats[:method],
    show_method_toggle: show_method_toggle
  }
  template("coverage_summary").result(binding)
end

#coverage_type_summary(type, label, summary, enabled:, **opts)

[ GitHub ]

  
# File 'lib/simplecov/formatter/html_formatter/coverage_helpers.rb', line 44

def coverage_type_summary(type, label, summary, enabled:, **opts)
  return disabled_summary(type, label) unless enabled

  enabled_type_summary(type, label, summary.fetch(type.to_sym), opts)
end

#disabled_summary(type, label) (private)

[ GitHub ]

  
# File 'lib/simplecov/formatter/html_formatter/coverage_helpers.rb', line 115

def disabled_summary(type, label)
  %(<div class="t-#{type}-summary">\n    #{label}: <span class="coverage-disabled">disabled</span>\n  </div>)
end

#enabled_type_summary(type, label, stats, opts) (private)

[ GitHub ]

  
# File 'lib/simplecov/formatter/html_formatter/coverage_helpers.rb', line 102

def enabled_type_summary(type, label, stats, opts)
  css = coverage_css_class(stats.percent)
  missed = stats.missed
  parts = [
    %(<div class="t-#{type}-summary">\n    #{label}: ),
    %(<span class="#{css}"><b>#{Kernel.format('%.2f', stats.percent.floor(2))}%</b></span>),
    %(<span class="coverage-cell__fraction"> #{stats.covered}/#{stats.total} #{opts.fetch(:suffix, 'covered')}</span>)
  ]
  parts << missed_summary_html(missed, opts.fetch(:missed_class, "red"), opts.fetch(:toggle, false)) if missed.positive?
  parts << "\n  </div>"
  parts.join
end

#file_data_attrs(source_file)

[ GitHub ]

  
# File 'lib/simplecov/formatter/html_formatter/coverage_helpers.rb', line 40

def file_data_attrs(source_file)
  build_data_attr_pairs(source_file).map { |k, v| %(data-#{k}="#{v}") }.join(" ")
end

#missed_summary_html(count, missed_class, toggle) (private)

[ GitHub ]

  
# File 'lib/simplecov/formatter/html_formatter/coverage_helpers.rb', line 119

def missed_summary_html(count, missed_class, toggle)
  missed = if toggle
             %(<a href="#" class="t-missed-method-toggle"><b>#{count}</b> missed</a>)
           else
             %(<span class="#{missed_class}"><b>#{count}</b> missed</span>)
           end
  %(<span class="coverage-cell__fraction">,</span>\n    #{missed})
end

#regular_cell_attrs(pct, type, css) (private)

[ GitHub ]

  
# File 'lib/simplecov/formatter/html_formatter/coverage_helpers.rb', line 69

def regular_cell_attrs(pct, type, css)
  ["cell--coverage cell--#{type}-pct #{css}",
   "cell--numerator", "cell--denominator",
   %( data-order="#{Kernel.format('%.2f', pct)}")]
end

#totals_cell_attrs(type, css) (private)

[ GitHub ]

  
# File 'lib/simplecov/formatter/html_formatter/coverage_helpers.rb', line 63

def totals_cell_attrs(type, css)
  ["cell--coverage strong t-totals__#{type}-pct #{css}",
   "cell--numerator strong t-totals__#{type}-num",
   "cell--denominator strong t-totals__#{type}-den", ""]
end