rubocop 1.41.1 → 1.45.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/LICENSE.txt +1 -1
- data/README.md +2 -2
- data/config/default.yml +97 -31
- data/lib/rubocop/cli.rb +55 -9
- data/lib/rubocop/config.rb +7 -7
- data/lib/rubocop/config_loader.rb +12 -15
- data/lib/rubocop/config_loader_resolver.rb +8 -5
- data/lib/rubocop/cop/base.rb +89 -70
- data/lib/rubocop/cop/commissioner.rb +8 -2
- data/lib/rubocop/cop/cop.rb +51 -31
- data/lib/rubocop/cop/corrector.rb +30 -10
- data/lib/rubocop/cop/correctors/ordered_gem_corrector.rb +1 -6
- data/lib/rubocop/cop/gemspec/dependency_version.rb +16 -18
- data/lib/rubocop/cop/gemspec/development_dependencies.rb +107 -0
- data/lib/rubocop/cop/internal_affairs/redundant_let_rubocop_config_new.rb +11 -3
- data/lib/rubocop/cop/layout/array_alignment.rb +1 -1
- data/lib/rubocop/cop/layout/block_end_newline.rb +7 -1
- data/lib/rubocop/cop/layout/class_structure.rb +31 -23
- data/lib/rubocop/cop/layout/closing_parenthesis_indentation.rb +2 -6
- data/lib/rubocop/cop/layout/comment_indentation.rb +3 -1
- data/lib/rubocop/cop/layout/first_argument_indentation.rb +1 -1
- data/lib/rubocop/cop/layout/heredoc_indentation.rb +6 -9
- data/lib/rubocop/cop/layout/indentation_style.rb +4 -1
- data/lib/rubocop/cop/layout/line_continuation_spacing.rb +6 -6
- data/lib/rubocop/cop/layout/multiline_block_layout.rb +1 -1
- data/lib/rubocop/cop/layout/space_around_keyword.rb +2 -2
- data/lib/rubocop/cop/layout/space_around_operators.rb +1 -1
- data/lib/rubocop/cop/layout/space_inside_array_literal_brackets.rb +11 -13
- data/lib/rubocop/cop/layout/space_inside_reference_brackets.rb +4 -4
- data/lib/rubocop/cop/layout/space_inside_string_interpolation.rb +5 -4
- data/lib/rubocop/cop/layout/trailing_whitespace.rb +5 -2
- data/lib/rubocop/cop/lint/ambiguous_operator.rb +4 -0
- data/lib/rubocop/cop/lint/debugger.rb +8 -27
- data/lib/rubocop/cop/lint/deprecated_class_methods.rb +62 -112
- data/lib/rubocop/cop/lint/else_layout.rb +2 -6
- data/lib/rubocop/cop/lint/format_parameter_mismatch.rb +14 -7
- data/lib/rubocop/cop/lint/heredoc_method_call_position.rb +15 -17
- data/lib/rubocop/cop/lint/implicit_string_concatenation.rb +1 -1
- data/lib/rubocop/cop/lint/mixed_regexp_capture_types.rb +1 -0
- data/lib/rubocop/cop/lint/nested_method_definition.rb +8 -5
- data/lib/rubocop/cop/lint/out_of_range_regexp_ref.rb +19 -0
- data/lib/rubocop/cop/lint/redundant_require_statement.rb +11 -1
- data/lib/rubocop/cop/lint/regexp_as_condition.rb +6 -0
- data/lib/rubocop/cop/lint/require_parentheses.rb +3 -1
- data/lib/rubocop/cop/lint/unused_method_argument.rb +2 -1
- data/lib/rubocop/cop/lint/useless_access_modifier.rb +7 -4
- data/lib/rubocop/cop/lint/useless_method_definition.rb +3 -3
- data/lib/rubocop/cop/lint/useless_rescue.rb +85 -0
- data/lib/rubocop/cop/lint/useless_ruby2_keywords.rb +14 -4
- data/lib/rubocop/cop/lint/void.rb +19 -10
- data/lib/rubocop/cop/metrics/block_length.rb +1 -1
- data/lib/rubocop/cop/metrics/block_nesting.rb +1 -1
- data/lib/rubocop/cop/metrics/cyclomatic_complexity.rb +1 -1
- data/lib/rubocop/cop/metrics/parameter_lists.rb +27 -0
- data/lib/rubocop/cop/metrics/perceived_complexity.rb +1 -1
- data/lib/rubocop/cop/metrics/utils/abc_size_calculator.rb +3 -6
- data/lib/rubocop/cop/mixin/alignment.rb +1 -1
- data/lib/rubocop/cop/mixin/allowed_methods.rb +3 -1
- data/lib/rubocop/cop/mixin/annotation_comment.rb +1 -1
- data/lib/rubocop/cop/mixin/comments_help.rb +5 -3
- data/lib/rubocop/cop/mixin/hash_shorthand_syntax.rb +57 -23
- data/lib/rubocop/cop/mixin/line_length_help.rb +3 -1
- data/lib/rubocop/cop/mixin/preceding_following_alignment.rb +1 -1
- data/lib/rubocop/cop/mixin/statement_modifier.rb +1 -0
- data/lib/rubocop/cop/mixin/surrounding_space.rb +3 -3
- data/lib/rubocop/cop/mixin/trailing_comma.rb +1 -1
- data/lib/rubocop/cop/naming/block_forwarding.rb +4 -0
- data/lib/rubocop/cop/naming/class_and_module_camel_case.rb +1 -1
- data/lib/rubocop/cop/registry.rb +34 -29
- data/lib/rubocop/cop/security/compound_hash.rb +2 -1
- data/lib/rubocop/cop/style/access_modifier_declarations.rb +26 -11
- data/lib/rubocop/cop/style/arguments_forwarding.rb +1 -0
- data/lib/rubocop/cop/style/block_comments.rb +1 -1
- data/lib/rubocop/cop/style/block_delimiters.rb +8 -2
- data/lib/rubocop/cop/style/class_and_module_children.rb +3 -10
- data/lib/rubocop/cop/style/command_literal.rb +1 -1
- data/lib/rubocop/cop/style/comparable_clamp.rb +125 -0
- data/lib/rubocop/cop/style/concat_array_literals.rb +22 -2
- data/lib/rubocop/cop/style/conditional_assignment.rb +0 -6
- data/lib/rubocop/cop/style/documentation.rb +1 -1
- data/lib/rubocop/cop/style/documentation_method.rb +6 -0
- data/lib/rubocop/cop/style/guard_clause.rb +11 -7
- data/lib/rubocop/cop/style/hash_each_methods.rb +13 -1
- data/lib/rubocop/cop/style/hash_syntax.rb +11 -7
- data/lib/rubocop/cop/style/identical_conditional_branches.rb +15 -0
- data/lib/rubocop/cop/style/infinite_loop.rb +2 -5
- data/lib/rubocop/cop/style/invertible_unless_condition.rb +114 -0
- data/lib/rubocop/cop/style/map_to_set.rb +61 -0
- data/lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb +23 -14
- data/lib/rubocop/cop/style/method_call_without_args_parentheses.rb +2 -0
- data/lib/rubocop/cop/style/method_def_parentheses.rb +11 -4
- data/lib/rubocop/cop/style/min_max_comparison.rb +83 -0
- data/lib/rubocop/cop/style/missing_else.rb +13 -1
- data/lib/rubocop/cop/style/multiline_if_modifier.rb +0 -4
- data/lib/rubocop/cop/style/multiline_memoization.rb +2 -2
- data/lib/rubocop/cop/style/multiline_ternary_operator.rb +18 -3
- data/lib/rubocop/cop/style/negated_if_else_condition.rb +1 -5
- data/lib/rubocop/cop/style/numbered_parameters_limit.rb +11 -3
- data/lib/rubocop/cop/style/one_line_conditional.rb +3 -6
- data/lib/rubocop/cop/style/operator_method_call.rb +16 -2
- data/lib/rubocop/cop/style/parallel_assignment.rb +3 -1
- data/lib/rubocop/cop/style/redundant_condition.rb +16 -1
- data/lib/rubocop/cop/style/redundant_conditional.rb +0 -4
- data/lib/rubocop/cop/style/redundant_double_splat_hash_braces.rb +16 -10
- data/lib/rubocop/cop/style/redundant_heredoc_delimiter_quotes.rb +58 -0
- data/lib/rubocop/cop/style/redundant_regexp_escape.rb +2 -1
- data/lib/rubocop/cop/style/redundant_string_escape.rb +4 -2
- data/lib/rubocop/cop/style/require_order.rb +6 -11
- data/lib/rubocop/cop/style/select_by_regexp.rb +6 -2
- data/lib/rubocop/cop/style/self_assignment.rb +2 -2
- data/lib/rubocop/cop/style/semicolon.rb +24 -2
- data/lib/rubocop/cop/style/signal_exception.rb +8 -6
- data/lib/rubocop/cop/style/string_hash_keys.rb +4 -1
- data/lib/rubocop/cop/style/symbol_array.rb +1 -1
- data/lib/rubocop/cop/style/trailing_comma_in_arguments.rb +4 -4
- data/lib/rubocop/cop/style/word_array.rb +42 -1
- data/lib/rubocop/cop/style/yoda_condition.rb +12 -5
- data/lib/rubocop/cop/style/yoda_expression.rb +90 -0
- data/lib/rubocop/cop/style/zero_length_predicate.rb +31 -14
- data/lib/rubocop/cop/team.rb +48 -43
- data/lib/rubocop/cop/variable_force/scope.rb +3 -3
- data/lib/rubocop/cop/variable_force/variable_table.rb +3 -1
- data/lib/rubocop/cop/variable_force.rb +1 -4
- data/lib/rubocop/formatter.rb +0 -1
- data/lib/rubocop/options.rb +22 -1
- data/lib/rubocop/path_util.rb +17 -7
- data/lib/rubocop/result_cache.rb +1 -1
- data/lib/rubocop/rspec/expect_offense.rb +6 -4
- data/lib/rubocop/runner.rb +50 -7
- data/lib/rubocop/server/cache.rb +10 -3
- data/lib/rubocop/server/cli.rb +37 -18
- data/lib/rubocop/server/client_command/exec.rb +1 -1
- data/lib/rubocop/server/client_command/start.rb +6 -1
- data/lib/rubocop/server/core.rb +23 -8
- data/lib/rubocop/target_ruby.rb +0 -1
- data/lib/rubocop/version.rb +1 -1
- data/lib/rubocop.rb +8 -0
- metadata +21 -33
data/lib/rubocop/cop/base.rb
CHANGED
@@ -68,6 +68,64 @@ module RuboCop
|
|
68
68
|
Documentation.url_for(self) if builtin?
|
69
69
|
end
|
70
70
|
|
71
|
+
def self.inherited(subclass)
|
72
|
+
super
|
73
|
+
Registry.global.enlist(subclass)
|
74
|
+
end
|
75
|
+
|
76
|
+
# Call for abstract Cop classes
|
77
|
+
def self.exclude_from_registry
|
78
|
+
Registry.global.dismiss(self)
|
79
|
+
end
|
80
|
+
|
81
|
+
# Returns if class supports autocorrect.
|
82
|
+
# It is recommended to extend AutoCorrector instead of overriding
|
83
|
+
def self.support_autocorrect?
|
84
|
+
false
|
85
|
+
end
|
86
|
+
|
87
|
+
### Naming
|
88
|
+
|
89
|
+
def self.badge
|
90
|
+
@badge ||= Badge.for(name)
|
91
|
+
end
|
92
|
+
|
93
|
+
def self.cop_name
|
94
|
+
badge.to_s
|
95
|
+
end
|
96
|
+
|
97
|
+
def self.department
|
98
|
+
badge.department
|
99
|
+
end
|
100
|
+
|
101
|
+
def self.lint?
|
102
|
+
department == :Lint
|
103
|
+
end
|
104
|
+
|
105
|
+
# Returns true if the cop name or the cop namespace matches any of the
|
106
|
+
# given names.
|
107
|
+
def self.match?(given_names)
|
108
|
+
return false unless given_names
|
109
|
+
|
110
|
+
given_names.include?(cop_name) || given_names.include?(badge.department_name)
|
111
|
+
end
|
112
|
+
|
113
|
+
# Override and return the Force class(es) you need to join
|
114
|
+
def self.joining_forces; end
|
115
|
+
|
116
|
+
### Persistence
|
117
|
+
|
118
|
+
# Override if your cop should be called repeatedly for multiple investigations
|
119
|
+
# Between calls to `on_new_investigation` and `on_investigation_end`,
|
120
|
+
# the result of `processed_source` will remain constant.
|
121
|
+
# You should invalidate any caches that depend on the current `processed_source`
|
122
|
+
# in the `on_new_investigation` callback.
|
123
|
+
# If your cop does autocorrections, be aware that your instance may be called
|
124
|
+
# multiple times with the same `processed_source.path` but different content.
|
125
|
+
def self.support_multiple_source?
|
126
|
+
false
|
127
|
+
end
|
128
|
+
|
71
129
|
def initialize(config = nil, options = nil)
|
72
130
|
@config = config || Config.new
|
73
131
|
@options = options || { debug: false }
|
@@ -92,9 +150,6 @@ module RuboCop
|
|
92
150
|
# Typically do nothing here
|
93
151
|
end
|
94
152
|
|
95
|
-
# Override and return the Force class(es) you need to join
|
96
|
-
def self.joining_forces; end
|
97
|
-
|
98
153
|
# Gets called if no message is specified when calling `add_offense` or
|
99
154
|
# `add_global_offense`
|
100
155
|
# Cops are discouraged to override this; instead pass your message directly
|
@@ -125,6 +180,10 @@ module RuboCop
|
|
125
180
|
|
126
181
|
status, corrector = enabled_line?(range.line) ? correct(range, &block) : :disabled
|
127
182
|
|
183
|
+
# Since this range may be generated from Ruby code embedded in some
|
184
|
+
# template file, we convert it to location info in the original file.
|
185
|
+
range = range_for_original(range)
|
186
|
+
|
128
187
|
current_offenses << Offense.new(severity, range, message, name, status, corrector)
|
129
188
|
end
|
130
189
|
|
@@ -147,48 +206,6 @@ module RuboCop
|
|
147
206
|
nil
|
148
207
|
end
|
149
208
|
|
150
|
-
def self.inherited(subclass)
|
151
|
-
super
|
152
|
-
Registry.global.enlist(subclass)
|
153
|
-
end
|
154
|
-
|
155
|
-
# Call for abstract Cop classes
|
156
|
-
def self.exclude_from_registry
|
157
|
-
Registry.global.dismiss(self)
|
158
|
-
end
|
159
|
-
|
160
|
-
# Returns if class supports autocorrect.
|
161
|
-
# It is recommended to extend AutoCorrector instead of overriding
|
162
|
-
def self.support_autocorrect?
|
163
|
-
false
|
164
|
-
end
|
165
|
-
|
166
|
-
### Naming
|
167
|
-
|
168
|
-
def self.badge
|
169
|
-
@badge ||= Badge.for(name)
|
170
|
-
end
|
171
|
-
|
172
|
-
def self.cop_name
|
173
|
-
badge.to_s
|
174
|
-
end
|
175
|
-
|
176
|
-
def self.department
|
177
|
-
badge.department
|
178
|
-
end
|
179
|
-
|
180
|
-
def self.lint?
|
181
|
-
department == :Lint
|
182
|
-
end
|
183
|
-
|
184
|
-
# Returns true if the cop name or the cop namespace matches any of the
|
185
|
-
# given names.
|
186
|
-
def self.match?(given_names)
|
187
|
-
return false unless given_names
|
188
|
-
|
189
|
-
given_names.include?(cop_name) || given_names.include?(badge.department_name)
|
190
|
-
end
|
191
|
-
|
192
209
|
def cop_name
|
193
210
|
@cop_name ||= self.class.cop_name
|
194
211
|
end
|
@@ -240,19 +257,6 @@ module RuboCop
|
|
240
257
|
ProcessedSource.new(source, target_ruby_version, path)
|
241
258
|
end
|
242
259
|
|
243
|
-
### Persistence
|
244
|
-
|
245
|
-
# Override if your cop should be called repeatedly for multiple investigations
|
246
|
-
# Between calls to `on_new_investigation` and `on_investigation_end`,
|
247
|
-
# the result of `processed_source` will remain constant.
|
248
|
-
# You should invalidate any caches that depend on the current `processed_source`
|
249
|
-
# in the `on_new_investigation` callback.
|
250
|
-
# If your cop does autocorrections, be aware that your instance may be called
|
251
|
-
# multiple times with the same `processed_source.path` but different content.
|
252
|
-
def self.support_multiple_source?
|
253
|
-
false
|
254
|
-
end
|
255
|
-
|
256
260
|
# @api private
|
257
261
|
# Called between investigations
|
258
262
|
def ready
|
@@ -271,6 +275,7 @@ module RuboCop
|
|
271
275
|
|
272
276
|
### Reserved for Commissioner
|
273
277
|
|
278
|
+
# rubocop:disable Layout/ClassStructure
|
274
279
|
# @api private
|
275
280
|
def callbacks_needed
|
276
281
|
self.class.callbacks_needed
|
@@ -283,6 +288,22 @@ module RuboCop
|
|
283
288
|
!Base.method_defined?(m) # exclude standard "callbacks" like 'on_begin_investigation'
|
284
289
|
end
|
285
290
|
end
|
291
|
+
# rubocop:enable Layout/ClassStructure
|
292
|
+
|
293
|
+
# Called before any investigation
|
294
|
+
# @api private
|
295
|
+
def begin_investigation(processed_source, offset: 0, original: processed_source)
|
296
|
+
@current_offenses = nil
|
297
|
+
@current_offense_locations = nil
|
298
|
+
@currently_disabled_lines = nil
|
299
|
+
@processed_source = processed_source
|
300
|
+
@current_corrector = nil
|
301
|
+
|
302
|
+
# We need to keep track of the original source and offset,
|
303
|
+
# because `processed_source` here may be an embedded code in it.
|
304
|
+
@current_offset = offset
|
305
|
+
@current_original = original
|
306
|
+
end
|
286
307
|
|
287
308
|
private
|
288
309
|
|
@@ -318,20 +339,8 @@ module RuboCop
|
|
318
339
|
@restrict_on_send ||= self::RESTRICT_ON_SEND.to_a.freeze
|
319
340
|
end
|
320
341
|
|
321
|
-
# Called before any investigation
|
322
|
-
def begin_investigation(processed_source)
|
323
|
-
@current_offenses = nil
|
324
|
-
@current_offense_locations = nil
|
325
|
-
@currently_disabled_lines = nil
|
326
|
-
@processed_source = processed_source
|
327
|
-
@current_corrector = nil
|
328
|
-
end
|
329
|
-
|
330
|
-
# rubocop:disable Layout/ClassStructure
|
331
342
|
EMPTY_OFFENSES = [].freeze
|
332
343
|
private_constant :EMPTY_OFFENSES
|
333
|
-
# rubocop:enable Layout/ClassStructure
|
334
|
-
|
335
344
|
# Called to complete an investigation
|
336
345
|
def complete_investigation
|
337
346
|
InvestigationReport.new(
|
@@ -343,6 +352,7 @@ module RuboCop
|
|
343
352
|
|
344
353
|
### Actually private methods
|
345
354
|
|
355
|
+
# rubocop:disable Layout/ClassStructure
|
346
356
|
def self.builtin?
|
347
357
|
return false unless (m = instance_methods(false).first) # any custom method will do
|
348
358
|
|
@@ -350,6 +360,7 @@ module RuboCop
|
|
350
360
|
path.start_with?(__dir__)
|
351
361
|
end
|
352
362
|
private_class_method :builtin?
|
363
|
+
# rubocop:enable Layout/ClassStructure
|
353
364
|
|
354
365
|
def reset_investigation
|
355
366
|
@currently_disabled_lines = @current_offenses = @processed_source = @current_corrector = nil
|
@@ -458,6 +469,14 @@ module RuboCop
|
|
458
469
|
warn(Rainbow(message).red)
|
459
470
|
end
|
460
471
|
end
|
472
|
+
|
473
|
+
def range_for_original(range)
|
474
|
+
::Parser::Source::Range.new(
|
475
|
+
@current_original.buffer,
|
476
|
+
range.begin_pos + @current_offset,
|
477
|
+
range.end_pos + @current_offset
|
478
|
+
)
|
479
|
+
end
|
461
480
|
end
|
462
481
|
end
|
463
482
|
end
|
@@ -76,10 +76,10 @@ module RuboCop
|
|
76
76
|
end
|
77
77
|
|
78
78
|
# @return [InvestigationReport]
|
79
|
-
def investigate(processed_source)
|
79
|
+
def investigate(processed_source, offset: 0, original: processed_source)
|
80
80
|
reset
|
81
81
|
|
82
|
-
|
82
|
+
begin_investigation(processed_source, offset: offset, original: original)
|
83
83
|
if processed_source.valid_syntax?
|
84
84
|
invoke(:on_new_investigation, @cops)
|
85
85
|
invoke_with_argument(:investigate, @forces, processed_source)
|
@@ -95,6 +95,12 @@ module RuboCop
|
|
95
95
|
|
96
96
|
private
|
97
97
|
|
98
|
+
def begin_investigation(processed_source, offset:, original:)
|
99
|
+
@cops.each do |cop|
|
100
|
+
cop.begin_investigation(processed_source, offset: offset, original: original)
|
101
|
+
end
|
102
|
+
end
|
103
|
+
|
98
104
|
def trigger_responding_cops(callback, node)
|
99
105
|
@callbacks[callback]&.each do |cop|
|
100
106
|
with_cop_error_handling(cop, node) do
|
data/lib/rubocop/cop/cop.rb
CHANGED
@@ -22,9 +22,42 @@ module RuboCop
|
|
22
22
|
end
|
23
23
|
end
|
24
24
|
|
25
|
+
def self.support_autocorrect?
|
26
|
+
method_defined?(:autocorrect)
|
27
|
+
end
|
28
|
+
|
29
|
+
def self.joining_forces
|
30
|
+
return unless method_defined?(:join_force?)
|
31
|
+
|
32
|
+
cop = new
|
33
|
+
Force.all.select { |force_class| cop.join_force?(force_class) }
|
34
|
+
end
|
35
|
+
|
36
|
+
### Deprecated registry access
|
37
|
+
|
38
|
+
# @deprecated Use Registry.global
|
39
|
+
def self.registry
|
40
|
+
Registry.global
|
41
|
+
end
|
42
|
+
|
43
|
+
# @deprecated Use Registry.all
|
44
|
+
def self.all
|
45
|
+
Registry.all
|
46
|
+
end
|
47
|
+
|
48
|
+
# @deprecated Use Registry.qualified_cop_name
|
49
|
+
def self.qualified_cop_name(name, origin)
|
50
|
+
Registry.qualified_cop_name(name, origin)
|
51
|
+
end
|
52
|
+
|
25
53
|
def add_offense(node_or_range, location: :expression, message: nil, severity: nil, &block)
|
26
54
|
@v0_argument = node_or_range
|
27
55
|
range = find_location(node_or_range, location)
|
56
|
+
|
57
|
+
# Since this range may be generated from Ruby code embedded in some
|
58
|
+
# template file, we convert it to location info in the original file.
|
59
|
+
range = range_for_original(range)
|
60
|
+
|
28
61
|
if block.nil? && !support_autocorrect?
|
29
62
|
super(range, message: message, severity: severity)
|
30
63
|
else
|
@@ -45,17 +78,6 @@ module RuboCop
|
|
45
78
|
self.class.support_autocorrect?
|
46
79
|
end
|
47
80
|
|
48
|
-
def self.support_autocorrect?
|
49
|
-
method_defined?(:autocorrect)
|
50
|
-
end
|
51
|
-
|
52
|
-
def self.joining_forces
|
53
|
-
return unless method_defined?(:join_force?)
|
54
|
-
|
55
|
-
cop = new
|
56
|
-
Force.all.select { |force_class| cop.join_force?(force_class) }
|
57
|
-
end
|
58
|
-
|
59
81
|
# @deprecated
|
60
82
|
def corrections
|
61
83
|
# warn 'Cop#corrections is deprecated' TODO
|
@@ -76,31 +98,21 @@ module RuboCop
|
|
76
98
|
super
|
77
99
|
end
|
78
100
|
|
79
|
-
|
80
|
-
|
81
|
-
|
82
|
-
def self.registry
|
83
|
-
Registry.global
|
84
|
-
end
|
85
|
-
|
86
|
-
# @deprecated Use Registry.all
|
87
|
-
def self.all
|
88
|
-
Registry.all
|
89
|
-
end
|
90
|
-
|
91
|
-
# @deprecated Use Registry.qualified_cop_name
|
92
|
-
def self.qualified_cop_name(name, origin)
|
93
|
-
Registry.qualified_cop_name(name, origin)
|
94
|
-
end
|
95
|
-
|
96
|
-
private
|
97
|
-
|
98
|
-
def begin_investigation(processed_source)
|
101
|
+
# Called before any investigation
|
102
|
+
# @api private
|
103
|
+
def begin_investigation(processed_source, offset: 0, original: processed_source)
|
99
104
|
super
|
100
105
|
@offenses = current_offenses
|
101
106
|
@last_corrector = @current_corrector
|
107
|
+
|
108
|
+
# We need to keep track of the original source and offset,
|
109
|
+
# because `processed_source` here may be an embedded code in it.
|
110
|
+
@current_offset = offset
|
111
|
+
@current_original = original
|
102
112
|
end
|
103
113
|
|
114
|
+
private
|
115
|
+
|
104
116
|
# Override Base
|
105
117
|
def callback_argument(_range)
|
106
118
|
@v0_argument
|
@@ -141,6 +153,14 @@ module RuboCop
|
|
141
153
|
rescue ::Parser::ClobberingError
|
142
154
|
# ignore Clobbering errors
|
143
155
|
end
|
156
|
+
|
157
|
+
def range_for_original(range)
|
158
|
+
::Parser::Source::Range.new(
|
159
|
+
@current_original.buffer,
|
160
|
+
range.begin_pos + @current_offset,
|
161
|
+
range.end_pos + @current_offset
|
162
|
+
)
|
163
|
+
end
|
144
164
|
end
|
145
165
|
end
|
146
166
|
end
|
@@ -11,6 +11,20 @@ module RuboCop
|
|
11
11
|
class Corrector < ::Parser::Source::TreeRewriter
|
12
12
|
NOOP_CONSUMER = ->(diagnostic) {} # noop
|
13
13
|
|
14
|
+
# Duck typing for get to a ::Parser::Source::Buffer
|
15
|
+
def self.source_buffer(source)
|
16
|
+
source = source.processed_source if source.respond_to?(:processed_source)
|
17
|
+
source = source.buffer if source.respond_to?(:buffer)
|
18
|
+
source = source.source_buffer if source.respond_to?(:source_buffer)
|
19
|
+
|
20
|
+
unless source.is_a? ::Parser::Source::Buffer
|
21
|
+
raise TypeError, 'Expected argument to lead to a Parser::Source::Buffer ' \
|
22
|
+
"but got #{source.inspect}"
|
23
|
+
end
|
24
|
+
|
25
|
+
source
|
26
|
+
end
|
27
|
+
|
14
28
|
# @param source [Parser::Source::Buffer, or anything
|
15
29
|
# leading to one via `(processed_source.)buffer`]
|
16
30
|
#
|
@@ -64,18 +78,24 @@ module RuboCop
|
|
64
78
|
remove(to_remove)
|
65
79
|
end
|
66
80
|
|
67
|
-
#
|
68
|
-
|
69
|
-
|
70
|
-
|
71
|
-
|
81
|
+
# Swaps sources at the given ranges.
|
82
|
+
#
|
83
|
+
# @param [Parser::Source::Range, RuboCop::AST::Node] node_or_range1
|
84
|
+
# @param [Parser::Source::Range, RuboCop::AST::Node] node_or_range2
|
85
|
+
def swap(node_or_range1, node_or_range2)
|
86
|
+
range1 = to_range(node_or_range1)
|
87
|
+
range2 = to_range(node_or_range2)
|
72
88
|
|
73
|
-
|
74
|
-
|
75
|
-
|
89
|
+
if range1.end_pos == range2.begin_pos
|
90
|
+
insert_before(range1, range2.source)
|
91
|
+
remove(range2)
|
92
|
+
elsif range2.end_pos == range1.begin_pos
|
93
|
+
insert_before(range2, range1.source)
|
94
|
+
remove(range1)
|
95
|
+
else
|
96
|
+
replace(range1, range2.source)
|
97
|
+
replace(range2, range1.source)
|
76
98
|
end
|
77
|
-
|
78
|
-
source
|
79
99
|
end
|
80
100
|
|
81
101
|
private
|
@@ -18,7 +18,7 @@ module RuboCop
|
|
18
18
|
current_range = declaration_with_comment(node)
|
19
19
|
previous_range = declaration_with_comment(previous_declaration)
|
20
20
|
|
21
|
-
->(corrector) {
|
21
|
+
->(corrector) { corrector.swap(current_range, previous_range) }
|
22
22
|
end
|
23
23
|
|
24
24
|
private
|
@@ -32,11 +32,6 @@ module RuboCop
|
|
32
32
|
|
33
33
|
range_between(begin_pos, end_pos)
|
34
34
|
end
|
35
|
-
|
36
|
-
def swap_range(corrector, range1, range2)
|
37
|
-
corrector.insert_before(range2, range1.source)
|
38
|
-
corrector.remove(range1)
|
39
|
-
end
|
40
35
|
end
|
41
36
|
end
|
42
37
|
end
|
@@ -58,8 +58,13 @@ module RuboCop
|
|
58
58
|
FORBIDDEN_MSG = 'Dependency version specification is forbidden.'
|
59
59
|
VERSION_SPECIFICATION_REGEX = /^\s*[~<>=]*\s*[0-9.]+/.freeze
|
60
60
|
|
61
|
-
|
62
|
-
|
61
|
+
ADD_DEPENDENCY_METHODS = %i[
|
62
|
+
add_dependency add_runtime_dependency add_development_dependency
|
63
|
+
].freeze
|
64
|
+
RESTRICT_ON_SEND = ADD_DEPENDENCY_METHODS
|
65
|
+
|
66
|
+
# @!method add_dependency_method_declaration?(node)
|
67
|
+
def_node_matcher :add_dependency_method_declaration?, <<~PATTERN
|
63
68
|
(send
|
64
69
|
(lvar #match_block_variable_name?) #add_dependency_method? ...)
|
65
70
|
PATTERN
|
@@ -74,18 +79,15 @@ module RuboCop
|
|
74
79
|
(send _ #add_dependency_method? <(hash <(pair (sym {:branch :ref :tag}) (str _)) ...>) ...>)
|
75
80
|
PATTERN
|
76
81
|
|
77
|
-
def
|
78
|
-
return
|
79
|
-
|
80
|
-
add_dependency_method_nodes.each do |node|
|
81
|
-
next if allowed_gem?(node)
|
82
|
+
def on_send(node)
|
83
|
+
return unless add_dependency_method_declaration?(node)
|
84
|
+
return if allowed_gem?(node)
|
82
85
|
|
83
|
-
|
84
|
-
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
end
|
86
|
+
if offense?(node)
|
87
|
+
add_offense(node)
|
88
|
+
opposite_style_detected
|
89
|
+
else
|
90
|
+
correct_style_detected
|
89
91
|
end
|
90
92
|
end
|
91
93
|
|
@@ -116,11 +118,7 @@ module RuboCop
|
|
116
118
|
end
|
117
119
|
|
118
120
|
def add_dependency_method?(method_name)
|
119
|
-
|
120
|
-
end
|
121
|
-
|
122
|
-
def add_dependency_method_nodes
|
123
|
-
add_dependency_method_declarations(processed_source.ast)
|
121
|
+
ADD_DEPENDENCY_METHODS.include?(method_name)
|
124
122
|
end
|
125
123
|
|
126
124
|
def offense?(node)
|
@@ -0,0 +1,107 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module RuboCop
|
4
|
+
module Cop
|
5
|
+
module Gemspec
|
6
|
+
# Enforce that development dependencies for a gem are specified in
|
7
|
+
# `Gemfile`, rather than in the `gemspec` using
|
8
|
+
# `add_development_dependency`. Alternatively, using `EnforcedStyle:
|
9
|
+
# gemspec`, enforce that all dependencies are specified in `gemspec`,
|
10
|
+
# rather than in `Gemfile`.
|
11
|
+
#
|
12
|
+
# @example EnforcedStyle: Gemfile (default)
|
13
|
+
# # Specify runtime dependencies in your gemspec,
|
14
|
+
# # but all other dependencies in your Gemfile.
|
15
|
+
#
|
16
|
+
# # bad
|
17
|
+
# # example.gemspec
|
18
|
+
# s.add_development_dependency "foo"
|
19
|
+
#
|
20
|
+
# # good
|
21
|
+
# # Gemfile
|
22
|
+
# gem "foo"
|
23
|
+
#
|
24
|
+
# # good
|
25
|
+
# # gems.rb
|
26
|
+
# gem "foo"
|
27
|
+
#
|
28
|
+
# # good (with AllowedGems: ["bar"])
|
29
|
+
# # example.gemspec
|
30
|
+
# s.add_development_dependency "bar"
|
31
|
+
#
|
32
|
+
# @example EnforcedStyle: gems.rb
|
33
|
+
# # Specify runtime dependencies in your gemspec,
|
34
|
+
# # but all other dependencies in your Gemfile.
|
35
|
+
# #
|
36
|
+
# # Identical to `EnforcedStyle: Gemfile`, but with a different error message.
|
37
|
+
# # Rely on Bundler/GemFilename to enforce the use of `Gemfile` vs `gems.rb`.
|
38
|
+
#
|
39
|
+
# # bad
|
40
|
+
# # example.gemspec
|
41
|
+
# s.add_development_dependency "foo"
|
42
|
+
#
|
43
|
+
# # good
|
44
|
+
# # Gemfile
|
45
|
+
# gem "foo"
|
46
|
+
#
|
47
|
+
# # good
|
48
|
+
# # gems.rb
|
49
|
+
# gem "foo"
|
50
|
+
#
|
51
|
+
# # good (with AllowedGems: ["bar"])
|
52
|
+
# # example.gemspec
|
53
|
+
# s.add_development_dependency "bar"
|
54
|
+
#
|
55
|
+
# @example EnforcedStyle: gemspec
|
56
|
+
# # Specify all dependencies in your gemspec.
|
57
|
+
#
|
58
|
+
# # bad
|
59
|
+
# # Gemfile
|
60
|
+
# gem "foo"
|
61
|
+
#
|
62
|
+
# # good
|
63
|
+
# # example.gemspec
|
64
|
+
# s.add_development_dependency "foo"
|
65
|
+
#
|
66
|
+
# # good (with AllowedGems: ["bar"])
|
67
|
+
# # Gemfile
|
68
|
+
# gem "bar"
|
69
|
+
#
|
70
|
+
class DevelopmentDependencies < Base
|
71
|
+
include ConfigurableEnforcedStyle
|
72
|
+
|
73
|
+
MSG = 'Specify development dependencies in %<preferred>s.'
|
74
|
+
RESTRICT_ON_SEND = %i[add_development_dependency gem].freeze
|
75
|
+
|
76
|
+
# @!method add_development_dependency?(node)
|
77
|
+
def_node_matcher :add_development_dependency?, <<~PATTERN
|
78
|
+
(send _ :add_development_dependency (str #forbidden_gem? ...))
|
79
|
+
PATTERN
|
80
|
+
|
81
|
+
# @!method gem?(node)
|
82
|
+
def_node_matcher :gem?, <<~PATTERN
|
83
|
+
(send _ :gem (str #forbidden_gem? ...))
|
84
|
+
PATTERN
|
85
|
+
|
86
|
+
def on_send(node)
|
87
|
+
case style
|
88
|
+
when :Gemfile, :'gems.rb'
|
89
|
+
add_offense(node) if add_development_dependency?(node)
|
90
|
+
when :gemspec
|
91
|
+
add_offense(node) if gem?(node)
|
92
|
+
end
|
93
|
+
end
|
94
|
+
|
95
|
+
private
|
96
|
+
|
97
|
+
def forbidden_gem?(gem_name)
|
98
|
+
!cop_config['AllowedGems'].include?(gem_name)
|
99
|
+
end
|
100
|
+
|
101
|
+
def message(_range)
|
102
|
+
format(MSG, preferred: style)
|
103
|
+
end
|
104
|
+
end
|
105
|
+
end
|
106
|
+
end
|
107
|
+
end
|
@@ -31,9 +31,17 @@ module RuboCop
|
|
31
31
|
(send nil? :let
|
32
32
|
(sym :config))
|
33
33
|
(args)
|
34
|
-
|
35
|
-
(
|
36
|
-
(const
|
34
|
+
{
|
35
|
+
(send
|
36
|
+
(const
|
37
|
+
(const nil? :RuboCop) :Config) :new)
|
38
|
+
(send
|
39
|
+
(const
|
40
|
+
(const nil? :RuboCop) :Config) :new
|
41
|
+
(hash (pair (send (send (send nil? :described_class) :badge) :to_s)
|
42
|
+
(send nil? :cop_config))))
|
43
|
+
}
|
44
|
+
)
|
37
45
|
PATTERN
|
38
46
|
|
39
47
|
def on_block(node)
|
@@ -46,7 +46,7 @@ module RuboCop
|
|
46
46
|
def register_offense(node)
|
47
47
|
add_offense(node.loc.end, message: message(node)) do |corrector|
|
48
48
|
offense_range = offense_range(node)
|
49
|
-
replacement =
|
49
|
+
replacement = replacement(node)
|
50
50
|
|
51
51
|
if (heredoc = last_heredoc_argument(node.body))
|
52
52
|
corrector.remove(offense_range)
|
@@ -79,6 +79,12 @@ module RuboCop
|
|
79
79
|
)
|
80
80
|
end
|
81
81
|
|
82
|
+
def replacement(node)
|
83
|
+
end_with_method_chain = node.loc.end.join(end_of_method_chain(node).loc.expression.end)
|
84
|
+
|
85
|
+
"\n#{end_with_method_chain.source.strip}"
|
86
|
+
end
|
87
|
+
|
82
88
|
def end_of_method_chain(node)
|
83
89
|
return node unless node.parent&.call_type?
|
84
90
|
|