rubocop 1.50.2 → 1.57.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +5 -3
- data/config/default.yml +110 -14
- data/config/obsoletion.yml +5 -0
- data/lib/rubocop/cli/command/auto_generate_config.rb +10 -5
- data/lib/rubocop/cli/command/lsp.rb +19 -0
- data/lib/rubocop/cli.rb +4 -1
- data/lib/rubocop/config.rb +4 -0
- data/lib/rubocop/config_finder.rb +2 -2
- data/lib/rubocop/config_loader_resolver.rb +4 -3
- data/lib/rubocop/config_obsoletion/parameter_rule.rb +9 -1
- data/lib/rubocop/config_obsoletion.rb +2 -2
- data/lib/rubocop/cop/autocorrect_logic.rb +3 -1
- data/lib/rubocop/cop/base.rb +6 -2
- data/lib/rubocop/cop/bundler/duplicated_gem.rb +1 -0
- data/lib/rubocop/cop/bundler/duplicated_group.rb +127 -0
- data/lib/rubocop/cop/bundler/gem_comment.rb +1 -1
- data/lib/rubocop/cop/bundler/gem_version.rb +2 -2
- data/lib/rubocop/cop/bundler/ordered_gems.rb +9 -1
- data/lib/rubocop/cop/correctors/alignment_corrector.rb +1 -1
- data/lib/rubocop/cop/correctors/lambda_literal_to_method_corrector.rb +7 -4
- data/lib/rubocop/cop/gemspec/dependency_version.rb +2 -2
- data/lib/rubocop/cop/gemspec/development_dependencies.rb +1 -1
- data/lib/rubocop/cop/gemspec/ordered_dependencies.rb +9 -1
- data/lib/rubocop/cop/generator/require_file_injector.rb +1 -1
- data/lib/rubocop/cop/internal_affairs/cop_description.rb +32 -8
- data/lib/rubocop/cop/internal_affairs/example_description.rb +42 -21
- data/lib/rubocop/cop/internal_affairs/location_line_equality_comparison.rb +3 -1
- data/lib/rubocop/cop/internal_affairs/node_matcher_directive.rb +5 -5
- data/lib/rubocop/cop/internal_affairs/redundant_method_dispatch_node.rb +11 -2
- data/lib/rubocop/cop/internal_affairs/useless_message_assertion.rb +2 -0
- data/lib/rubocop/cop/layout/class_structure.rb +7 -0
- data/lib/rubocop/cop/layout/closing_heredoc_indentation.rb +1 -2
- data/lib/rubocop/cop/layout/dot_position.rb +1 -5
- data/lib/rubocop/cop/layout/empty_line_after_guard_clause.rb +42 -9
- data/lib/rubocop/cop/layout/empty_line_between_defs.rb +27 -4
- data/lib/rubocop/cop/layout/empty_lines_around_exception_handling_keywords.rb +2 -0
- data/lib/rubocop/cop/layout/end_alignment.rb +7 -1
- data/lib/rubocop/cop/layout/heredoc_argument_closing_parenthesis.rb +2 -2
- data/lib/rubocop/cop/layout/heredoc_indentation.rb +3 -0
- data/lib/rubocop/cop/layout/indentation_style.rb +1 -1
- data/lib/rubocop/cop/layout/indentation_width.rb +3 -3
- data/lib/rubocop/cop/layout/leading_comment_space.rb +1 -1
- data/lib/rubocop/cop/layout/line_continuation_leading_space.rb +17 -9
- data/lib/rubocop/cop/layout/line_continuation_spacing.rb +1 -1
- data/lib/rubocop/cop/layout/line_end_string_concatenation_indentation.rb +2 -0
- data/lib/rubocop/cop/layout/multiline_method_call_indentation.rb +18 -3
- data/lib/rubocop/cop/layout/redundant_line_break.rb +14 -4
- data/lib/rubocop/cop/layout/space_after_comma.rb +9 -1
- data/lib/rubocop/cop/layout/space_after_not.rb +1 -1
- data/lib/rubocop/cop/layout/space_around_method_call_operator.rb +2 -2
- data/lib/rubocop/cop/layout/space_around_operators.rb +3 -1
- data/lib/rubocop/cop/layout/space_inside_block_braces.rb +2 -0
- data/lib/rubocop/cop/layout/space_inside_parens.rb +1 -1
- data/lib/rubocop/cop/layout/space_inside_range_literal.rb +1 -1
- data/lib/rubocop/cop/layout/trailing_empty_lines.rb +5 -0
- data/lib/rubocop/cop/lint/ambiguous_block_association.rb +13 -1
- data/lib/rubocop/cop/lint/debugger.rb +18 -5
- data/lib/rubocop/cop/lint/duplicate_hash_key.rb +2 -1
- data/lib/rubocop/cop/lint/duplicate_regexp_character_class_element.rb +46 -19
- data/lib/rubocop/cop/lint/empty_block.rb +1 -1
- data/lib/rubocop/cop/lint/erb_new_arguments.rb +3 -4
- data/lib/rubocop/cop/lint/heredoc_method_call_position.rb +1 -1
- data/lib/rubocop/cop/lint/identity_comparison.rb +0 -1
- data/lib/rubocop/cop/lint/incompatible_io_select_with_fiber_scheduler.rb +5 -3
- data/lib/rubocop/cop/lint/inherit_exception.rb +9 -0
- data/lib/rubocop/cop/lint/lambda_without_literal_block.rb +1 -1
- data/lib/rubocop/cop/lint/literal_in_interpolation.rb +1 -1
- data/lib/rubocop/cop/lint/missing_super.rb +34 -5
- data/lib/rubocop/cop/lint/mixed_case_range.rb +111 -0
- data/lib/rubocop/cop/lint/non_atomic_file_operation.rb +10 -7
- data/lib/rubocop/cop/lint/number_conversion.rb +5 -0
- data/lib/rubocop/cop/lint/numbered_parameter_assignment.rb +2 -2
- data/lib/rubocop/cop/lint/ordered_magic_comments.rb +0 -1
- data/lib/rubocop/cop/lint/out_of_range_regexp_ref.rb +2 -2
- data/lib/rubocop/cop/lint/redundant_regexp_quantifiers.rb +130 -0
- data/lib/rubocop/cop/lint/redundant_require_statement.rb +12 -3
- data/lib/rubocop/cop/lint/redundant_safe_navigation.rb +20 -4
- data/lib/rubocop/cop/lint/redundant_string_coercion.rb +1 -1
- data/lib/rubocop/cop/lint/safe_navigation_chain.rb +11 -4
- data/lib/rubocop/cop/lint/send_with_mixin_argument.rb +1 -2
- data/lib/rubocop/cop/lint/shadowed_exception.rb +5 -11
- data/lib/rubocop/cop/lint/shadowing_outer_local_variable.rb +7 -1
- data/lib/rubocop/cop/lint/struct_new_override.rb +12 -12
- data/lib/rubocop/cop/lint/suppressed_exception.rb +2 -2
- data/lib/rubocop/cop/lint/symbol_conversion.rb +1 -1
- data/lib/rubocop/cop/lint/to_enum_arguments.rb +5 -3
- data/lib/rubocop/cop/lint/top_level_return_with_argument.rb +23 -9
- data/lib/rubocop/cop/lint/useless_assignment.rb +94 -10
- data/lib/rubocop/cop/lint/void.rb +78 -10
- data/lib/rubocop/cop/metrics/block_length.rb +1 -1
- data/lib/rubocop/cop/metrics/class_length.rb +8 -3
- data/lib/rubocop/cop/metrics/method_length.rb +1 -1
- data/lib/rubocop/cop/metrics/utils/abc_size_calculator.rb +1 -2
- data/lib/rubocop/cop/metrics/utils/code_length_calculator.rb +32 -4
- data/lib/rubocop/cop/migration/department_name.rb +2 -2
- data/lib/rubocop/cop/mixin/allowed_receivers.rb +34 -0
- data/lib/rubocop/cop/mixin/comments_help.rb +19 -11
- data/lib/rubocop/cop/mixin/def_node.rb +1 -1
- data/lib/rubocop/cop/mixin/end_keyword_alignment.rb +1 -1
- data/lib/rubocop/cop/mixin/hash_shorthand_syntax.rb +14 -11
- data/lib/rubocop/cop/mixin/heredoc.rb +6 -2
- data/lib/rubocop/cop/mixin/multiline_expression_indentation.rb +3 -2
- data/lib/rubocop/cop/mixin/percent_literal.rb +1 -1
- data/lib/rubocop/cop/mixin/preceding_following_alignment.rb +5 -7
- data/lib/rubocop/cop/mixin/space_after_punctuation.rb +1 -1
- data/lib/rubocop/cop/mixin/string_help.rb +4 -2
- data/lib/rubocop/cop/mixin/trailing_comma.rb +1 -1
- data/lib/rubocop/cop/naming/block_forwarding.rb +1 -1
- data/lib/rubocop/cop/naming/constant_name.rb +1 -1
- data/lib/rubocop/cop/naming/file_name.rb +1 -1
- data/lib/rubocop/cop/naming/heredoc_delimiter_naming.rb +3 -1
- data/lib/rubocop/cop/naming/memoized_instance_variable_name.rb +25 -10
- data/lib/rubocop/cop/naming/rescued_exceptions_variable_name.rb +11 -3
- data/lib/rubocop/cop/naming/variable_name.rb +6 -1
- data/lib/rubocop/cop/style/accessor_grouping.rb +5 -1
- data/lib/rubocop/cop/style/alias.rb +9 -8
- data/lib/rubocop/cop/style/arguments_forwarding.rb +280 -63
- data/lib/rubocop/cop/style/array_intersect.rb +13 -5
- data/lib/rubocop/cop/style/attr.rb +11 -1
- data/lib/rubocop/cop/style/begin_block.rb +1 -2
- data/lib/rubocop/cop/style/block_comments.rb +1 -1
- data/lib/rubocop/cop/style/block_delimiters.rb +5 -4
- data/lib/rubocop/cop/style/class_and_module_children.rb +1 -1
- data/lib/rubocop/cop/style/class_equality_comparison.rb +24 -39
- data/lib/rubocop/cop/style/collection_compact.rb +16 -6
- data/lib/rubocop/cop/style/collection_methods.rb +2 -0
- data/lib/rubocop/cop/style/colon_method_call.rb +2 -2
- data/lib/rubocop/cop/style/combinable_loops.rb +30 -8
- data/lib/rubocop/cop/style/concat_array_literals.rb +1 -1
- data/lib/rubocop/cop/style/conditional_assignment.rb +5 -3
- data/lib/rubocop/cop/style/copyright.rb +5 -2
- data/lib/rubocop/cop/style/dir.rb +1 -1
- data/lib/rubocop/cop/style/dir_empty.rb +8 -14
- data/lib/rubocop/cop/style/document_dynamic_eval_definition.rb +1 -1
- data/lib/rubocop/cop/style/documentation.rb +1 -1
- data/lib/rubocop/cop/style/empty_case_condition.rb +6 -1
- data/lib/rubocop/cop/style/eval_with_location.rb +5 -5
- data/lib/rubocop/cop/style/exact_regexp_match.rb +68 -0
- data/lib/rubocop/cop/style/file_read.rb +2 -2
- data/lib/rubocop/cop/style/for.rb +1 -1
- data/lib/rubocop/cop/style/format_string.rb +24 -3
- data/lib/rubocop/cop/style/frozen_string_literal_comment.rb +3 -1
- data/lib/rubocop/cop/style/guard_clause.rb +28 -0
- data/lib/rubocop/cop/style/hash_conversion.rb +10 -0
- data/lib/rubocop/cop/style/hash_each_methods.rb +1 -22
- data/lib/rubocop/cop/style/hash_except.rb +19 -8
- data/lib/rubocop/cop/style/hash_transform_keys.rb +2 -2
- data/lib/rubocop/cop/style/hash_transform_values.rb +2 -2
- data/lib/rubocop/cop/style/identical_conditional_branches.rb +31 -5
- data/lib/rubocop/cop/style/if_inside_else.rb +6 -0
- data/lib/rubocop/cop/style/if_unless_modifier.rb +3 -0
- data/lib/rubocop/cop/style/if_with_semicolon.rb +2 -2
- data/lib/rubocop/cop/style/invertible_unless_condition.rb +10 -6
- data/lib/rubocop/cop/style/lambda.rb +3 -3
- data/lib/rubocop/cop/style/lambda_call.rb +5 -0
- data/lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb +11 -5
- data/lib/rubocop/cop/style/mixin_grouping.rb +1 -1
- data/lib/rubocop/cop/style/multiline_block_chain.rb +1 -1
- data/lib/rubocop/cop/style/multiline_ternary_operator.rb +1 -1
- data/lib/rubocop/cop/style/multiple_comparison.rb +14 -0
- data/lib/rubocop/cop/style/nested_ternary_operator.rb +3 -11
- data/lib/rubocop/cop/style/numeric_literals.rb +1 -1
- data/lib/rubocop/cop/style/open_struct_use.rb +1 -1
- data/lib/rubocop/cop/style/operator_method_call.rb +6 -0
- data/lib/rubocop/cop/style/percent_literal_delimiters.rb +1 -1
- data/lib/rubocop/cop/style/preferred_hash_methods.rb +1 -1
- data/lib/rubocop/cop/style/redundant_argument.rb +6 -1
- data/lib/rubocop/cop/style/redundant_array_constructor.rb +77 -0
- data/lib/rubocop/cop/style/redundant_begin.rb +10 -2
- data/lib/rubocop/cop/style/redundant_conditional.rb +2 -10
- data/lib/rubocop/cop/style/redundant_current_directory_in_path.rb +38 -0
- data/lib/rubocop/cop/style/redundant_double_splat_hash_braces.rb +93 -5
- data/lib/rubocop/cop/style/redundant_exception.rb +32 -12
- data/lib/rubocop/cop/style/redundant_filter_chain.rb +118 -0
- data/lib/rubocop/cop/style/redundant_line_continuation.rb +7 -3
- data/lib/rubocop/cop/style/redundant_parentheses.rb +42 -16
- data/lib/rubocop/cop/style/redundant_regexp_argument.rb +100 -0
- data/lib/rubocop/cop/style/redundant_regexp_constructor.rb +46 -0
- data/lib/rubocop/cop/style/redundant_regexp_escape.rb +2 -1
- data/lib/rubocop/cop/style/redundant_return.rb +7 -2
- data/lib/rubocop/cop/style/redundant_self_assignment_branch.rb +8 -1
- data/lib/rubocop/cop/style/redundant_sort.rb +1 -1
- data/lib/rubocop/cop/style/redundant_string_escape.rb +2 -0
- data/lib/rubocop/cop/style/regexp_literal.rb +11 -2
- data/lib/rubocop/cop/style/require_order.rb +11 -5
- data/lib/rubocop/cop/style/rescue_modifier.rb +1 -3
- data/lib/rubocop/cop/style/return_nil.rb +6 -2
- data/lib/rubocop/cop/style/return_nil_in_predicate_method_definition.rb +95 -0
- data/lib/rubocop/cop/style/select_by_regexp.rb +15 -5
- data/lib/rubocop/cop/style/semicolon.rb +12 -4
- data/lib/rubocop/cop/style/signal_exception.rb +1 -1
- data/lib/rubocop/cop/style/single_argument_dig.rb +2 -1
- data/lib/rubocop/cop/style/single_line_do_end_block.rb +67 -0
- data/lib/rubocop/cop/style/single_line_methods.rb +1 -1
- data/lib/rubocop/cop/style/sole_nested_conditional.rb +6 -2
- data/lib/rubocop/cop/style/special_global_vars.rb +3 -4
- data/lib/rubocop/cop/style/string_literals_in_interpolation.rb +30 -5
- data/lib/rubocop/cop/style/symbol_array.rb +35 -15
- data/lib/rubocop/cop/style/yaml_file_read.rb +66 -0
- data/lib/rubocop/cop/style/yoda_condition.rb +4 -2
- data/lib/rubocop/cop/style/yoda_expression.rb +8 -7
- data/lib/rubocop/cop/team.rb +1 -1
- data/lib/rubocop/cop/util.rb +1 -1
- data/lib/rubocop/cop/utils/regexp_ranges.rb +113 -0
- data/lib/rubocop/cop/variable_force/assignment.rb +45 -4
- data/lib/rubocop/cop/variable_force/variable_table.rb +2 -2
- data/lib/rubocop/cop/variable_force.rb +1 -0
- data/lib/rubocop/cops_documentation_generator.rb +1 -1
- data/lib/rubocop/ext/regexp_parser.rb +4 -1
- data/lib/rubocop/file_finder.rb +4 -7
- data/lib/rubocop/formatter/html_formatter.rb +4 -2
- data/lib/rubocop/formatter/junit_formatter.rb +1 -1
- data/lib/rubocop/lsp/logger.rb +22 -0
- data/lib/rubocop/lsp/routes.rb +246 -0
- data/lib/rubocop/lsp/runtime.rb +99 -0
- data/lib/rubocop/lsp/server.rb +68 -0
- data/lib/rubocop/lsp/severity.rb +27 -0
- data/lib/rubocop/magic_comment.rb +12 -10
- data/lib/rubocop/options.rb +11 -1
- data/lib/rubocop/result_cache.rb +5 -1
- data/lib/rubocop/rspec/cop_helper.rb +1 -1
- data/lib/rubocop/rspec/shared_contexts.rb +2 -3
- data/lib/rubocop/runner.rb +5 -3
- data/lib/rubocop/server/cache.rb +1 -0
- data/lib/rubocop/server/client_command/exec.rb +3 -2
- data/lib/rubocop/string_interpreter.rb +3 -3
- data/lib/rubocop/target_finder.rb +7 -3
- data/lib/rubocop/target_ruby.rb +12 -7
- data/lib/rubocop/version.rb +10 -6
- data/lib/rubocop.rb +15 -0
- metadata +45 -11
@@ -8,6 +8,12 @@ module RuboCop
|
|
8
8
|
# This cop identifies places where `do_something(*args, &block)`
|
9
9
|
# can be replaced by `do_something(...)`.
|
10
10
|
#
|
11
|
+
# In Ruby 3.2, anonymous args/kwargs forwarding has been added.
|
12
|
+
#
|
13
|
+
# This cop also identifies places where `use_args(*args)`/`use_kwargs(**kwargs)` can be
|
14
|
+
# replaced by `use_args(*)`/`use_kwargs(**)`; if desired, this functionality can be disabled
|
15
|
+
# by setting UseAnonymousForwarding: false.
|
16
|
+
#
|
11
17
|
# @example
|
12
18
|
# # bad
|
13
19
|
# def foo(*args, &block)
|
@@ -24,7 +30,27 @@ module RuboCop
|
|
24
30
|
# bar(...)
|
25
31
|
# end
|
26
32
|
#
|
27
|
-
# @example
|
33
|
+
# @example UseAnonymousForwarding: true (default, only relevant for Ruby >= 3.2)
|
34
|
+
# # bad
|
35
|
+
# def foo(*args, **kwargs)
|
36
|
+
# args_only(*args)
|
37
|
+
# kwargs_only(**kwargs)
|
38
|
+
# end
|
39
|
+
#
|
40
|
+
# # good
|
41
|
+
# def foo(*, **)
|
42
|
+
# args_only(*)
|
43
|
+
# kwargs_only(**)
|
44
|
+
# end
|
45
|
+
#
|
46
|
+
# @example UseAnonymousForwarding: false (only relevant for Ruby >= 3.2)
|
47
|
+
# # good
|
48
|
+
# def foo(*args, **kwargs)
|
49
|
+
# args_only(*args)
|
50
|
+
# kwargs_only(**kwargs)
|
51
|
+
# end
|
52
|
+
#
|
53
|
+
# @example AllowOnlyRestArgument: true (default, only relevant for Ruby < 3.2)
|
28
54
|
# # good
|
29
55
|
# def foo(*args)
|
30
56
|
# bar(*args)
|
@@ -34,7 +60,7 @@ module RuboCop
|
|
34
60
|
# bar(**kwargs)
|
35
61
|
# end
|
36
62
|
#
|
37
|
-
# @example AllowOnlyRestArgument: false
|
63
|
+
# @example AllowOnlyRestArgument: false (only relevant for Ruby < 3.2)
|
38
64
|
# # bad
|
39
65
|
# # The following code can replace the arguments with `...`,
|
40
66
|
# # but it will change the behavior. Because `...` forwards block also.
|
@@ -53,102 +79,293 @@ module RuboCop
|
|
53
79
|
|
54
80
|
minimum_target_ruby_version 2.7
|
55
81
|
|
56
|
-
|
57
|
-
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
# @!method only_rest_arguments?(node, name)
|
64
|
-
def_node_matcher :only_rest_arguments?, <<~PATTERN
|
65
|
-
{
|
66
|
-
(send _ _ (splat (lvar %1)))
|
67
|
-
(send _ _ (hash (kwsplat (lvar %1))))
|
68
|
-
}
|
69
|
-
PATTERN
|
70
|
-
|
71
|
-
# @!method forwarding_method_arguments?(node, rest_name, block_name, kwargs_name)
|
72
|
-
def_node_matcher :forwarding_method_arguments?, <<~PATTERN
|
73
|
-
{
|
74
|
-
(send _ _
|
75
|
-
(splat (lvar %1))
|
76
|
-
(block-pass {(lvar %2) nil?}))
|
77
|
-
(send _ _
|
78
|
-
(splat (lvar %1))
|
79
|
-
(hash (kwsplat (lvar %3)))
|
80
|
-
(block-pass {(lvar %2) nil?}))
|
81
|
-
}
|
82
|
-
PATTERN
|
82
|
+
FORWARDING_LVAR_TYPES = %i[splat kwsplat block_pass].freeze
|
83
|
+
ADDITIONAL_ARG_TYPES = %i[lvar arg].freeze
|
84
|
+
|
85
|
+
FORWARDING_MSG = 'Use shorthand syntax `...` for arguments forwarding.'
|
86
|
+
ARGS_MSG = 'Use anonymous positional arguments forwarding (`*`).'
|
87
|
+
KWARGS_MSG = 'Use anonymous keyword arguments forwarding (`**`).'
|
83
88
|
|
84
89
|
def on_def(node)
|
85
90
|
return unless node.body
|
86
|
-
return unless (rest_args_name, args = use_rest_arguments?(node.arguments))
|
87
|
-
return if args.any?(&:default?)
|
88
91
|
|
89
|
-
node.
|
90
|
-
|
92
|
+
forwardable_args = extract_forwardable_args(node.arguments)
|
93
|
+
|
94
|
+
send_classifications = classify_send_nodes(
|
95
|
+
node,
|
96
|
+
node.each_descendant(:send).to_a,
|
97
|
+
non_splat_or_block_pass_lvar_references(node.body),
|
98
|
+
forwardable_args
|
99
|
+
)
|
91
100
|
|
92
|
-
|
93
|
-
all_lvars_as_forwarding_method_arguments?(node, send_node)
|
101
|
+
return if send_classifications.empty?
|
94
102
|
|
95
|
-
|
96
|
-
|
103
|
+
if only_forwards_all?(send_classifications)
|
104
|
+
add_forward_all_offenses(node, send_classifications, forwardable_args)
|
105
|
+
elsif target_ruby_version >= 3.2
|
106
|
+
add_post_ruby_32_offenses(node, send_classifications, forwardable_args)
|
97
107
|
end
|
98
108
|
end
|
109
|
+
|
99
110
|
alias on_defs on_def
|
100
111
|
|
101
112
|
private
|
102
113
|
|
103
|
-
def
|
104
|
-
|
105
|
-
|
114
|
+
def extract_forwardable_args(args)
|
115
|
+
[args.find(&:restarg_type?), args.find(&:kwrestarg_type?), args.find(&:blockarg_type?)]
|
116
|
+
end
|
106
117
|
|
107
|
-
|
118
|
+
def only_forwards_all?(send_classifications)
|
119
|
+
send_classifications.all? { |_, c, _, _| c == :all }
|
108
120
|
end
|
109
121
|
|
110
|
-
def
|
111
|
-
|
122
|
+
def add_forward_all_offenses(node, send_classifications, forwardable_args)
|
123
|
+
send_classifications.each do |send_node, _c, forward_rest, _forward_kwrest|
|
124
|
+
register_forward_all_offense(send_node, send_node, forward_rest)
|
125
|
+
end
|
112
126
|
|
113
|
-
|
127
|
+
rest_arg, _kwrest_arg, _block_arg = *forwardable_args
|
128
|
+
register_forward_all_offense(node, node.arguments, rest_arg)
|
114
129
|
end
|
115
130
|
|
116
|
-
def
|
117
|
-
|
131
|
+
def add_post_ruby_32_offenses(def_node, send_classifications, forwardable_args)
|
132
|
+
return unless use_anonymous_forwarding?
|
133
|
+
|
134
|
+
rest_arg, kwrest_arg, _block_arg = *forwardable_args
|
118
135
|
|
119
|
-
|
120
|
-
|
136
|
+
send_classifications.each do |send_node, _c, forward_rest, forward_kwrest|
|
137
|
+
if forward_rest
|
138
|
+
register_forward_args_offense(def_node.arguments, rest_arg)
|
139
|
+
register_forward_args_offense(send_node, forward_rest)
|
140
|
+
end
|
121
141
|
|
122
|
-
|
142
|
+
if forward_kwrest
|
143
|
+
register_forward_kwargs_offense(!forward_rest, def_node.arguments, kwrest_arg)
|
144
|
+
register_forward_kwargs_offense(!forward_rest, send_node, forward_kwrest)
|
145
|
+
end
|
146
|
+
end
|
123
147
|
end
|
124
148
|
|
125
|
-
def
|
126
|
-
|
127
|
-
|
128
|
-
range = range_between(begin_pos, forwarding_method.source_range.end_pos)
|
149
|
+
def non_splat_or_block_pass_lvar_references(body)
|
150
|
+
body.each_descendant(:lvar, :lvasgn).filter_map do |lvar|
|
151
|
+
parent = lvar.parent
|
129
152
|
|
130
|
-
|
131
|
-
|
153
|
+
next if lvar.lvar_type? && FORWARDING_LVAR_TYPES.include?(parent.type)
|
154
|
+
|
155
|
+
lvar.children.first
|
156
|
+
end.uniq
|
132
157
|
end
|
133
158
|
|
134
|
-
def
|
135
|
-
|
136
|
-
|
137
|
-
|
159
|
+
def classify_send_nodes(def_node, send_nodes, referenced_lvars, forwardable_args)
|
160
|
+
send_nodes.filter_map do |send_node|
|
161
|
+
classification_and_forwards = classification_and_forwards(
|
162
|
+
def_node,
|
163
|
+
send_node,
|
164
|
+
referenced_lvars,
|
165
|
+
forwardable_args
|
138
166
|
)
|
139
|
-
|
167
|
+
|
168
|
+
next unless classification_and_forwards
|
169
|
+
|
170
|
+
[send_node, *classification_and_forwards]
|
140
171
|
end
|
141
172
|
end
|
142
173
|
|
143
|
-
def
|
144
|
-
|
174
|
+
def classification_and_forwards(def_node, send_node, referenced_lvars, forwardable_args)
|
175
|
+
classifier = SendNodeClassifier.new(
|
176
|
+
def_node,
|
177
|
+
send_node,
|
178
|
+
referenced_lvars,
|
179
|
+
forwardable_args,
|
180
|
+
target_ruby_version: target_ruby_version,
|
181
|
+
allow_only_rest_arguments: allow_only_rest_arguments?
|
182
|
+
)
|
183
|
+
|
184
|
+
classification = classifier.classification
|
145
185
|
|
146
|
-
|
186
|
+
return unless classification
|
187
|
+
|
188
|
+
[classification, classifier.forwarded_rest_arg, classifier.forwarded_kwrest_arg]
|
189
|
+
end
|
190
|
+
|
191
|
+
def register_forward_args_offense(def_arguments_or_send, rest_arg_or_splat)
|
192
|
+
add_offense(rest_arg_or_splat, message: ARGS_MSG) do |corrector|
|
193
|
+
add_parens_if_missing(def_arguments_or_send, corrector)
|
194
|
+
|
195
|
+
corrector.replace(rest_arg_or_splat, '*')
|
196
|
+
end
|
197
|
+
end
|
198
|
+
|
199
|
+
def register_forward_kwargs_offense(add_parens, def_arguments_or_send, kwrest_arg_or_splat)
|
200
|
+
add_offense(kwrest_arg_or_splat, message: KWARGS_MSG) do |corrector|
|
201
|
+
add_parens_if_missing(def_arguments_or_send, corrector) if add_parens
|
202
|
+
|
203
|
+
corrector.replace(kwrest_arg_or_splat, '**')
|
204
|
+
end
|
205
|
+
end
|
206
|
+
|
207
|
+
def register_forward_all_offense(def_or_send, send_or_arguments, rest_or_splat)
|
208
|
+
arg_range = arguments_range(def_or_send, rest_or_splat)
|
209
|
+
|
210
|
+
add_offense(arg_range, message: FORWARDING_MSG) do |corrector|
|
211
|
+
add_parens_if_missing(send_or_arguments, corrector)
|
212
|
+
|
213
|
+
corrector.replace(arg_range, '...')
|
214
|
+
end
|
215
|
+
end
|
216
|
+
|
217
|
+
def arguments_range(node, first_node)
|
218
|
+
arguments = node.arguments.reject { |arg| ADDITIONAL_ARG_TYPES.include?(arg.type) }
|
219
|
+
|
220
|
+
start_node = first_node || arguments.first
|
221
|
+
|
222
|
+
range_between(start_node.source_range.begin_pos, arguments.last.source_range.end_pos)
|
147
223
|
end
|
148
224
|
|
149
225
|
def allow_only_rest_arguments?
|
150
226
|
cop_config.fetch('AllowOnlyRestArgument', true)
|
151
227
|
end
|
228
|
+
|
229
|
+
def use_anonymous_forwarding?
|
230
|
+
cop_config.fetch('UseAnonymousForwarding', false)
|
231
|
+
end
|
232
|
+
|
233
|
+
def add_parens_if_missing(node, corrector)
|
234
|
+
return if parentheses?(node)
|
235
|
+
|
236
|
+
add_parentheses(node, corrector)
|
237
|
+
end
|
238
|
+
|
239
|
+
# Classifies send nodes for possible rest/kwrest/all (including block) forwarding.
|
240
|
+
class SendNodeClassifier
|
241
|
+
extend NodePattern::Macros
|
242
|
+
|
243
|
+
# @!method forwarded_rest_arg?(node, rest_name)
|
244
|
+
def_node_matcher :forwarded_rest_arg?, '(splat (lvar %1))'
|
245
|
+
|
246
|
+
# @!method extract_forwarded_kwrest_arg(node, kwrest_name)
|
247
|
+
def_node_matcher :extract_forwarded_kwrest_arg, '(hash <$(kwsplat (lvar %1)) ...>)'
|
248
|
+
|
249
|
+
# @!method forwarded_block_arg?(node, block_name)
|
250
|
+
def_node_matcher :forwarded_block_arg?, '(block_pass {(lvar %1) nil?})'
|
251
|
+
|
252
|
+
def initialize(def_node, send_node, referenced_lvars, forwardable_args, **config)
|
253
|
+
@def_node = def_node
|
254
|
+
@send_node = send_node
|
255
|
+
@referenced_lvars = referenced_lvars
|
256
|
+
@rest_arg, @kwrest_arg, @block_arg = *forwardable_args
|
257
|
+
@rest_arg_name, @kwrest_arg_name, @block_arg_name =
|
258
|
+
*forwardable_args.map { |a| a&.name }
|
259
|
+
@config = config
|
260
|
+
end
|
261
|
+
|
262
|
+
def forwarded_rest_arg
|
263
|
+
return nil if referenced_rest_arg?
|
264
|
+
|
265
|
+
arguments.find { |arg| forwarded_rest_arg?(arg, @rest_arg_name) }
|
266
|
+
end
|
267
|
+
|
268
|
+
def forwarded_kwrest_arg
|
269
|
+
return nil if referenced_kwrest_arg?
|
270
|
+
|
271
|
+
arguments.filter_map { |arg| extract_forwarded_kwrest_arg(arg, @kwrest_arg_name) }.first
|
272
|
+
end
|
273
|
+
|
274
|
+
def forwarded_block_arg
|
275
|
+
return nil if referenced_block_arg?
|
276
|
+
|
277
|
+
arguments.find { |arg| forwarded_block_arg?(arg, @block_arg_name) }
|
278
|
+
end
|
279
|
+
|
280
|
+
def classification
|
281
|
+
return nil unless forwarded_rest_arg || forwarded_kwrest_arg
|
282
|
+
|
283
|
+
if can_forward_all?
|
284
|
+
:all
|
285
|
+
else
|
286
|
+
:rest_or_kwrest
|
287
|
+
end
|
288
|
+
end
|
289
|
+
|
290
|
+
private
|
291
|
+
|
292
|
+
def can_forward_all?
|
293
|
+
return false if any_arg_referenced?
|
294
|
+
return false if ruby_32_missing_rest_or_kwest?
|
295
|
+
return false unless offensive_block_forwarding?
|
296
|
+
return false if additional_kwargs_or_forwarded_kwargs?
|
297
|
+
|
298
|
+
no_additional_args? || (target_ruby_version >= 3.0 && no_post_splat_args?)
|
299
|
+
end
|
300
|
+
|
301
|
+
def ruby_32_missing_rest_or_kwest?
|
302
|
+
target_ruby_version >= 3.2 && !forwarded_rest_and_kwrest_args
|
303
|
+
end
|
304
|
+
|
305
|
+
def offensive_block_forwarding?
|
306
|
+
@block_arg ? forwarded_block_arg : allow_offense_for_no_block?
|
307
|
+
end
|
308
|
+
|
309
|
+
def forwarded_rest_and_kwrest_args
|
310
|
+
forwarded_rest_arg && forwarded_kwrest_arg
|
311
|
+
end
|
312
|
+
|
313
|
+
def arguments
|
314
|
+
@send_node.arguments
|
315
|
+
end
|
316
|
+
|
317
|
+
def referenced_rest_arg?
|
318
|
+
@referenced_lvars.include?(@rest_arg_name)
|
319
|
+
end
|
320
|
+
|
321
|
+
def referenced_kwrest_arg?
|
322
|
+
@referenced_lvars.include?(@kwrest_arg_name)
|
323
|
+
end
|
324
|
+
|
325
|
+
def referenced_block_arg?
|
326
|
+
@referenced_lvars.include?(@block_arg_name)
|
327
|
+
end
|
328
|
+
|
329
|
+
def any_arg_referenced?
|
330
|
+
referenced_rest_arg? || referenced_kwrest_arg? || referenced_block_arg?
|
331
|
+
end
|
332
|
+
|
333
|
+
def target_ruby_version
|
334
|
+
@config.fetch(:target_ruby_version)
|
335
|
+
end
|
336
|
+
|
337
|
+
def no_post_splat_args?
|
338
|
+
return true unless (splat_index = arguments.index(forwarded_rest_arg))
|
339
|
+
|
340
|
+
arg_after_splat = arguments[splat_index + 1]
|
341
|
+
[nil, :hash, :block_pass].include?(arg_after_splat&.type)
|
342
|
+
end
|
343
|
+
|
344
|
+
def additional_kwargs_or_forwarded_kwargs?
|
345
|
+
additional_kwargs? || forward_additional_kwargs?
|
346
|
+
end
|
347
|
+
|
348
|
+
def additional_kwargs?
|
349
|
+
@def_node.arguments.any? { |a| a.kwarg_type? || a.kwoptarg_type? }
|
350
|
+
end
|
351
|
+
|
352
|
+
def forward_additional_kwargs?
|
353
|
+
return false unless forwarded_kwrest_arg
|
354
|
+
|
355
|
+
!forwarded_kwrest_arg.parent.children.one?
|
356
|
+
end
|
357
|
+
|
358
|
+
def allow_offense_for_no_block?
|
359
|
+
!@config.fetch(:allow_only_rest_arguments)
|
360
|
+
end
|
361
|
+
|
362
|
+
def no_additional_args?
|
363
|
+
forwardable_count = [@rest_arg, @kwrest_arg, @block_arg].compact.size
|
364
|
+
|
365
|
+
@def_node.arguments.size == forwardable_count &&
|
366
|
+
@send_node.arguments.size == forwardable_count
|
367
|
+
end
|
368
|
+
end
|
152
369
|
end
|
153
370
|
end
|
154
371
|
end
|
@@ -11,6 +11,15 @@ module RuboCop
|
|
11
11
|
# The `array1.intersect?(array2)` method is faster than
|
12
12
|
# `(array1 & array2).any?` and is more readable.
|
13
13
|
#
|
14
|
+
# In cases like the following, compatibility is not ensured,
|
15
|
+
# so it will not be detected when using block argument.
|
16
|
+
#
|
17
|
+
# [source,ruby]
|
18
|
+
# ----
|
19
|
+
# ([1] & [1,2]).any? { |x| false } # => false
|
20
|
+
# [1].intersect?([1,2]) { |x| false } # => true
|
21
|
+
# ----
|
22
|
+
#
|
14
23
|
# @safety
|
15
24
|
# This cop cannot guarantee that `array1` and `array2` are
|
16
25
|
# actually arrays while method `intersect?` is for arrays only.
|
@@ -68,16 +77,15 @@ module RuboCop
|
|
68
77
|
RESTRICT_ON_SEND = (STRAIGHT_METHODS + NEGATED_METHODS).freeze
|
69
78
|
|
70
79
|
def on_send(node)
|
80
|
+
return if (parent = node.parent) && (parent.block_type? || parent.numblock_type?)
|
71
81
|
return unless (receiver, argument, method_name = bad_intersection_check?(node))
|
72
82
|
|
73
83
|
message = message(receiver.source, argument.source, method_name)
|
74
84
|
|
75
85
|
add_offense(node, message: message) do |corrector|
|
76
|
-
|
77
|
-
|
78
|
-
|
79
|
-
corrector.replace(node, "!#{receiver.source}.intersect?(#{argument.source})")
|
80
|
-
end
|
86
|
+
bang = straight?(method_name) ? '' : '!'
|
87
|
+
|
88
|
+
corrector.replace(node, "#{bang}#{receiver.source}.intersect?(#{argument.source})")
|
81
89
|
end
|
82
90
|
end
|
83
91
|
|
@@ -24,7 +24,7 @@ module RuboCop
|
|
24
24
|
def on_send(node)
|
25
25
|
return unless node.command?(:attr) && node.arguments?
|
26
26
|
# check only for method definitions in class/module body
|
27
|
-
return if
|
27
|
+
return if allowed_context?(node)
|
28
28
|
|
29
29
|
message = message(node)
|
30
30
|
add_offense(node.loc.selector, message: message) do |corrector|
|
@@ -34,6 +34,16 @@ module RuboCop
|
|
34
34
|
|
35
35
|
private
|
36
36
|
|
37
|
+
def allowed_context?(node)
|
38
|
+
return false unless (class_node = node.each_ancestor(:class, :block).first)
|
39
|
+
|
40
|
+
(!class_node.class_type? && !class_eval?(class_node)) || define_attr_method?(class_node)
|
41
|
+
end
|
42
|
+
|
43
|
+
def define_attr_method?(node)
|
44
|
+
node.each_descendant(:def).any? { |def_node| def_node.method?(:attr) }
|
45
|
+
end
|
46
|
+
|
37
47
|
def autocorrect(corrector, node)
|
38
48
|
attr_name, setter = *node.arguments
|
39
49
|
|
@@ -35,7 +35,7 @@ module RuboCop
|
|
35
35
|
unless contents.empty?
|
36
36
|
corrector.replace(
|
37
37
|
contents,
|
38
|
-
contents.source.gsub(/\A/, '# ').gsub(
|
38
|
+
contents.source.gsub(/\A/, '# ').gsub("\n\n", "\n#\n").gsub(/\n(?=[^#])/, "\n# ")
|
39
39
|
)
|
40
40
|
end
|
41
41
|
corrector.remove(eq_end)
|
@@ -370,7 +370,8 @@ module RuboCop
|
|
370
370
|
def special_method_proper_block_style?(node)
|
371
371
|
method_name = node.method_name
|
372
372
|
return true if allowed_method?(method_name) || matches_allowed_pattern?(method_name)
|
373
|
-
|
373
|
+
|
374
|
+
node.braces? if braces_required_method?(method_name)
|
374
375
|
end
|
375
376
|
|
376
377
|
def braces_required_method?(method_name)
|
@@ -411,7 +412,7 @@ module RuboCop
|
|
411
412
|
end
|
412
413
|
|
413
414
|
def correction_would_break_code?(node)
|
414
|
-
return unless node.keywords?
|
415
|
+
return false unless node.keywords?
|
415
416
|
|
416
417
|
node.send_node.arguments? && !node.send_node.parenthesized?
|
417
418
|
end
|
@@ -433,7 +434,7 @@ module RuboCop
|
|
433
434
|
end
|
434
435
|
|
435
436
|
def return_value_used?(node)
|
436
|
-
return unless node.parent
|
437
|
+
return false unless node.parent
|
437
438
|
|
438
439
|
# If there are parentheses around the block, check if that
|
439
440
|
# is being used.
|
@@ -445,7 +446,7 @@ module RuboCop
|
|
445
446
|
end
|
446
447
|
|
447
448
|
def return_value_of_scope?(node)
|
448
|
-
return unless node.parent
|
449
|
+
return false unless node.parent
|
449
450
|
|
450
451
|
conditional?(node.parent) || array_or_range?(node.parent) ||
|
451
452
|
node.parent.children.last == node
|
@@ -5,9 +5,14 @@ module RuboCop
|
|
5
5
|
module Style
|
6
6
|
# Enforces the use of `Object#instance_of?` instead of class comparison
|
7
7
|
# for equality.
|
8
|
-
# `==`, `equal?`, and `eql?`
|
8
|
+
# `==`, `equal?`, and `eql?` custom method definitions are allowed by default.
|
9
9
|
# These are customizable with `AllowedMethods` option.
|
10
10
|
#
|
11
|
+
# @safety
|
12
|
+
# This cop's autocorrection is unsafe because there is no guarantee that
|
13
|
+
# the constant `Foo` exists when autocorrecting `var.class.name == 'Foo'` to
|
14
|
+
# `var.instance_of?(Foo)`.
|
15
|
+
#
|
11
16
|
# @example
|
12
17
|
# # bad
|
13
18
|
# var.class == Date
|
@@ -18,53 +23,31 @@ module RuboCop
|
|
18
23
|
# # good
|
19
24
|
# var.instance_of?(Date)
|
20
25
|
#
|
21
|
-
# @example AllowedMethods: [] (default)
|
26
|
+
# @example AllowedMethods: ['==', 'equal?', 'eql?'] (default)
|
22
27
|
# # good
|
23
|
-
#
|
28
|
+
# def ==(other)
|
29
|
+
# self.class == other.class && name == other.name
|
30
|
+
# end
|
24
31
|
#
|
25
|
-
#
|
26
|
-
#
|
27
|
-
#
|
28
|
-
# var.class.eql?(Date)
|
29
|
-
# var.class.name == 'Date'
|
30
|
-
# var.class.to_s == 'Date'
|
31
|
-
# var.class.inspect == 'Date'
|
32
|
+
# def equal?(other)
|
33
|
+
# self.class.equal?(other.class) && name.equal?(other.name)
|
34
|
+
# end
|
32
35
|
#
|
33
|
-
#
|
34
|
-
#
|
35
|
-
#
|
36
|
-
# var.class == Date
|
37
|
-
# var.class.name == 'Date'
|
38
|
-
# var.class.to_s == 'Date'
|
39
|
-
# var.class.inspect == 'Date'
|
40
|
-
#
|
41
|
-
# # bad
|
42
|
-
# var.class.equal?(Date)
|
43
|
-
# var.class.eql?(Date)
|
36
|
+
# def eql?(other)
|
37
|
+
# self.class.eql?(other.class) && name.eql?(other.name)
|
38
|
+
# end
|
44
39
|
#
|
45
40
|
# @example AllowedPatterns: [] (default)
|
46
|
-
# # good
|
47
|
-
# var.instance_of?(Date)
|
48
|
-
#
|
49
41
|
# # bad
|
50
|
-
#
|
51
|
-
#
|
52
|
-
#
|
53
|
-
# var.class.name == 'Date'
|
54
|
-
# var.class.to_s == 'Date'
|
55
|
-
# var.class.inspect == 'Date'
|
42
|
+
# def eq(other)
|
43
|
+
# self.class.eq(other.class) && name.eq(other.name)
|
44
|
+
# end
|
56
45
|
#
|
57
46
|
# @example AllowedPatterns: ['eq']
|
58
47
|
# # good
|
59
|
-
#
|
60
|
-
#
|
61
|
-
#
|
62
|
-
#
|
63
|
-
# # bad
|
64
|
-
# var.class == Date
|
65
|
-
# var.class.name == 'Date'
|
66
|
-
# var.class.to_s == 'Date'
|
67
|
-
# var.class.inspect == 'Date'
|
48
|
+
# def eq(other)
|
49
|
+
# self.class.eq(other.class) && name.eq(other.name)
|
50
|
+
# end
|
68
51
|
#
|
69
52
|
class ClassEqualityComparison < Base
|
70
53
|
include RangeHelp
|
@@ -91,6 +74,8 @@ module RuboCop
|
|
91
74
|
matches_allowed_pattern?(def_node.method_name))
|
92
75
|
|
93
76
|
class_comparison_candidate?(node) do |receiver_node, class_node|
|
77
|
+
return if class_node.dstr_type?
|
78
|
+
|
94
79
|
range = offense_range(receiver_node, node)
|
95
80
|
class_argument = (class_name = class_name(class_node, node)) ? "(#{class_name})" : ''
|
96
81
|
|