Class: Pod::Specification::Linter

Inherits:
Object
  • Object
show all
Includes:
ResultHelpers
Defined in:
lib/cocoapods-core/specification/linter.rb,
lib/cocoapods-core/specification/linter/result.rb,
lib/cocoapods-core/specification/linter/analyzer.rb

Overview

The Linter check specifications for errors and warnings.

It is designed not only to guarantee the formal functionality of a specification, but also to support the maintenance of sources.

Defined Under Namespace

Modules: ResultHelpers Classes: Analyzer, Result

Instance Attribute Summary collapse

Attributes included from ResultHelpers

#results

Instance Method Summary collapse

Constructor Details

#initialize(spec_or_path) ⇒ Linter

Returns a new instance of Linter.

Parameters:

  • spec_or_path (Specification, Pathname, String) —

    the Specification or the path of the ‘podspec` file to lint.



26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/cocoapods-core/specification/linter.rb', line 26

def initialize(spec_or_path)
  if spec_or_path.is_a?(Specification)
    @spec = spec_or_path
    @file = @spec.defined_in_file
  else
    @file = Pathname.new(spec_or_path)
    begin
      @spec = Specification.from_file(@file)
    rescue => e
      @spec = nil
      @raise_message = e.message
    end
  end
end

Instance Attribute Details

#file ⇒ Pathname (readonly)

Returns the path of the ‘podspec` file where #spec is defined.

Returns:

  • (Pathname) —

    the path of the ‘podspec` file where #spec is defined.



21
22
23
 
# File 'lib/cocoapods-core/specification/linter.rb', line 21

def file
  @file
end

#spec ⇒ Specification (readonly)

Returns the specification to lint.

Returns:



16
17
18
 
# File 'lib/cocoapods-core/specification/linter.rb', line 16

def spec
  @spec
end

Instance Method Details

#errors ⇒ Array<Result>

Returns all the errors generated by the Linter.

Returns:

  • (Array<Result>) —

    all the errors generated by the Linter.



68
69
70
 
# File 'lib/cocoapods-core/specification/linter.rb', line 68

def errors
  @errors ||= results.select { |r| r.type == :error }
end

#lint ⇒ Bool

Lints the specification adding a Result for any failed check to the Pod::Specification::Linter::ResultHelpers#results list.

Returns:

  • (Bool) —

    whether the specification passed validation.



46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/cocoapods-core/specification/linter.rb', line 46

def lint
  @results = []
  if spec
    check_required_root_attributes
    run_root_validation_hooks
    perform_all_specs_analysis
  else
    error "[spec] The specification defined in `#{file}` could not be" \
    ' loaded.' \
      "\n\n#{@raise_message}"
  end
  results.empty?
end

#warnings ⇒ Array<Result>

Returns all the warnings generated by the Linter.

Returns:

  • (Array<Result>) —

    all the warnings generated by the Linter.



74
75
76
 
# File 'lib/cocoapods-core/specification/linter.rb', line 74

def warnings
  @warnings ||= results.select { |r| r.type == :warning }
end