Class: RuboCop::Config

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
FileFinder, PathUtil
Defined in:
lib/rubocop/config.rb

Overview

This class represents the configuration of the RuboCop application and all its cops. A Config is associated with a YAML configuration file from which it was read. Several different Configs can be used during a run of the rubocop program, if files in several directories are inspected.

Constant Summary collapse

DEFAULT_RAILS_VERSION =
5.0

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from FileFinder

#find_file_upwards, #find_files_upwards, root_level=, root_level?

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

#initialize(hash = {}, loaded_path = nil) ⇒ Config

Returns a new instance of Config


19
20
21
22
23
24
25
26
27
28
29
# File 'lib/rubocop/config.rb', line 19

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
  @validator = ConfigValidator.new(self)
end

Instance Attribute Details

#loaded_pathObject (readonly)

Returns the value of attribute loaded_path


17
18
19
# File 'lib/rubocop/config.rb', line 17

def loaded_path
  @loaded_path
end

Class Method Details

.create(hash, path) ⇒ Object


31
32
33
# File 'lib/rubocop/config.rb', line 31

def self.create(hash, path)
  new(hash, path).check
end

Instance Method Details

#add_excludes_from_higher_level(highest_config) ⇒ Object


72
73
74
75
76
77
78
79
80
81
82
# File 'lib/rubocop/config.rb', line 72

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) ⇒ Boolean

Returns:

  • (Boolean)

124
125
126
127
128
129
130
131
132
133
134
135
# File 'lib/rubocop/config.rb', line 124

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_parametersObject

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.


171
172
173
174
175
176
177
178
179
# File 'lib/rubocop/config.rb', line 171

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

#bundler_lock_file_pathObject


196
197
198
199
200
201
202
203
204
205
# File 'lib/rubocop/config.rb', line 196

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

#checkObject


35
36
37
38
39
40
41
42
# File 'lib/rubocop/config.rb', line 35

def check
  deprecation_check do |deprecation_message|
    warn("#{loaded_path} - #{deprecation_message}")
  end
  @validator.validate
  make_excludes_absolute
  self
end

#deprecation_checkObject


84
85
86
87
88
89
90
91
92
93
# File 'lib/rubocop/config.rb', line 84

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

#file_to_exclude?(file) ⇒ Boolean

Returns:

  • (Boolean)

147
148
149
150
151
152
# File 'lib/rubocop/config.rb', line 147

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) ⇒ Boolean

Returns:

  • (Boolean)

103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'lib/rubocop/config.rb', line 103

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_copsObject


99
100
101
# File 'lib/rubocop/config.rb', line 99

def for_all_cops
  @for_all_cops ||= self['AllCops'] || {}
end

#for_cop(cop) ⇒ Object


95
96
97
# File 'lib/rubocop/config.rb', line 95

def for_cop(cop)
  @for_cop[cop.respond_to?(:cop_name) ? cop.cop_name : cop]
end

#make_excludes_absoluteObject


56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# File 'lib/rubocop/config.rb', line 56

def make_excludes_absolute
  each_key do |key|
    @validator.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

#path_relative_to_config(path) ⇒ Object


162
163
164
# File 'lib/rubocop/config.rb', line 162

def path_relative_to_config(path)
  relative_path(path, base_dir_for_path_parameters)
end

#patterns_to_excludeObject


158
159
160
# File 'lib/rubocop/config.rb', line 158

def patterns_to_exclude
  for_all_cops['Exclude'] || []
end

#patterns_to_includeObject


154
155
156
# File 'lib/rubocop/config.rb', line 154

def patterns_to_include
  for_all_cops['Include'] || []
end

#possibly_include_hidden?Boolean

Returns true if there's a chance that an Include pattern matches hidden files, false if that's definitely not possible.

Returns:

  • (Boolean)

139
140
141
142
143
144
145
# File 'lib/rubocop/config.rb', line 139

def possibly_include_hidden?
  return @possibly_include_hidden if defined?(@possibly_include_hidden)

  @possibly_include_hidden = patterns_to_include.any? do |s|
    s.is_a?(Regexp) || s.start_with?('.') || s.include?('/.')
  end
end

#signatureObject


52
53
54
# File 'lib/rubocop/config.rb', line 52

def signature
  @signature ||= Digest::SHA1.hexdigest(to_s)
end

#smart_loaded_pathObject


192
193
194
# File 'lib/rubocop/config.rb', line 192

def smart_loaded_path
  PathUtil.smart_path(@loaded_path)
end

#target_rails_versionObject


181
182
183
184
185
186
187
188
189
190
# File 'lib/rubocop/config.rb', line 181

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

#to_sObject


48
49
50
# File 'lib/rubocop/config.rb', line 48

def to_s
  @to_s ||= @hash.to_s
end