module RuboCop::Cop::Documentation

Helpers for builtin documentation

Public Instance Methods

base_url_for(cop_class, config) click to toggle source

@api private

# File lib/rubocop/cop/documentation.rb, line 24
def base_url_for(cop_class, config)
  return default_base_url unless config

  department_name = cop_class.department.to_s

  config.for_department(department_name)['DocumentationBaseURL'] ||
    config.for_all_cops['DocumentationBaseURL']
end
default_base_url() click to toggle source

@api private

# File lib/rubocop/cop/documentation.rb, line 34
def default_base_url
  'https://docs.rubocop.org/rubocop'
end
department_to_basename(department) click to toggle source

@api private

# File lib/rubocop/cop/documentation.rb, line 10
def department_to_basename(department)
  "cops_#{department.to_s.downcase.tr('/', '_')}"
end
url_for(cop_class, config = nil) click to toggle source

@api private

# File lib/rubocop/cop/documentation.rb, line 15
def url_for(cop_class, config = nil)
  base = department_to_basename(cop_class.department)
  fragment = cop_class.cop_name.downcase.gsub(/[^a-z]/, '')
  base_url = base_url_for(cop_class, config)

  "#{base_url}/#{base}.html##{fragment}"
end