rbhint 0.85.1.rc2 → 0.87.1.rc1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (148) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +9 -1
  3. data/bin/rubocop-profile +16 -0
  4. data/config/default.yml +118 -10
  5. data/lib/rbhint/version.rb +1 -1
  6. data/lib/rubocop.rb +15 -1
  7. data/lib/rubocop/cli.rb +0 -2
  8. data/lib/rubocop/cli/command/auto_genenerate_config.rb +40 -5
  9. data/lib/rubocop/cli/command/init_dotfile.rb +1 -1
  10. data/lib/rubocop/cli/command/show_cops.rb +1 -1
  11. data/lib/rubocop/config_loader.rb +24 -66
  12. data/lib/rubocop/config_obsoletion.rb +0 -1
  13. data/lib/rubocop/cop/autocorrect_logic.rb +14 -24
  14. data/lib/rubocop/cop/badge.rb +1 -1
  15. data/lib/rubocop/cop/base.rb +407 -0
  16. data/lib/rubocop/cop/bundler/insecure_protocol_source.rb +10 -20
  17. data/lib/rubocop/cop/commissioner.rb +48 -50
  18. data/lib/rubocop/cop/cop.rb +85 -236
  19. data/lib/rubocop/cop/corrector.rb +38 -115
  20. data/lib/rubocop/cop/correctors/multiline_literal_brace_corrector.rb +26 -0
  21. data/lib/rubocop/cop/gemspec/required_ruby_version.rb +6 -1
  22. data/lib/rubocop/cop/gemspec/ruby_version_globals_usage.rb +1 -1
  23. data/lib/rubocop/cop/generator.rb +1 -1
  24. data/lib/rubocop/cop/internal_affairs/node_type_predicate.rb +11 -14
  25. data/lib/rubocop/cop/layout/case_indentation.rb +18 -19
  26. data/lib/rubocop/cop/layout/class_structure.rb +2 -37
  27. data/lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb +1 -0
  28. data/lib/rubocop/cop/layout/empty_lines_around_attribute_accessor.rb +1 -8
  29. data/lib/rubocop/cop/layout/end_alignment.rb +3 -2
  30. data/lib/rubocop/cop/layout/first_argument_indentation.rb +4 -0
  31. data/lib/rubocop/cop/layout/hash_alignment.rb +1 -2
  32. data/lib/rubocop/cop/layout/multiline_block_layout.rb +17 -7
  33. data/lib/rubocop/cop/layout/space_around_block_parameters.rb +22 -27
  34. data/lib/rubocop/cop/layout/space_around_method_call_operator.rb +27 -68
  35. data/lib/rubocop/cop/layout/space_inside_array_literal_brackets.rb +3 -2
  36. data/lib/rubocop/cop/legacy/corrections_proxy.rb +49 -0
  37. data/lib/rubocop/cop/legacy/corrector.rb +29 -0
  38. data/lib/rubocop/cop/lint/deprecated_open_ssl_constant.rb +4 -4
  39. data/lib/rubocop/cop/lint/duplicate_elsif_condition.rb +39 -0
  40. data/lib/rubocop/cop/lint/duplicate_methods.rb +2 -2
  41. data/lib/rubocop/cop/lint/implicit_string_concatenation.rb +3 -2
  42. data/lib/rubocop/cop/lint/interpolation_check.rb +13 -0
  43. data/lib/rubocop/cop/lint/literal_as_condition.rb +11 -1
  44. data/lib/rubocop/cop/lint/nested_method_definition.rb +14 -20
  45. data/lib/rubocop/cop/lint/non_deterministic_require_order.rb +2 -2
  46. data/lib/rubocop/cop/lint/parentheses_as_grouped_expression.rb +8 -3
  47. data/lib/rubocop/cop/lint/raise_exception.rb +8 -0
  48. data/lib/rubocop/cop/lint/rand_one.rb +1 -1
  49. data/lib/rubocop/cop/lint/redundant_cop_disable_directive.rb +27 -23
  50. data/lib/rubocop/cop/lint/redundant_splat_expansion.rb +2 -2
  51. data/lib/rubocop/cop/lint/regexp_as_condition.rb +6 -0
  52. data/lib/rubocop/cop/lint/safe_navigation_with_empty.rb +8 -0
  53. data/lib/rubocop/cop/lint/syntax.rb +11 -26
  54. data/lib/rubocop/cop/lint/unused_method_argument.rb +1 -1
  55. data/lib/rubocop/cop/lint/useless_access_modifier.rb +1 -1
  56. data/lib/rubocop/cop/metrics/block_length.rb +24 -2
  57. data/lib/rubocop/cop/metrics/block_nesting.rb +1 -1
  58. data/lib/rubocop/cop/metrics/class_length.rb +26 -3
  59. data/lib/rubocop/cop/metrics/cyclomatic_complexity.rb +1 -1
  60. data/lib/rubocop/cop/metrics/method_length.rb +24 -1
  61. data/lib/rubocop/cop/metrics/module_length.rb +26 -3
  62. data/lib/rubocop/cop/metrics/parameter_lists.rb +1 -1
  63. data/lib/rubocop/cop/metrics/perceived_complexity.rb +3 -3
  64. data/lib/rubocop/cop/metrics/utils/code_length_calculator.rb +129 -0
  65. data/lib/rubocop/cop/mixin/allowed_methods.rb +19 -0
  66. data/lib/rubocop/cop/mixin/auto_corrector.rb +12 -0
  67. data/lib/rubocop/cop/mixin/code_length.rb +4 -0
  68. data/lib/rubocop/cop/mixin/configurable_formatting.rb +1 -1
  69. data/lib/rubocop/cop/mixin/enforce_superclass.rb +3 -1
  70. data/lib/rubocop/cop/mixin/nil_methods.rb +3 -5
  71. data/lib/rubocop/cop/mixin/ordered_gem_node.rb +6 -1
  72. data/lib/rubocop/cop/mixin/statement_modifier.rb +3 -3
  73. data/lib/rubocop/cop/mixin/surrounding_space.rb +7 -2
  74. data/lib/rubocop/cop/mixin/too_many_lines.rb +3 -13
  75. data/lib/rubocop/cop/mixin/uncommunicative_name.rb +4 -2
  76. data/lib/rubocop/cop/mixin/visibility_help.rb +50 -0
  77. data/lib/rubocop/cop/naming/ascii_identifiers.rb +27 -4
  78. data/lib/rubocop/cop/naming/binary_operator_parameter_name.rb +2 -2
  79. data/lib/rubocop/cop/naming/method_name.rb +1 -1
  80. data/lib/rubocop/cop/naming/method_parameter_name.rb +1 -1
  81. data/lib/rubocop/cop/naming/predicate_name.rb +3 -5
  82. data/lib/rubocop/cop/naming/variable_name.rb +1 -1
  83. data/lib/rubocop/cop/naming/variable_number.rb +1 -1
  84. data/lib/rubocop/cop/offense.rb +16 -2
  85. data/lib/rubocop/cop/style/accessor_grouping.rb +147 -0
  86. data/lib/rubocop/cop/style/array_coercion.rb +63 -0
  87. data/lib/rubocop/cop/style/auto_resource_cleanup.rb +3 -2
  88. data/lib/rubocop/cop/style/bisected_attr_accessor.rb +146 -0
  89. data/lib/rubocop/cop/style/case_like_if.rb +217 -0
  90. data/lib/rubocop/cop/style/class_vars.rb +21 -0
  91. data/lib/rubocop/cop/style/commented_keyword.rb +5 -2
  92. data/lib/rubocop/cop/style/conditional_assignment.rb +1 -1
  93. data/lib/rubocop/cop/style/date_time.rb +1 -1
  94. data/lib/rubocop/cop/style/dir.rb +2 -2
  95. data/lib/rubocop/cop/style/empty_literal.rb +5 -5
  96. data/lib/rubocop/cop/style/expand_path_arguments.rb +2 -2
  97. data/lib/rubocop/cop/style/exponential_notation.rb +6 -8
  98. data/lib/rubocop/cop/style/float_division.rb +7 -10
  99. data/lib/rubocop/cop/style/format_string_token.rb +5 -5
  100. data/lib/rubocop/cop/style/hash_as_last_array_item.rb +62 -0
  101. data/lib/rubocop/cop/style/hash_like_case.rb +76 -0
  102. data/lib/rubocop/cop/style/if_unless_modifier.rb +11 -11
  103. data/lib/rubocop/cop/style/if_unless_modifier_of_if_unless.rb +12 -0
  104. data/lib/rubocop/cop/style/missing_else.rb +1 -11
  105. data/lib/rubocop/cop/style/multiline_block_chain.rb +10 -1
  106. data/lib/rubocop/cop/style/mutable_constant.rb +4 -4
  107. data/lib/rubocop/cop/style/nested_parenthesized_calls.rb +2 -5
  108. data/lib/rubocop/cop/style/numeric_predicate.rb +3 -4
  109. data/lib/rubocop/cop/style/parallel_assignment.rb +3 -3
  110. data/lib/rubocop/cop/style/proc.rb +1 -1
  111. data/lib/rubocop/cop/style/random_with_offset.rb +4 -10
  112. data/lib/rubocop/cop/style/redundant_assignment.rb +117 -0
  113. data/lib/rubocop/cop/style/redundant_exception.rb +14 -10
  114. data/lib/rubocop/cop/style/redundant_fetch_block.rb +122 -0
  115. data/lib/rubocop/cop/style/redundant_file_extension_in_require.rb +50 -0
  116. data/lib/rubocop/cop/style/redundant_freeze.rb +1 -1
  117. data/lib/rubocop/cop/style/redundant_parentheses.rb +7 -1
  118. data/lib/rubocop/cop/style/redundant_regexp_character_class.rb +2 -1
  119. data/lib/rubocop/cop/style/redundant_regexp_escape.rb +2 -2
  120. data/lib/rubocop/cop/style/redundant_sort.rb +3 -2
  121. data/lib/rubocop/cop/style/rescue_standard_error.rb +1 -1
  122. data/lib/rubocop/cop/style/signal_exception.rb +1 -1
  123. data/lib/rubocop/cop/style/stabby_lambda_parentheses.rb +3 -2
  124. data/lib/rubocop/cop/style/stderr_puts.rb +1 -1
  125. data/lib/rubocop/cop/style/struct_inheritance.rb +2 -2
  126. data/lib/rubocop/cop/style/symbol_proc.rb +1 -1
  127. data/lib/rubocop/cop/style/trailing_method_end_statement.rb +9 -32
  128. data/lib/rubocop/cop/style/trivial_accessors.rb +8 -7
  129. data/lib/rubocop/cop/style/yoda_condition.rb +18 -1
  130. data/lib/rubocop/cop/style/zero_length_predicate.rb +2 -2
  131. data/lib/rubocop/cop/team.rb +97 -81
  132. data/lib/rubocop/cop/utils/format_string.rb +1 -2
  133. data/lib/rubocop/cop/variable_force/variable.rb +5 -3
  134. data/lib/rubocop/file_finder.rb +4 -4
  135. data/lib/rubocop/formatter/disabled_config_formatter.rb +1 -1
  136. data/lib/rubocop/name_similarity.rb +1 -3
  137. data/lib/rubocop/options.rb +15 -8
  138. data/lib/rubocop/path_util.rb +2 -17
  139. data/lib/rubocop/rake_task.rb +6 -9
  140. data/lib/rubocop/result_cache.rb +9 -5
  141. data/lib/rubocop/rspec/cop_helper.rb +4 -4
  142. data/lib/rubocop/rspec/expect_offense.rb +52 -22
  143. data/lib/rubocop/rspec/shared_contexts.rb +8 -8
  144. data/lib/rubocop/runner.rb +33 -32
  145. data/lib/rubocop/target_ruby.rb +1 -1
  146. data/lib/rubocop/version.rb +1 -1
  147. metadata +25 -8
  148. data/lib/rubocop/cop/mixin/classish_length.rb +0 -37
