class RuboCop::Config
rubocop:disable Metrics/ClassLength
Constants
- COMMON_PARAMS
- DEFAULT_RAILS_VERSION
- DEFAULT_RUBY_VERSION
2.3 is the oldest officially supported Ruby version.
- INTERNAL_PARAMS
- KNOWN_RUBIES
- OBSOLETE_COPS
- OBSOLETE_ENFORCED_STYLES
- OBSOLETE_PARAMETERS
- OBSOLETE_RUBIES
- RUBY_VERSION_FILENAME
Attributes
loaded_path[R]
Public Class Methods
create(hash, path)
click to toggle source
# File lib/rubocop/config.rb, line 255 def self.create(hash, path) new(hash, path).check end
new(hash = {}, loaded_path = nil)
click to toggle source
# File lib/rubocop/config.rb, line 244 def initialize(hash = {}, loaded_path = nil) @loaded_path = loaded_path @for_cop = Hash.new do |h, cop| qualified_cop_name = Cop::Cop.qualified_cop_name(cop, loaded_path) cop_options = self[qualified_cop_name] || {} cop_options['Enabled'] = enable_cop?(qualified_cop_name, cop_options) h[cop] = cop_options end @hash = hash end
Public Instance Methods
[](key)
click to toggle source
# File lib/rubocop/config.rb, line 268 def [](key) @hash[key] end
[]=(key, value)
click to toggle source
# File lib/rubocop/config.rb, line 272 def []=(key, value) @hash[key] = value end
add_excludes_from_higher_level(highest_config)
click to toggle source
# File lib/rubocop/config.rb, line 336 def add_excludes_from_higher_level(highest_config) return unless highest_config.for_all_cops['Exclude'] excludes = for_all_cops['Exclude'] ||= [] highest_config.for_all_cops['Exclude'].each do |path| unless path.is_a?(Regexp) || absolute?(path) path = File.join(File.dirname(highest_config.loaded_path), path) end excludes << path unless excludes.include?(path) end end
allowed_camel_case_file?(file)
click to toggle source
# File lib/rubocop/config.rb, line 407 def allowed_camel_case_file?(file) # Gemspecs are allowed to have dashes because that fits with bundler best # practices in the case when the gem is nested under a namespace (e.g., # `bundler-console` conveys `Bundler::Console`). return true if File.extname(file) == '.gemspec' file_to_include?(file) do |pattern, relative_path, absolute_path| pattern.to_s =~ /[A-Z]/ && (match_path?(pattern, relative_path) || match_path?(pattern, absolute_path)) end end
base_dir_for_path_parameters()
click to toggle source
Paths specified in configuration files starting with .rubocop are relative to the directory where that file is. Paths in other config files are relative to the current directory. This is so that paths in config/default.yml, for example, are not relative to RuboCop's config directory since that wouldn't work.
# File lib/rubocop/config.rb, line 454 def base_dir_for_path_parameters @base_dir_for_path_parameters ||= if File.basename(loaded_path).start_with?('.rubocop') && loaded_path != File.join(Dir.home, ConfigLoader::DOTFILE) File.expand_path(File.dirname(loaded_path)) else Dir.pwd end end
check()
click to toggle source
# File lib/rubocop/config.rb, line 259 def check deprecation_check do |deprecation_message| warn("#{loaded_path} - #{deprecation_message}") end validate make_excludes_absolute self end
delete(key)
click to toggle source
# File lib/rubocop/config.rb, line 276 def delete(key) @hash.delete(key) end
deprecation_check() { |"AllCops/#{plural} was renamed to AllCops/#{key}"| ... }
click to toggle source
# File lib/rubocop/config.rb, line 348 def deprecation_check %w[Exclude Include].each do |key| plural = "#{key}s" next unless for_all_cops[plural] for_all_cops[key] = for_all_cops[plural] # Stay backwards compatible. for_all_cops.delete(plural) yield "AllCops/#{plural} was renamed to AllCops/#{key}" end end
each(&block)
click to toggle source
# File lib/rubocop/config.rb, line 280 def each(&block) @hash.each(&block) end
each_key(&block)
click to toggle source
# File lib/rubocop/config.rb, line 292 def each_key(&block) @hash.each_key(&block) end
file_to_exclude?(file)
click to toggle source
# File lib/rubocop/config.rb, line 430 def file_to_exclude?(file) file = File.expand_path(file) patterns_to_exclude.any? do |pattern| match_path?(pattern, file) end end
file_to_include?(file) { |pattern, relative_file_path, absolute_file_path| ... }
click to toggle source
# File lib/rubocop/config.rb, line 386 def file_to_include?(file) relative_file_path = path_relative_to_config(file) # Optimization to quickly decide if the given file is hidden (on the top # level) and can not be matched by any pattern. is_hidden = relative_file_path.start_with?('.') && !relative_file_path.start_with?('..') return false if is_hidden && !possibly_include_hidden? absolute_file_path = File.expand_path(file) patterns_to_include.any? do |pattern| if block_given? yield pattern, relative_file_path, absolute_file_path else match_path?(pattern, relative_file_path) || match_path?(pattern, absolute_file_path) end end end
for_all_cops()
click to toggle source
# File lib/rubocop/config.rb, line 363 def for_all_cops @for_all_cops ||= self['AllCops'] || {} end
for_cop(cop)
click to toggle source
# File lib/rubocop/config.rb, line 359 def for_cop(cop) @for_cop[cop.respond_to?(:cop_name) ? cop.cop_name : cop] end
key?(key)
click to toggle source
# File lib/rubocop/config.rb, line 284 def key?(key) @hash.key?(key) end
keys()
click to toggle source
# File lib/rubocop/config.rb, line 288 def keys @hash.keys end
make_excludes_absolute()
click to toggle source
# File lib/rubocop/config.rb, line 320 def make_excludes_absolute each_key do |key| validate_section_presence(key) next unless self[key]['Exclude'] self[key]['Exclude'].map! do |exclude_elem| if exclude_elem.is_a?(String) && !absolute?(exclude_elem) File.expand_path(File.join(base_dir_for_path_parameters, exclude_elem)) else exclude_elem end end end end
map(&block)
click to toggle source
# File lib/rubocop/config.rb, line 296 def map(&block) @hash.map(&block) end
merge(other_hash)
click to toggle source
# File lib/rubocop/config.rb, line 300 def merge(other_hash) @hash.merge(other_hash) end
path_relative_to_config(path)
click to toggle source
# File lib/rubocop/config.rb, line 445 def path_relative_to_config(path) relative_path(path, base_dir_for_path_parameters) end
patterns_to_exclude()
click to toggle source
# File lib/rubocop/config.rb, line 441 def patterns_to_exclude for_all_cops['Exclude'] || [] end
patterns_to_include()
click to toggle source
# File lib/rubocop/config.rb, line 437 def patterns_to_include for_all_cops['Include'] || [] end
signature()
click to toggle source
# File lib/rubocop/config.rb, line 316 def signature @signature ||= Digest::SHA1.hexdigest(to_s) end
target_rails_version()
click to toggle source
# File lib/rubocop/config.rb, line 484 def target_rails_version @target_rails_version ||= if for_all_cops['TargetRailsVersion'] for_all_cops['TargetRailsVersion'].to_f elsif target_rails_version_from_bundler_lock_file target_rails_version_from_bundler_lock_file else DEFAULT_RAILS_VERSION end end
target_ruby_version()
click to toggle source
# File lib/rubocop/config.rb, line 464 def target_ruby_version @target_ruby_version ||= begin if for_all_cops['TargetRubyVersion'] @target_ruby_version_source = :rubocop_yml for_all_cops['TargetRubyVersion'].to_f elsif target_ruby_version_from_version_file @target_ruby_version_source = :ruby_version_file target_ruby_version_from_version_file elsif target_ruby_version_from_bundler_lock_file @target_ruby_version_source = :bundler_lock_file target_ruby_version_from_bundler_lock_file else DEFAULT_RUBY_VERSION end end end
to_h()
click to toggle source
# File lib/rubocop/config.rb, line 304 def to_h @hash end
to_hash()
click to toggle source
# File lib/rubocop/config.rb, line 308 def to_hash @hash end
to_s()
click to toggle source
# File lib/rubocop/config.rb, line 312 def to_s @to_s ||= @hash.to_s end
validate()
click to toggle source
# File lib/rubocop/config.rb, line 367 def validate # Don't validate RuboCop's own files. Avoids infinite recursion. base_config_path = File.expand_path(File.join(ConfigLoader::RUBOCOP_HOME, 'config')) return if File.expand_path(loaded_path).start_with?(base_config_path) valid_cop_names, invalid_cop_names = keys.partition do |key| ConfigLoader.default_configuration.key?(key) end reject_obsolete_cops_and_parameters warn_about_unrecognized_cops(invalid_cop_names) check_target_ruby validate_parameter_names(valid_cop_names) validate_enforced_styles(valid_cop_names) validate_syntax_cop reject_mutually_exclusive_defaults end
Private Instance Methods
bundler_lock_file_path()
click to toggle source
# File lib/rubocop/config.rb, line 721 def bundler_lock_file_path return nil unless loaded_path base_path = base_dir_for_path_parameters ['gems.locked', 'Gemfile.lock'].each do |file_name| path = find_file_upwards(file_name, base_path) return path if path end nil end
check_target_ruby()
click to toggle source
# File lib/rubocop/config.rb, line 628 def check_target_ruby return if KNOWN_RUBIES.include?(target_ruby_version) msg = if OBSOLETE_RUBIES.include?(target_ruby_version) "RuboCop found unsupported Ruby version #{target_ruby_version} " \ "in #{target_ruby_source}. #{target_ruby_version}-compatible " \ 'analysis was dropped after version ' \ "#{OBSOLETE_RUBIES[target_ruby_version]}." else 'RuboCop found unknown Ruby version ' \ "#{target_ruby_version.inspect} in #{target_ruby_source}." end msg += "\nSupported versions: #{KNOWN_RUBIES.join(', ')}" raise ValidationError, msg end
enable_cop?(qualified_cop_name, cop_options)
click to toggle source
# File lib/rubocop/config.rb, line 741 def enable_cop?(qualified_cop_name, cop_options) cop_department, cop_name = qualified_cop_name.split('/') department = cop_name.nil? unless department department_options = self[cop_department] if department_options && department_options['Enabled'] == false return false end end cop_options.fetch('Enabled') { !for_all_cops['DisabledByDefault'] } end
obsolete_cops()
click to toggle source
# File lib/rubocop/config.rb, line 601 def obsolete_cops OBSOLETE_COPS.map do |cop_name, message| next unless key?(cop_name) || key?(Cop::Badge.parse(cop_name).cop_name) message + "\n(obsolete configuration found in #{smart_loaded_path}," \ ' please update it)' end end
obsolete_enforced_style()
click to toggle source
# File lib/rubocop/config.rb, line 610 def obsolete_enforced_style OBSOLETE_ENFORCED_STYLES.map do |params| obsolete_enforced_style_message(params[:cop], params[:parameter], params[:enforced_style], params[:alternative]) end end
obsolete_enforced_style_message(cop, param, enforced_style, alternative)
click to toggle source
# File lib/rubocop/config.rb, line 618 def obsolete_enforced_style_message(cop, param, enforced_style, alternative) style = self[cop]&.detect { |key, _| key.start_with?(param) } return unless style && style[1] == enforced_style "obsolete `#{param}: #{enforced_style}` (for #{cop}) " \ "found in #{smart_loaded_path}" \ "\n#{alternative}" end
obsolete_parameter_message(cop, parameter, alternative)
click to toggle source
# File lib/rubocop/config.rb, line 593 def obsolete_parameter_message(cop, parameter, alternative) return unless self[cop]&.key?(parameter) "obsolete parameter #{parameter} (for #{cop}) " \ "found in #{smart_loaded_path}" \ "\n#{alternative}" end
obsolete_parameters()
click to toggle source
# File lib/rubocop/config.rb, line 586 def obsolete_parameters OBSOLETE_PARAMETERS.map do |params| obsolete_parameter_message(params[:cop], params[:parameter], params[:alternative]) end end
read_rails_version_from_bundler_lock_file()
click to toggle source
# File lib/rubocop/config.rb, line 709 def read_rails_version_from_bundler_lock_file lock_file_path = bundler_lock_file_path return nil unless lock_file_path File.foreach(lock_file_path) do |line| # If rails is in Gemfile.lock or gems.lock, there should be a line like: # rails (X.X.X) result = line.match(/^\s+rails\s+\((\d+\.\d+)/) return result.captures.first.to_f if result end end
read_ruby_version_from_bundler_lock_file()
click to toggle source
# File lib/rubocop/config.rb, line 677 def read_ruby_version_from_bundler_lock_file lock_file_path = bundler_lock_file_path return nil unless lock_file_path in_ruby_section = false File.foreach(lock_file_path) do |line| # If ruby is in Gemfile.lock or gems.lock, there should be two lines # towards the bottom of the file that look like: # RUBY VERSION # ruby W.X.YpZ # We ultimately want to match the "ruby W.X.Y.pZ" line, but there's # extra logic to make sure we only start looking once we've seen the # "RUBY VERSION" line. in_ruby_section ||= line.match(/^\s*RUBY\s*VERSION\s*$/) next unless in_ruby_section # We currently only allow this feature to work with MRI ruby. If jruby # (or something else) is used by the project, it's lock file will have a # line that looks like: # RUBY VERSION # ruby W.X.YpZ (jruby x.x.x.x) # The regex won't match in this situation. result = line.match(/^\s*ruby\s+(\d+\.\d+)[p.\d]*\s*$/) return result.captures.first.to_f if result end end
reject_mutually_exclusive_defaults()
click to toggle source
# File lib/rubocop/config.rb, line 732 def reject_mutually_exclusive_defaults disabled_by_default = for_all_cops['DisabledByDefault'] enabled_by_default = for_all_cops['EnabledByDefault'] return unless disabled_by_default && enabled_by_default msg = 'Cops cannot be both enabled by default and disabled by default' raise ValidationError, msg end
reject_obsolete_cops_and_parameters()
click to toggle source
# File lib/rubocop/config.rb, line 575 def reject_obsolete_cops_and_parameters messages = [ obsolete_cops, obsolete_parameters, obsolete_enforced_style ].flatten.compact return if messages.empty? raise ValidationError, messages.join("\n") end
ruby_version_file()
click to toggle source
# File lib/rubocop/config.rb, line 657 def ruby_version_file @ruby_version_file ||= find_file_upwards(RUBY_VERSION_FILENAME, base_dir_for_path_parameters) end
smart_loaded_path()
click to toggle source
# File lib/rubocop/config.rb, line 755 def smart_loaded_path PathUtil.smart_path(@loaded_path) end
target_rails_version_from_bundler_lock_file()
click to toggle source
# File lib/rubocop/config.rb, line 704 def target_rails_version_from_bundler_lock_file @target_rails_version_from_bundler_lock_file ||= read_rails_version_from_bundler_lock_file end
target_ruby_source()
click to toggle source
# File lib/rubocop/config.rb, line 646 def target_ruby_source case @target_ruby_version_source when :ruby_version_file "`#{RUBY_VERSION_FILENAME}`" when :bundler_lock_file "`#{bundler_lock_file_path}`" when :rubocop_yml "`TargetRubyVersion` parameter (in #{smart_loaded_path})" end end
target_ruby_version_from_bundler_lock_file()
click to toggle source
# File lib/rubocop/config.rb, line 672 def target_ruby_version_from_bundler_lock_file @target_ruby_version_from_bundler_lock_file ||= read_ruby_version_from_bundler_lock_file end
target_ruby_version_from_version_file()
click to toggle source
# File lib/rubocop/config.rb, line 662 def target_ruby_version_from_version_file file = ruby_version_file return unless file && File.file?(file) @target_ruby_version_from_version_file ||= File.read(file).match(/\A(ruby-)?(?<version>\d+\.\d+)/) do |md| md[:version].to_f end end
validate_enforced_styles(valid_cop_names)
click to toggle source
# File lib/rubocop/config.rb, line 549 def validate_enforced_styles(valid_cop_names) valid_cop_names.each do |name| styles = self[name].select { |key, _| key.start_with?('Enforced') } styles.each do |style_name, style| supported_key = RuboCop::Cop::Util.to_supported_styles(style_name) valid = ConfigLoader.default_configuration[name][supported_key] next unless valid next if valid.include?(style) next if validate_support_and_has_list(name, style, valid) msg = "invalid #{style_name} '#{style}' for #{name} found in " \ "#{smart_loaded_path}\n" \ "Valid choices are: #{valid.join(', ')}" raise ValidationError, msg end end end
validate_parameter_names(valid_cop_names)
click to toggle source
# File lib/rubocop/config.rb, line 531 def validate_parameter_names(valid_cop_names) valid_cop_names.each do |name| validate_section_presence(name) default_config = ConfigLoader.default_configuration[name] self[name].each_key do |param| next if COMMON_PARAMS.include?(param) || default_config.key?(param) message = "Warning: #{name} does not support #{param} parameter.\n\n" \ "Supported parameters are:\n\n" \ " - #{(default_config.keys - INTERNAL_PARAMS).join("\n - ")}\n" warn Rainbow(message).yellow.to_s end end end
validate_section_presence(name)
click to toggle source
# File lib/rubocop/config.rb, line 524 def validate_section_presence(name) return unless key?(name) && self[name].nil? raise ValidationError, "empty section #{name} found in #{smart_loaded_path}" end
validate_support_and_has_list(name, formats, valid)
click to toggle source
# File lib/rubocop/config.rb, line 569 def validate_support_and_has_list(name, formats, valid) ConfigLoader.default_configuration[name]['AllowMultipleStyles'] && formats.is_a?(Array) && formats.all? { |format| valid.include?(format) } end
validate_syntax_cop()
click to toggle source
# File lib/rubocop/config.rb, line 512 def validate_syntax_cop syntax_config = self['Lint/Syntax'] default_config = ConfigLoader.default_configuration['Lint/Syntax'] return unless syntax_config && default_config.merge(syntax_config) != default_config raise ValidationError, "configuration for Syntax cop found in #{smart_loaded_path}\n" \ 'It\'s not possible to disable this cop.' end
warn_about_unrecognized_cops(invalid_cop_names)
click to toggle source
# File lib/rubocop/config.rb, line 497 def warn_about_unrecognized_cops(invalid_cop_names) invalid_cop_names.each do |name| # There could be a custom cop with this name. If so, don't warn next if Cop::Cop.registry.contains_cop_matching?([name]) # Special case for inherit_mode, which is a directive that we keep in # the configuration (even though it's not a cop), because it's easier # to do so than to pass the value around to various methods. next if name == 'inherit_mode' warn Rainbow("Warning: unrecognized cop #{name} found in " \ "#{smart_loaded_path}").yellow end end