Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    # Helpers for builtin documentation
    module Documentation
      module_function

      # @api private
      def department_to_basename(department)
        "cops_#{department.to_s.downcase.tr('/', '_')}"
      end

      # @api private
      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

      # @api private
      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

      # @api private
      def default_base_url
        'https://docs.rubocop.org/rubocop'
      end
    end
  end
end

Version data entries

193 entries across 184 versions & 17 rubygems

Version	Path
rubocop-1.41.1	lib/rubocop/cop/documentation.rb
rubocop-1.41.0	lib/rubocop/cop/documentation.rb
rubocop-1.40.0	lib/rubocop/cop/documentation.rb
rubocop-1.39.0	lib/rubocop/cop/documentation.rb
rubocop-1.38.0	lib/rubocop/cop/documentation.rb
rubocop-1.37.1	lib/rubocop/cop/documentation.rb
rubocop-1.37.0	lib/rubocop/cop/documentation.rb
rubocop-1.36.0	lib/rubocop/cop/documentation.rb
rubocop-1.35.1	lib/rubocop/cop/documentation.rb
rubocop-1.35.0	lib/rubocop/cop/documentation.rb
rubocop-1.34.1	lib/rubocop/cop/documentation.rb
rubocop-1.34.0	lib/rubocop/cop/documentation.rb
rubocop-1.33.0	lib/rubocop/cop/documentation.rb
rubocop-1.32.0	lib/rubocop/cop/documentation.rb
rubocop-1.31.2	lib/rubocop/cop/documentation.rb
rubocop-1.31.1	lib/rubocop/cop/documentation.rb
rubocop-1.31.0	lib/rubocop/cop/documentation.rb
rubocop-1.30.1	lib/rubocop/cop/documentation.rb
rubocop-1.30.0	lib/rubocop/cop/documentation.rb
rubocop-1.29.1	lib/rubocop/cop/documentation.rb