@@ -101,11 +101,9 @@ module RuboCop
101
101
 
102
102
  def set_options_to_config_loader
103
103
  ConfigLoader.debug = @options[:debug]
104
- ConfigLoader.auto_gen_config = @options[:auto_gen_config]
105
104
  ConfigLoader.disable_pending_cops = @options[:disable_pending_cops]
106
105
  ConfigLoader.enable_pending_cops = @options[:enable_pending_cops]
107
106
  ConfigLoader.ignore_parent_exclusion = @options[:ignore_parent_exclusion]
108
- ConfigLoader.options_config = @options[:config]
109
107
  end
110
108
 
111
109
  def handle_exiting_options
@@ -7,6 +7,8 @@ module RuboCop
7
7
  class AutoGenerateConfig < Base
8
8
  self.command_name = :auto_gen_config
9
9
 
10
+ AUTO_GENERATED_FILE = '.rubocop_todo.yml'
11
+
10
12
  PHASE_1 = 'Phase 1 of 2: run Layout/LineLength cop'
11
13
  PHASE_2 = 'Phase 2 of 2: run all cops'
12
14
 
@@ -67,7 +69,7 @@ module RuboCop
67
69
  @options.delete(:only)
68
70
  @config_store = ConfigStore.new
69
71
  # Save the todo configuration of the LineLength cop.
