rubocop 1.46.0 → 1.48.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +1 -1
- data/config/default.yml +24 -0
- data/lib/rubocop/cli/command/auto_generate_config.rb +7 -0
- data/lib/rubocop/comment_config.rb +2 -0
- data/lib/rubocop/cop/autocorrect_logic.rb +1 -1
- data/lib/rubocop/cop/base.rb +1 -1
- data/lib/rubocop/cop/bundler/gem_comment.rb +1 -1
- data/lib/rubocop/cop/corrector.rb +1 -1
- data/lib/rubocop/cop/correctors/alignment_corrector.rb +2 -2
- data/lib/rubocop/cop/correctors/each_to_for_corrector.rb +3 -3
- data/lib/rubocop/cop/correctors/for_to_each_corrector.rb +3 -3
- data/lib/rubocop/cop/correctors/line_break_corrector.rb +1 -1
- data/lib/rubocop/cop/correctors/multiline_literal_brace_corrector.rb +2 -2
- data/lib/rubocop/cop/correctors/ordered_gem_corrector.rb +1 -1
- data/lib/rubocop/cop/correctors/parentheses_corrector.rb +1 -1
- data/lib/rubocop/cop/internal_affairs/cop_description.rb +4 -4
- data/lib/rubocop/cop/internal_affairs/example_heredoc_delimiter.rb +1 -1
- data/lib/rubocop/cop/internal_affairs/location_expression.rb +37 -0
- data/lib/rubocop/cop/internal_affairs/node_matcher_directive.rb +1 -1
- data/lib/rubocop/cop/internal_affairs/node_type_predicate.rb +1 -1
- data/lib/rubocop/cop/internal_affairs/processed_source_buffer_name.rb +1 -1
- data/lib/rubocop/cop/internal_affairs/redundant_location_argument.rb +1 -1
- data/lib/rubocop/cop/internal_affairs/redundant_message_argument.rb +1 -1
- data/lib/rubocop/cop/internal_affairs/redundant_source_range.rb +39 -0
- data/lib/rubocop/cop/internal_affairs.rb +2 -0
- data/lib/rubocop/cop/layout/block_end_newline.rb +4 -4
- data/lib/rubocop/cop/layout/class_structure.rb +5 -3
- data/lib/rubocop/cop/layout/closing_heredoc_indentation.rb +1 -1
- data/lib/rubocop/cop/layout/empty_comment.rb +3 -3
- data/lib/rubocop/cop/layout/empty_line_between_defs.rb +1 -1
- data/lib/rubocop/cop/layout/first_argument_indentation.rb +1 -1
- data/lib/rubocop/cop/layout/heredoc_indentation.rb +2 -2
- data/lib/rubocop/cop/layout/leading_comment_space.rb +1 -1
- data/lib/rubocop/cop/layout/line_continuation_leading_space.rb +1 -3
- data/lib/rubocop/cop/layout/rescue_ensure_alignment.rb +2 -2
- data/lib/rubocop/cop/layout/space_in_lambda_literal.rb +2 -2
- data/lib/rubocop/cop/layout/space_inside_block_braces.rb +1 -1
- data/lib/rubocop/cop/layout/space_inside_percent_literal_delimiters.rb +1 -1
- data/lib/rubocop/cop/layout/trailing_whitespace.rb +1 -1
- data/lib/rubocop/cop/lint/constant_resolution.rb +1 -1
- data/lib/rubocop/cop/lint/deprecated_class_methods.rb +1 -1
- data/lib/rubocop/cop/lint/deprecated_open_ssl_constant.rb +1 -1
- data/lib/rubocop/cop/lint/duplicate_methods.rb +2 -2
- data/lib/rubocop/cop/lint/duplicate_regexp_character_class_element.rb +1 -3
- data/lib/rubocop/cop/lint/else_layout.rb +1 -1
- data/lib/rubocop/cop/lint/empty_block.rb +1 -1
- data/lib/rubocop/cop/lint/empty_conditional_body.rb +4 -2
- data/lib/rubocop/cop/lint/empty_interpolation.rb +1 -1
- data/lib/rubocop/cop/lint/ineffective_access_modifier.rb +1 -1
- data/lib/rubocop/cop/lint/literal_in_interpolation.rb +46 -4
- data/lib/rubocop/cop/lint/missing_super.rb +31 -2
- data/lib/rubocop/cop/lint/or_assignment_to_constant.rb +2 -0
- data/lib/rubocop/cop/lint/percent_string_array.rb +1 -1
- data/lib/rubocop/cop/lint/percent_symbol_array.rb +1 -1
- data/lib/rubocop/cop/lint/redundant_cop_disable_directive.rb +3 -3
- data/lib/rubocop/cop/lint/redundant_cop_enable_directive.rb +5 -5
- data/lib/rubocop/cop/lint/redundant_require_statement.rb +1 -1
- data/lib/rubocop/cop/lint/redundant_splat_expansion.rb +1 -1
- data/lib/rubocop/cop/lint/redundant_with_index.rb +1 -1
- data/lib/rubocop/cop/lint/redundant_with_object.rb +1 -1
- data/lib/rubocop/cop/lint/rescue_type.rb +3 -3
- data/lib/rubocop/cop/lint/safe_navigation_consistency.rb +1 -1
- data/lib/rubocop/cop/lint/script_permission.rb +1 -1
- data/lib/rubocop/cop/lint/shadowed_exception.rb +1 -1
- data/lib/rubocop/cop/lint/useless_access_modifier.rb +9 -1
- data/lib/rubocop/cop/lint/useless_times.rb +1 -1
- data/lib/rubocop/cop/metrics/collection_literal_length.rb +76 -0
- data/lib/rubocop/cop/metrics/utils/code_length_calculator.rb +2 -2
- data/lib/rubocop/cop/migration/department_name.rb +1 -1
- data/lib/rubocop/cop/mixin/annotation_comment.rb +1 -1
- data/lib/rubocop/cop/mixin/code_length.rb +1 -1
- data/lib/rubocop/cop/mixin/comments_help.rb +2 -2
- data/lib/rubocop/cop/mixin/documentation_comment.rb +1 -1
- data/lib/rubocop/cop/mixin/hash_alignment_styles.rb +1 -1
- data/lib/rubocop/cop/mixin/hash_shorthand_syntax.rb +3 -2
- data/lib/rubocop/cop/mixin/hash_transform_method.rb +3 -3
- data/lib/rubocop/cop/mixin/min_branches_count.rb +40 -0
- data/lib/rubocop/cop/mixin/ordered_gem_node.rb +1 -1
- data/lib/rubocop/cop/mixin/range_help.rb +1 -6
- data/lib/rubocop/cop/mixin/statement_modifier.rb +2 -2
- data/lib/rubocop/cop/mixin/trailing_comma.rb +1 -1
- data/lib/rubocop/cop/naming/heredoc_delimiter_case.rb +1 -1
- data/lib/rubocop/cop/naming/method_name.rb +1 -1
- data/lib/rubocop/cop/naming/predicate_name.rb +1 -1
- data/lib/rubocop/cop/naming/rescued_exceptions_variable_name.rb +1 -1
- data/lib/rubocop/cop/registry.rb +3 -1
- data/lib/rubocop/cop/style/accessor_grouping.rb +23 -2
- data/lib/rubocop/cop/style/arguments_forwarding.rb +3 -3
- data/lib/rubocop/cop/style/ascii_comments.rb +1 -1
- data/lib/rubocop/cop/style/bisected_attr_accessor.rb +1 -1
- data/lib/rubocop/cop/style/block_comments.rb +1 -1
- data/lib/rubocop/cop/style/block_delimiters.rb +11 -2
- data/lib/rubocop/cop/style/case_like_if.rb +20 -3
- data/lib/rubocop/cop/style/collection_compact.rb +1 -1
- data/lib/rubocop/cop/style/comment_annotation.rb +1 -1
- data/lib/rubocop/cop/style/commented_keyword.rb +2 -2
- data/lib/rubocop/cop/style/concat_array_literals.rb +10 -2
- data/lib/rubocop/cop/style/conditional_assignment.rb +6 -6
- data/lib/rubocop/cop/style/dir_empty.rb +60 -0
- data/lib/rubocop/cop/style/document_dynamic_eval_definition.rb +1 -1
- data/lib/rubocop/cop/style/documentation.rb +10 -4
- data/lib/rubocop/cop/style/each_with_object.rb +1 -1
- data/lib/rubocop/cop/style/empty_block_parameter.rb +1 -1
- data/lib/rubocop/cop/style/empty_lambda_parameter.rb +1 -1
- data/lib/rubocop/cop/style/eval_with_location.rb +4 -4
- data/lib/rubocop/cop/style/explicit_block_argument.rb +1 -1
- data/lib/rubocop/cop/style/file_empty.rb +71 -0
- data/lib/rubocop/cop/style/file_read.rb +1 -1
- data/lib/rubocop/cop/style/file_write.rb +1 -1
- data/lib/rubocop/cop/style/guard_clause.rb +1 -1
- data/lib/rubocop/cop/style/hash_like_case.rb +3 -9
- data/lib/rubocop/cop/style/hash_syntax.rb +1 -1
- data/lib/rubocop/cop/style/if_unless_modifier.rb +76 -9
- data/lib/rubocop/cop/style/if_with_boolean_literal_branches.rb +2 -0
- data/lib/rubocop/cop/style/inverse_methods.rb +5 -5
- data/lib/rubocop/cop/style/map_compact_with_conditional_block.rb +2 -2
- data/lib/rubocop/cop/style/method_call_with_args_parentheses.rb +1 -1
- data/lib/rubocop/cop/style/min_max.rb +3 -3
- data/lib/rubocop/cop/style/mixin_grouping.rb +4 -4
- data/lib/rubocop/cop/style/multiline_method_signature.rb +1 -1
- data/lib/rubocop/cop/style/multiline_ternary_operator.rb +1 -1
- data/lib/rubocop/cop/style/negated_if_else_condition.rb +12 -7
- data/lib/rubocop/cop/style/nil_lambda.rb +2 -2
- data/lib/rubocop/cop/style/redundant_condition.rb +2 -2
- data/lib/rubocop/cop/style/redundant_double_splat_hash_braces.rb +2 -2
- data/lib/rubocop/cop/style/redundant_interpolation.rb +2 -2
- data/lib/rubocop/cop/style/redundant_regexp_escape.rb +10 -3
- data/lib/rubocop/cop/style/redundant_sort.rb +3 -3
- data/lib/rubocop/cop/style/redundant_string_escape.rb +2 -2
- data/lib/rubocop/cop/style/require_order.rb +1 -3
- data/lib/rubocop/cop/style/rescue_standard_error.rb +2 -2
- data/lib/rubocop/cop/style/safe_navigation.rb +2 -2
- data/lib/rubocop/cop/style/sole_nested_conditional.rb +2 -2
- data/lib/rubocop/cop/style/stderr_puts.rb +1 -1
- data/lib/rubocop/cop/style/struct_inheritance.rb +1 -1
- data/lib/rubocop/cop/style/trailing_underscore_variable.rb +1 -1
- data/lib/rubocop/cop/style/unpack_first.rb +3 -3
- data/lib/rubocop/cop/style/yoda_condition.rb +1 -1
- data/lib/rubocop/cop/style/zero_length_predicate.rb +9 -5
- data/lib/rubocop/cop/team.rb +1 -1
- data/lib/rubocop/cop/util.rb +1 -1
- data/lib/rubocop/cop/variable_force/variable.rb +5 -3
- data/lib/rubocop/directive_comment.rb +3 -3
- data/lib/rubocop/ext/comment.rb +18 -0
- data/lib/rubocop/formatter/junit_formatter.rb +4 -1
- data/lib/rubocop/server/core.rb +1 -1
- data/lib/rubocop/version.rb +1 -1
- data/lib/rubocop.rb +5 -0
- metadata +10 -3
@@ -23,7 +23,7 @@ module RuboCop
|
|
23
23
|
# The args node1 & node2 may represent a RuboCop::AST::Node
|
24
24
|
# or a Parser::Source::Comment. Both respond to #loc.
|
25
25
|
def preceding_comment?(node1, node2)
|
26
|
-
node1 && node2 && precede?(node2, node1) && comment_line?(node2.
|
26
|
+
node1 && node2 && precede?(node2, node1) && comment_line?(node2.source)
|
27
27
|
end
|
28
28
|
|
29
29
|
# The args node1 & node2 may represent a RuboCop::AST::Node
|
@@ -33,7 +33,7 @@ module RuboCop
|
|
33
33
|
|
34
34
|
def separator_delta(pair)
|
35
35
|
if pair.hash_rocket?
|
36
|
-
correct_separator_column = pair.key.
|
36
|
+
correct_separator_column = pair.key.source_range.end.column + 1
|
37
37
|
actual_separator_column = pair.loc.operator.column
|
38
38
|
|
39
39
|
correct_separator_column - actual_separator_column
|
@@ -95,19 +95,20 @@ module RuboCop
|
|
95
95
|
use_modifier_form_without_parenthesized_method_call?(method_dispatch_node)
|
96
96
|
end
|
97
97
|
|
98
|
-
# rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
|
98
|
+
# rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
|
99
99
|
def def_node_that_require_parentheses(node)
|
100
100
|
last_pair = node.parent.pairs.last
|
101
101
|
return unless last_pair.key.source == last_pair.value.source
|
102
102
|
return unless (dispatch_node = find_ancestor_method_dispatch_node(node))
|
103
103
|
return if dispatch_node.parenthesized?
|
104
|
+
return if dispatch_node.parent && parentheses?(dispatch_node.parent)
|
104
105
|
return if last_expression?(dispatch_node) && !method_dispatch_as_argument?(dispatch_node)
|
105
106
|
|
106
107
|
def_node = node.each_ancestor(:send, :csend, :super, :yield).first
|
107
108
|
|
108
109
|
DefNode.new(def_node) unless def_node && def_node.arguments.empty?
|
109
110
|
end
|
110
|
-
# rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
|
111
|
+
# rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
|
111
112
|
|
112
113
|
def find_ancestor_method_dispatch_node(node)
|
113
114
|
return unless (ancestor = node.parent.parent)
|
@@ -159,7 +159,7 @@ module RuboCop
|
|
159
159
|
end
|
160
160
|
|
161
161
|
def strip_prefix_and_suffix(node, corrector)
|
162
|
-
expression = node.
|
162
|
+
expression = node.source_range
|
163
163
|
corrector.remove_leading(expression, leading)
|
164
164
|
corrector.remove_trailing(expression, trailing)
|
165
165
|
end
|
@@ -175,11 +175,11 @@ module RuboCop
|
|
175
175
|
end
|
176
176
|
|
177
177
|
def set_new_arg_name(transformed_argname, corrector)
|
178
|
-
corrector.replace(block_node.arguments.
|
178
|
+
corrector.replace(block_node.arguments.source_range, "|#{transformed_argname}|")
|
179
179
|
end
|
180
180
|
|
181
181
|
def set_new_body_expression(transforming_body_expr, corrector)
|
182
|
-
body_source = transforming_body_expr.
|
182
|
+
body_source = transforming_body_expr.source
|
183
183
|
if transforming_body_expr.hash_type? && !transforming_body_expr.braces?
|
184
184
|
body_source = "{ #{body_source} }"
|
185
185
|
end
|
@@ -0,0 +1,40 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module RuboCop
|
4
|
+
module Cop
|
5
|
+
# Common functionality for checking minimum branches count.
|
6
|
+
module MinBranchesCount
|
7
|
+
private
|
8
|
+
|
9
|
+
def min_branches_count?(node)
|
10
|
+
branches =
|
11
|
+
if node.case_type?
|
12
|
+
node.when_branches
|
13
|
+
elsif node.if_type?
|
14
|
+
if_conditional_branches(node)
|
15
|
+
else
|
16
|
+
raise ArgumentError, "Unsupported #{node.type.inspect} node type"
|
17
|
+
end
|
18
|
+
|
19
|
+
branches.size >= min_branches_count
|
20
|
+
end
|
21
|
+
|
22
|
+
def min_branches_count
|
23
|
+
length = cop_config['MinBranchesCount'] || 3
|
24
|
+
return length if length.is_a?(Integer) && length.positive?
|
25
|
+
|
26
|
+
raise 'MinBranchesCount needs to be a positive integer!'
|
27
|
+
end
|
28
|
+
|
29
|
+
def if_conditional_branches(node, branches = [])
|
30
|
+
return [] if node.nil? || !node.if_type?
|
31
|
+
|
32
|
+
branches << node.if_branch
|
33
|
+
|
34
|
+
else_branch = node.else_branch
|
35
|
+
if_conditional_branches(else_branch, branches) if else_branch&.if_type?
|
36
|
+
branches
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
40
|
+
end
|
@@ -10,7 +10,7 @@ module RuboCop
|
|
10
10
|
def get_source_range(node, comments_as_separators)
|
11
11
|
unless comments_as_separators
|
12
12
|
first_comment = processed_source.ast_with_comments[node].first
|
13
|
-
return first_comment.
|
13
|
+
return first_comment.source_range unless first_comment.nil?
|
14
14
|
end
|
15
15
|
node.source_range
|
16
16
|
end
|
@@ -132,12 +132,7 @@ module RuboCop
|
|
132
132
|
end
|
133
133
|
|
134
134
|
def range_with_comments(node)
|
135
|
-
ranges = [
|
136
|
-
node,
|
137
|
-
*@processed_source.ast_with_comments[node]
|
138
|
-
].map do |element|
|
139
|
-
element.location.expression
|
140
|
-
end
|
135
|
+
ranges = [node, *@processed_source.ast_with_comments[node]].map(&:source_range)
|
141
136
|
ranges.reduce do |result, range|
|
142
137
|
add_range(result, range)
|
143
138
|
end
|
@@ -65,14 +65,14 @@ module RuboCop
|
|
65
65
|
end
|
66
66
|
|
67
67
|
def method_source(if_body)
|
68
|
-
range_between(if_body.
|
68
|
+
range_between(if_body.source_range.begin_pos, if_body.loc.selector.end_pos).source
|
69
69
|
end
|
70
70
|
|
71
71
|
def first_line_comment(node)
|
72
72
|
comment = processed_source.find_comment { |c| same_line?(c, node) }
|
73
73
|
return unless comment
|
74
74
|
|
75
|
-
comment_source = comment.
|
75
|
+
comment_source = comment.source
|
76
76
|
comment_source unless comment_disables_cop?(comment_source)
|
77
77
|
end
|
78
78
|
|
@@ -75,7 +75,7 @@ module RuboCop
|
|
75
75
|
|
76
76
|
def inside_comment?(range, comma_offset)
|
77
77
|
comment = processed_source.comment_at_line(range.line)
|
78
|
-
comment && comment.
|
78
|
+
comment && comment.source_range.begin_pos < range.begin_pos + comma_offset
|
79
79
|
end
|
80
80
|
|
81
81
|
# Returns true if the node has round/square/curly brackets.
|
@@ -38,7 +38,7 @@ module RuboCop
|
|
38
38
|
return if correct_case_delimiters?(node)
|
39
39
|
|
40
40
|
add_offense(node.loc.heredoc_end) do |corrector|
|
41
|
-
expr = node.
|
41
|
+
expr = node.source_range
|
42
42
|
|
43
43
|
corrector.replace(expr, correct_delimiters(expr.source))
|
44
44
|
corrector.replace(node.loc.heredoc_end, correct_delimiters(delimiter_string(expr)))
|
data/lib/rubocop/cop/registry.rb
CHANGED
@@ -197,7 +197,9 @@ module RuboCop
|
|
197
197
|
def enabled?(cop, config)
|
198
198
|
return true if options[:only]&.include?(cop.cop_name)
|
199
199
|
|
200
|
-
|
200
|
+
# We need to use `cop_name` in this case, because `for_cop` uses caching
|
201
|
+
# which expects cop names or cop classes as keys.
|
202
|
+
cfg = config.for_cop(cop.cop_name)
|
201
203
|
|
202
204
|
cop_enabled = cfg.fetch('Enabled') == true || enabled_pending_cop?(cfg, config)
|
203
205
|
|
@@ -14,12 +14,25 @@ module RuboCop
|
|
14
14
|
# # bad
|
15
15
|
# class Foo
|
16
16
|
# attr_reader :bar
|
17
|
+
# attr_reader :bax
|
17
18
|
# attr_reader :baz
|
18
19
|
# end
|
19
20
|
#
|
20
21
|
# # good
|
21
22
|
# class Foo
|
22
|
-
# attr_reader :bar, :baz
|
23
|
+
# attr_reader :bar, :bax, :baz
|
24
|
+
# end
|
25
|
+
#
|
26
|
+
# # good
|
27
|
+
# class Foo
|
28
|
+
# # may be intended comment for bar.
|
29
|
+
# attr_reader :bar
|
30
|
+
#
|
31
|
+
# sig { returns(String) }
|
32
|
+
# attr_reader :bax
|
33
|
+
#
|
34
|
+
# may_be_intended_annotation :baz
|
35
|
+
# attr_reader :baz
|
23
36
|
# end
|
24
37
|
#
|
25
38
|
# @example EnforcedStyle: separated
|
@@ -70,7 +83,7 @@ module RuboCop
|
|
70
83
|
if (preferred_accessors = preferred_accessors(node))
|
71
84
|
corrector.replace(node, preferred_accessors)
|
72
85
|
else
|
73
|
-
range = range_with_surrounding_space(node.
|
86
|
+
range = range_with_surrounding_space(node.source_range, side: :left)
|
74
87
|
corrector.remove(range)
|
75
88
|
end
|
76
89
|
end
|
@@ -81,6 +94,14 @@ module RuboCop
|
|
81
94
|
|
82
95
|
def groupable_accessor?(node)
|
83
96
|
return true unless (previous_expression = node.left_siblings.last)
|
97
|
+
|
98
|
+
# Accessors with Sorbet `sig { ... }` blocks shouldn't be groupable.
|
99
|
+
if previous_expression.block_type?
|
100
|
+
previous_expression.child_nodes.each do |child_node|
|
101
|
+
break previous_expression = child_node if child_node.send_type?
|
102
|
+
end
|
103
|
+
end
|
104
|
+
|
84
105
|
return true unless previous_expression.send_type?
|
85
106
|
|
86
107
|
previous_expression.attribute_accessor? || previous_expression.access_modifier?
|
@@ -124,9 +124,9 @@ module RuboCop
|
|
124
124
|
|
125
125
|
def register_offense_to_forwarding_method_arguments(forwarding_method)
|
126
126
|
add_offense(arguments_range(forwarding_method)) do |corrector|
|
127
|
-
|
128
|
-
|
129
|
-
|
127
|
+
begin_pos = forwarding_method.loc.selector&.end_pos || forwarding_method.loc.dot.end_pos
|
128
|
+
range = range_between(begin_pos, forwarding_method.source_range.end_pos)
|
129
|
+
|
130
130
|
corrector.replace(range, '(...)')
|
131
131
|
end
|
132
132
|
end
|
@@ -30,7 +30,7 @@ module RuboCop
|
|
30
30
|
private
|
31
31
|
|
32
32
|
def first_offense_range(comment)
|
33
|
-
expression = comment.
|
33
|
+
expression = comment.source_range
|
34
34
|
first_offense = first_non_ascii_chars(comment.text)
|
35
35
|
|
36
36
|
start_position = expression.begin_pos + comment.text.index(first_offense)
|
@@ -55,7 +55,7 @@ module RuboCop
|
|
55
55
|
def after_class(class_node)
|
56
56
|
@macros_to_rewrite[class_node].each do |macro|
|
57
57
|
node = macro.node
|
58
|
-
range = range_by_whole_lines(node.
|
58
|
+
range = range_by_whole_lines(node.source_range, include_final_newline: true)
|
59
59
|
|
60
60
|
correct(range) do |corrector|
|
61
61
|
if macro.writer?
|
@@ -299,7 +299,7 @@ module RuboCop
|
|
299
299
|
|
300
300
|
def move_comment_before_block(corrector, comment, block_node, closing_brace)
|
301
301
|
range = block_node.chained? ? end_of_chain(block_node.parent).source_range : closing_brace
|
302
|
-
corrector.remove(range_with_surrounding_space(comment.
|
302
|
+
corrector.remove(range_with_surrounding_space(comment.source_range, side: :right))
|
303
303
|
remove_trailing_whitespace(corrector, range, comment)
|
304
304
|
corrector.insert_after(range, "\n")
|
305
305
|
|
@@ -314,7 +314,7 @@ module RuboCop
|
|
314
314
|
end
|
315
315
|
|
316
316
|
def remove_trailing_whitespace(corrector, range, comment)
|
317
|
-
range_of_trailing = range.end.join(comment.
|
317
|
+
range_of_trailing = range.end.join(comment.source_range.begin)
|
318
318
|
|
319
319
|
corrector.remove(range_of_trailing) if range_of_trailing.source.match?(/\A\s+\z/)
|
320
320
|
end
|
@@ -342,6 +342,7 @@ module RuboCop
|
|
342
342
|
end
|
343
343
|
|
344
344
|
def proper_block_style?(node)
|
345
|
+
return true if require_braces?(node)
|
345
346
|
return special_method_proper_block_style?(node) if special_method?(node.method_name)
|
346
347
|
|
347
348
|
case style
|
@@ -352,6 +353,14 @@ module RuboCop
|
|
352
353
|
end
|
353
354
|
end
|
354
355
|
|
356
|
+
def require_braces?(node)
|
357
|
+
return false unless node.braces?
|
358
|
+
|
359
|
+
node.each_ancestor(:send).any? do |send|
|
360
|
+
send.arithmetic_operation? && node.source_range.end_pos < send.loc.selector.begin_pos
|
361
|
+
end
|
362
|
+
end
|
363
|
+
|
355
364
|
def special_method?(method_name)
|
356
365
|
allowed_method?(method_name) ||
|
357
366
|
matches_allowed_pattern?(method_name) ||
|
@@ -11,12 +11,14 @@ module RuboCop
|
|
11
11
|
# so if the original conditional used a different equality operator, the
|
12
12
|
# behavior may be different.
|
13
13
|
#
|
14
|
-
# @example
|
14
|
+
# @example MinBranchesCount: 3 (default)
|
15
15
|
# # bad
|
16
16
|
# if status == :active
|
17
17
|
# perform_action
|
18
18
|
# elsif status == :inactive || status == :hibernating
|
19
19
|
# check_timeout
|
20
|
+
# elsif status == :invalid
|
21
|
+
# report_invalid
|
20
22
|
# else
|
21
23
|
# final_action
|
22
24
|
# end
|
@@ -27,12 +29,27 @@ module RuboCop
|
|
27
29
|
# perform_action
|
28
30
|
# when :inactive, :hibernating
|
29
31
|
# check_timeout
|
32
|
+
# when :invalid
|
33
|
+
# report_invalid
|
34
|
+
# else
|
35
|
+
# final_action
|
36
|
+
# end
|
37
|
+
#
|
38
|
+
# @example MinBranchesCount: 4
|
39
|
+
# # good
|
40
|
+
# if status == :active
|
41
|
+
# perform_action
|
42
|
+
# elsif status == :inactive || status == :hibernating
|
43
|
+
# check_timeout
|
44
|
+
# elsif status == :invalid
|
45
|
+
# report_invalid
|
30
46
|
# else
|
31
47
|
# final_action
|
32
48
|
# end
|
33
49
|
#
|
34
50
|
class CaseLikeIf < Base
|
35
51
|
include RangeHelp
|
52
|
+
include MinBranchesCount
|
36
53
|
extend AutoCorrector
|
37
54
|
|
38
55
|
MSG = 'Convert `if-elsif` to `case-when`.'
|
@@ -78,7 +95,7 @@ module RuboCop
|
|
78
95
|
|
79
96
|
def should_check?(node)
|
80
97
|
!node.unless? && !node.elsif? && !node.modifier_form? && !node.ternary? &&
|
81
|
-
node.elsif_conditional?
|
98
|
+
node.elsif_conditional? && min_branches_count?(node)
|
82
99
|
end
|
83
100
|
|
84
101
|
# rubocop:disable Metrics/MethodLength
|
@@ -239,7 +256,7 @@ module RuboCop
|
|
239
256
|
end
|
240
257
|
|
241
258
|
def correction_range(node)
|
242
|
-
range_between(node.parent.loc.keyword.begin_pos, node.
|
259
|
+
range_between(node.parent.loc.keyword.begin_pos, node.source_range.end_pos)
|
243
260
|
end
|
244
261
|
|
245
262
|
# Named captures work with `=~` (if regexp is on lhs) and with `match` (both sides)
|
@@ -112,7 +112,7 @@ module RuboCop
|
|
112
112
|
end
|
113
113
|
|
114
114
|
def range(begin_pos_node, end_pos_node)
|
115
|
-
range_between(begin_pos_node.loc.selector.begin_pos, end_pos_node.
|
115
|
+
range_between(begin_pos_node.loc.selector.begin_pos, end_pos_node.source_range.end_pos)
|
116
116
|
end
|
117
117
|
end
|
118
118
|
end
|
@@ -66,7 +66,7 @@ module RuboCop
|
|
66
66
|
|
67
67
|
def register_offense(comment, matched_keyword)
|
68
68
|
add_offense(comment, message: format(MSG, keyword: matched_keyword)) do |corrector|
|
69
|
-
range = range_with_surrounding_space(comment.
|
69
|
+
range = range_with_surrounding_space(comment.source_range, newlines: false)
|
70
70
|
corrector.remove(range)
|
71
71
|
|
72
72
|
unless matched_keyword == 'end'
|
@@ -84,7 +84,7 @@ module RuboCop
|
|
84
84
|
end
|
85
85
|
|
86
86
|
def source_line(comment)
|
87
|
-
comment.
|
87
|
+
comment.source_range.source_line
|
88
88
|
end
|
89
89
|
end
|
90
90
|
end
|
@@ -38,7 +38,7 @@ module RuboCop
|
|
38
38
|
offense = offense_range(node)
|
39
39
|
current = offense.source
|
40
40
|
|
41
|
-
if node.arguments.any?(&:percent_literal?)
|
41
|
+
if (use_percent_literal = node.arguments.any?(&:percent_literal?))
|
42
42
|
if percent_literals_includes_only_basic_literals?(node)
|
43
43
|
prefer = preferred_method(node)
|
44
44
|
message = format(MSG, prefer: prefer, current: current)
|
@@ -51,7 +51,15 @@ module RuboCop
|
|
51
51
|
end
|
52
52
|
|
53
53
|
add_offense(offense, message: message) do |corrector|
|
54
|
-
|
54
|
+
if use_percent_literal
|
55
|
+
corrector.replace(offense, prefer)
|
56
|
+
else
|
57
|
+
corrector.replace(node.loc.selector, 'push')
|
58
|
+
node.arguments.each do |argument|
|
59
|
+
corrector.remove(argument.loc.begin)
|
60
|
+
corrector.remove(argument.loc.end)
|
61
|
+
end
|
62
|
+
end
|
55
63
|
end
|
56
64
|
end
|
57
65
|
# rubocop:enable Metrics
|
@@ -450,7 +450,7 @@ module RuboCop
|
|
450
450
|
end
|
451
451
|
|
452
452
|
def white_space_range(node, column)
|
453
|
-
expression = node.
|
453
|
+
expression = node.source_range
|
454
454
|
begin_pos = expression.begin_pos - (expression.column - column - 2)
|
455
455
|
|
456
456
|
Parser::Source::Range.new(expression.source_buffer, begin_pos, expression.begin_pos)
|
@@ -458,9 +458,9 @@ module RuboCop
|
|
458
458
|
|
459
459
|
def assignment(node)
|
460
460
|
*_, condition = *node
|
461
|
-
Parser::Source::Range.new(node.
|
462
|
-
node.
|
463
|
-
condition.
|
461
|
+
Parser::Source::Range.new(node.source_range.source_buffer,
|
462
|
+
node.source_range.begin_pos,
|
463
|
+
condition.source_range.begin_pos)
|
464
464
|
end
|
465
465
|
|
466
466
|
def correct_if_branches(corrector, cop, node)
|
@@ -565,7 +565,7 @@ module RuboCop
|
|
565
565
|
end
|
566
566
|
|
567
567
|
def move_assignment_inside_condition(corrector, node)
|
568
|
-
column = node.
|
568
|
+
column = node.source_range.column
|
569
569
|
*_var, condition = *node
|
570
570
|
assignment = assignment(node)
|
571
571
|
|
@@ -616,7 +616,7 @@ module RuboCop
|
|
616
616
|
end
|
617
617
|
|
618
618
|
def move_assignment_inside_condition(corrector, node)
|
619
|
-
column = node.
|
619
|
+
column = node.source_range.column
|
620
620
|
*_var, condition = *node
|
621
621
|
assignment = assignment(node)
|
622
622
|
|
@@ -0,0 +1,60 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module RuboCop
|
4
|
+
module Cop
|
5
|
+
module Style
|
6
|
+
# Prefer to use `Dir.empty?('path/to/dir')` when checking if a directory is empty.
|
7
|
+
#
|
8
|
+
# @example
|
9
|
+
# # bad
|
10
|
+
# Dir.entries('path/to/dir').size == 2
|
11
|
+
# Dir.children('path/to/dir').empty?
|
12
|
+
# Dir.children('path/to/dir').size == 0
|
13
|
+
# Dir.each_child('path/to/dir').none?
|
14
|
+
#
|
15
|
+
# # good
|
16
|
+
# Dir.empty?('path/to/dir')
|
17
|
+
#
|
18
|
+
class DirEmpty < Base
|
19
|
+
extend AutoCorrector
|
20
|
+
extend TargetRubyVersion
|
21
|
+
|
22
|
+
MSG = 'Use `Dir.empty?(%<arg>s)` instead.'
|
23
|
+
RESTRICT_ON_SEND = %i[== > empty? none?].freeze
|
24
|
+
|
25
|
+
minimum_target_ruby_version 2.4
|
26
|
+
|
27
|
+
# @!method offensive?(node)
|
28
|
+
def_node_matcher :offensive?, <<~PATTERN
|
29
|
+
{
|
30
|
+
(send (send (send $(const {nil? cbase} :Dir) :entries $_) :size) {:== :>} (int 2))
|
31
|
+
(send (send (send $(const {nil? cbase} :Dir) :children $_) :size) {:== :>} (int 0))
|
32
|
+
(send (send (send (send $(const {nil? cbase} :Dir) :entries $_) :size) :!) {:== :>} (int 2))
|
33
|
+
(send (send (send (send $(const {nil? cbase} :Dir) :children $_) :size) :!) {:== :>} (int 0))
|
34
|
+
(send (send $(const {nil? cbase} :Dir) :children $_) :empty?)
|
35
|
+
(send (send $(const {nil? cbase} :Dir) :each_child $_) :none?)
|
36
|
+
}
|
37
|
+
PATTERN
|
38
|
+
|
39
|
+
def on_send(node)
|
40
|
+
offensive?(node) do |const_node, arg_node|
|
41
|
+
add_offense(node, message: format(MSG, arg: arg_node.source)) do |corrector|
|
42
|
+
bang(node)
|
43
|
+
corrector.replace(node,
|
44
|
+
"#{bang(node)}#{const_node.source}.empty?(#{arg_node.source})")
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
48
|
+
|
49
|
+
private
|
50
|
+
|
51
|
+
def bang(node)
|
52
|
+
if (node.method?(:==) && node.child_nodes.first.method?(:!)) ||
|
53
|
+
(node.method?(:>) && !node.child_nodes.first.method?(:!))
|
54
|
+
'!'
|
55
|
+
end
|
56
|
+
end
|
57
|
+
end
|
58
|
+
end
|
59
|
+
end
|
60
|
+
end
|
@@ -116,7 +116,7 @@ module RuboCop
|
|
116
116
|
|
117
117
|
def preceding_comment_blocks(node)
|
118
118
|
# Collect comments in the method call, but outside the heredoc
|
119
|
-
comments = processed_source.each_comment_in_lines(node.
|
119
|
+
comments = processed_source.each_comment_in_lines(node.source_range.line_span)
|
120
120
|
|
121
121
|
comments.each_with_object({}) do |comment, hash|
|
122
122
|
merge_adjacent_comments(comment.text, comment.loc.line, hash)
|
@@ -110,7 +110,7 @@ module RuboCop
|
|
110
110
|
return if nodoc_self_or_outer_module?(node)
|
111
111
|
return if include_statement_only?(body)
|
112
112
|
|
113
|
-
range = range_between(node.
|
113
|
+
range = range_between(node.source_range.begin_pos, node.loc.name.end_pos)
|
114
114
|
message = format(MSG, type: node.type, identifier: identifier(node))
|
115
115
|
add_offense(range, message: message)
|
116
116
|
end
|
@@ -178,13 +178,19 @@ module RuboCop
|
|
178
178
|
def identifier(node)
|
179
179
|
# Get the fully qualified identifier for a class/module
|
180
180
|
nodes = [node, *node.each_ancestor(:class, :module)]
|
181
|
-
nodes.reverse_each.flat_map { |n| qualify_const(n.identifier) }.join('::')
|
181
|
+
identifier = nodes.reverse_each.flat_map { |n| qualify_const(n.identifier) }.join('::')
|
182
|
+
|
183
|
+
identifier.sub('::::', '::')
|
182
184
|
end
|
183
185
|
|
184
186
|
def qualify_const(node)
|
185
|
-
return if node.nil?
|
187
|
+
return if node.nil?
|
186
188
|
|
187
|
-
|
189
|
+
if node.cbase_type? || node.self_type? || node.call_type? || node.variable?
|
190
|
+
node.source
|
191
|
+
else
|
192
|
+
[qualify_const(node.namespace), node.short_name].compact
|
193
|
+
end
|
188
194
|
end
|
189
195
|
end
|
190
196
|
end
|
@@ -37,7 +37,7 @@ module RuboCop
|
|
37
37
|
|
38
38
|
def autocorrect(corrector, node)
|
39
39
|
block = node.parent
|
40
|
-
range = range_between(block.loc.begin.end_pos, node.
|
40
|
+
range = range_between(block.loc.begin.end_pos, node.source_range.end_pos)
|
41
41
|
|
42
42
|
corrector.remove(range)
|
43
43
|
end
|
@@ -34,7 +34,7 @@ module RuboCop
|
|
34
34
|
|
35
35
|
def autocorrect(corrector, node)
|
36
36
|
send_node = node.parent.send_node
|
37
|
-
range = range_between(send_node.
|
37
|
+
range = range_between(send_node.source_range.end_pos, node.source_range.end_pos)
|
38
38
|
|
39
39
|
corrector.remove(range)
|
40
40
|
end
|