Module: CodeClimate::TestReporter

Defined in:
lib/code_climate/test_reporter.rb,
lib/code_climate/test_reporter/ci.rb,
lib/code_climate/test_reporter/git.rb,
lib/code_climate/test_reporter/client.rb,
lib/code_climate/test_reporter/version.rb,
lib/code_climate/test_reporter/formatter.rb,
lib/code_climate/test_reporter/configuration.rb,
lib/code_climate/test_reporter/exception_message.rb,
lib/code_climate/test_reporter/payload_validator.rb

Defined Under Namespace

Classes: Ci, Client, Configuration, ExceptionMessage, Formatter, Git, PayloadValidator, VCRMessage, WebMockMessage

Constant Summary collapse

VERSION = 
"0.4.0"
InvalidPayload = 
Class.new(StandardError)
@@configuration = 
nil

Class Method Summary collapse

Class Method Details

.configuration ⇒ Object 



17
18
19
 
# File 'lib/code_climate/test_reporter/configuration.rb', line 17

def self.configuration
  @@configuration || configure
end

.configure ⇒ Object 



7
8
9
10
11
12
13
14
15
 
# File 'lib/code_climate/test_reporter/configuration.rb', line 7

def self.configure
  @@configuration = Configuration.new

  if block_given?
    yield configuration
  end

  configuration
end

.configured_branch ⇒ Object 



41
42
43
 
# File 'lib/code_climate/test_reporter.rb', line 41

def self.configured_branch
  configuration.branch
end

.current_branch ⇒ Object 



45
46
47
 
# File 'lib/code_climate/test_reporter.rb', line 45

def self.current_branch
  Git.branch_from_git_or_ci
end

.environment_variable_set? ⇒ Boolean

Returns:

  • (Boolean) 


17
18
19
20
21
22
23
24
25
26
 
# File 'lib/code_climate/test_reporter.rb', line 17

def self.environment_variable_set?
  return @environment_variable_set if defined?(@environment_variable_set)

  @environment_variable_set = !!ENV["CODECLIMATE_REPO_TOKEN"]
  unless @environment_variable_set
    logger.info("Not reporting to Code Climate because ENV['CODECLIMATE_REPO_TOKEN'] is not set.")
  end

  @environment_variable_set
end

.logger ⇒ Object 



49
50
51
 
# File 'lib/code_climate/test_reporter.rb', line 49

def self.logger
  CodeClimate::TestReporter.configuration.logger
end

.run? ⇒ Boolean

Returns:

  • (Boolean) 


13
14
15
 
# File 'lib/code_climate/test_reporter.rb', line 13

def self.run?
  environment_variable_set? && run_on_current_branch?
end

.run_on_current_branch? ⇒ Boolean

Returns:

  • (Boolean) 


28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/code_climate/test_reporter.rb', line 28

def self.run_on_current_branch?
  return @run_on_current_branch if defined?(@run_on_current_branch)

  @run_on_current_branch = true if configured_branch.nil?
  @run_on_current_branch ||= !!(current_branch =~ /#{configured_branch}/i)

  unless @run_on_current_branch
    logger.info("Not reporting to Code Climate because #{configured_branch} is set as the reporting branch.")
  end

  @run_on_current_branch
end

.start ⇒ Object 



4
5
6
7
8
9
10
11
 
# File 'lib/code_climate/test_reporter.rb', line 4

def self.start
  if run?
    require "simplecov"
    ::SimpleCov.add_filter 'vendor'
    ::SimpleCov.formatter = Formatter
    ::SimpleCov.start(configuration.profile)
  end
end