Class: Pod::Source::HealthReporter::HealthReport

Inherits:
Object
  • Object
show all
Defined in:
lib/cocoapods-core/source/health_reporter.rb

Overview

Encapsulates the information about the state of a repo.

Private helpers collapse

Private helpers collapse

Constructor Details

#initialize(source) ⇒ HealthReport

Returns a new instance of HealthReport.

Parameters:



146
147
148
149
150
151
 
# File 'lib/cocoapods-core/source/health_reporter.rb', line 146

def initialize(source)
  @source = source
  @analyzed_paths = []
  @pods_by_error = {}
  @pods_by_warning = {}
end

Instance Attribute Details

#analyzed_paths ⇒ Array<Pathname>

Returns The list of the analyzed paths.

Returns:

  • (Array<Pathname>) —

    The list of the analyzed paths.



155
156
157
 
# File 'lib/cocoapods-core/source/health_reporter.rb', line 155

def analyzed_paths
  @analyzed_paths
end

#pods_by_error ⇒ Hash{ String => Hash }

Returns The pods (the version grouped by name) grouped by an error message.

Returns:

  • (Hash{ String => Hash }) —

    The pods (the version grouped by name) grouped by an error message.



160
161
162
 
# File 'lib/cocoapods-core/source/health_reporter.rb', line 160

def pods_by_error
  @pods_by_error
end

#pods_by_warning ⇒ Hash{ String => Hash }

Returns The pods (the version grouped by name) grouped by a warning message.

Returns:

  • (Hash{ String => Hash }) —

    The pods (the version grouped by name) grouped by a warning message.



165
166
167
 
# File 'lib/cocoapods-core/source/health_reporter.rb', line 165

def pods_by_warning
  @pods_by_warning
end

#source ⇒ Source (readonly)

Returns the source analyzed.

Returns:

  • (Source) —

    the source analyzed.



142
143
144
 
# File 'lib/cocoapods-core/source/health_reporter.rb', line 142

def source
  @source
end

Instance Method Details

#add_message(type, message, spec_name, spec_version = nil) ⇒ void

This method returns an undefined value.

Adds a message with the given type for the specification with the given name and version.

Parameters:

  • type (Symbol) —

    The type of message. Either ‘:error` or `:warning`.

  • message (String) —

    The contents of the message.

  • spec_name (String) —

    The name of the Pod.

  • spec_version (String) (defaults to: nil) —

    The version of the specification.



184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/cocoapods-core/source/health_reporter.rb', line 184

def add_message(type, message, spec_name, spec_version = nil)
  if type == :error
    pods_by_error[message] ||= {}
    pods_by_error[message][spec_name] ||= []
    pods_by_error[message][spec_name] << spec_version
  else
    pods_by_warning[message] ||= {}
    pods_by_warning[message][spec_name] ||= []
    pods_by_warning[message][spec_name] << spec_version
  end
end