70
- IO.read(ConfigLoader::AUTO_GENERATED_FILE)
72
+ IO.read(AUTO_GENERATED_FILE)
71
73
  .lines
72
74
  .drop_while { |line| line.start_with?('#') }
73
75
  .join
@@ -78,7 +80,7 @@ module RuboCop
78
80
  result = execute_runner
79
81
  # This run was made with the current maximum length allowed, so append
80
82
  # the saved setting for LineLength.
81
- File.open(ConfigLoader::AUTO_GENERATED_FILE, 'a') do |f|
83
+ File.open(AUTO_GENERATED_FILE, 'a') do |f|
82
84
  f.write(line_length_contents)
83
85
  end
84
86
  result
@@ -87,18 +89,51 @@ module RuboCop
87
89
  def reset_config_and_auto_gen_file
88
90
  @config_store = ConfigStore.new
89
91
  @config_store.options_config = @options[:config] if @options[:config]
90
- File.open(ConfigLoader::AUTO_GENERATED_FILE, 'w') {}
91
- ConfigLoader.add_inheritance_from_auto_generated_file
92
+ File.open(AUTO_GENERATED_FILE, 'w') {}
93
+ add_inheritance_from_auto_generated_file(@options[:config])
92
94
  end
93
95
 
94
96
  def add_formatter
95
97
  @options[:formatters] << [Formatter::DisabledConfigFormatter,
96
- ConfigLoader::AUTO_GENERATED_FILE]
98
+ AUTO_GENERATED_FILE]
97
99
  end
98
100
 
99
101
  def execute_runner
100
102
  Environment.new(@options, @config_store, @paths).run(:execute_runner)
101
103
  end
