Class: CircleCI::CoverageReporter::Reporters::Base Abstract

Inherits:
Object
  • Object
show all
Defined in:
lib/circleci/coverage_reporter/reporters/base.rb

Overview

This class is abstract.

Subclass and override Base.default_dir, Base.default_html_file_name, Base.default_json_file_name and #parse_json to implement a custom Reporter class.

Direct Known Subclasses

Flow, RubyCritic, SimpleCov

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Base

Returns a new instance of Base.



21
22
23
 
# File 'lib/circleci/coverage_reporter/reporters/base.rb', line 21

def initialize(options = {})
  @options = options
end

Class Method Details

.default_dir ⇒ Object

Raises:

  • (NotImplementedError) 


9
10
11
 
# File 'lib/circleci/coverage_reporter/reporters/base.rb', line 9

def self.default_dir
  raise NotImplementedError
end

.default_html_file_name ⇒ Object

Raises:

  • (NotImplementedError) 


13
14
15
 
# File 'lib/circleci/coverage_reporter/reporters/base.rb', line 13

def self.default_html_file_name
  raise NotImplementedError
end

.default_json_file_name ⇒ Object

Raises:

  • (NotImplementedError) 


17
18
19
 
# File 'lib/circleci/coverage_reporter/reporters/base.rb', line 17

def self.default_json_file_name
  raise NotImplementedError
end

Instance Method Details

#active? ⇒ Boolean

Returns:

  • (Boolean) 


26
27
28
 
# File 'lib/circleci/coverage_reporter/reporters/base.rb', line 26

def active?
  File.directory?(File.join(configuration.artifacts_dir, dir))
end

#name ⇒ String

Name of reporter.

Returns:

  • (String) 


45
46
47
 
# File 'lib/circleci/coverage_reporter/reporters/base.rb', line 45

def name
  self.class.name.split('::').last
end

#report(base_build, previous_build) ⇒ Report

Parameters:

  • base_build (Build, nil)
  • previous_build (Build, nil)

Returns:



33
34
35
36
37
38
39
40
 
# File 'lib/circleci/coverage_reporter/reporters/base.rb', line 33

def report(base_build, previous_build)
  Report.new(
    self,
    create_current_result,
    base: base_build ? create_build_result(base_build) : nil,
    previous: previous_build ? create_build_result(previous_build) : nil
  )
end