Module: Undercover::CLI

Defined in:
lib/undercover/cli.rb

Constant Summary collapse

WARNINGS_TO_S = 
{
  stale_coverage: Rainbow('🚨 WARNING: Coverage data is older than your ' \
                          'latest changes and results might be incomplete. ' \
                          'Re-run tests to update').yellow,
  no_changes: Rainbow('✅ No reportable changes').green
}.freeze

Class Method Summary collapse

Class Method Details

.changeset(opts) ⇒ Object 



69
70
71
72
 
# File 'lib/undercover/cli.rb', line 69

def self.changeset(opts)
  git_dir = File.join(opts.path, opts.git_dir)
  Undercover::Changeset.new(git_dir, opts.compare)
end

.handle_missing_coverage_path(opts) ⇒ Object 



38
39
40
41
42
43
44
 
# File 'lib/undercover/cli.rb', line 38

def self.handle_missing_coverage_path(opts)
  puts Rainbow('❌ ERROR: No coverage report found. Checked default paths:').red
  puts Rainbow('  - ./coverage/coverage.json (SimpleCov)').red
  puts Rainbow("  - ./coverage/lcov/#{Pathname.new(File.expand_path(opts.path)).split.last}.lcov (LCOV)").red
  puts Rainbow('Set a custom path with --lcov or --simplecov option').red
  1
end

.handle_missing_file(coverage_path) ⇒ Object 



46
47
48
49
 
# File 'lib/undercover/cli.rb', line 46

def self.handle_missing_file(coverage_path)
  puts Rainbow("❌ ERROR: Coverage report not found at: #{coverage_path}").red
  1
end

.handle_report_validation(report, coverage_path) ⇒ Object 



51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/undercover/cli.rb', line 51

def self.handle_report_validation(report, coverage_path)
  error = report.validate(coverage_path)
  if error
    puts(WARNINGS_TO_S[error])
    return 0 if error == :no_changes
  end

  flagged = report.flagged_results
  puts Undercover::Formatter.new(flagged)
  flagged.any? ? 1 : 0
end

.run(args) ⇒ Object 



14
15
16
17
18
19
 
# File 'lib/undercover/cli.rb', line 14

def self.run(args)
  opts = Undercover::Options.new.parse(args)
  syntax_version(opts.syntax_version)

  run_report(opts)
end

.run_report(opts) ⇒ Object

rubocop:disable Metrics/AbcSize,Metrics/MethodLength



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/undercover/cli.rb', line 21

def self.run_report(opts) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
  coverage_path = opts.simplecov_resultset || opts.lcov
  return handle_missing_coverage_path(opts) if coverage_path.nil?
  return handle_missing_file(coverage_path) unless File.exist?(coverage_path)

  simplecov_adapter = if opts.simplecov_resultset
                        SimplecovResultAdapter.parse(File.open(opts.simplecov_resultset), opts)
                      else
                        # TODO: lcov will be deprecated end of 2025 and we'll be able to refactor harder
                        LcovParser.parse(File.open(opts.lcov), opts)
                      end

  changeset_obj = changeset(opts)
  report = Undercover::Report.new(changeset_obj, opts, simplecov_adapter).build
  handle_report_validation(report, coverage_path)
end

.syntax_version(version) ⇒ Object 



63
64
65
66
67
 
# File 'lib/undercover/cli.rb', line 63

def self.syntax_version(version)
  return unless version

  Imagen.parser_version = version
end