rubocop 0.77.0 → 0.81.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE.txt +1 -1
- data/README.md +3 -3
- data/config/default.yml +136 -60
- data/lib/rubocop.rb +20 -4
- data/lib/rubocop/ast/builder.rb +45 -42
- data/lib/rubocop/ast/node.rb +11 -18
- data/lib/rubocop/ast/node/block_node.rb +5 -1
- data/lib/rubocop/ast/node/case_match_node.rb +56 -0
- data/lib/rubocop/ast/node/def_node.rb +11 -0
- data/lib/rubocop/ast/node/forward_args_node.rb +18 -0
- data/lib/rubocop/ast/node/regexp_node.rb +2 -4
- data/lib/rubocop/ast/traversal.rb +29 -10
- data/lib/rubocop/cli/command/auto_genenerate_config.rb +7 -7
- data/lib/rubocop/cli/command/show_cops.rb +11 -4
- data/lib/rubocop/comment_config.rb +6 -1
- data/lib/rubocop/config.rb +28 -10
- data/lib/rubocop/config_loader.rb +19 -19
- data/lib/rubocop/config_obsoletion.rb +6 -4
- data/lib/rubocop/config_validator.rb +55 -95
- data/lib/rubocop/cop/autocorrect_logic.rb +7 -4
- data/lib/rubocop/cop/bundler/insecure_protocol_source.rb +2 -2
- data/lib/rubocop/cop/cop.rb +3 -1
- data/lib/rubocop/cop/gemspec/ordered_dependencies.rb +1 -1
- data/lib/rubocop/cop/generator.rb +3 -4
- data/lib/rubocop/cop/generator/configuration_injector.rb +1 -1
- data/lib/rubocop/cop/layout/array_alignment.rb +53 -10
- data/lib/rubocop/cop/layout/block_end_newline.rb +5 -3
- data/lib/rubocop/cop/layout/else_alignment.rb +8 -0
- data/lib/rubocop/cop/layout/empty_line_between_defs.rb +2 -1
- data/lib/rubocop/cop/layout/first_argument_indentation.rb +2 -2
- data/lib/rubocop/cop/layout/hash_alignment.rb +8 -4
- data/lib/rubocop/cop/layout/heredoc_indentation.rb +4 -4
- data/lib/rubocop/cop/layout/leading_comment_space.rb +33 -2
- data/lib/rubocop/cop/{metrics → layout}/line_length.rb +35 -79
- data/lib/rubocop/cop/layout/multiline_block_layout.rb +14 -5
- data/lib/rubocop/cop/layout/multiline_hash_brace_layout.rb +0 -4
- data/lib/rubocop/cop/layout/multiline_method_call_indentation.rb +1 -1
- data/lib/rubocop/cop/layout/space_around_operators.rb +49 -6
- data/lib/rubocop/cop/layout/space_before_block_braces.rb +17 -0
- data/lib/rubocop/cop/layout/space_before_first_arg.rb +8 -0
- data/lib/rubocop/cop/layout/space_inside_hash_literal_braces.rb +2 -9
- data/lib/rubocop/cop/lint/boolean_symbol.rb +12 -0
- data/lib/rubocop/cop/lint/debugger.rb +1 -1
- data/lib/rubocop/cop/lint/each_with_object_argument.rb +1 -1
- data/lib/rubocop/cop/lint/erb_new_arguments.rb +1 -1
- data/lib/rubocop/cop/lint/loop.rb +6 -4
- data/lib/rubocop/cop/lint/nested_method_definition.rb +2 -2
- data/lib/rubocop/cop/lint/non_deterministic_require_order.rb +89 -0
- data/lib/rubocop/cop/lint/raise_exception.rb +39 -0
- data/lib/rubocop/cop/lint/redundant_cop_disable_directive.rb +3 -3
- data/lib/rubocop/cop/lint/redundant_cop_enable_directive.rb +13 -8
- data/lib/rubocop/cop/lint/safe_navigation_chain.rb +1 -1
- data/lib/rubocop/cop/lint/struct_new_override.rb +58 -0
- data/lib/rubocop/cop/lint/suppressed_exception.rb +12 -22
- data/lib/rubocop/cop/lint/unused_method_argument.rb +32 -6
- data/lib/rubocop/cop/lint/useless_setter_call.rb +4 -0
- data/lib/rubocop/cop/migration/department_name.rb +47 -6
- data/lib/rubocop/cop/mixin/alignment.rb +1 -1
- data/lib/rubocop/cop/mixin/configurable_enforced_style.rb +4 -0
- data/lib/rubocop/cop/mixin/end_keyword_alignment.rb +6 -1
- data/lib/rubocop/cop/mixin/frozen_string_literal.rb +7 -7
- data/lib/rubocop/cop/mixin/hash_transform_method.rb +171 -0
- data/lib/rubocop/cop/mixin/line_length_help.rb +88 -0
- data/lib/rubocop/cop/mixin/method_complexity.rb +5 -0
- data/lib/rubocop/cop/mixin/rational_literal.rb +18 -0
- data/lib/rubocop/cop/mixin/statement_modifier.rb +2 -2
- data/lib/rubocop/cop/mixin/trailing_comma.rb +8 -12
- data/lib/rubocop/cop/naming/memoized_instance_variable_name.rb +1 -1
- data/lib/rubocop/cop/naming/method_name.rb +30 -0
- data/lib/rubocop/cop/naming/method_parameter_name.rb +1 -1
- data/lib/rubocop/cop/offense.rb +11 -0
- data/lib/rubocop/cop/registry.rb +7 -2
- data/lib/rubocop/cop/style/access_modifier_declarations.rb +26 -6
- data/lib/rubocop/cop/style/attr.rb +8 -0
- data/lib/rubocop/cop/style/block_delimiters.rb +60 -1
- data/lib/rubocop/cop/style/collection_methods.rb +2 -0
- data/lib/rubocop/cop/style/conditional_assignment.rb +2 -2
- data/lib/rubocop/cop/style/documentation.rb +43 -5
- data/lib/rubocop/cop/style/end_block.rb +6 -0
- data/lib/rubocop/cop/style/frozen_string_literal_comment.rb +89 -11
- data/lib/rubocop/cop/style/guard_clause.rb +3 -2
- data/lib/rubocop/cop/style/hash_each_methods.rb +89 -0
- data/lib/rubocop/cop/style/hash_transform_keys.rb +83 -0
- data/lib/rubocop/cop/style/hash_transform_values.rb +83 -0
- data/lib/rubocop/cop/style/if_unless_modifier.rb +38 -3
- data/lib/rubocop/cop/style/infinite_loop.rb +1 -1
- data/lib/rubocop/cop/style/inverse_methods.rb +9 -5
- data/lib/rubocop/cop/style/lambda.rb +1 -0
- data/lib/rubocop/cop/style/method_call_with_args_parentheses.rb +7 -205
- data/lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb +169 -0
- data/lib/rubocop/cop/style/method_call_with_args_parentheses/require_parentheses.rb +54 -0
- data/lib/rubocop/cop/style/module_function.rb +56 -10
- data/lib/rubocop/cop/style/multiline_method_signature.rb +1 -1
- data/lib/rubocop/cop/style/multiline_when_then.rb +5 -1
- data/lib/rubocop/cop/style/nested_parenthesized_calls.rb +4 -4
- data/lib/rubocop/cop/style/numeric_predicate.rb +4 -3
- data/lib/rubocop/cop/style/one_line_conditional.rb +3 -2
- data/lib/rubocop/cop/style/or_assignment.rb +3 -2
- data/lib/rubocop/cop/style/percent_literal_delimiters.rb +7 -7
- data/lib/rubocop/cop/style/redundant_condition.rb +17 -4
- data/lib/rubocop/cop/style/redundant_sort.rb +2 -2
- data/lib/rubocop/cop/style/symbol_array.rb +2 -2
- data/lib/rubocop/cop/style/ternary_parentheses.rb +1 -1
- data/lib/rubocop/cop/style/trailing_comma_in_arguments.rb +34 -22
- data/lib/rubocop/cop/style/trailing_comma_in_array_literal.rb +41 -0
- data/lib/rubocop/cop/style/trailing_comma_in_block_args.rb +85 -0
- data/lib/rubocop/cop/style/trailing_comma_in_hash_literal.rb +44 -0
- data/lib/rubocop/cop/style/trailing_underscore_variable.rb +7 -1
- data/lib/rubocop/cop/style/while_until_modifier.rb +1 -1
- data/lib/rubocop/cop/style/yoda_condition.rb +16 -1
- data/lib/rubocop/cop/variable_force.rb +4 -1
- data/lib/rubocop/formatter/base_formatter.rb +2 -2
- data/lib/rubocop/formatter/clang_style_formatter.rb +1 -1
- data/lib/rubocop/formatter/formatter_set.rb +1 -0
- data/lib/rubocop/formatter/json_formatter.rb +6 -5
- data/lib/rubocop/formatter/junit_formatter.rb +74 -0
- data/lib/rubocop/formatter/tap_formatter.rb +1 -1
- data/lib/rubocop/node_pattern.rb +97 -11
- data/lib/rubocop/options.rb +8 -8
- data/lib/rubocop/processed_source.rb +1 -1
- data/lib/rubocop/result_cache.rb +2 -0
- data/lib/rubocop/rspec/shared_contexts.rb +5 -0
- data/lib/rubocop/runner.rb +5 -1
- data/lib/rubocop/target_ruby.rb +151 -0
- data/lib/rubocop/version.rb +1 -1
- metadata +38 -10
- data/lib/rubocop/cop/lint/end_in_method.rb +0 -40
- data/lib/rubocop/cop/style/braces_around_hash_parameters.rb +0 -209
@@ -97,7 +97,8 @@ module RuboCop
|
|
97
97
|
def line_break_necessary_in_args?(node)
|
98
98
|
needed_length = node.source_range.column +
|
99
99
|
node.source.lines.first.length +
|
100
|
-
block_arg_string(node.arguments).length +
|
100
|
+
block_arg_string(node, node.arguments).length +
|
101
|
+
PIPE_SIZE
|
101
102
|
needed_length > max_line_length
|
102
103
|
end
|
103
104
|
|
@@ -115,7 +116,8 @@ module RuboCop
|
|
115
116
|
newlines: false
|
116
117
|
).end_pos
|
117
118
|
range = range_between(node.loc.begin.end.begin_pos, end_pos)
|
118
|
-
corrector.replace(range,
|
119
|
+
corrector.replace(range,
|
120
|
+
" |#{block_arg_string(node, node.arguments)}|")
|
119
121
|
end
|
120
122
|
|
121
123
|
def autocorrect_body(corrector, node, block_body)
|
@@ -131,14 +133,21 @@ module RuboCop
|
|
131
133
|
"\n #{' ' * block_start_col}")
|
132
134
|
end
|
133
135
|
|
134
|
-
def block_arg_string(args)
|
135
|
-
args.children.map do |arg|
|
136
|
+
def block_arg_string(node, args)
|
137
|
+
arg_string = args.children.map do |arg|
|
136
138
|
if arg.mlhs_type?
|
137
|
-
"(#{block_arg_string(arg)})"
|
139
|
+
"(#{block_arg_string(node, arg)})"
|
138
140
|
else
|
139
141
|
arg.source
|
140
142
|
end
|
141
143
|
end.join(', ')
|
144
|
+
arg_string += ',' if include_trailing_comma?(node.arguments)
|
145
|
+
arg_string
|
146
|
+
end
|
147
|
+
|
148
|
+
def include_trailing_comma?(args)
|
149
|
+
arg_count = args.each_descendant(:arg).to_a.size
|
150
|
+
arg_count == 1 && args.source.include?(',')
|
142
151
|
end
|
143
152
|
end
|
144
153
|
end
|
@@ -105,10 +105,6 @@ module RuboCop
|
|
105
105
|
ALWAYS_SAME_LINE_MESSAGE = 'Closing hash brace must be on the same ' \
|
106
106
|
'line as the last hash element.'
|
107
107
|
|
108
|
-
def self.autocorrect_incompatible_with
|
109
|
-
[Style::BracesAroundHashParameters]
|
110
|
-
end
|
111
|
-
|
112
108
|
def on_hash(node)
|
113
109
|
check_brace_layout(node)
|
114
110
|
end
|
@@ -193,7 +193,7 @@ module RuboCop
|
|
193
193
|
node = node.receiver while node.receiver
|
194
194
|
# ascend to first call which has a dot
|
195
195
|
node = node.parent
|
196
|
-
node = node.parent until node.loc.dot
|
196
|
+
node = node.parent until node.loc.respond_to?(:dot) && node.loc.dot
|
197
197
|
|
198
198
|
return if node.loc.dot.line != node.first_line
|
199
199
|
|
@@ -3,24 +3,55 @@
|
|
3
3
|
module RuboCop
|
4
4
|
module Cop
|
5
5
|
module Layout
|
6
|
-
# Checks that operators have space around them, except for **
|
7
|
-
#
|
6
|
+
# Checks that operators have space around them, except for ** which
|
7
|
+
# should or shouldn't have surrounding space depending on configuration.
|
8
|
+
#
|
9
|
+
# This cop has `AllowForAlignment` option. When `true`, allows most
|
10
|
+
# uses of extra spacing if the intent is to align with an operator on
|
11
|
+
# the previous or next line, not counting empty lines or comment lines.
|
8
12
|
#
|
9
13
|
# @example
|
10
14
|
# # bad
|
11
15
|
# total = 3*4
|
12
16
|
# "apple"+"juice"
|
13
17
|
# my_number = 38/4
|
14
|
-
# a ** b
|
15
18
|
#
|
16
19
|
# # good
|
17
20
|
# total = 3 * 4
|
18
21
|
# "apple" + "juice"
|
19
22
|
# my_number = 38 / 4
|
23
|
+
#
|
24
|
+
# @example AllowForAlignment: true (default)
|
25
|
+
# # good
|
26
|
+
# {
|
27
|
+
# 1 => 2,
|
28
|
+
# 11 => 3
|
29
|
+
# }
|
30
|
+
#
|
31
|
+
# @example AllowForAlignment: false
|
32
|
+
# # bad
|
33
|
+
# {
|
34
|
+
# 1 => 2,
|
35
|
+
# 11 => 3
|
36
|
+
# }
|
37
|
+
#
|
38
|
+
# @example EnforcedStyleForExponentOperator: no_space (default)
|
39
|
+
# # bad
|
40
|
+
# a ** b
|
41
|
+
#
|
42
|
+
# # good
|
20
43
|
# a**b
|
44
|
+
#
|
45
|
+
# @example EnforcedStyleForExponentOperator: space
|
46
|
+
# # bad
|
47
|
+
# a**b
|
48
|
+
#
|
49
|
+
# # good
|
50
|
+
# a ** b
|
21
51
|
class SpaceAroundOperators < Cop
|
22
52
|
include PrecedingFollowingAlignment
|
23
53
|
include RangeHelp
|
54
|
+
include RationalLiteral
|
24
55
|
|
25
56
|
IRREGULAR_METHODS = %i[[] ! []=].freeze
|
26
57
|
EXCESSIVE_SPACE = ' '
|
@@ -53,6 +84,8 @@ module RuboCop
|
|
53
84
|
end
|
54
85
|
|
55
86
|
def on_send(node)
|
87
|
+
return if rational_literal?(node)
|
88
|
+
|
56
89
|
if node.setter_method?
|
57
90
|
on_special_asgn(node)
|
58
91
|
elsif regular_operator?(node)
|
@@ -101,7 +134,7 @@ module RuboCop
|
|
101
134
|
|
102
135
|
def autocorrect(range)
|
103
136
|
lambda do |corrector|
|
104
|
-
if range.source =~ /\*\*/
|
137
|
+
if range.source =~ /\*\*/ && !space_around_exponent_operator?
|
105
138
|
corrector.replace(range, '**')
|
106
139
|
elsif range.source.end_with?("\n")
|
107
140
|
corrector.replace(range, " #{range.source.strip}\n")
|
@@ -138,8 +171,10 @@ module RuboCop
|
|
138
171
|
end
|
139
172
|
|
140
173
|
def offense_message(type, operator, with_space, right_operand)
|
141
|
-
if
|
142
|
-
|
174
|
+
if should_not_have_surrounding_space?(operator)
|
175
|
+
return if with_space.is?(operator.source)
|
176
|
+
|
177
|
+
"Space around operator `#{operator.source}` detected."
|
143
178
|
elsif with_space.source !~ /^\s.*\s$/
|
144
179
|
"Surrounding space missing for operator `#{operator.source}`."
|
145
180
|
elsif excess_leading_space?(type, operator, with_space) ||
|
@@ -176,6 +211,14 @@ module RuboCop
|
|
176
211
|
align_hash_cop_config &&
|
177
212
|
align_hash_cop_config['EnforcedHashRocketStyle'] == 'table'
|
178
213
|
end
|
214
|
+
|
215
|
+
def space_around_exponent_operator?
|
216
|
+
cop_config['EnforcedStyleForExponentOperator'] == 'space'
|
217
|
+
end
|
218
|
+
|
219
|
+
def should_not_have_surrounding_space?(operator)
|
220
|
+
operator.is?('**') ? !space_around_exponent_operator? : false
|
221
|
+
end
|
179
222
|
end
|
180
223
|
end
|
181
224
|
end
|
@@ -41,6 +41,14 @@ module RuboCop
|
|
41
41
|
def on_block(node)
|
42
42
|
return if node.keywords?
|
43
43
|
|
44
|
+
# Do not register an offense for multi-line braces when specifying
|
45
|
+
# `EnforcedStyle: no_space`. It will conflict with auto-correction
|
46
|
+
# by `EnforcedStyle: line_count_based` of `Style/BlockDelimiters` cop.
|
47
|
+
# That means preventing auto-correction to incorrect auto-corrected
|
48
|
+
# code.
|
49
|
+
# See: https://github.com/rubocop-hq/rubocop/issues/7534
|
50
|
+
return if conflict_with_block_delimiters?(node)
|
51
|
+
|
44
52
|
left_brace = node.loc.begin
|
45
53
|
space_plus_brace = range_with_surrounding_space(range: left_brace)
|
46
54
|
used_style =
|
@@ -110,6 +118,15 @@ module RuboCop
|
|
110
118
|
end
|
111
119
|
end
|
112
120
|
|
121
|
+
def conflict_with_block_delimiters?(node)
|
122
|
+
block_delimiters_style == 'line_count_based' &&
|
123
|
+
style == :no_space && node.multiline?
|
124
|
+
end
|
125
|
+
|
126
|
+
def block_delimiters_style
|
127
|
+
config.for_cop('Style/BlockDelimiters')['EnforcedStyle']
|
128
|
+
end
|
129
|
+
|
113
130
|
def empty_braces?(loc)
|
114
131
|
loc.begin.end_pos == loc.end.begin_pos
|
115
132
|
end
|
@@ -54,6 +54,7 @@ module RuboCop
|
|
54
54
|
|
55
55
|
def expect_params_after_method_name?(node)
|
56
56
|
return false if node.parenthesized?
|
57
|
+
return true if no_space_between_method_name_and_first_argument?(node)
|
57
58
|
|
58
59
|
first_arg = node.first_argument
|
59
60
|
|
@@ -61,6 +62,13 @@ module RuboCop
|
|
61
62
|
!(allow_for_alignment? &&
|
62
63
|
aligned_with_something?(first_arg.source_range))
|
63
64
|
end
|
65
|
+
|
66
|
+
def no_space_between_method_name_and_first_argument?(node)
|
67
|
+
end_pos_of_method_name = node.loc.selector.end_pos
|
68
|
+
begin_pos_of_argument = node.first_argument.source_range.begin_pos
|
69
|
+
|
70
|
+
end_pos_of_method_name == begin_pos_of_argument
|
71
|
+
end
|
64
72
|
end
|
65
73
|
end
|
66
74
|
end
|
@@ -83,17 +83,10 @@ module RuboCop
|
|
83
83
|
|
84
84
|
def autocorrect(range)
|
85
85
|
lambda do |corrector|
|
86
|
-
# It is possible that BracesAroundHashParameters will remove the
|
87
|
-
# braces while this cop inserts spaces. This can lead to unwanted
|
88
|
-
# changes to the inspected code. If we replace the brace with a
|
89
|
-
# brace plus space (rather than just inserting a space), then any
|
90
|
-
# removal of the same brace will give us a clobbering error. This
|
91
|
-
# in turn will make RuboCop fall back on cop-by-cop
|
92
|
-
# auto-correction. Problem solved.
|
93
86
|
case range.source
|
94
87
|
when /\s/ then corrector.remove(range)
|
95
|
-
when '{' then corrector.
|
96
|
-
else corrector.
|
88
|
+
when '{' then corrector.insert_after(range, ' ')
|
89
|
+
else corrector.insert_before(range, ' ')
|
97
90
|
end
|
98
91
|
end
|
99
92
|
end
|
@@ -32,6 +32,18 @@ module RuboCop
|
|
32
32
|
|
33
33
|
add_offense(node, message: format(MSG, boolean: node.value))
|
34
34
|
end
|
35
|
+
|
36
|
+
def autocorrect(node)
|
37
|
+
lambda do |corrector|
|
38
|
+
boolean_literal = node.source.delete(':')
|
39
|
+
parent = node.parent
|
40
|
+
if parent&.pair_type?
|
41
|
+
corrector.remove(parent.loc.operator)
|
42
|
+
boolean_literal = "#{node.source} =>"
|
43
|
+
end
|
44
|
+
corrector.replace(node.loc.expression, boolean_literal)
|
45
|
+
end
|
46
|
+
end
|
35
47
|
end
|
36
48
|
end
|
37
49
|
end
|
@@ -45,7 +45,7 @@ module RuboCop
|
|
45
45
|
def_node_matcher :debugger_call?, <<~PATTERN
|
46
46
|
{(send {nil? #kernel?} {:debugger :byebug :remote_byebug} ...)
|
47
47
|
(send (send {#kernel? nil?} :binding)
|
48
|
-
{:pry :remote_pry :pry_remote} ...)
|
48
|
+
{:pry :remote_pry :pry_remote :console} ...)
|
49
49
|
(send (const {nil? (cbase)} :Pry) :rescue ...)
|
50
50
|
(send nil? {:save_and_open_page
|
51
51
|
:save_and_open_screenshot
|
@@ -22,7 +22,7 @@ module RuboCop
|
|
22
22
|
# num = 0
|
23
23
|
# sum = numbers.each_with_object(num) { |e, a| a += e }
|
24
24
|
class EachWithObjectArgument < Cop
|
25
|
-
MSG = 'The argument to each_with_object
|
25
|
+
MSG = 'The argument to each_with_object cannot be immutable.'
|
26
26
|
|
27
27
|
def_node_matcher :each_with_object?, <<~PATTERN
|
28
28
|
({send csend} _ :each_with_object $_)
|
@@ -84,7 +84,7 @@ module RuboCop
|
|
84
84
|
|
85
85
|
def on_send(node)
|
86
86
|
erb_new_with_non_keyword_arguments(node) do |arguments|
|
87
|
-
return if correct_arguments?(arguments)
|
87
|
+
return if arguments.empty? || correct_arguments?(arguments)
|
88
88
|
|
89
89
|
arguments[1..3].each_with_index do |argument, i|
|
90
90
|
next if !argument || argument.hash_type?
|
@@ -27,18 +27,20 @@ module RuboCop
|
|
27
27
|
#
|
28
28
|
# # good
|
29
29
|
#
|
30
|
-
# #
|
31
|
-
#
|
30
|
+
# # while replacement
|
31
|
+
# loop do
|
32
32
|
# do_something
|
33
|
+
# break unless some_condition
|
33
34
|
# end
|
34
35
|
#
|
35
36
|
# @example
|
36
37
|
#
|
37
38
|
# # good
|
38
39
|
#
|
39
|
-
# #
|
40
|
-
#
|
40
|
+
# # until replacement
|
41
|
+
# loop do
|
41
42
|
# do_something
|
43
|
+
# break if some_condition
|
42
44
|
# end
|
43
45
|
class Loop < Cop
|
44
46
|
MSG = 'Use `Kernel#loop` with `break` rather than ' \
|
@@ -31,14 +31,14 @@ module RuboCop
|
|
31
31
|
# # good
|
32
32
|
#
|
33
33
|
# def foo
|
34
|
-
# self.class_eval do
|
34
|
+
# self.class.class_eval do
|
35
35
|
# def bar
|
36
36
|
# end
|
37
37
|
# end
|
38
38
|
# end
|
39
39
|
#
|
40
40
|
# def foo
|
41
|
-
# self.module_exec do
|
41
|
+
# self.class.module_exec do
|
42
42
|
# def bar
|
43
43
|
# end
|
44
44
|
# end
|
@@ -0,0 +1,89 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module RuboCop
|
4
|
+
module Cop
|
5
|
+
module Lint
|
6
|
+
# `Dir[...]` and `Dir.glob(...)` do not make any guarantees about
|
7
|
+
# the order in which files are returned. The final order is
|
8
|
+
# determined by the operating system and file system.
|
9
|
+
# This means that using them in cases where the order matters,
|
10
|
+
# such as requiring files, can lead to intermittent failures
|
11
|
+
# that are hard to debug. To ensure this doesn't happen,
|
12
|
+
# always sort the list.
|
13
|
+
#
|
14
|
+
# @example
|
15
|
+
#
|
16
|
+
# # bad
|
17
|
+
# Dir["./lib/**/*.rb"].each do |file|
|
18
|
+
# require file
|
19
|
+
# end
|
20
|
+
#
|
21
|
+
# # good
|
22
|
+
# Dir["./lib/**/*.rb"].sort.each do |file|
|
23
|
+
# require file
|
24
|
+
# end
|
25
|
+
#
|
26
|
+
# @example
|
27
|
+
#
|
28
|
+
# # bad
|
29
|
+
# Dir.glob(Rails.root.join(__dir__, 'test', '*.rb')) do |file|
|
30
|
+
# require file
|
31
|
+
# end
|
32
|
+
#
|
33
|
+
# # good
|
34
|
+
# Dir.glob(Rails.root.join(__dir__, 'test', '*.rb')).sort.each do |file|
|
35
|
+
# require file
|
36
|
+
# end
|
37
|
+
#
|
38
|
+
class NonDeterministicRequireOrder < Cop
|
39
|
+
MSG = 'Sort files before requiring them.'
|
40
|
+
|
41
|
+
def on_block(node)
|
42
|
+
return unless node.body
|
43
|
+
return unless unsorted_dir_loop?(node.send_node)
|
44
|
+
|
45
|
+
loop_variable(node.arguments) do |var_name|
|
46
|
+
return unless var_is_required?(node.body, var_name)
|
47
|
+
|
48
|
+
add_offense(node.send_node)
|
49
|
+
end
|
50
|
+
end
|
51
|
+
|
52
|
+
def autocorrect(node)
|
53
|
+
if unsorted_dir_block?(node)
|
54
|
+
lambda do |corrector|
|
55
|
+
corrector.replace(node.loc.expression, "#{node.source}.sort.each")
|
56
|
+
end
|
57
|
+
else
|
58
|
+
lambda do |corrector|
|
59
|
+
source = node.receiver.source
|
60
|
+
corrector.replace(node.loc.expression, "#{source}.sort.each")
|
61
|
+
end
|
62
|
+
end
|
63
|
+
end
|
64
|
+
|
65
|
+
private
|
66
|
+
|
67
|
+
def unsorted_dir_loop?(node)
|
68
|
+
unsorted_dir_block?(node) || unsorted_dir_each?(node)
|
69
|
+
end
|
70
|
+
|
71
|
+
def_node_matcher :unsorted_dir_block?, <<~PATTERN
|
72
|
+
(send (const nil? :Dir) :glob ...)
|
73
|
+
PATTERN
|
74
|
+
|
75
|
+
def_node_matcher :unsorted_dir_each?, <<~PATTERN
|
76
|
+
(send (send (const nil? :Dir) {:[] :glob} ...) :each)
|
77
|
+
PATTERN
|
78
|
+
|
79
|
+
def_node_matcher :loop_variable, <<~PATTERN
|
80
|
+
(args (arg $_))
|
81
|
+
PATTERN
|
82
|
+
|
83
|
+
def_node_search :var_is_required?, <<~PATTERN
|
84
|
+
(send nil? :require (lvar %1))
|
85
|
+
PATTERN
|
86
|
+
end
|
87
|
+
end
|
88
|
+
end
|
89
|
+
end
|
@@ -0,0 +1,39 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module RuboCop
|
4
|
+
module Cop
|
5
|
+
module Lint
|
6
|
+
# This cop checks for `raise` or `fail` statements which are
|
7
|
+
# raising `Exception` class.
|
8
|
+
#
|
9
|
+
# @example
|
10
|
+
# # bad
|
11
|
+
# raise Exception, 'Error message here'
|
12
|
+
#
|
13
|
+
# # good
|
14
|
+
# raise StandardError, 'Error message here'
|
15
|
+
class RaiseException < Cop
|
16
|
+
MSG = 'Use `StandardError` over `Exception`.'
|
17
|
+
|
18
|
+
def_node_matcher :exception?, <<~PATTERN
|
19
|
+
(send nil? ${:raise :fail} (const _ :Exception) ... )
|
20
|
+
PATTERN
|
21
|
+
|
22
|
+
def_node_matcher :exception_new_with_message?, <<~PATTERN
|
23
|
+
(send nil? ${:raise :fail}
|
24
|
+
(send (const _ :Exception) :new ... ))
|
25
|
+
PATTERN
|
26
|
+
|
27
|
+
def on_send(node)
|
28
|
+
add_offense(node) if raise_exception?(node)
|
29
|
+
end
|
30
|
+
|
31
|
+
private
|
32
|
+
|
33
|
+
def raise_exception?(node)
|
34
|
+
exception?(node) || exception_new_with_message?(node)
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|