class Pod::Specification::Linter

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.

Attributes

consumer[RW]

@return [Specification::Consumer] the current consumer.

file[R]

@return [Pathname] the path of the `podspec` file where {#spec} is

defined.
results[R]
spec[R]

@return [Specification] the specification to lint.

Public Class Methods

new(spec_or_path) click to toggle source

@param [Specification, Pathname, String] spec_or_path

the Specification or the path of the `podspec` file to lint.
# 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

Public Instance Methods

errors() click to toggle source

@return [Array<Result>] all the errors generated by the Linter.

# File lib/cocoapods-core/specification/linter.rb, line 69
def errors
  @errors ||= results.select { |r| r.type == :error }
end
lint() click to toggle source

Lints the specification adding a {Result} for any failed check to the {#results} object.

@return [Bool] whether the specification passed validation.

# File lib/cocoapods-core/specification/linter.rb, line 46
def lint
  @results = Results.new
  if spec
    validate_root_name
    check_required_attributes
    check_requires_arc_attribute
    run_root_validation_hooks
    perform_all_specs_analysis
  else
    results.add_error('spec', "The specification defined in `#{file}` "\
      "could not be loaded.\n\n#{@raise_message}")
  end
  results.empty?
end
warnings() click to toggle source

@return [Array<Result>] all the warnings generated by the Linter.

# File lib/cocoapods-core/specification/linter.rb, line 75
def warnings
  @warnings ||= results.select { |r| r.type == :warning }
end

Private Instance Methods

_validate_app_host_name(n) click to toggle source
# File lib/cocoapods-core/specification/linter.rb, line 404
def _validate_app_host_name(n)
  unless consumer.requires_app_host?
    results.add_error('app_host_name', '`requires_app_host` must be set to ' \
      '`true` when `app_host_name` is specified.')
  end

  unless consumer.dependencies.map(&:name).include?(n)
    results.add_error('app_host_name', "The app host name (#{n}) specified by `#{consumer.spec.name}` could " \
      'not be found. You must explicitly declare a dependency on that app spec.')
  end
end
_validate_authors(a) click to toggle source

Performs validations related to the `authors` attribute.

# File lib/cocoapods-core/specification/linter.rb, line 231
def _validate_authors(a)
  if a.is_a? Hash
    if a == { 'YOUR NAME HERE' => 'YOUR EMAIL HERE' }
      results.add_error('authors', 'The authors have not been updated ' \
        'from default')
    end
  end
end
_validate_changelog(s) click to toggle source

Performs validations related to the `changelog` attribute.

# File lib/cocoapods-core/specification/linter.rb, line 529
def _validate_changelog(s)
  if s =~ %r{https://www.example.com/CHANGELOG}
    results.add_warning('changelog', 'The changelog has ' \
      'not been updated from the default.')
  end
end
_validate_compiler_flags(flags) click to toggle source

Performs validations related to the `compiler_flags` attribute.

# File lib/cocoapods-core/specification/linter.rb, line 553
def _validate_compiler_flags(flags)
  if flags.join(' ').split(' ').any? { |flag| flag.start_with?('-Wno') }
    results.add_warning('compiler_flags', 'Warnings must not be disabled' \
    '(`-Wno compiler` flags).')
  end
end
_validate_deprecated_in_favor_of(d) click to toggle source

Performs validations related to the `deprecated_in_favor_of` attribute.

# File lib/cocoapods-core/specification/linter.rb, line 387
def _validate_deprecated_in_favor_of(d)
  if spec.root.name == Specification.root_name(d)
    results.add_error('deprecated_in_favor_of', 'a spec cannot be ' \
      'deprecated in favor of itself')
  end
end
_validate_description(d) click to toggle source

Performs validations related to the `description` attribute.

# File lib/cocoapods-core/specification/linter.rb, line 271
def _validate_description(d)
  if d == spec.summary
    results.add_warning('description', 'The description is equal to' \
     ' the summary.')
  end

  if d.strip.empty?
    results.add_error('description', 'The description is empty.')
  elsif spec.summary && d.length < spec.summary.length
    results.add_warning('description', 'The description is shorter ' \
    'than the summary.')
  end
end
_validate_frameworks(frameworks) click to toggle source

Performs validations related to the `frameworks` attribute.

# File lib/cocoapods-core/specification/linter.rb, line 297
def _validate_frameworks(frameworks)
  if frameworks_invalid?(frameworks)
    results.add_error('frameworks', 'A framework should only be' \
    ' specified by its name')
  end
end
_validate_homepage(h) click to toggle source

Performs validations related to the `homepage` attribute.

# File lib/cocoapods-core/specification/linter.rb, line 287
def _validate_homepage(h)
  return unless h.is_a?(String)
  if h =~ %r{http://EXAMPLE}
    results.add_warning('homepage', 'The homepage has not been updated' \
     ' from default')
  end
end
_validate_info_plist(value) click to toggle source

@param [Hash,Object] value

# File lib/cocoapods-core/specification/linter.rb, line 538
def _validate_info_plist(value)
  return if value.empty?
  if consumer.spec.subspec? && consumer.spec.library_specification?
    results.add_error('info_plist', 'Info.plist configuration is not currently supported for subspecs.')
  end
end
_validate_libraries(libs) click to toggle source

Performs validations related to the `libraries` attribute.

# File lib/cocoapods-core/specification/linter.rb, line 315
def _validate_libraries(libs)
  libs.each do |lib|
    lib = lib.downcase
    if lib.end_with?('.a') || lib.end_with?('.dylib')
      results.add_error('libraries', 'Libraries should not include the' \
      ' extension ' \
      "(`#{lib}`)")
    end

    if lib.start_with?('lib')
      results.add_error('libraries', 'Libraries should omit the `lib`' \
      ' prefix ' \
      " (`#{lib}`)")
    end

    if lib.include?(',')
      results.add_error('libraries', 'Libraries should not include comas ' \
      "(`#{lib}`)")
    end
  end
end
_validate_license(l) click to toggle source

Performs validations related to the `license` attribute.

# File lib/cocoapods-core/specification/linter.rb, line 339
def _validate_license(l)
  type = l[:type]
  file = l[:file]
  if type.nil?
    results.add_warning('license', 'Missing license type.')
  end
  if type && type.delete(' ').delete("\n").empty?
    results.add_warning('license', 'Invalid license type.')
  end
  if type && type =~ /\(example\)/
    results.add_error('license', 'Sample license type.')
  end
  if file && Pathname.new(file).extname !~ /^(\.(txt|md|markdown|))?$/i
    results.add_error('license', 'Invalid file type')
  end
end
_validate_module_name(m) click to toggle source

Performs validations related to the `module_name` attribute.

# File lib/cocoapods-core/specification/linter.rb, line 250
def _validate_module_name(m)
  unless m.nil? || m =~ /^[a-z_][0-9a-z_]*$/i
    results.add_error('module_name', 'The module name of a spec' \
      ' should be a valid C99 identifier.')
  end
end
_validate_name(name) click to toggle source

Performs validations related to the `name` attribute.

# File lib/cocoapods-core/specification/linter.rb, line 210
def _validate_name(name)
  if name =~ %r{/}
    results.add_error('name', 'The name of a spec should not contain ' \
                   'a slash.')
  end

  if name =~ /\s/
    results.add_error('name', 'The name of a spec should not contain ' \
                   'whitespace.')
  end

  if name[0, 1] == '.'
    results.add_error('name', 'The name of a spec should not begin' \
    ' with a period.')
  end
end
_validate_on_demand_resources(h) click to toggle source

Performs validations related to the `on_demand_resources` attribute.

# File lib/cocoapods-core/specification/linter.rb, line 439
def _validate_on_demand_resources(h)
  h.values.each do |value|
    unless Specification::ON_DEMAND_RESOURCES_CATEGORY_KEYS.include?(value[:category])
      results.add_error('on_demand_resources', "Invalid on demand resources category value `#{value[:category]}`. " \
        "Available options are `#{Specification::ON_DEMAND_RESOURCES_CATEGORY_KEYS.join(', ')}`.")
    end
  end
end
_validate_readme(s) click to toggle source

Performs validations related to the `readme` attribute.

# File lib/cocoapods-core/specification/linter.rb, line 520
def _validate_readme(s)
  if s =~ %r{https://www.example.com/README}
    results.add_warning('readme', 'The readme has ' \
      'not been updated from the default.')
  end
end
_validate_scheme(s) click to toggle source

Performs validation related to the `scheme` attribute.

# File lib/cocoapods-core/specification/linter.rb, line 450
def _validate_scheme(s)
  unless s.empty?
    if consumer.spec.subspec? && consumer.spec.library_specification?
      results.add_error('scheme', 'Scheme configuration is not currently supported for subspecs.')
      return
    end
    if s.key?(:launch_arguments) && !s[:launch_arguments].is_a?(Array)
      results.add_error('scheme', 'Expected an array for key `launch_arguments`.')
    end
    if s.key?(:environment_variables) && !s[:environment_variables].is_a?(Hash)
      results.add_error('scheme', 'Expected a hash for key `environment_variables`.')
    end
    if s.key?(:code_coverage) && ![true, false].include?(s[:code_coverage])
      results.add_error('scheme', 'Expected a boolean for key `code_coverage`.')
    end
  end
end
_validate_script_phases(s) click to toggle source

Performs validations related to the `script_phases` attribute.

# File lib/cocoapods-core/specification/linter.rb, line 418
def _validate_script_phases(s)
  s.each do |script_phase|
    keys = script_phase.keys
    unrecognized_keys = keys - Specification::ALL_SCRIPT_PHASE_KEYS
    unless unrecognized_keys.empty?
      results.add_error('script_phases', "Unrecognized option(s) `#{unrecognized_keys.join(', ')}` in script phase `#{script_phase[:name]}`. " \
        "Available options are `#{Specification::ALL_SCRIPT_PHASE_KEYS.join(', ')}`.")
    end
    missing_required_keys = Specification::SCRIPT_PHASE_REQUIRED_KEYS - keys
    unless missing_required_keys.empty?
      results.add_error('script_phases', "Missing required shell script phase options `#{missing_required_keys.join(', ')}` in script phase `#{script_phase[:name]}`.")
    end
    unless Specification::EXECUTION_POSITION_KEYS.include?(script_phase[:execution_position])
      results.add_error('script_phases', "Invalid execution position value `#{script_phase[:execution_position]}` in shell script `#{script_phase[:name]}`. " \
      "Available options are `#{Specification::EXECUTION_POSITION_KEYS.join(', ')}`.")
    end
  end
end
_validate_social_media_url(s) click to toggle source

Performs validations related to the `social_media_url` attribute.

# File lib/cocoapods-core/specification/linter.rb, line 511
def _validate_social_media_url(s)
  if s =~ %r{https://twitter.com/EXAMPLE}
    results.add_warning('social_media_url', 'The social media URL has ' \
      'not been updated from the default.')
  end
end
_validate_source(s) click to toggle source

Performs validations related to the `source` attribute.

# File lib/cocoapods-core/specification/linter.rb, line 358
def _validate_source(s)
  return unless s.is_a?(Hash)
  if git = s[:git]
    tag, commit = s.values_at(:tag, :commit)
    version = spec.version.to_s

    if git =~ %r{http://EXAMPLE}
      results.add_error('source', 'The Git source still contains the ' \
      'example URL.')
    end
    if commit && commit.downcase =~ /head/
      results.add_error('source', 'The commit of a Git source cannot be' \
      ' `HEAD`.')
    end
    if tag && !tag.to_s.include?(version)
      results.add_warning('source', 'The version should be included in' \
       ' the Git tag.')
    end
    if tag.nil?
      results.add_warning('source', 'Git sources should specify a tag.', true)
    end
  end

  perform_github_source_checks(s)
  check_git_ssh_source(s)
end
_validate_summary(s) click to toggle source

Performs validations related to the `summary` attribute.

# File lib/cocoapods-core/specification/linter.rb, line 259
def _validate_summary(s)
  if s.length > 140
    results.add_warning('summary', 'The summary should be a short ' \
      'version of `description` (max 140 characters).')
  end
  if s =~ /A short description of/
    results.add_warning('summary', 'The summary is not meaningful.')
  end
end
_validate_test_type(t) click to toggle source

Performs validations related to the `test_type` attribute.

# File lib/cocoapods-core/specification/linter.rb, line 396
def _validate_test_type(t)
  supported_test_types = Specification::DSL::SUPPORTED_TEST_TYPES.map(&:to_s)
  unless supported_test_types.include?(t.to_s)
    results.add_error('test_type', "The test type `#{t}` is not supported. " \
      "Supported test type values are #{supported_test_types}.")
  end
end
_validate_version(v) click to toggle source

Performs validations related to the `version` attribute.

# File lib/cocoapods-core/specification/linter.rb, line 242
def _validate_version(v)
  if v.to_s.empty?
    results.add_error('version', 'A version is required.')
  end
end
_validate_weak_frameworks(frameworks) click to toggle source

Performs validations related to the `weak frameworks` attribute.

# File lib/cocoapods-core/specification/linter.rb, line 306
def _validate_weak_frameworks(frameworks)
  if frameworks_invalid?(frameworks)
    results.add_error('weak_frameworks', 'A weak framework should only be' \
    ' specified by its name')
  end
end
check_git_ssh_source(s) click to toggle source

Performs validations related to SSH sources

# File lib/cocoapods-core/specification/linter.rb, line 499
def check_git_ssh_source(s)
  if git = s[:git]
    if git =~ %r{\w+\@(\w|\.)+\:(/\w+)*}
      results.add_warning('source', 'Git SSH URLs will NOT work for ' \
        'people behind firewalls configured to only allow HTTP, ' \
        'therefore HTTPS is preferred.', true)
    end
  end
end
check_required_attributes() click to toggle source

Checks that every required attribute has a value.

@return [void]

# File lib/cocoapods-core/specification/linter.rb, line 121
def check_required_attributes
  attributes = DSL.attributes.values.select(&:required?)
  attributes.each do |attr|
    begin
      value = spec.send(attr.name)
      unless value && (!value.respond_to?(:empty?) || !value.empty?)
        if attr.name == :license
          results.add_warning('attributes', 'Missing required attribute ' \
          "`#{attr.name}`.")
        else
          results.add_error('attributes', 'Missing required attribute ' \
           "`#{attr.name}`.")
        end
      end
    rescue => exception
      results.add_error('attributes', "Unable to parse attribute `#{attr.name}` due to error: #{exception}")
    end
  end
end
check_requires_arc_attribute() click to toggle source

Generates a warning if the requires_arc attribute has true or false string values.

@return [void]

# File lib/cocoapods-core/specification/linter.rb, line 107
def check_requires_arc_attribute
  attribute = DSL.attributes.values.find { |attr| attr.name == :requires_arc }
  if attribute
    value = spec.send(attribute.name)
    if value == 'true' || value == 'false'
      results.add_warning('requires_arc', value + ' is considered to be the name of a file.')
    end
  end
end
frameworks_invalid?(frameworks) click to toggle source

Returns whether the frameworks are valid

@param frameworks [Array<String>] The frameworks to be validated

@return [Boolean] true if a framework contains any non-alphanumeric character or includes an extension.

# File lib/cocoapods-core/specification/linter.rb, line 568
def frameworks_invalid?(frameworks)
  frameworks.any? do |framework|
    framework_regex = /[^\w\-\+]/
    framework =~ framework_regex
  end
end
perform_all_specs_analysis() click to toggle source

Run validations for multi-platform attributes activating.

@return [void]

# File lib/cocoapods-core/specification/linter.rb, line 154
def perform_all_specs_analysis
  all_specs = [spec, *spec.recursive_subspecs]
  all_specs.each do |current_spec|
    current_spec.available_platforms.each do |platform|
      @consumer = Specification::Consumer.new(current_spec, platform)
      results.consumer = @consumer
      run_all_specs_validation_hooks
      analyzer = Analyzer.new(@consumer, results)
      results = analyzer.analyze
      @consumer = nil
      results.consumer = nil
    end
  end
end
perform_github_source_checks(s) click to toggle source

Performs validations related to github sources.

# File lib/cocoapods-core/specification/linter.rb, line 470
def perform_github_source_checks(s)
  require 'uri'

  if git = s[:git]
    return unless git =~ /^#{URI.regexp}$/
    git_uri = URI.parse(git)
    if git_uri.host
      perform_github_uri_checks(git, git_uri) if git_uri.host.end_with?('github.com')
    end
  end
end
perform_github_uri_checks(git, git_uri) click to toggle source
# File lib/cocoapods-core/specification/linter.rb, line 482
def perform_github_uri_checks(git, git_uri)
  if git_uri.host.start_with?('www.')
    results.add_warning('github_sources', 'Github repositories should ' \
      'not use `www` in their URL.')
  end
  unless git.end_with?('.git')
    results.add_warning('github_sources', 'Github repositories ' \
      'should end in `.git`.')
  end
  unless git_uri.scheme == 'https'
    results.add_warning('github_sources', 'Github repositories ' \
      'should use an `https` link.', true)
  end
end
run_all_specs_validation_hooks() click to toggle source

Runs the validation hook for the attributes that are not root only.

@return [void]

# File lib/cocoapods-core/specification/linter.rb, line 177
def run_all_specs_validation_hooks
  attributes = DSL.attributes.values.reject(&:root_only?)
  run_validation_hooks(attributes, consumer)
end
run_root_validation_hooks() click to toggle source

Runs the validation hook for root only attributes.

@return [void]

# File lib/cocoapods-core/specification/linter.rb, line 145
def run_root_validation_hooks
  attributes = DSL.attributes.values.select(&:root_only?)
  run_validation_hooks(attributes, spec)
end
run_validation_hooks(attributes, target) click to toggle source

Runs the validation hook for each attribute.

@note Hooks are called only if there is a value for the attribute as

required attributes are already checked by the
{#check_required_attributes} step.

@return [void]

# File lib/cocoapods-core/specification/linter.rb, line 190
def run_validation_hooks(attributes, target)
  attributes.each do |attr|
    validation_hook = "_validate_#{attr.name}"
    next unless respond_to?(validation_hook, true)
    begin
      value = target.send(attr.name)
      next unless value
      send(validation_hook, value)
    rescue => e
      results.add_error(attr.name, "Unable to validate due to exception: #{e}")
    end
  end
end
validate_root_name() click to toggle source

Checks that the spec's root name matches the filename.

@return [void]

# File lib/cocoapods-core/specification/linter.rb, line 89
def validate_root_name
  if spec.root.name && file
    acceptable_names = [
      spec.root.name + '.podspec',
      spec.root.name + '.podspec.json',
    ]
    names_match = acceptable_names.include?(file.basename.to_s)
    unless names_match
      results.add_error('name', 'The name of the spec should match the ' \
                        'name of the file.')
    end
  end
end