104
+
105
+ def add_inheritance_from_auto_generated_file(config_file)
106
+ file_string = " #{AUTO_GENERATED_FILE}"
107
+
108
+ config_file ||= ConfigLoader::DOTFILE
109
+
110
+ if File.exist?(config_file)
111
+ files = Array(ConfigLoader.load_yaml_configuration(config_file)['inherit_from'])
112
+
113
+ return if files.include?(AUTO_GENERATED_FILE)
114
+
115
+ files.unshift(AUTO_GENERATED_FILE)
116
+ file_string = "\n - " + files.join("\n - ") if files.size > 1
117
+ rubocop_yml_contents = existing_configuration(config_file)
118
+ end
119
+
120
+ write_config_file(config_file, file_string, rubocop_yml_contents)
121
+
122
+ puts "Added inheritance from `#{AUTO_GENERATED_FILE}` in `#{ConfigLoader::DOTFILE}`."
123
+ end
124
+
125
+ def existing_configuration(config_file)
126
+ IO.read(config_file, encoding: Encoding::UTF_8)
127
+ .sub(/^inherit_from: *[^\n]+/, '')
128
+ .sub(/^inherit_from: *(\n *- *[^\n]+)+/, '')
129
+ end
130
+
131
+ def write_config_file(file_name, file_string, rubocop_yml_contents)
132
+ File.open(file_name, 'w') do |f|
133
+ f.write "inherit_from:#{file_string}\n"
134
+ f.write "\n#{rubocop_yml_contents}" if /\S/.match?(rubocop_yml_contents)
135
+ end
136
+ end
102
137
  end
103
138
  end
104
139
  end
@@ -27,7 +27,7 @@ module RuboCop
27
27
  # RuboCop will start looking for the configuration file in the directory
28
28
  # where the inspected file is and continue its way up to the root directory.
29
29
  #
30
- # See https://github.com/zspencer/rbhint/blob/development/manual/configuration.md
30
+ # See https://docs.rubocop.org/rubocop/configuration
31
31
  DESC
32
32
 
33
33
  File.open(DOTFILE, 'w') do |f|
@@ -49,7 +49,7 @@ module RuboCop
49
49
 
50
50
  def print_cop_details(cops)
51
51
  cops.each do |cop|
52
- puts '# Supports --auto-correct' if cop.new(@config).support_autocorrect?
52
+ puts '# Supports --auto-correct' if cop.support_autocorrect?
53
53
  puts "#{cop.cop_name}:"
54
54
  puts config_lines(cop)
55
55
  puts
@@ -18,21 +18,19 @@ module RuboCop
18
18
  XDG_CONFIG = 'config.yml'
19
19
  RUBOCOP_HOME = File.realpath(File.join(File.dirname(__FILE__), '..', '..'))
20
20
  DEFAULT_FILE = File.join(RUBOCOP_HOME, 'config', 'default.yml')
21
- AUTO_GENERATED_FILE = '.rubocop_todo.yml'
22
21
 
23
22
  class << self
24
23
  include FileFinder
25
24
 
26
- attr_accessor :debug, :auto_gen_config, :ignore_parent_exclusion,
27
- :options_config, :disable_pending_cops, :enable_pending_cops
25
+ attr_accessor :debug, :ignore_parent_exclusion,
26
+ :disable_pending_cops, :enable_pending_cops
28
27
  attr_writer :default_configuration
29
28
 
30
29
  alias debug? debug
31
- alias auto_gen_config? auto_gen_config
32
30
  alias ignore_parent_exclusion? ignore_parent_exclusion
33
31
 
34
32
  def clear_options
35
- @debug = @auto_gen_config = @options_config = nil
33
+ @debug = nil
36
34
  FileFinder.root_level = nil
37
35
  end
38
36
 
@@ -55,6 +53,21 @@ module RuboCop
55
53
  Config.create(hash, path)
56
54
  end
57
55
 
56
+ def load_yaml_configuration(absolute_path)
57
+ file_contents = read_file(absolute_path)
58
+ yaml_code = Dir.chdir(File.dirname(absolute_path)) do
59
+ ERB.new(file_contents).result
60
+ end
61
+ check_duplication(yaml_code, absolute_path)
62
+ hash = yaml_safe_load(yaml_code, absolute_path) || {}
63
+
64
+ puts "configuration from #{absolute_path}" if debug?
65
+
66
+ raise(TypeError, "Malformed configuration in #{absolute_path}") unless hash.is_a?(Hash)
67
+
68
+ hash
69
+ end
70
+
58
71
  def add_missing_namespaces(path, hash)
59
72
  # Using `hash.each_key` will cause the
60
73
  # `can't add a new key into hash during iteration` error
@@ -85,7 +98,7 @@ module RuboCop
85
98
  end
86
99
 
87
100
  def configuration_from_file(config_file)
88
- return ConfigLoader.default_configuration if config_file == DEFAULT_FILE
101
+ return default_configuration if config_file == DEFAULT_FILE
89
102
 
90
103
  config = load_file(config_file)
91
104
  if ignore_parent_exclusion?
@@ -105,15 +118,13 @@ module RuboCop
105
118
  end
106
119
 
107
120
  def add_excludes_from_files(config, config_file)
108
- found_files = find_files_upwards(DOTFILE, config_file) +
109
- [find_user_dotfile, find_user_xdg_config].compact
121
+ exclusion_file = find_last_file_upwards(DOTFILE, config_file)
110
122
 
111
- return if found_files.empty?
112
- return if PathUtil.relative_path(found_files.last) ==
113
- PathUtil.relative_path(config_file)
123
+ return unless exclusion_file
124
+ return if PathUtil.relative_path(exclusion_file) == PathUtil.relative_path(config_file)
114
125
 
115
126
  print 'AllCops/Exclude ' if debug?
116
- config.add_excludes_from_higher_level(load_file(found_files.last))
127
+ config.add_excludes_from_higher_level(load_file(exclusion_file))
117
128
  end
