Class: Pod::Source::HealthReporter

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

Overview

Checks a source for errors and warnings.

Defined Under Namespace

Classes: HealthReport

Actions collapse

Instance Attribute Summary collapse

Configuration collapse

Actions collapse

Private helpers collapse

Instance Method Summary collapse

Constructor Details

#initialize(repo) ⇒ HealthReporter

Returns a new instance of HealthReporter.

Parameters:

  • repo (Pathname) —

    @see Source#repo.



12
13
14
15
16
 
# File 'lib/cocoapods-core/source/health_reporter.rb', line 12

def initialize(repo)
  @source = Source.new(repo)
  @errors = {}
  @linter_results = {}
end

Instance Attribute Details

#report ⇒ HealtReport (readonly)

Returns The report produced by the analysis.

Returns:

  • (HealtReport) —

    The report produced by the analysis.



65
66
67
 
# File 'lib/cocoapods-core/source/health_reporter.rb', line 65

def report
  @report
end

#source ⇒ Source (readonly)

Returns the source to check.

Returns:

  • (Source) —

    the source to check.



8
9
10
 
# File 'lib/cocoapods-core/source/health_reporter.rb', line 8

def source
  @source
end

Instance Method Details

#analyze ⇒ HealthReport

Analyzes all the specification files in the source.

Returns:

  • (HealthReport) —

    A report which contains the information about the state of the source.



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/cocoapods-core/source/health_reporter.rb', line 46

def analyze
  @report = HealthReport.new(source)

  source.pods.each do |name|
    source.versions(name).each do |version|
      @pre_check_callback.call(name, version) if @pre_check_callback
      spec_path = source.specification_path(name, version)
      spec = lint_spec(name, version, spec_path)
      check_spec_path(name, version, spec) if spec
      report.analyzed_paths << spec_path
    end
  end

  check_stray_specs
  report
end

#check_spec_path(name, version, spec) ⇒ void (private)

This method returns an undefined value.

Ensures that the name and the version of the specification correspond to the ones expected by the repo given its path.

Parameters:

  • name (String) —

    The name of the Pod.

  • version (Version) —

    The version of the specification.

  • spec (Specification) —

    The specification to check.



110
111
112
113
114
115
 
# File 'lib/cocoapods-core/source/health_reporter.rb', line 110

def check_spec_path(name, version, spec)
  unless spec.name == name && spec.version.to_s == version.to_s
    message = "Incorrect path #{spec.defined_in_file}"
    report.add_message(:error, message, name, spec.version)
  end
end

#check_stray_specs ⇒ void (private)

This method returns an undefined value.

Checks for any stray specification in the repo.

Parameters:

  • analyzed_paths (Array<Pathname>) —

    The specification to check.



124
125
126
127
128
129
130
 
# File 'lib/cocoapods-core/source/health_reporter.rb', line 124

def check_stray_specs
  all_paths = Pathname.glob(source.repo + '**/*.podspec{,.json}')
  stray_specs = all_paths - report.analyzed_paths
  stray_specs.each do |path|
    report.add_message(:error, 'Stray spec', path)
  end
end

#lint_spec(name, version, spec_path) ⇒ Specification, Nil (private)

Checks the validity of the specification with the linter.

Parameters:

  • name (String) —

    The name of the Pod.

  • version (Version) —

    The version of the specification.

  • spec_path (Pathname) —

    The path of the specification to check.

Returns:

  • (Specification) —

    The specification loaded by the linter.

  • (Nil) —

    If the specifications raised during evaluation.



86
87
88
89
90
91
92
93
94
 
# File 'lib/cocoapods-core/source/health_reporter.rb', line 86

def lint_spec(name, version, spec_path)
  linter = Specification::Linter.new(spec_path)
  linter.lint
  linter.results.each do |result|
    next if result.public_only?
    report.add_message(result.type, result.message, name, version)
  end
  linter.spec
end

#pre_check(&block) ⇒ void

This method returns an undefined value.

Allows to specify an optional callback which is called before analysing every spec. Suitable for UI.

Parameters:

  • A (Proc) —

    callback which is called before checking any specification. It receives the name and the version of the spec.



32
33
34
 
# File 'lib/cocoapods-core/source/health_reporter.rb', line 32

def pre_check(&block)
  @pre_check_callback = block
end