118
129
 
119
130
  def default_configuration
@@ -139,36 +150,11 @@ module RuboCop
139
150
  warn Rainbow('For more information: https://docs.rubocop.org/rubocop/versioning.html').yellow
140
151
  end
141
152
 
142
- # Merges the given configuration with the default one. If
143
- # AllCops:DisabledByDefault is true, it changes the Enabled params so
144
- # that only cops from user configuration are enabled.
145
- # If AllCops::EnabledByDefault is true, it changes the Enabled params
146
- # so that only cops explicitly disabled in user configuration are
147
- # disabled.
153
+ # Merges the given configuration with the default one.
148
154
  def merge_with_default(config, config_file, unset_nil: true)
149
155
  resolver.merge_with_default(config, config_file, unset_nil: unset_nil)
150
156
  end
151
157
 
152
- def add_inheritance_from_auto_generated_file
153
- file_string = " #{AUTO_GENERATED_FILE}"
154
-
155
- config_file = options_config || DOTFILE
156
-
157
- if File.exist?(config_file)
158
- files = Array(load_yaml_configuration(config_file)['inherit_from'])
159
-
160
- return if files.include?(AUTO_GENERATED_FILE)
161
-
162
- files.unshift(AUTO_GENERATED_FILE)
163
- file_string = "\n - " + files.join("\n - ") if files.size > 1
164
- rubocop_yml_contents = existing_configuration(config_file)
165
- end
166
-
167
- write_config_file(config_file, file_string, rubocop_yml_contents)
168
-
169
- puts "Added inheritance from `#{AUTO_GENERATED_FILE}` in `#{DOTFILE}`."
170
- end
171
-
172
158
  private
173
159
 
174
160
  def find_project_dotfile(target_dir)
@@ -196,38 +182,10 @@ module RuboCop
196
182
  path
197
183
  end
198
184
 
199
- def existing_configuration(config_file)
200
- IO.read(config_file, encoding: Encoding::UTF_8)
201
- .sub(/^inherit_from: *[^\n]+/, '')
202
- .sub(/^inherit_from: *(\n *- *[^\n]+)+/, '')
203
- end
204
-
205
- def write_config_file(file_name, file_string, rubocop_yml_contents)
206
- File.open(file_name, 'w') do |f|
207
- f.write "inherit_from:#{file_string}\n"
208
- f.write "\n#{rubocop_yml_contents}" if /\S/.match?(rubocop_yml_contents)
209
- end
210
- end
211
-
212
185
  def resolver
213
186
  @resolver ||= ConfigLoaderResolver.new
214
187
  end
215
188
 
216
- def load_yaml_configuration(absolute_path)
217
- file_contents = read_file(absolute_path)
218
- yaml_code = Dir.chdir(File.dirname(absolute_path)) do
219
- ERB.new(file_contents).result
220
- end
221
- check_duplication(yaml_code, absolute_path)
222
- hash = yaml_safe_load(yaml_code, absolute_path) || {}
223
-
224
- puts "configuration from #{absolute_path}" if debug?
225
-
226
- raise(TypeError, "Malformed configuration in #{absolute_path}") unless hash.is_a?(Hash)
227
-
228
- hash
229
- end
230
-
231
189
  def check_duplication(yaml_code, absolute_path)
232
190
  smart_path = PathUtil.smart_path(absolute_path)
233
191
  YAMLDuplicationChecker.check(yaml_code, absolute_path) do |key1, key2|
@@ -63,7 +63,6 @@ module RuboCop
63
63
  'Layout/SpaceAfterControlKeyword' => 'Layout/SpaceAroundKeyword',
64
64
  'Layout/SpaceBeforeModifierKeyword' => 'Layout/SpaceAroundKeyword',
65
65
  'Lint/RescueWithoutErrorClass' => 'Style/RescueStandardError',
66
- 'Rails/DefaultScope' => nil,
67
66
  'Style/SpaceAfterControlKeyword' => 'Layout/SpaceAroundKeyword',
68
67
  'Style/SpaceBeforeModifierKeyword' => 'Layout/SpaceAroundKeyword',
69
68
  'Style/TrailingComma' => 'Style/TrailingCommaInArguments, ' \
@@ -13,11 +13,7 @@ module RuboCop
13
13
  end
14
14
 
15
15
  def correctable?
16
- support_autocorrect? || disable_uncorrectable?
17
- end
18
-
19
- def support_autocorrect?
20
- respond_to?(:autocorrect)
16
+ self.class.support_autocorrect? || disable_uncorrectable?
21
17
  end
22
18
 
23
19
  def disable_uncorrectable?
@@ -40,8 +36,9 @@ module RuboCop
40
36
  true
41
37
  end
42
38
 
43
- def disable_offense(node)
44
- range = node.location.expression
39
+ private
40
+
41
+ def disable_offense(range)
45
42
  eol_comment = " # rubocop:todo #{cop_name}"
46
43
  needed_line_length = (range.source_line + eol_comment).length
47
44
  if needed_line_length <= max_line_length
@@ -52,8 +49,6 @@ module RuboCop
52
49
  end
53
50
  end
54
51
 
55
- private
56
-
57
52
  def range_of_first_line(range)
58
53
  begin_of_first_line = range.begin_pos - range.column
59
54
  end_of_first_line = begin_of_first_line + range.source_line.length
@@ -78,27 +73,22 @@ module RuboCop
78
73
  end
79
74
 
80
75
  def max_line_length
81
- config.for_cop('Layout/LineLength')['Max'] || 80
76
+ config.for_cop('Layout/LineLength')['Max'] || 120
82
77
  end
83
78
 
84
79
  def disable_offense_at_end_of_line(range, eol_comment)
85
- ->(corrector) { corrector.insert_after(range, eol_comment) }
80
+ Corrector.new(range).insert_after(range, eol_comment)
86
81
  end
87
82
 
88
83
  def disable_offense_before_and_after(range_by_lines)
89
- lambda do |corrector|
90
- range_with_newline = range_by_lines.resize(range_by_lines.size + 1)
91
- leading_whitespace = range_by_lines.source_line[/^\s*/]
92
-
93
- corrector.insert_before(
94
- range_with_newline,
95
- "#{leading_whitespace}# rubocop:todo #{cop_name}\n"
96
- )
97
- corrector.insert_after(
98
- range_with_newline,
99
- "#{leading_whitespace}# rubocop:enable #{cop_name}\n"
100
- )
101
- end
84
+ range_with_newline = range_by_lines.resize(range_by_lines.size + 1)
85
+ leading_whitespace = range_by_lines.source_line[/^\s*/]
86
+
87
+ Corrector.new(range_by_lines).wrap(
88
+ range_with_newline,
89
+ "#{leading_whitespace}# rubocop:todo #{cop_name}\n",
90
+ "#{leading_whitespace}# rubocop:enable #{cop_name}\n"
91
+ )
102
92
  end
103
93
  end
104
94
  end
@@ -58,7 +58,7 @@ module RuboCop
58
58
  end
59
59
 
60
60
  def to_s
61
- qualified? ? "#{department}/#{cop_name}" : cop_name
61
+ @to_s ||= qualified? ? "#{department}/#{cop_name}" : cop_name
62
62
  end
63
63
 
64
64
  def qualified?
@@ -0,0 +1,407 @@
1
+ # frozen_string_literal: true
2
+
3
+ module RuboCop
4
+ module Cop
5
+ # A scaffold for concrete cops.
6
+ #
7
+ # The Cop::Base class is meant to be extended.
8
+ #
9
+ # Cops track offenses and can autocorrect them on the fly.
10
+ #
11
+ # A commissioner object is responsible for traversing the AST and invoking
12
+ # the specific callbacks on each cop.
13
+ #
14
+ # First the callback `on_new_investigation` is called;
15
+ # if a cop needs to do its own processing of the AST or depends on
16
+ # something else.
17
+ #
18
+ # Then callbacks like `on_def`, `on_send` (see AST::Traversal) are called
19
+ # with their respective nodes.
20
+ #
21
+ # Finally the callback `on_investigation_end` is called.
22
+ #
23
+ # Within these callbacks, cops are meant to call `add_offense` or
24
+ # `add_global_offense`. Use the `processed_source` method to
25
+ # get the currently processed source being investigated.
26
+ #
27
+ # In case of invalid syntax / unparseable content,
28
+ # the callback `on_other_file` is called instead of all the other
29
+ # `on_...` callbacks.
30
+ #
31
+ # Private methods are not meant for custom cops consumption,
32
+ # nor are any instance variables.
33
+ #
34
+ class Base # rubocop:disable Metrics/ClassLength
35
+ extend RuboCop::AST::Sexp
36
+ extend NodePattern::Macros
37
+ include RuboCop::AST::Sexp
38
+ include Util
39
+ include IgnoredNode
40
+ include AutocorrectLogic
41
+
42
+ attr_reader :config, :processed_source
43
+
44
+ # Reports of an investigation.
45
+ # Immutable
46
+ # Consider creation API private
47
+ InvestigationReport = Struct.new(:cop, :processed_source, :offenses, :corrector)
48
+
49
+ # List of cops that should not try to autocorrect at the same
50
+ # time as this cop
51
+ #
52
+ # @return [Array<RuboCop::Cop::Cop>]
53
+ #
54
+ # @api public
55
+ def self.autocorrect_incompatible_with
56
+ []
57
+ end
58
+
59
+ def initialize(config = nil, options = nil)
60
+ @config = config || Config.new
61
+ @options = options || { debug: false }
62
+ reset_investigation
63
+ end
64
+
65
+ # Called before all on_... have been called
66
+ # When refining this method, always call `super`
67
+ def on_new_investigation
68
+ # Typically do nothing here
69
+ end
70
+
71
+ # Called after all on_... have been called
72
+ # When refining this method, always call `super`
73
+ def on_investigation_end
74
+ # Typically do nothing here
75
+ end
76
+
77
+ # Called instead of all on_... callbacks for unrecognized files / syntax errors
78
+ # When refining this method, always call `super`
79
+ def on_other_file
80
+ # Typically do nothing here
81
+ end
82
+
83
+ # Override and return the Force class(es) you need to join
84
+ def self.joining_forces; end
85
+
86
+ # Gets called if no message is specified when calling `add_offense` or
87
+ # `add_global_offense`
88
+ # Cops are discouraged to override this; instead pass your message directly
89
+ def message(_range = nil)
90
+ self.class::MSG
91
+ end
92
+
93
+ # Adds an offense that has no particular location.
94
+ # No correction can be applied to global offenses
95
+ def add_global_offense(message = nil, severity: nil)
96
+ severity = find_severity(nil, severity)
97
+ message = find_message(nil, message)
98
+ @current_offenses <<
99
+ Offense.new(severity, Offense::NO_LOCATION, message, name, :unsupported)
100
+ end
101
+
102
+ # Adds an offense on the specified range (or node with an expression)
103
+ # Unless that offense is disabled for this range, a corrector will be yielded
104
+ # to provide the cop the opportunity to autocorrect the offense.
105
+ # If message is not specified, the method `message` will be called.
106
+ def add_offense(node_or_range, message: nil, severity: nil, &block)
107
+ range = range_from_node_or_range(node_or_range)
108
+ return unless current_offense_locations.add?(range)
109
+
110
+ range_to_pass = callback_argument(range)
111
+
112
+ severity = find_severity(range_to_pass, severity)
113
+ message = find_message(range_to_pass, message)
114
+
115
+ status, corrector = enabled_line?(range.line) ? correct(range, &block) : :disabled
116
+
117
+ @current_offenses << Offense.new(severity, range, message, name, status, corrector)
118
+ end
119
+
120
+ # This method should be overridden when a cop's behavior depends
121
+ # on state that lives outside of these locations:
122
+ #
123
+ # (1) the file under inspection
124
+ # (2) the cop's source code
125
+ # (3) the config (eg a .rubocop.yml file)
126
+ #
127
+ # For example, some cops may want to look at other parts of
128
+ # the codebase being inspected to find violations. A cop may
129
+ # use the presence or absence of file `foo.rb` to determine
130
+ # whether a certain violation exists in `bar.rb`.
131
+ #
132
+ # Overriding this method allows the cop to indicate to RuboCop's
133
+ # ResultCache system when those external dependencies change,
134
+ # ie when the ResultCache should be invalidated.
135
+ def external_dependency_checksum
136
+ nil
137
+ end
138
+
139
+ def self.inherited(subclass)
140
+ Registry.global.enlist(subclass)
141
+ end
142
+
143
+ # Call for abstract Cop classes
144
+ def self.exclude_from_registry
145
+ Registry.global.dismiss(self)
146
+ end
147
+
148
+ # Returns if class supports auto_correct.
149
+ # It is recommended to extend AutoCorrector instead of overriding
150
+ def self.support_autocorrect?
151
+ false
152
+ end
153
+
154
+ ### Naming
155
+
156
+ def self.badge
157
+ @badge ||= Badge.for(name)
158
+ end
159
+
160
+ def self.cop_name
161
+ badge.to_s
162
+ end
163
+
164
+ def self.department
165
+ badge.department
166
+ end
167
+
168
+ def self.lint?
169
+ department == :Lint
170
+ end
171
+
172
+ # Returns true if the cop name or the cop namespace matches any of the
173
+ # given names.
174
+ def self.match?(given_names)
175
+ return false unless given_names
176
+
177
+ given_names.include?(cop_name) ||
178
+ given_names.include?(department.to_s)
179
+ end
180
+
181
+ def cop_name
182
+ @cop_name ||= self.class.cop_name
183
+ end
184
+
185
+ alias name cop_name
186
+
187
+ ### Configuration Helpers
188
+
189
+ def cop_config
190
+ # Use department configuration as basis, but let individual cop
191
+ # configuration override.
192
+ @cop_config ||= @config.for_cop(self.class.department.to_s)
193
+ .merge(@config.for_cop(self))
194
+ end
195
+
196
+ def config_to_allow_offenses
197
+ Formatter::DisabledConfigFormatter
198
+ .config_to_allow_offenses[cop_name] ||= {}
199
+ end
200
+
201
+ def config_to_allow_offenses=(hash)
202
+ Formatter::DisabledConfigFormatter.config_to_allow_offenses[cop_name] =
203
+ hash
204
+ end
205
+
206
+ def target_ruby_version
207
+ @config.target_ruby_version
208
+ end
209
+
210
+ def target_rails_version
211
+ @config.target_rails_version
212
+ end
213
+
214
+ def relevant_file?(file)
215
+ file == RuboCop::AST::ProcessedSource::STRING_SOURCE_NAME ||
216
+ file_name_matches_any?(file, 'Include', true) &&
217
+ !file_name_matches_any?(file, 'Exclude', false)
218
+ end
219
+
220
+ def excluded_file?(file)
221
+ !relevant_file?(file)
222
+ end
223
+
224
+ ### Persistence
225
+
226
+ # Override if your cop should be called repeatedly for multiple investigations
227
+ # Between calls to `on_new_investigation` and `on_investigation_end`,
228
+ # the result of `processed_source` will remain constant.
229
+ # You should invalidate any caches that depend on the current `processed_source`
230
+ # in the `on_new_investigation` callback.
231
+ # If your cop does autocorrections, be aware that your instance may be called
232
+ # multiple times with the same `processed_source.path` but different content.
233
+ def self.support_multiple_source?
234
+ false
235
+ end
236
+
237
+ # @api private
238
+ # Called between investigations
239
+ def ready
240
+ return self if self.class.support_multiple_source?
241
+
242
+ self.class.new(@config, @options)
243
+ end
244
+
245
+ ### Reserved for Cop::Cop
246
+
247
+ # @deprecated Make potential errors with previous API more obvious
248
+ def offenses
249
+ raise 'The offenses are not directly available; ' \
250
+ 'they are returned as the result of the investigation'
251
+ end
252
+
253
+ private
254
+
255
+ ### Reserved for Cop::Cop
256
+
257
+ def callback_argument(range)
258
+ range
259
+ end
260
+
261
+ def apply_correction(corrector)
262
+ @current_corrector&.merge!(corrector) if corrector
263
+ end
264
+
265
+ def correction_strategy
266
+ return :unsupported unless correctable?
267
+ return :uncorrected unless autocorrect?
268
+
269
+ :attempt_correction
270
+ end
271
+
272
+ ### Reserved for Commissioner:
273
+
274
+ def current_offense_locations
275
+ @current_offense_locations ||= Set.new
276
+ end
277
+
278
+ def currently_disabled_lines
279
+ @currently_disabled_lines ||= Set.new
280
+ end
281
+
282
+ # Called before any investigation
283
+ def begin_investigation(processed_source)
284
+ @current_offenses = []
285
+ @current_offense_locations = nil
286
+ @currently_disabled_lines = nil
287
+ @processed_source = processed_source
288
+ @current_corrector = Corrector.new(@processed_source) if @processed_source.valid_syntax?
289
+ end
290
+
291
+ # Called to complete an investigation
292
+ def complete_investigation
293
+ InvestigationReport.new(self, processed_source, @current_offenses, @current_corrector)
294
+ ensure
295
+ reset_investigation
296
+ end
297
+
298
+ ### Actually private methods
299
+
300
+ def reset_investigation
301
+ @currently_disabled_lines = @current_offenses = @processed_source = @current_corrector = nil
302
+ end
303
+
304
+ # @return [Symbol, Corrector] offense status
305
+ def correct(range)
306
+ status = correction_strategy
307
+
308
+ if block_given?
309
+ corrector = Corrector.new(self)
310
+ yield corrector
311
+ if !corrector.empty? && !self.class.support_autocorrect?
312
+ raise "The Cop #{name} must `extend AutoCorrector` to be able to autocorrect"
313
+ end
314
+ end
315
+
316
+ status = attempt_correction(range, corrector) if status == :attempt_correction
317
+
318
+ [status, corrector]
319
+ end
320
+
321
+ # @return [Symbol] offense status
322
+ def attempt_correction(range, corrector)
323
+ if corrector && !corrector.empty?
324
+ status = :corrected
325
+ elsif disable_uncorrectable?
326
+ corrector = disable_uncorrectable(range)
327
+ status = :corrected_with_todo
328
+ else
329
+ return :uncorrected
330
+ end
331
+
332
+ apply_correction(corrector) if corrector
333
+ status
334
+ end
335
+
336
+ def disable_uncorrectable(range)
337
+ line = range.line
338
+ return unless currently_disabled_lines.add?(line)
339
+
340
+ disable_offense(range)
341
+ end
342
+
343
+ def range_from_node_or_range(node_or_range)
344
+ if node_or_range.respond_to?(:loc)
345
+ node_or_range.loc.expression
346
+ elsif node_or_range.is_a?(::Parser::Source::Range)
347
+ node_or_range
348
+ else
349
+ extra = ' (call `add_global_offense`)' if node_or_range.nil?
350
+ raise "Expected a Source::Range, got #{node_or_range.inspect}#{extra}"
351
+ end
352
+ end
353
+
354
+ def find_message(range, message)
355
+ annotate(message || message(range))
356
+ end
357
+
358
+ def annotate(message)
359
+ RuboCop::Cop::MessageAnnotator.new(
360
+ config, cop_name, cop_config, @options
361
+ ).annotate(message)
362
+ end
363
+
364
+ def file_name_matches_any?(file, parameter, default_result)
365
+ patterns = cop_config[parameter]
366
+ return default_result unless patterns
367
+
368
+ path = nil
369
+ patterns.any? do |pattern|
370
+ # Try to match the absolute path, as Exclude properties are absolute.
371
+ next true if match_path?(pattern, file)
372
+
373
+ # Try with relative path.
374
+ path ||= config.path_relative_to_config(file)
375
+ match_path?(pattern, path)
376
+ end
377
+ end
378
+
379
+ def enabled_line?(line_number)
380
+ return true if @options[:ignore_disable_comments] || !@processed_source
381
+
382
+ @processed_source.comment_config.cop_enabled_at_line?(self, line_number)
383
+ end
384
+
385
+ def find_severity(_range, severity)
386
+ custom_severity || severity || default_severity
387
+ end
388
+
389
+ def default_severity
390
+ self.class.lint? ? :warning : :convention
391
+ end
392
+
393
+ def custom_severity
394
+ severity = cop_config['Severity']
395
+ return unless severity
396
+
397
+ if Severity::NAMES.include?(severity.to_sym)
398
+ severity.to_sym
399
+ else
400
+ message = "Warning: Invalid severity '#{severity}'. " \
401
+ "Valid severities are #{Severity::NAMES.join(', ')}."
402
+ warn(Rainbow(message).red)
403
+ end
404
+ end
405
+ end
406
+ end
407
+ end