rubocop 0.82.0 → 1.18.4
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 +69 -37
- data/assets/output.html.erb +1 -1
- data/config/default.yml +1025 -139
- data/config/obsoletion.yml +200 -0
- data/exe/rubocop +2 -4
- data/lib/rubocop.rb +137 -68
- data/lib/rubocop/ast_aliases.rb +8 -0
- data/lib/rubocop/cached_data.rb +4 -4
- data/lib/rubocop/cli.rb +11 -11
- data/lib/rubocop/cli/command.rb +1 -0
- data/lib/rubocop/cli/command/auto_genenerate_config.rb +46 -19
- data/lib/rubocop/cli/command/base.rb +2 -0
- data/lib/rubocop/cli/command/execute_runner.rb +36 -12
- data/lib/rubocop/cli/command/init_dotfile.rb +3 -4
- data/lib/rubocop/cli/command/show_cops.rb +6 -12
- data/lib/rubocop/cli/command/suggest_extensions.rb +81 -0
- data/lib/rubocop/cli/command/version.rb +3 -2
- data/lib/rubocop/cli/environment.rb +1 -0
- data/lib/rubocop/comment_config.rb +54 -103
- data/lib/rubocop/config.rb +45 -29
- data/lib/rubocop/config_loader.rb +101 -106
- data/lib/rubocop/config_loader_resolver.rb +100 -29
- data/lib/rubocop/config_obsoletion.rb +67 -242
- data/lib/rubocop/config_obsoletion/changed_enforced_styles.rb +33 -0
- data/lib/rubocop/config_obsoletion/changed_parameter.rb +21 -0
- data/lib/rubocop/config_obsoletion/cop_rule.rb +33 -0
- data/lib/rubocop/config_obsoletion/extracted_cop.rb +44 -0
- data/lib/rubocop/config_obsoletion/parameter_rule.rb +44 -0
- data/lib/rubocop/config_obsoletion/removed_cop.rb +41 -0
- data/lib/rubocop/config_obsoletion/renamed_cop.rb +34 -0
- data/lib/rubocop/config_obsoletion/rule.rb +41 -0
- data/lib/rubocop/config_obsoletion/split_cop.rb +27 -0
- data/lib/rubocop/config_regeneration.rb +33 -0
- data/lib/rubocop/config_store.rb +31 -7
- data/lib/rubocop/config_validator.rb +53 -28
- data/lib/rubocop/cop/autocorrect_logic.rb +37 -38
- data/lib/rubocop/cop/badge.rb +11 -27
- data/lib/rubocop/cop/base.rb +450 -0
- data/lib/rubocop/cop/bundler/duplicated_gem.rb +31 -7
- data/lib/rubocop/cop/bundler/gem_comment.rb +117 -10
- data/lib/rubocop/cop/bundler/gem_version.rb +133 -0
- data/lib/rubocop/cop/bundler/insecure_protocol_source.rb +13 -20
- data/lib/rubocop/cop/bundler/ordered_gems.rb +2 -4
- data/lib/rubocop/cop/commissioner.rb +98 -74
- data/lib/rubocop/cop/cop.rb +84 -234
- data/lib/rubocop/cop/corrector.rb +41 -119
- data/lib/rubocop/cop/correctors/alignment_corrector.rb +11 -21
- data/lib/rubocop/cop/correctors/condition_corrector.rb +3 -5
- data/lib/rubocop/cop/correctors/each_to_for_corrector.rb +2 -4
- data/lib/rubocop/cop/correctors/empty_line_corrector.rb +9 -10
- data/lib/rubocop/cop/correctors/for_to_each_corrector.rb +1 -2
- data/lib/rubocop/cop/correctors/lambda_literal_to_method_corrector.rb +1 -1
- data/lib/rubocop/cop/correctors/line_break_corrector.rb +8 -11
- data/lib/rubocop/cop/correctors/multiline_literal_brace_corrector.rb +35 -6
- data/lib/rubocop/cop/correctors/ordered_gem_corrector.rb +1 -3
- data/lib/rubocop/cop/correctors/parentheses_corrector.rb +5 -8
- data/lib/rubocop/cop/correctors/percent_literal_corrector.rb +10 -21
- data/lib/rubocop/cop/correctors/punctuation_corrector.rb +8 -10
- data/lib/rubocop/cop/correctors/space_corrector.rb +1 -3
- data/lib/rubocop/cop/correctors/string_literal_corrector.rb +6 -8
- data/lib/rubocop/cop/correctors/unused_arg_corrector.rb +15 -18
- data/lib/rubocop/cop/documentation.rb +22 -0
- data/lib/rubocop/cop/exclude_limit.rb +26 -0
- data/lib/rubocop/cop/force.rb +2 -1
- data/lib/rubocop/cop/gemspec/date_assignment.rb +57 -0
- data/lib/rubocop/cop/gemspec/duplicated_assignment.rb +6 -5
- data/lib/rubocop/cop/gemspec/ordered_dependencies.rb +3 -7
- data/lib/rubocop/cop/gemspec/required_ruby_version.rb +48 -20
- data/lib/rubocop/cop/gemspec/ruby_version_globals_usage.rb +4 -2
- data/lib/rubocop/cop/generator.rb +12 -22
- data/lib/rubocop/cop/generator/configuration_injector.rb +4 -5
- data/lib/rubocop/cop/generator/require_file_injector.rb +2 -5
- data/lib/rubocop/cop/ignored_node.rb +1 -3
- data/lib/rubocop/cop/internal_affairs.rb +7 -1
- data/lib/rubocop/cop/internal_affairs/empty_line_between_expect_offense_and_correction.rb +68 -0
- data/lib/rubocop/cop/internal_affairs/example_description.rb +92 -0
- data/lib/rubocop/cop/internal_affairs/method_name_equal.rb +8 -17
- data/lib/rubocop/cop/internal_affairs/node_destructuring.rb +4 -4
- data/lib/rubocop/cop/internal_affairs/node_matcher_directive.rb +151 -0
- data/lib/rubocop/cop/internal_affairs/node_type_predicate.rb +11 -14
- data/lib/rubocop/cop/internal_affairs/offense_location_keyword.rb +12 -10
- data/lib/rubocop/cop/internal_affairs/redundant_described_class_as_subject.rb +62 -0
- data/lib/rubocop/cop/internal_affairs/redundant_let_rubocop_config_new.rb +65 -0
- data/lib/rubocop/cop/internal_affairs/redundant_location_argument.rb +12 -7
- data/lib/rubocop/cop/internal_affairs/redundant_message_argument.rb +11 -8
- data/lib/rubocop/cop/internal_affairs/style_detected_api_use.rb +148 -0
- data/lib/rubocop/cop/internal_affairs/useless_message_assertion.rb +6 -6
- data/lib/rubocop/cop/layout/access_modifier_indentation.rb +12 -10
- data/lib/rubocop/cop/layout/argument_alignment.rb +36 -19
- data/lib/rubocop/cop/layout/array_alignment.rb +10 -8
- data/lib/rubocop/cop/layout/assignment_indentation.rb +8 -7
- data/lib/rubocop/cop/layout/begin_end_alignment.rb +74 -0
- data/lib/rubocop/cop/layout/block_alignment.rb +36 -44
- data/lib/rubocop/cop/layout/block_end_newline.rb +4 -8
- data/lib/rubocop/cop/layout/case_indentation.rb +72 -30
- data/lib/rubocop/cop/layout/class_structure.rb +62 -74
- data/lib/rubocop/cop/layout/closing_heredoc_indentation.rb +4 -6
- data/lib/rubocop/cop/layout/closing_parenthesis_indentation.rb +24 -30
- data/lib/rubocop/cop/layout/comment_indentation.rb +22 -26
- data/lib/rubocop/cop/layout/condition_position.rb +16 -8
- data/lib/rubocop/cop/layout/def_end_alignment.rb +9 -10
- data/lib/rubocop/cop/layout/dot_position.rb +26 -21
- data/lib/rubocop/cop/layout/else_alignment.rb +25 -11
- data/lib/rubocop/cop/layout/empty_comment.rb +29 -29
- data/lib/rubocop/cop/layout/empty_line_after_guard_clause.rb +51 -36
- data/lib/rubocop/cop/layout/empty_line_after_magic_comment.rb +13 -13
- data/lib/rubocop/cop/layout/empty_line_after_multiline_condition.rb +136 -0
- data/lib/rubocop/cop/layout/empty_line_between_defs.rb +140 -40
- data/lib/rubocop/cop/layout/empty_lines.rb +7 -12
- data/lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb +29 -38
- data/lib/rubocop/cop/layout/empty_lines_around_arguments.rb +13 -9
- data/lib/rubocop/cop/layout/empty_lines_around_attribute_accessor.rb +118 -0
- data/lib/rubocop/cop/layout/empty_lines_around_begin_body.rb +2 -5
- data/lib/rubocop/cop/layout/empty_lines_around_block_body.rb +2 -5
- data/lib/rubocop/cop/layout/empty_lines_around_class_body.rb +2 -5
- data/lib/rubocop/cop/layout/empty_lines_around_exception_handling_keywords.rb +4 -14
- data/lib/rubocop/cop/layout/empty_lines_around_method_body.rb +2 -5
- data/lib/rubocop/cop/layout/empty_lines_around_module_body.rb +2 -5
- data/lib/rubocop/cop/layout/end_alignment.rb +24 -23
- data/lib/rubocop/cop/layout/end_of_line.rb +8 -8
- data/lib/rubocop/cop/layout/extra_spacing.rb +23 -42
- data/lib/rubocop/cop/layout/first_argument_indentation.rb +40 -13
- data/lib/rubocop/cop/layout/first_array_element_indentation.rb +13 -13
- data/lib/rubocop/cop/layout/first_array_element_line_break.rb +4 -8
- data/lib/rubocop/cop/layout/first_hash_element_indentation.rb +36 -20
- data/lib/rubocop/cop/layout/first_hash_element_line_break.rb +3 -7
- data/lib/rubocop/cop/layout/first_method_argument_line_break.rb +6 -13
- data/lib/rubocop/cop/layout/first_method_parameter_line_break.rb +3 -7
- data/lib/rubocop/cop/layout/first_parameter_indentation.rb +9 -8
- data/lib/rubocop/cop/layout/hash_alignment.rb +76 -57
- data/lib/rubocop/cop/layout/heredoc_argument_closing_parenthesis.rb +45 -29
- data/lib/rubocop/cop/layout/heredoc_indentation.rb +32 -116
- data/lib/rubocop/cop/layout/indentation_consistency.rb +9 -6
- data/lib/rubocop/cop/layout/indentation_style.rb +25 -32
- data/lib/rubocop/cop/layout/indentation_width.rb +34 -15
- data/lib/rubocop/cop/layout/initial_indentation.rb +7 -11
- data/lib/rubocop/cop/layout/leading_comment_space.rb +12 -10
- data/lib/rubocop/cop/layout/leading_empty_lines.rb +6 -11
- data/lib/rubocop/cop/layout/line_end_string_concatenation_indentation.rb +122 -0
- data/lib/rubocop/cop/layout/line_length.rb +37 -47
- data/lib/rubocop/cop/layout/multiline_array_brace_layout.rb +8 -11
- data/lib/rubocop/cop/layout/multiline_array_line_breaks.rb +3 -7
- data/lib/rubocop/cop/layout/multiline_assignment_layout.rb +38 -16
- data/lib/rubocop/cop/layout/multiline_block_layout.rb +41 -37
- data/lib/rubocop/cop/layout/multiline_hash_brace_layout.rb +8 -11
- data/lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb +3 -7
- data/lib/rubocop/cop/layout/multiline_method_argument_line_breaks.rb +6 -13
- data/lib/rubocop/cop/layout/multiline_method_call_brace_layout.rb +8 -11
- data/lib/rubocop/cop/layout/multiline_method_call_indentation.rb +29 -18
- data/lib/rubocop/cop/layout/multiline_method_definition_brace_layout.rb +8 -11
- data/lib/rubocop/cop/layout/multiline_operation_indentation.rb +26 -12
- data/lib/rubocop/cop/layout/parameter_alignment.rb +8 -7
- data/lib/rubocop/cop/layout/redundant_line_break.rb +139 -0
- data/lib/rubocop/cop/layout/rescue_ensure_alignment.rb +37 -30
- data/lib/rubocop/cop/layout/single_line_block_chain.rb +53 -0
- data/lib/rubocop/cop/layout/space_after_colon.rb +10 -8
- data/lib/rubocop/cop/layout/space_after_comma.rb +2 -5
- data/lib/rubocop/cop/layout/space_after_method_name.rb +7 -10
- data/lib/rubocop/cop/layout/space_after_not.rb +9 -11
- data/lib/rubocop/cop/layout/space_after_semicolon.rb +2 -5
- data/lib/rubocop/cop/layout/space_around_block_parameters.rb +45 -52
- data/lib/rubocop/cop/layout/space_around_equals_in_parameter_default.rb +19 -23
- data/lib/rubocop/cop/layout/space_around_keyword.rb +50 -26
- data/lib/rubocop/cop/layout/space_around_method_call_operator.rb +34 -69
- data/lib/rubocop/cop/layout/space_around_operators.rb +51 -25
- data/lib/rubocop/cop/layout/space_before_block_braces.rb +39 -23
- data/lib/rubocop/cop/layout/space_before_brackets.rb +65 -0
- data/lib/rubocop/cop/layout/space_before_comma.rb +3 -5
- data/lib/rubocop/cop/layout/space_before_comment.rb +8 -9
- data/lib/rubocop/cop/layout/space_before_first_arg.rb +9 -15
- data/lib/rubocop/cop/layout/space_before_semicolon.rb +2 -5
- data/lib/rubocop/cop/layout/space_in_lambda_literal.rb +11 -21
- data/lib/rubocop/cop/layout/space_inside_array_literal_brackets.rb +30 -39
- data/lib/rubocop/cop/layout/space_inside_array_percent_literal.rb +5 -15
- data/lib/rubocop/cop/layout/space_inside_block_braces.rb +32 -37
- data/lib/rubocop/cop/layout/space_inside_hash_literal_braces.rb +22 -41
- data/lib/rubocop/cop/layout/space_inside_parens.rb +39 -22
- data/lib/rubocop/cop/layout/space_inside_percent_literal_delimiters.rb +5 -10
- data/lib/rubocop/cop/layout/space_inside_range_literal.rb +8 -17
- data/lib/rubocop/cop/layout/space_inside_reference_brackets.rb +18 -29
- data/lib/rubocop/cop/layout/space_inside_string_interpolation.rb +12 -13
- data/lib/rubocop/cop/layout/trailing_empty_lines.rb +10 -15
- data/lib/rubocop/cop/layout/trailing_whitespace.rb +42 -18
- data/lib/rubocop/cop/legacy/corrections_proxy.rb +43 -0
- data/lib/rubocop/cop/legacy/corrector.rb +27 -0
- data/lib/rubocop/cop/lint/ambiguous_assignment.rb +54 -0
- data/lib/rubocop/cop/lint/ambiguous_block_association.rb +21 -9
- data/lib/rubocop/cop/lint/ambiguous_operator.rb +53 -5
- data/lib/rubocop/cop/lint/ambiguous_regexp_literal.rb +36 -6
- data/lib/rubocop/cop/lint/assignment_in_condition.rb +2 -2
- data/lib/rubocop/cop/lint/big_decimal_new.rb +10 -10
- data/lib/rubocop/cop/lint/binary_operator_with_identical_operands.rb +55 -0
- data/lib/rubocop/cop/lint/boolean_symbol.rb +21 -13
- data/lib/rubocop/cop/lint/circular_argument_reference.rb +1 -1
- data/lib/rubocop/cop/lint/constant_definition_in_block.rb +100 -0
- data/lib/rubocop/cop/lint/constant_resolution.rb +89 -0
- data/lib/rubocop/cop/lint/debugger.rb +61 -21
- data/lib/rubocop/cop/lint/deprecated_class_methods.rb +86 -47
- data/lib/rubocop/cop/lint/deprecated_constants.rb +80 -0
- data/lib/rubocop/cop/lint/deprecated_open_ssl_constant.rb +148 -0
- data/lib/rubocop/cop/lint/disjunctive_assignment_in_constructor.rb +8 -2
- data/lib/rubocop/cop/lint/duplicate_branch.rb +155 -0
- data/lib/rubocop/cop/lint/duplicate_case_condition.rb +3 -13
- data/lib/rubocop/cop/lint/duplicate_elsif_condition.rb +39 -0
- data/lib/rubocop/cop/lint/duplicate_hash_key.rb +2 -4
- data/lib/rubocop/cop/lint/duplicate_methods.rb +12 -16
- data/lib/rubocop/cop/lint/duplicate_regexp_character_class_element.rb +77 -0
- data/lib/rubocop/cop/lint/duplicate_require.rb +47 -0
- data/lib/rubocop/cop/lint/duplicate_rescue_exception.rb +47 -0
- data/lib/rubocop/cop/lint/each_with_object_argument.rb +3 -1
- data/lib/rubocop/cop/lint/else_layout.rb +29 -5
- data/lib/rubocop/cop/lint/empty_block.rb +98 -0
- data/lib/rubocop/cop/lint/empty_class.rb +93 -0
- data/lib/rubocop/cop/lint/empty_conditional_body.rb +67 -0
- data/lib/rubocop/cop/lint/empty_ensure.rb +5 -7
- data/lib/rubocop/cop/lint/empty_expression.rb +2 -2
- data/lib/rubocop/cop/lint/empty_file.rb +48 -0
- data/lib/rubocop/cop/lint/empty_in_pattern.rb +62 -0
- data/lib/rubocop/cop/lint/empty_interpolation.rb +4 -7
- data/lib/rubocop/cop/lint/empty_when.rb +31 -8
- data/lib/rubocop/cop/lint/ensure_return.rb +29 -16
- data/lib/rubocop/cop/lint/erb_new_arguments.rb +18 -20
- data/lib/rubocop/cop/lint/flip_flop.rb +9 -3
- data/lib/rubocop/cop/lint/float_comparison.rb +93 -0
- data/lib/rubocop/cop/lint/float_out_of_range.rb +2 -3
- data/lib/rubocop/cop/lint/format_parameter_mismatch.rb +45 -10
- data/lib/rubocop/cop/lint/hash_compare_by_identity.rb +38 -0
- data/lib/rubocop/cop/lint/heredoc_method_call_position.rb +14 -16
- data/lib/rubocop/cop/lint/identity_comparison.rb +51 -0
- data/lib/rubocop/cop/lint/implicit_string_concatenation.rb +6 -6
- data/lib/rubocop/cop/lint/ineffective_access_modifier.rb +14 -20
- data/lib/rubocop/cop/lint/inherit_exception.rb +14 -9
- data/lib/rubocop/cop/lint/interpolation_check.rb +20 -7
- data/lib/rubocop/cop/lint/lambda_without_literal_block.rb +44 -0
- data/lib/rubocop/cop/lint/literal_as_condition.rb +37 -16
- data/lib/rubocop/cop/lint/literal_in_interpolation.rb +44 -15
- data/lib/rubocop/cop/lint/loop.rb +25 -5
- data/lib/rubocop/cop/lint/missing_cop_enable_directive.rb +35 -23
- data/lib/rubocop/cop/lint/missing_super.rb +101 -0
- data/lib/rubocop/cop/lint/mixed_regexp_capture_types.rb +36 -0
- data/lib/rubocop/cop/lint/multiple_comparison.rb +14 -14
- data/lib/rubocop/cop/lint/nested_method_definition.rb +19 -23
- data/lib/rubocop/cop/lint/nested_percent_literal.rb +18 -6
- data/lib/rubocop/cop/lint/next_without_accumulator.rb +2 -1
- data/lib/rubocop/cop/lint/no_return_in_begin_end_blocks.rb +58 -0
- data/lib/rubocop/cop/lint/non_deterministic_require_order.rb +95 -15
- data/lib/rubocop/cop/lint/non_local_exit_from_iterator.rb +12 -9
- data/lib/rubocop/cop/lint/number_conversion.rb +97 -23
- data/lib/rubocop/cop/lint/numbered_parameter_assignment.rb +47 -0
- data/lib/rubocop/cop/lint/or_assignment_to_constant.rb +39 -0
- data/lib/rubocop/cop/lint/ordered_magic_comments.rb +12 -15
- data/lib/rubocop/cop/lint/out_of_range_regexp_ref.rb +96 -0
- data/lib/rubocop/cop/lint/parentheses_as_grouped_expression.rb +31 -12
- data/lib/rubocop/cop/lint/percent_string_array.rb +6 -11
- data/lib/rubocop/cop/lint/percent_symbol_array.rb +13 -14
- data/lib/rubocop/cop/lint/raise_exception.rb +19 -7
- data/lib/rubocop/cop/lint/rand_one.rb +5 -4
- data/lib/rubocop/cop/lint/redundant_cop_disable_directive.rb +142 -115
- data/lib/rubocop/cop/lint/redundant_cop_enable_directive.rb +44 -30
- data/lib/rubocop/cop/lint/redundant_dir_glob_sort.rb +50 -0
- data/lib/rubocop/cop/lint/redundant_require_statement.rb +9 -10
- data/lib/rubocop/cop/lint/redundant_safe_navigation.rb +77 -0
- data/lib/rubocop/cop/lint/redundant_splat_expansion.rb +72 -35
- data/lib/rubocop/cop/lint/redundant_string_coercion.rb +8 -15
- data/lib/rubocop/cop/lint/redundant_with_index.rb +13 -18
- data/lib/rubocop/cop/lint/redundant_with_object.rb +13 -18
- data/lib/rubocop/cop/lint/regexp_as_condition.rb +4 -2
- data/lib/rubocop/cop/lint/require_parentheses.rb +4 -6
- data/lib/rubocop/cop/lint/rescue_exception.rb +3 -4
- data/lib/rubocop/cop/lint/rescue_type.rb +10 -16
- data/lib/rubocop/cop/lint/return_in_void_context.rb +3 -6
- data/lib/rubocop/cop/lint/safe_navigation_chain.rb +5 -8
- data/lib/rubocop/cop/lint/safe_navigation_consistency.rb +15 -17
- data/lib/rubocop/cop/lint/safe_navigation_with_empty.rb +12 -4
- data/lib/rubocop/cop/lint/script_permission.rb +10 -7
- data/lib/rubocop/cop/lint/self_assignment.rb +78 -0
- data/lib/rubocop/cop/lint/send_with_mixin_argument.rb +11 -19
- data/lib/rubocop/cop/lint/shadowed_argument.rb +8 -14
- data/lib/rubocop/cop/lint/shadowed_exception.rb +18 -30
- data/lib/rubocop/cop/lint/shadowing_outer_local_variable.rb +21 -7
- data/lib/rubocop/cop/lint/struct_new_override.rb +4 -3
- data/lib/rubocop/cop/lint/suppressed_exception.rb +53 -6
- data/lib/rubocop/cop/lint/symbol_conversion.rb +178 -0
- data/lib/rubocop/cop/lint/syntax.rb +11 -30
- data/lib/rubocop/cop/lint/to_enum_arguments.rb +89 -0
- data/lib/rubocop/cop/lint/to_json.rb +21 -13
- data/lib/rubocop/cop/lint/top_level_return_with_argument.rb +34 -0
- data/lib/rubocop/cop/lint/trailing_comma_in_attribute_declaration.rb +55 -0
- data/lib/rubocop/cop/lint/triple_quotes.rb +71 -0
- data/lib/rubocop/cop/lint/underscore_prefixed_variable_name.rb +5 -7
- data/lib/rubocop/cop/lint/unexpected_block_arity.rb +85 -0
- data/lib/rubocop/cop/lint/unified_integer.rb +5 -6
- data/lib/rubocop/cop/lint/unmodified_reduce_accumulator.rb +204 -0
- data/lib/rubocop/cop/lint/unreachable_code.rb +5 -7
- data/lib/rubocop/cop/lint/unreachable_loop.rb +196 -0
- data/lib/rubocop/cop/lint/unused_block_argument.rb +18 -11
- data/lib/rubocop/cop/lint/unused_method_argument.rb +11 -6
- data/lib/rubocop/cop/lint/uri_escape_unescape.rb +5 -2
- data/lib/rubocop/cop/lint/uri_regexp.rb +12 -47
- data/lib/rubocop/cop/lint/useless_access_modifier.rb +38 -22
- data/lib/rubocop/cop/lint/useless_assignment.rb +10 -14
- data/lib/rubocop/cop/lint/useless_else_without_rescue.rb +7 -11
- data/lib/rubocop/cop/lint/useless_method_definition.rb +68 -0
- data/lib/rubocop/cop/lint/useless_setter_call.rb +12 -10
- data/lib/rubocop/cop/lint/useless_times.rb +109 -0
- data/lib/rubocop/cop/lint/void.rb +8 -19
- data/lib/rubocop/cop/message_annotator.rb +5 -4
- data/lib/rubocop/cop/metrics/abc_size.rb +26 -2
- data/lib/rubocop/cop/metrics/block_length.rb +40 -10
- data/lib/rubocop/cop/metrics/block_nesting.rb +5 -10
- data/lib/rubocop/cop/metrics/class_length.rb +40 -11
- data/lib/rubocop/cop/metrics/cyclomatic_complexity.rb +38 -6
- data/lib/rubocop/cop/metrics/method_length.rb +32 -4
- data/lib/rubocop/cop/metrics/module_length.rb +29 -9
- data/lib/rubocop/cop/metrics/parameter_lists.rb +74 -11
- data/lib/rubocop/cop/metrics/perceived_complexity.rb +7 -9
- data/lib/rubocop/cop/metrics/utils/abc_size_calculator.rb +76 -15
- data/lib/rubocop/cop/metrics/utils/code_length_calculator.rb +160 -0
- data/lib/rubocop/cop/metrics/utils/iterating_block.rb +61 -0
- data/lib/rubocop/cop/metrics/utils/repeated_attribute_discount.rb +143 -0
- data/lib/rubocop/cop/metrics/utils/repeated_csend_discount.rb +42 -0
- data/lib/rubocop/cop/migration/department_name.rb +25 -29
- data/lib/rubocop/cop/mixin/alignment.rb +18 -11
- data/lib/rubocop/cop/mixin/allowed_identifiers.rb +18 -0
- data/lib/rubocop/cop/mixin/allowed_methods.rb +21 -0
- data/lib/rubocop/cop/mixin/annotation_comment.rb +5 -0
- data/lib/rubocop/cop/mixin/array_min_size.rb +2 -4
- data/lib/rubocop/cop/mixin/auto_corrector.rb +12 -0
- data/lib/rubocop/cop/mixin/check_line_breakable.rb +51 -18
- data/lib/rubocop/cop/mixin/code_length.rb +29 -8
- data/lib/rubocop/cop/mixin/comments_help.rb +42 -0
- data/lib/rubocop/cop/mixin/configurable_enforced_style.rb +3 -5
- data/lib/rubocop/cop/mixin/configurable_formatting.rb +4 -11
- data/lib/rubocop/cop/mixin/configurable_max.rb +1 -0
- data/lib/rubocop/cop/mixin/configurable_naming.rb +2 -2
- data/lib/rubocop/cop/mixin/configurable_numbering.rb +4 -3
- data/lib/rubocop/cop/mixin/def_node.rb +3 -5
- data/lib/rubocop/cop/mixin/documentation_comment.rb +4 -7
- data/lib/rubocop/cop/mixin/empty_lines_around_body.rb +14 -14
- data/lib/rubocop/cop/mixin/empty_parameter.rb +2 -1
- data/lib/rubocop/cop/mixin/end_keyword_alignment.rb +11 -2
- data/lib/rubocop/cop/mixin/enforce_superclass.rb +16 -8
- data/lib/rubocop/cop/mixin/first_element_line_break.rb +3 -3
- data/lib/rubocop/cop/mixin/frozen_string_literal.rb +14 -5
- data/lib/rubocop/cop/mixin/gem_declaration.rb +13 -0
- data/lib/rubocop/cop/mixin/hash_alignment_styles.rb +17 -9
- data/lib/rubocop/cop/mixin/hash_transform_method.rb +48 -31
- data/lib/rubocop/cop/mixin/ignored_methods.rb +36 -3
- data/lib/rubocop/cop/mixin/ignored_pattern.rb +1 -1
- data/lib/rubocop/cop/mixin/interpolation.rb +1 -3
- data/lib/rubocop/cop/mixin/line_length_help.rb +17 -15
- data/lib/rubocop/cop/mixin/match_range.rb +2 -5
- data/lib/rubocop/cop/mixin/method_complexity.rb +21 -6
- data/lib/rubocop/cop/mixin/method_preference.rb +1 -2
- data/lib/rubocop/cop/mixin/multiline_element_indentation.rb +4 -3
- data/lib/rubocop/cop/mixin/multiline_element_line_breaks.rb +1 -1
- data/lib/rubocop/cop/mixin/multiline_expression_indentation.rb +13 -42
- data/lib/rubocop/cop/mixin/multiline_literal_brace_layout.rb +14 -14
- data/lib/rubocop/cop/mixin/negative_conditional.rb +6 -4
- data/lib/rubocop/cop/mixin/nil_methods.rb +3 -5
- data/lib/rubocop/cop/mixin/ordered_gem_node.rb +7 -5
- data/lib/rubocop/cop/mixin/parentheses.rb +1 -2
- data/lib/rubocop/cop/mixin/percent_array.rb +14 -9
- data/lib/rubocop/cop/mixin/percent_literal.rb +0 -6
- data/lib/rubocop/cop/mixin/preceding_following_alignment.rb +6 -12
- data/lib/rubocop/cop/mixin/preferred_delimiters.rb +6 -9
- data/lib/rubocop/cop/mixin/range_help.rb +24 -13
- data/lib/rubocop/cop/mixin/rational_literal.rb +1 -0
- data/lib/rubocop/cop/mixin/rescue_node.rb +13 -7
- data/lib/rubocop/cop/mixin/safe_assignment.rb +6 -2
- data/lib/rubocop/cop/mixin/space_after_punctuation.rb +6 -7
- data/lib/rubocop/cop/mixin/space_before_punctuation.rb +5 -5
- data/lib/rubocop/cop/mixin/statement_modifier.rb +45 -23
- data/lib/rubocop/cop/mixin/string_help.rb +4 -1
- data/lib/rubocop/cop/mixin/string_literals_help.rb +3 -5
- data/lib/rubocop/cop/mixin/surrounding_space.rb +15 -31
- data/lib/rubocop/cop/mixin/symbol_help.rb +13 -0
- data/lib/rubocop/cop/mixin/target_ruby_version.rb +5 -1
- data/lib/rubocop/cop/mixin/trailing_body.rb +1 -2
- data/lib/rubocop/cop/mixin/trailing_comma.rb +12 -17
- data/lib/rubocop/cop/mixin/uncommunicative_name.rb +25 -32
- data/lib/rubocop/cop/mixin/unused_argument.rb +5 -9
- data/lib/rubocop/cop/mixin/visibility_help.rb +37 -0
- data/lib/rubocop/cop/naming/accessor_method_name.rb +19 -3
- data/lib/rubocop/cop/naming/ascii_identifiers.rb +29 -8
- data/lib/rubocop/cop/naming/binary_operator_parameter_name.rb +17 -7
- data/lib/rubocop/cop/naming/block_parameter_name.rb +1 -1
- data/lib/rubocop/cop/naming/class_and_module_camel_case.rb +13 -3
- data/lib/rubocop/cop/naming/constant_name.rb +4 -2
- data/lib/rubocop/cop/naming/file_name.rb +36 -34
- data/lib/rubocop/cop/naming/heredoc_delimiter_case.rb +12 -6
- data/lib/rubocop/cop/naming/heredoc_delimiter_naming.rb +3 -3
- data/lib/rubocop/cop/naming/inclusive_language.rb +249 -0
- data/lib/rubocop/cop/naming/memoized_instance_variable_name.rb +134 -26
- data/lib/rubocop/cop/naming/method_name.rb +6 -8
- data/lib/rubocop/cop/naming/method_parameter_name.rb +2 -2
- data/lib/rubocop/cop/naming/predicate_name.rb +10 -13
- data/lib/rubocop/cop/naming/rescued_exceptions_variable_name.rb +59 -15
- data/lib/rubocop/cop/naming/variable_name.rb +3 -1
- data/lib/rubocop/cop/naming/variable_number.rb +94 -9
- data/lib/rubocop/cop/offense.rb +35 -12
- data/lib/rubocop/cop/registry.rb +87 -23
- data/lib/rubocop/cop/security/eval.rb +4 -2
- data/lib/rubocop/cop/security/json_load.rb +8 -8
- data/lib/rubocop/cop/security/marshal_load.rb +4 -4
- data/lib/rubocop/cop/security/open.rb +15 -11
- data/lib/rubocop/cop/security/yaml_load.rb +8 -6
- data/lib/rubocop/cop/severity.rb +4 -14
- data/lib/rubocop/cop/style/access_modifier_declarations.rb +15 -11
- data/lib/rubocop/cop/style/accessor_grouping.rb +150 -0
- data/lib/rubocop/cop/style/alias.rb +46 -45
- data/lib/rubocop/cop/style/and_or.rb +25 -17
- data/lib/rubocop/cop/style/arguments_forwarding.rb +143 -0
- data/lib/rubocop/cop/style/array_coercion.rb +69 -0
- data/lib/rubocop/cop/style/array_join.rb +9 -9
- data/lib/rubocop/cop/style/ascii_comments.rb +6 -7
- data/lib/rubocop/cop/style/attr.rb +15 -15
- data/lib/rubocop/cop/style/auto_resource_cleanup.rb +9 -12
- data/lib/rubocop/cop/style/bare_percent_literals.rb +12 -14
- data/lib/rubocop/cop/style/begin_block.rb +2 -2
- data/lib/rubocop/cop/style/bisected_attr_accessor.rb +125 -0
- data/lib/rubocop/cop/style/bisected_attr_accessor/macro.rb +60 -0
- data/lib/rubocop/cop/style/block_comments.rb +14 -18
- data/lib/rubocop/cop/style/block_delimiters.rb +41 -34
- data/lib/rubocop/cop/style/case_equality.rb +34 -6
- data/lib/rubocop/cop/style/case_like_if.rb +258 -0
- data/lib/rubocop/cop/style/character_literal.rb +12 -15
- data/lib/rubocop/cop/style/class_and_module_children.rb +57 -24
- data/lib/rubocop/cop/style/class_check.rb +6 -11
- data/lib/rubocop/cop/style/class_equality_comparison.rb +67 -0
- data/lib/rubocop/cop/style/class_methods.rb +8 -14
- data/lib/rubocop/cop/style/class_methods_definitions.rb +157 -0
- data/lib/rubocop/cop/style/class_vars.rb +23 -7
- data/lib/rubocop/cop/style/collection_compact.rb +91 -0
- data/lib/rubocop/cop/style/collection_methods.rb +22 -15
- data/lib/rubocop/cop/style/colon_method_call.rb +7 -9
- data/lib/rubocop/cop/style/colon_method_definition.rb +6 -6
- data/lib/rubocop/cop/style/combinable_loops.rb +92 -0
- data/lib/rubocop/cop/style/command_literal.rb +22 -28
- data/lib/rubocop/cop/style/comment_annotation.rb +73 -26
- data/lib/rubocop/cop/style/commented_keyword.rb +34 -21
- data/lib/rubocop/cop/style/conditional_assignment.rb +71 -87
- data/lib/rubocop/cop/style/constant_visibility.rb +31 -2
- data/lib/rubocop/cop/style/copyright.rb +20 -23
- data/lib/rubocop/cop/style/date_time.rb +16 -5
- data/lib/rubocop/cop/style/def_with_parentheses.rb +9 -12
- data/lib/rubocop/cop/style/dir.rb +11 -12
- data/lib/rubocop/cop/style/disable_cops_within_source_code_directive.rb +51 -13
- data/lib/rubocop/cop/style/document_dynamic_eval_definition.rb +169 -0
- data/lib/rubocop/cop/style/documentation.rb +50 -14
- data/lib/rubocop/cop/style/documentation_method.rb +2 -1
- data/lib/rubocop/cop/style/double_cop_disable_directive.rb +7 -16
- data/lib/rubocop/cop/style/double_negation.rb +50 -6
- data/lib/rubocop/cop/style/each_for_simple_loop.rb +7 -10
- data/lib/rubocop/cop/style/each_with_object.rb +17 -19
- data/lib/rubocop/cop/style/empty_block_parameter.rb +9 -10
- data/lib/rubocop/cop/style/empty_case_condition.rb +22 -26
- data/lib/rubocop/cop/style/empty_else.rb +14 -22
- data/lib/rubocop/cop/style/empty_lambda_parameter.rb +9 -10
- data/lib/rubocop/cop/style/empty_literal.rb +46 -31
- data/lib/rubocop/cop/style/empty_method.rb +12 -23
- data/lib/rubocop/cop/style/encoding.rb +6 -10
- data/lib/rubocop/cop/style/end_block.rb +5 -8
- data/lib/rubocop/cop/style/endless_method.rb +101 -0
- data/lib/rubocop/cop/style/eval_with_location.rb +143 -54
- data/lib/rubocop/cop/style/even_odd.rb +9 -11
- data/lib/rubocop/cop/style/expand_path_arguments.rb +25 -23
- data/lib/rubocop/cop/style/explicit_block_argument.rb +114 -0
- data/lib/rubocop/cop/style/exponential_notation.rb +15 -18
- data/lib/rubocop/cop/style/float_division.rb +60 -11
- data/lib/rubocop/cop/style/for.rb +7 -13
- data/lib/rubocop/cop/style/format_string.rb +28 -22
- data/lib/rubocop/cop/style/format_string_token.rb +78 -22
- data/lib/rubocop/cop/style/frozen_string_literal_comment.rb +24 -51
- data/lib/rubocop/cop/style/global_std_stream.rb +66 -0
- data/lib/rubocop/cop/style/global_vars.rb +2 -2
- data/lib/rubocop/cop/style/guard_clause.rb +32 -13
- data/lib/rubocop/cop/style/hash_as_last_array_item.rb +88 -0
- data/lib/rubocop/cop/style/hash_conversion.rb +133 -0
- data/lib/rubocop/cop/style/hash_each_methods.rb +26 -12
- data/lib/rubocop/cop/style/hash_except.rb +96 -0
- data/lib/rubocop/cop/style/hash_like_case.rb +77 -0
- data/lib/rubocop/cop/style/hash_syntax.rb +48 -41
- data/lib/rubocop/cop/style/hash_transform_keys.rb +23 -11
- data/lib/rubocop/cop/style/hash_transform_values.rb +22 -10
- data/lib/rubocop/cop/style/identical_conditional_branches.rb +64 -11
- data/lib/rubocop/cop/style/if_inside_else.rb +50 -2
- data/lib/rubocop/cop/style/if_unless_modifier.rb +58 -49
- data/lib/rubocop/cop/style/if_unless_modifier_of_if_unless.rb +11 -3
- data/lib/rubocop/cop/style/if_with_boolean_literal_branches.rb +122 -0
- data/lib/rubocop/cop/style/if_with_semicolon.rb +51 -3
- data/lib/rubocop/cop/style/implicit_runtime_error.rb +3 -1
- data/lib/rubocop/cop/style/in_pattern_then.rb +56 -0
- data/lib/rubocop/cop/style/infinite_loop.rb +27 -26
- data/lib/rubocop/cop/style/inline_comment.rb +4 -4
- data/lib/rubocop/cop/style/inverse_methods.rb +28 -40
- data/lib/rubocop/cop/style/ip_addresses.rb +3 -4
- data/lib/rubocop/cop/style/keyword_parameters_order.rb +75 -0
- data/lib/rubocop/cop/style/lambda.rb +9 -16
- data/lib/rubocop/cop/style/lambda_call.rb +18 -35
- data/lib/rubocop/cop/style/line_end_concatenation.rb +21 -25
- data/lib/rubocop/cop/style/method_call_with_args_parentheses.rb +62 -13
- data/lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb +53 -32
- data/lib/rubocop/cop/style/method_call_with_args_parentheses/require_parentheses.rb +8 -18
- data/lib/rubocop/cop/style/method_call_without_args_parentheses.rb +19 -12
- data/lib/rubocop/cop/style/method_called_on_do_end_block.rb +14 -7
- data/lib/rubocop/cop/style/method_def_parentheses.rb +18 -24
- data/lib/rubocop/cop/style/min_max.rb +10 -14
- data/lib/rubocop/cop/style/missing_else.rb +13 -25
- data/lib/rubocop/cop/style/missing_respond_to_missing.rb +11 -5
- data/lib/rubocop/cop/style/mixin_grouping.rb +26 -39
- data/lib/rubocop/cop/style/mixin_usage.rb +12 -30
- data/lib/rubocop/cop/style/module_function.rb +18 -19
- data/lib/rubocop/cop/style/multiline_block_chain.rb +13 -5
- data/lib/rubocop/cop/style/multiline_if_modifier.rb +3 -10
- data/lib/rubocop/cop/style/multiline_if_then.rb +5 -11
- data/lib/rubocop/cop/style/multiline_in_pattern_then.rb +62 -0
- data/lib/rubocop/cop/style/multiline_memoization.rb +15 -13
- data/lib/rubocop/cop/style/multiline_method_signature.rb +33 -3
- data/lib/rubocop/cop/style/multiline_ternary_operator.rb +32 -11
- data/lib/rubocop/cop/style/multiline_when_then.rb +25 -18
- data/lib/rubocop/cop/style/multiple_comparison.rb +77 -12
- data/lib/rubocop/cop/style/mutable_constant.rb +45 -37
- data/lib/rubocop/cop/style/negated_if.rb +10 -11
- data/lib/rubocop/cop/style/negated_if_else_condition.rb +128 -0
- data/lib/rubocop/cop/style/negated_unless.rb +10 -11
- data/lib/rubocop/cop/style/negated_while.rb +7 -15
- data/lib/rubocop/cop/style/nested_modifier.rb +10 -17
- data/lib/rubocop/cop/style/nested_parenthesized_calls.rb +20 -17
- data/lib/rubocop/cop/style/nested_ternary_operator.rb +30 -4
- data/lib/rubocop/cop/style/next.rb +16 -25
- data/lib/rubocop/cop/style/nil_comparison.rb +19 -11
- data/lib/rubocop/cop/style/nil_lambda.rb +70 -0
- data/lib/rubocop/cop/style/non_nil_check.rb +56 -34
- data/lib/rubocop/cop/style/not.rb +20 -26
- data/lib/rubocop/cop/style/numeric_literal_prefix.rb +6 -11
- data/lib/rubocop/cop/style/numeric_literals.rb +19 -27
- data/lib/rubocop/cop/style/numeric_predicate.rb +15 -23
- data/lib/rubocop/cop/style/one_line_conditional.rb +73 -28
- data/lib/rubocop/cop/style/option_hash.rb +3 -4
- data/lib/rubocop/cop/style/optional_arguments.rb +4 -7
- data/lib/rubocop/cop/style/optional_boolean_parameter.rb +53 -0
- data/lib/rubocop/cop/style/or_assignment.rb +11 -10
- data/lib/rubocop/cop/style/parallel_assignment.rb +27 -24
- data/lib/rubocop/cop/style/parentheses_around_condition.rb +7 -6
- data/lib/rubocop/cop/style/percent_literal_delimiters.rb +16 -24
- data/lib/rubocop/cop/style/percent_q_literals.rb +9 -12
- data/lib/rubocop/cop/style/perl_backrefs.rb +84 -16
- data/lib/rubocop/cop/style/preferred_hash_methods.rb +12 -18
- data/lib/rubocop/cop/style/proc.rb +8 -8
- data/lib/rubocop/cop/style/quoted_symbols.rb +110 -0
- data/lib/rubocop/cop/style/raise_args.rb +41 -37
- data/lib/rubocop/cop/style/random_with_offset.rb +30 -35
- data/lib/rubocop/cop/style/redundant_argument.rb +85 -0
- data/lib/rubocop/cop/style/redundant_assignment.rb +106 -0
- data/lib/rubocop/cop/style/redundant_begin.rb +79 -13
- data/lib/rubocop/cop/style/redundant_capital_w.rb +7 -11
- data/lib/rubocop/cop/style/redundant_condition.rb +28 -15
- data/lib/rubocop/cop/style/redundant_conditional.rb +13 -14
- data/lib/rubocop/cop/style/redundant_exception.rb +21 -16
- data/lib/rubocop/cop/style/redundant_fetch_block.rb +115 -0
- data/lib/rubocop/cop/style/redundant_file_extension_in_require.rb +52 -0
- data/lib/rubocop/cop/style/redundant_freeze.rb +16 -14
- data/lib/rubocop/cop/style/redundant_interpolation.rb +32 -27
- data/lib/rubocop/cop/style/redundant_parentheses.rb +51 -38
- data/lib/rubocop/cop/style/redundant_percent_q.rb +13 -16
- data/lib/rubocop/cop/style/redundant_regexp_character_class.rb +104 -0
- data/lib/rubocop/cop/style/redundant_regexp_escape.rb +118 -0
- data/lib/rubocop/cop/style/redundant_return.rb +24 -22
- data/lib/rubocop/cop/style/redundant_self.rb +46 -26
- data/lib/rubocop/cop/style/redundant_self_assignment.rb +118 -0
- data/lib/rubocop/cop/style/redundant_sort.rb +30 -35
- data/lib/rubocop/cop/style/redundant_sort_by.rb +6 -9
- data/lib/rubocop/cop/style/regexp_literal.rb +24 -30
- data/lib/rubocop/cop/style/rescue_modifier.rb +39 -12
- data/lib/rubocop/cop/style/rescue_standard_error.rb +25 -23
- data/lib/rubocop/cop/style/return_nil.rb +12 -7
- data/lib/rubocop/cop/style/safe_navigation.rb +44 -39
- data/lib/rubocop/cop/style/sample.rb +14 -15
- data/lib/rubocop/cop/style/self_assignment.rb +26 -22
- data/lib/rubocop/cop/style/semicolon.rb +10 -10
- data/lib/rubocop/cop/style/send.rb +5 -7
- data/lib/rubocop/cop/style/signal_exception.rb +32 -27
- data/lib/rubocop/cop/style/single_argument_dig.rb +55 -0
- data/lib/rubocop/cop/style/single_line_block_params.rb +34 -12
- data/lib/rubocop/cop/style/single_line_methods.rb +81 -19
- data/lib/rubocop/cop/style/slicing_with_range.rb +38 -0
- data/lib/rubocop/cop/style/sole_nested_conditional.rb +176 -0
- data/lib/rubocop/cop/style/special_global_vars.rb +21 -54
- data/lib/rubocop/cop/style/stabby_lambda_parentheses.rb +18 -22
- data/lib/rubocop/cop/style/static_class.rb +97 -0
- data/lib/rubocop/cop/style/stderr_puts.rb +9 -13
- data/lib/rubocop/cop/style/string_chars.rb +39 -0
- data/lib/rubocop/cop/style/string_concatenation.rb +169 -0
- data/lib/rubocop/cop/style/string_hash_keys.rb +8 -7
- data/lib/rubocop/cop/style/string_literals.rb +19 -15
- data/lib/rubocop/cop/style/string_literals_in_interpolation.rb +5 -3
- data/lib/rubocop/cop/style/string_methods.rb +7 -17
- data/lib/rubocop/cop/style/strip.rb +10 -14
- data/lib/rubocop/cop/style/struct_inheritance.rb +33 -4
- data/lib/rubocop/cop/style/swap_values.rb +108 -0
- data/lib/rubocop/cop/style/symbol_array.rb +11 -22
- data/lib/rubocop/cop/style/symbol_literal.rb +4 -8
- data/lib/rubocop/cop/style/symbol_proc.rb +50 -32
- data/lib/rubocop/cop/style/ternary_parentheses.rb +29 -33
- data/lib/rubocop/cop/style/top_level_method_definition.rb +83 -0
- data/lib/rubocop/cop/style/trailing_body_on_class.rb +3 -6
- data/lib/rubocop/cop/style/trailing_body_on_method_definition.rb +10 -9
- data/lib/rubocop/cop/style/trailing_body_on_module.rb +3 -6
- data/lib/rubocop/cop/style/trailing_comma_in_arguments.rb +5 -8
- data/lib/rubocop/cop/style/trailing_comma_in_array_literal.rb +5 -8
- data/lib/rubocop/cop/style/trailing_comma_in_block_args.rb +22 -24
- data/lib/rubocop/cop/style/trailing_comma_in_hash_literal.rb +5 -8
- data/lib/rubocop/cop/style/trailing_method_end_statement.rb +12 -38
- data/lib/rubocop/cop/style/trailing_underscore_variable.rb +16 -31
- data/lib/rubocop/cop/style/trivial_accessors.rb +101 -40
- data/lib/rubocop/cop/style/unless_else.rb +7 -11
- data/lib/rubocop/cop/style/unless_logical_operators.rb +105 -0
- data/lib/rubocop/cop/style/unpack_first.rb +7 -9
- data/lib/rubocop/cop/style/variable_interpolation.rb +8 -11
- data/lib/rubocop/cop/style/when_then.rb +7 -7
- data/lib/rubocop/cop/style/while_until_do.rb +6 -16
- data/lib/rubocop/cop/style/while_until_modifier.rb +16 -24
- data/lib/rubocop/cop/style/word_array.rb +6 -25
- data/lib/rubocop/cop/style/yoda_condition.rb +17 -18
- data/lib/rubocop/cop/style/zero_length_predicate.rb +25 -23
- data/lib/rubocop/cop/team.rb +147 -84
- data/lib/rubocop/cop/util.rb +43 -27
- data/lib/rubocop/cop/utils/format_string.rb +22 -9
- data/lib/rubocop/cop/variable_force.rb +11 -26
- data/lib/rubocop/cop/variable_force/assignment.rb +2 -2
- data/lib/rubocop/cop/variable_force/branch.rb +18 -9
- data/lib/rubocop/cop/variable_force/reference.rb +1 -3
- data/lib/rubocop/cop/variable_force/scope.rb +6 -9
- data/lib/rubocop/cop/variable_force/variable.rb +9 -12
- data/lib/rubocop/cop/variable_force/variable_table.rb +1 -1
- data/lib/rubocop/cops_documentation_generator.rb +270 -0
- data/lib/rubocop/core_ext/string.rb +2 -2
- data/lib/rubocop/directive_comment.rb +144 -0
- data/lib/rubocop/error.rb +1 -0
- data/lib/rubocop/ext/processed_source.rb +18 -0
- data/lib/rubocop/ext/regexp_node.rb +87 -0
- data/lib/rubocop/ext/regexp_parser.rb +92 -0
- data/lib/rubocop/file_finder.rb +12 -13
- data/lib/rubocop/formatter/auto_gen_config_formatter.rb +2 -1
- data/lib/rubocop/formatter/base_formatter.rb +0 -4
- data/lib/rubocop/formatter/clang_style_formatter.rb +4 -2
- data/lib/rubocop/formatter/disabled_config_formatter.rb +39 -30
- data/lib/rubocop/formatter/emacs_style_formatter.rb +2 -0
- data/lib/rubocop/formatter/formatter_set.rb +5 -5
- data/lib/rubocop/formatter/git_hub_actions_formatter.rb +44 -0
- data/lib/rubocop/formatter/html_formatter.rb +6 -10
- data/lib/rubocop/formatter/json_formatter.rb +1 -5
- data/lib/rubocop/formatter/junit_formatter.rb +34 -15
- data/lib/rubocop/formatter/offense_count_formatter.rb +2 -2
- data/lib/rubocop/formatter/progress_formatter.rb +3 -4
- data/lib/rubocop/formatter/quiet_formatter.rb +1 -1
- data/lib/rubocop/formatter/simple_text_formatter.rb +40 -7
- data/lib/rubocop/formatter/tap_formatter.rb +6 -2
- data/lib/rubocop/formatter/worst_offenders_formatter.rb +2 -2
- data/lib/rubocop/lockfile.rb +40 -0
- data/lib/rubocop/magic_comment.rb +33 -4
- data/lib/rubocop/name_similarity.rb +18 -10
- data/lib/rubocop/options.rb +126 -91
- data/lib/rubocop/path_util.rb +20 -22
- data/lib/rubocop/platform.rb +1 -1
- data/lib/rubocop/rake_task.rb +12 -11
- data/lib/rubocop/remote_config.rb +15 -11
- data/lib/rubocop/result_cache.rb +50 -31
- data/lib/rubocop/rspec/cop_helper.rb +11 -35
- data/lib/rubocop/rspec/expect_offense.rb +128 -39
- data/lib/rubocop/rspec/shared_contexts.rb +78 -32
- data/lib/rubocop/runner.rb +111 -74
- data/lib/rubocop/string_interpreter.rb +3 -0
- data/lib/rubocop/target_finder.rb +58 -48
- data/lib/rubocop/target_ruby.rb +126 -13
- data/lib/rubocop/util.rb +16 -0
- data/lib/rubocop/version.rb +71 -7
- data/lib/rubocop/yaml_duplication_checker.rb +1 -0
- metadata +189 -91
- data/bin/console +0 -10
- data/bin/setup +0 -7
- data/lib/rubocop/ast/builder.rb +0 -85
- data/lib/rubocop/ast/node.rb +0 -637
- data/lib/rubocop/ast/node/alias_node.rb +0 -24
- data/lib/rubocop/ast/node/and_node.rb +0 -29
- data/lib/rubocop/ast/node/args_node.rb +0 -29
- data/lib/rubocop/ast/node/array_node.rb +0 -70
- data/lib/rubocop/ast/node/block_node.rb +0 -121
- data/lib/rubocop/ast/node/break_node.rb +0 -17
- data/lib/rubocop/ast/node/case_match_node.rb +0 -56
- data/lib/rubocop/ast/node/case_node.rb +0 -56
- data/lib/rubocop/ast/node/class_node.rb +0 -31
- data/lib/rubocop/ast/node/def_node.rb +0 -82
- data/lib/rubocop/ast/node/defined_node.rb +0 -17
- data/lib/rubocop/ast/node/ensure_node.rb +0 -17
- data/lib/rubocop/ast/node/float_node.rb +0 -12
- data/lib/rubocop/ast/node/for_node.rb +0 -53
- data/lib/rubocop/ast/node/forward_args_node.rb +0 -18
- data/lib/rubocop/ast/node/hash_node.rb +0 -109
- data/lib/rubocop/ast/node/if_node.rb +0 -175
- data/lib/rubocop/ast/node/int_node.rb +0 -12
- data/lib/rubocop/ast/node/keyword_splat_node.rb +0 -45
- data/lib/rubocop/ast/node/mixin/basic_literal_node.rb +0 -16
- data/lib/rubocop/ast/node/mixin/binary_operator_node.rb +0 -43
- data/lib/rubocop/ast/node/mixin/collection_node.rb +0 -15
- data/lib/rubocop/ast/node/mixin/conditional_node.rb +0 -45
- data/lib/rubocop/ast/node/mixin/hash_element_node.rb +0 -125
- data/lib/rubocop/ast/node/mixin/method_dispatch_node.rb +0 -269
- data/lib/rubocop/ast/node/mixin/method_identifier_predicates.rb +0 -114
- data/lib/rubocop/ast/node/mixin/modifier_node.rb +0 -17
- data/lib/rubocop/ast/node/mixin/numeric_node.rb +0 -21
- data/lib/rubocop/ast/node/mixin/parameterized_node.rb +0 -61
- data/lib/rubocop/ast/node/mixin/predicate_operator_node.rb +0 -35
- data/lib/rubocop/ast/node/module_node.rb +0 -24
- data/lib/rubocop/ast/node/or_node.rb +0 -29
- data/lib/rubocop/ast/node/pair_node.rb +0 -63
- data/lib/rubocop/ast/node/range_node.rb +0 -18
- data/lib/rubocop/ast/node/regexp_node.rb +0 -33
- data/lib/rubocop/ast/node/resbody_node.rb +0 -24
- data/lib/rubocop/ast/node/retry_node.rb +0 -17
- data/lib/rubocop/ast/node/return_node.rb +0 -24
- data/lib/rubocop/ast/node/self_class_node.rb +0 -24
- data/lib/rubocop/ast/node/send_node.rb +0 -13
- data/lib/rubocop/ast/node/str_node.rb +0 -16
- data/lib/rubocop/ast/node/super_node.rb +0 -21
- data/lib/rubocop/ast/node/symbol_node.rb +0 -12
- data/lib/rubocop/ast/node/until_node.rb +0 -35
- data/lib/rubocop/ast/node/when_node.rb +0 -53
- data/lib/rubocop/ast/node/while_node.rb +0 -35
- data/lib/rubocop/ast/node/yield_node.rb +0 -21
- data/lib/rubocop/ast/sexp.rb +0 -16
- data/lib/rubocop/ast/traversal.rb +0 -202
- data/lib/rubocop/cop/lint/useless_comparison.rb +0 -28
- data/lib/rubocop/cop/mixin/classish_length.rb +0 -37
- data/lib/rubocop/cop/mixin/parser_diagnostic.rb +0 -37
- data/lib/rubocop/cop/mixin/too_many_lines.rb +0 -35
- data/lib/rubocop/cop/style/method_missing_super.rb +0 -34
- data/lib/rubocop/node_pattern.rb +0 -887
- data/lib/rubocop/processed_source.rb +0 -213
- data/lib/rubocop/string_util.rb +0 -14
- data/lib/rubocop/token.rb +0 -114
@@ -26,19 +26,47 @@ module RuboCop
|
|
26
26
|
# public_constant :BAZ
|
27
27
|
# end
|
28
28
|
#
|
29
|
-
|
29
|
+
# @example IgnoreModules: false (default)
|
30
|
+
# # bad
|
31
|
+
# class Foo
|
32
|
+
# MyClass = Struct.new()
|
33
|
+
# end
|
34
|
+
#
|
35
|
+
# # good
|
36
|
+
# class Foo
|
37
|
+
# MyClass = Struct.new()
|
38
|
+
# public_constant :MyClass
|
39
|
+
# end
|
40
|
+
#
|
41
|
+
# @example IgnoreModules: true
|
42
|
+
# # good
|
43
|
+
# class Foo
|
44
|
+
# MyClass = Struct.new()
|
45
|
+
# end
|
46
|
+
#
|
47
|
+
class ConstantVisibility < Base
|
30
48
|
MSG = 'Explicitly make `%<constant_name>s` public or private using ' \
|
31
49
|
'either `#public_constant` or `#private_constant`.'
|
32
50
|
|
33
51
|
def on_casgn(node)
|
34
52
|
return unless class_or_module_scope?(node)
|
35
53
|
return if visibility_declaration?(node)
|
54
|
+
return if ignore_modules? && module?(node)
|
36
55
|
|
37
|
-
|
56
|
+
message = message(node)
|
57
|
+
add_offense(node, message: message)
|
38
58
|
end
|
39
59
|
|
40
60
|
private
|
41
61
|
|
62
|
+
def ignore_modules?
|
63
|
+
cop_config.fetch('IgnoreModules', false)
|
64
|
+
end
|
65
|
+
|
66
|
+
def module?(node)
|
67
|
+
node.children.last.class_constructor?
|
68
|
+
end
|
69
|
+
|
42
70
|
def message(node)
|
43
71
|
_namespace, constant_name, _value = *node
|
44
72
|
|
@@ -64,6 +92,7 @@ module RuboCop
|
|
64
92
|
end
|
65
93
|
end
|
66
94
|
|
95
|
+
# @!method visibility_declaration_for?(node, const_name)
|
67
96
|
def_node_matcher :visibility_declaration_for?, <<~PATTERN
|
68
97
|
(send nil? {:public_constant :private_constant} ({sym str} #match_name?(%1)))
|
69
98
|
PATTERN
|
@@ -8,35 +8,29 @@ module RuboCop
|
|
8
8
|
# The default regexp for an acceptable copyright notice can be found in
|
9
9
|
# config/default.yml. The default can be changed as follows:
|
10
10
|
#
|
11
|
-
#
|
12
|
-
#
|
11
|
+
# Style/Copyright:
|
12
|
+
# Notice: '^Copyright (\(c\) )?2\d{3} Acme Inc'
|
13
13
|
#
|
14
14
|
# This regex string is treated as an unanchored regex. For each file
|
15
15
|
# that RuboCop scans, a comment that matches this regex must be found or
|
16
16
|
# an offense is reported.
|
17
17
|
#
|
18
|
-
class Copyright <
|
18
|
+
class Copyright < Base
|
19
19
|
include RangeHelp
|
20
|
+
extend AutoCorrector
|
20
21
|
|
21
|
-
MSG = 'Include a copyright notice matching /%<notice>s/ before '
|
22
|
-
|
23
|
-
AUTOCORRECT_EMPTY_WARNING = 'An AutocorrectNotice must be defined in ' \
|
24
|
-
'your RuboCop config'
|
22
|
+
MSG = 'Include a copyright notice matching /%<notice>s/ before any code.'
|
23
|
+
AUTOCORRECT_EMPTY_WARNING = 'An AutocorrectNotice must be defined in your RuboCop config'
|
25
24
|
|
26
|
-
def
|
27
|
-
return if notice.empty?
|
28
|
-
return if notice_found?(processed_source)
|
25
|
+
def on_new_investigation
|
26
|
+
return if notice.empty? || notice_found?(processed_source)
|
29
27
|
|
30
|
-
|
31
|
-
|
32
|
-
location: range, message: format(MSG, notice: notice))
|
33
|
-
end
|
34
|
-
|
35
|
-
def autocorrect(token)
|
36
|
-
verify_autocorrect_notice!
|
28
|
+
add_offense(offense_range, message: format(MSG, notice: notice)) do |corrector|
|
29
|
+
verify_autocorrect_notice!
|
37
30
|
|
38
|
-
|
31
|
+
token = insert_notice_before(processed_source)
|
39
32
|
range = token.nil? ? range_between(0, 0) : token.pos
|
33
|
+
|
40
34
|
corrector.insert_before(range, "#{autocorrect_notice}\n")
|
41
35
|
end
|
42
36
|
end
|
@@ -51,14 +45,17 @@ module RuboCop
|
|
51
45
|
cop_config['AutocorrectNotice']
|
52
46
|
end
|
53
47
|
|
48
|
+
def offense_range
|
49
|
+
source_range(processed_source.buffer, 1, 0)
|
50
|
+
end
|
51
|
+
|
54
52
|
def verify_autocorrect_notice!
|
55
53
|
raise Warning, AUTOCORRECT_EMPTY_WARNING if autocorrect_notice.empty?
|
56
54
|
|
57
55
|
regex = Regexp.new(notice)
|
58
56
|
return if autocorrect_notice&.match?(regex)
|
59
57
|
|
60
|
-
raise Warning, "AutocorrectNotice '#{autocorrect_notice}' must "
|
61
|
-
"match Notice /#{notice}/"
|
58
|
+
raise Warning, "AutocorrectNotice '#{autocorrect_notice}' must match Notice /#{notice}/"
|
62
59
|
end
|
63
60
|
|
64
61
|
def insert_notice_before(processed_source)
|
@@ -72,14 +69,14 @@ module RuboCop
|
|
72
69
|
return false if token_index >= processed_source.tokens.size
|
73
70
|
|
74
71
|
token = processed_source.tokens[token_index]
|
75
|
-
token.comment? && token.text
|
72
|
+
token.comment? && /^#!.*$/.match?(token.text)
|
76
73
|
end
|
77
74
|
|
78
75
|
def encoding_token?(processed_source, token_index)
|
79
76
|
return false if token_index >= processed_source.tokens.size
|
80
77
|
|
81
78
|
token = processed_source.tokens[token_index]
|
82
|
-
token.comment? &&
|
79
|
+
token.comment? && /^#.*coding\s?[:=]\s?(?:UTF|utf)-8/.match?(token.text)
|
83
80
|
end
|
84
81
|
|
85
82
|
def notice_found?(processed_source)
|
@@ -88,7 +85,7 @@ module RuboCop
|
|
88
85
|
processed_source.each_token do |token|
|
89
86
|
break unless token.comment?
|
90
87
|
|
91
|
-
notice_found =
|
88
|
+
notice_found = notice_regexp.match?(token.text)
|
92
89
|
break if notice_found
|
93
90
|
end
|
94
91
|
notice_found
|
@@ -41,29 +41,34 @@ module RuboCop
|
|
41
41
|
#
|
42
42
|
# # good
|
43
43
|
# something.to_time
|
44
|
-
class DateTime <
|
44
|
+
class DateTime < Base
|
45
|
+
extend AutoCorrector
|
46
|
+
|
45
47
|
CLASS_MSG = 'Prefer Time over DateTime.'
|
46
48
|
COERCION_MSG = 'Do not use #to_datetime.'
|
47
49
|
|
50
|
+
# @!method date_time?(node)
|
48
51
|
def_node_matcher :date_time?, <<~PATTERN
|
49
52
|
(send (const {nil? (cbase)} :DateTime) ...)
|
50
53
|
PATTERN
|
51
54
|
|
55
|
+
# @!method historic_date?(node)
|
52
56
|
def_node_matcher :historic_date?, <<~PATTERN
|
53
|
-
(send _ _ _ (const (const nil? :Date) _))
|
57
|
+
(send _ _ _ (const (const {nil? (cbase)} :Date) _))
|
54
58
|
PATTERN
|
55
59
|
|
60
|
+
# @!method to_datetime?(node)
|
56
61
|
def_node_matcher :to_datetime?, <<~PATTERN
|
57
62
|
(send _ :to_datetime)
|
58
63
|
PATTERN
|
59
64
|
|
60
65
|
def on_send(node)
|
61
|
-
return unless date_time?(node) ||
|
62
|
-
(to_datetime?(node) && disallow_coercion?)
|
66
|
+
return unless date_time?(node) || (to_datetime?(node) && disallow_coercion?)
|
63
67
|
return if historic_date?(node)
|
64
68
|
|
65
69
|
message = to_datetime?(node) ? COERCION_MSG : CLASS_MSG
|
66
|
-
|
70
|
+
|
71
|
+
add_offense(node, message: message) { |corrector| autocorrect(corrector, node) }
|
67
72
|
end
|
68
73
|
|
69
74
|
private
|
@@ -71,6 +76,12 @@ module RuboCop
|
|
71
76
|
def disallow_coercion?
|
72
77
|
!cop_config['AllowCoercion']
|
73
78
|
end
|
79
|
+
|
80
|
+
def autocorrect(corrector, node)
|
81
|
+
return if to_datetime?(node)
|
82
|
+
|
83
|
+
corrector.replace(node.receiver.loc.name, 'Time')
|
84
|
+
end
|
74
85
|
end
|
75
86
|
end
|
76
87
|
end
|
@@ -33,24 +33,21 @@ module RuboCop
|
|
33
33
|
# def Baz.foo
|
34
34
|
# # does a thing
|
35
35
|
# end
|
36
|
-
class DefWithParentheses <
|
37
|
-
|
38
|
-
|
36
|
+
class DefWithParentheses < Base
|
37
|
+
extend AutoCorrector
|
38
|
+
|
39
|
+
MSG = "Omit the parentheses in defs when the method doesn't accept any arguments."
|
39
40
|
|
40
41
|
def on_def(node)
|
41
42
|
return if node.single_line?
|
42
|
-
return unless !node.arguments? && node.arguments.loc.begin
|
43
|
+
return unless !node.arguments? && (node_arguments_loc_begin = node.arguments.loc.begin)
|
43
44
|
|
44
|
-
add_offense(
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
def autocorrect(node)
|
49
|
-
lambda do |corrector|
|
50
|
-
corrector.remove(node.loc.begin)
|
51
|
-
corrector.remove(node.loc.end)
|
45
|
+
add_offense(node_arguments_loc_begin) do |corrector|
|
46
|
+
corrector.remove(node_arguments_loc_begin)
|
47
|
+
corrector.remove(node.arguments.loc.end)
|
52
48
|
end
|
53
49
|
end
|
50
|
+
alias on_defs on_def
|
54
51
|
end
|
55
52
|
end
|
56
53
|
end
|
@@ -16,24 +16,23 @@ module RuboCop
|
|
16
16
|
#
|
17
17
|
# # good
|
18
18
|
# path = __dir__
|
19
|
-
class Dir <
|
20
|
-
|
21
|
-
"file's directory."
|
19
|
+
class Dir < Base
|
20
|
+
extend AutoCorrector
|
22
21
|
|
22
|
+
MSG = "Use `__dir__` to get an absolute path to the current file's directory."
|
23
|
+
RESTRICT_ON_SEND = %i[expand_path dirname].freeze
|
24
|
+
|
25
|
+
# @!method dir_replacement?(node)
|
23
26
|
def_node_matcher :dir_replacement?, <<~PATTERN
|
24
|
-
{(send (const nil? :File) :expand_path (send (const nil? :File) :dirname #file_keyword?))
|
25
|
-
(send (const nil? :File) :dirname (send (const nil? :File) :realpath #file_keyword?))}
|
27
|
+
{(send (const {nil? cbase} :File) :expand_path (send (const {nil? cbase} :File) :dirname #file_keyword?))
|
28
|
+
(send (const {nil? cbase} :File) :dirname (send (const {nil? cbase} :File) :realpath #file_keyword?))}
|
26
29
|
PATTERN
|
27
30
|
|
28
31
|
def on_send(node)
|
29
32
|
dir_replacement?(node) do
|
30
|
-
add_offense(node)
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
def autocorrect(node)
|
35
|
-
lambda do |corrector|
|
36
|
-
corrector.replace(node, '__dir__')
|
33
|
+
add_offense(node) do |corrector|
|
34
|
+
corrector.replace(node, '__dir__')
|
35
|
+
end
|
37
36
|
end
|
38
37
|
end
|
39
38
|
|
@@ -9,39 +9,77 @@ module RuboCop
|
|
9
9
|
# This is useful if want to make sure that every RuboCop error gets fixed
|
10
10
|
# and not quickly disabled with a comment.
|
11
11
|
#
|
12
|
+
# Specific cops can be allowed with the `AllowedCops` configuration. Note that
|
13
|
+
# if this configuration is set, `rubocop:disable all` is still disallowed.
|
14
|
+
#
|
12
15
|
# @example
|
13
16
|
# # bad
|
14
17
|
# # rubocop:disable Metrics/AbcSize
|
15
|
-
# def
|
18
|
+
# def foo
|
16
19
|
# end
|
17
20
|
# # rubocop:enable Metrics/AbcSize
|
18
21
|
#
|
19
22
|
# # good
|
20
|
-
# def
|
23
|
+
# def foo
|
21
24
|
# end
|
22
25
|
#
|
23
|
-
|
26
|
+
# @example AllowedCops: [Metrics/AbcSize]
|
27
|
+
# # good
|
28
|
+
# # rubocop:disable Metrics/AbcSize
|
29
|
+
# def foo
|
30
|
+
# end
|
31
|
+
# # rubocop:enable Metrics/AbcSize
|
32
|
+
#
|
33
|
+
class DisableCopsWithinSourceCodeDirective < Base
|
34
|
+
extend AutoCorrector
|
35
|
+
|
24
36
|
# rubocop:enable Lint/RedundantCopDisableDirective
|
25
|
-
MSG = '
|
37
|
+
MSG = 'Rubocop disable/enable directives are not permitted.'
|
38
|
+
MSG_FOR_COPS = 'Rubocop disable/enable directives for %<cops>s are not permitted.'
|
26
39
|
|
27
|
-
def
|
40
|
+
def on_new_investigation
|
28
41
|
processed_source.comments.each do |comment|
|
29
|
-
|
42
|
+
directive_cops = directive_cops(comment)
|
43
|
+
disallowed_cops = directive_cops - allowed_cops
|
30
44
|
|
31
|
-
|
45
|
+
next unless disallowed_cops.any?
|
46
|
+
|
47
|
+
register_offense(comment, directive_cops, disallowed_cops)
|
32
48
|
end
|
33
49
|
end
|
34
50
|
|
35
|
-
|
36
|
-
|
37
|
-
|
51
|
+
private
|
52
|
+
|
53
|
+
def register_offense(comment, directive_cops, disallowed_cops)
|
54
|
+
message = if any_cops_allowed?
|
55
|
+
format(MSG_FOR_COPS, cops: "`#{disallowed_cops.join('`, `')}`")
|
56
|
+
else
|
57
|
+
MSG
|
58
|
+
end
|
59
|
+
|
60
|
+
add_offense(comment, message: message) do |corrector|
|
61
|
+
replacement = ''
|
62
|
+
|
63
|
+
if directive_cops.length != disallowed_cops.length
|
64
|
+
replacement = comment.text.sub(/#{Regexp.union(disallowed_cops)},?\s*/, '')
|
65
|
+
.sub(/,\s*$/, '')
|
66
|
+
end
|
67
|
+
|
68
|
+
corrector.replace(comment, replacement)
|
38
69
|
end
|
39
70
|
end
|
40
71
|
|
41
|
-
|
72
|
+
def directive_cops(comment)
|
73
|
+
match_captures = DirectiveComment.new(comment).match_captures
|
74
|
+
match_captures && match_captures[1] ? match_captures[1].split(',').map(&:strip) : []
|
75
|
+
end
|
76
|
+
|
77
|
+
def allowed_cops
|
78
|
+
Array(cop_config['AllowedCops'])
|
79
|
+
end
|
42
80
|
|
43
|
-
def
|
44
|
-
|
81
|
+
def any_cops_allowed?
|
82
|
+
allowed_cops.any?
|
45
83
|
end
|
46
84
|
end
|
47
85
|
end
|
@@ -0,0 +1,169 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module RuboCop
|
4
|
+
module Cop
|
5
|
+
module Style
|
6
|
+
# When using `class_eval` (or other `eval`) with string interpolation,
|
7
|
+
# add a comment block showing its appearance if interpolated (a practice used in Rails code).
|
8
|
+
#
|
9
|
+
# @example
|
10
|
+
# # from activesupport/lib/active_support/core_ext/string/output_safety.rb
|
11
|
+
#
|
12
|
+
# # bad
|
13
|
+
# UNSAFE_STRING_METHODS.each do |unsafe_method|
|
14
|
+
# if 'String'.respond_to?(unsafe_method)
|
15
|
+
# class_eval <<-EOT, __FILE__, __LINE__ + 1
|
16
|
+
# def #{unsafe_method}(*params, &block)
|
17
|
+
# to_str.#{unsafe_method}(*params, &block)
|
18
|
+
# end
|
19
|
+
#
|
20
|
+
# def #{unsafe_method}!(*params)
|
21
|
+
# @dirty = true
|
22
|
+
# super
|
23
|
+
# end
|
24
|
+
# EOT
|
25
|
+
# end
|
26
|
+
# end
|
27
|
+
#
|
28
|
+
# # good, inline comments in heredoc
|
29
|
+
# UNSAFE_STRING_METHODS.each do |unsafe_method|
|
30
|
+
# if 'String'.respond_to?(unsafe_method)
|
31
|
+
# class_eval <<-EOT, __FILE__, __LINE__ + 1
|
32
|
+
# def #{unsafe_method}(*params, &block) # def capitalize(*params, &block)
|
33
|
+
# to_str.#{unsafe_method}(*params, &block) # to_str.capitalize(*params, &block)
|
34
|
+
# end # end
|
35
|
+
#
|
36
|
+
# def #{unsafe_method}!(*params) # def capitalize!(*params)
|
37
|
+
# @dirty = true # @dirty = true
|
38
|
+
# super # super
|
39
|
+
# end # end
|
40
|
+
# EOT
|
41
|
+
# end
|
42
|
+
# end
|
43
|
+
#
|
44
|
+
# # good, block comments in heredoc
|
45
|
+
# class_eval <<-EOT, __FILE__, __LINE__ + 1
|
46
|
+
# # def capitalize!(*params)
|
47
|
+
# # @dirty = true
|
48
|
+
# # super
|
49
|
+
# # end
|
50
|
+
#
|
51
|
+
# def #{unsafe_method}!(*params)
|
52
|
+
# @dirty = true
|
53
|
+
# super
|
54
|
+
# end
|
55
|
+
# EOT
|
56
|
+
#
|
57
|
+
# # good, block comments before heredoc
|
58
|
+
# class_eval(
|
59
|
+
# # def capitalize!(*params)
|
60
|
+
# # @dirty = true
|
61
|
+
# # super
|
62
|
+
# # end
|
63
|
+
#
|
64
|
+
# <<-EOT, __FILE__, __LINE__ + 1
|
65
|
+
# def #{unsafe_method}!(*params)
|
66
|
+
# @dirty = true
|
67
|
+
# super
|
68
|
+
# end
|
69
|
+
# EOT
|
70
|
+
# )
|
71
|
+
#
|
72
|
+
# # bad - interpolated string without comment
|
73
|
+
# class_eval("def #{unsafe_method}!(*params); end")
|
74
|
+
#
|
75
|
+
# # good - with inline comment or replace it with block comment using heredoc
|
76
|
+
# class_eval("def #{unsafe_method}!(*params); end # def capitalize!(*params); end")
|
77
|
+
class DocumentDynamicEvalDefinition < Base
|
78
|
+
BLOCK_COMMENT_REGEXP = /^\s*#(?!{)/.freeze
|
79
|
+
COMMENT_REGEXP = /\s*#(?!{).*/.freeze
|
80
|
+
MSG = 'Add a comment block showing its appearance if interpolated.'
|
81
|
+
|
82
|
+
RESTRICT_ON_SEND = %i[eval class_eval module_eval instance_eval].freeze
|
83
|
+
|
84
|
+
def on_send(node)
|
85
|
+
arg_node = node.first_argument
|
86
|
+
|
87
|
+
return unless arg_node&.dstr_type? && interpolated?(arg_node)
|
88
|
+
return if inline_comment_docs?(arg_node) ||
|
89
|
+
arg_node.heredoc? && comment_block_docs?(arg_node)
|
90
|
+
|
91
|
+
add_offense(node.loc.selector)
|
92
|
+
end
|
93
|
+
|
94
|
+
private
|
95
|
+
|
96
|
+
def interpolated?(arg_node)
|
97
|
+
arg_node.each_child_node(:begin).any?
|
98
|
+
end
|
99
|
+
|
100
|
+
def inline_comment_docs?(node)
|
101
|
+
node.each_child_node(:begin).all? do |begin_node|
|
102
|
+
source_line = processed_source.lines[begin_node.first_line - 1]
|
103
|
+
source_line.match?(COMMENT_REGEXP)
|
104
|
+
end
|
105
|
+
end
|
106
|
+
|
107
|
+
def comment_block_docs?(arg_node)
|
108
|
+
comments = heredoc_comment_blocks(arg_node.loc.heredoc_body.line_span)
|
109
|
+
.concat(preceding_comment_blocks(arg_node.parent))
|
110
|
+
|
111
|
+
return if comments.none?
|
112
|
+
|
113
|
+
regexp = comment_regexp(arg_node)
|
114
|
+
comments.any? { |comment| regexp.match?(comment) } || regexp.match?(comments.join)
|
115
|
+
end
|
116
|
+
|
117
|
+
def preceding_comment_blocks(node)
|
118
|
+
# Collect comments in the method call, but outside the heredoc
|
119
|
+
comments = processed_source.each_comment_in_lines(node.loc.expression.line_span)
|
120
|
+
|
121
|
+
comments.each_with_object({}) do |comment, hash|
|
122
|
+
merge_adjacent_comments(comment.text, comment.loc.line, hash)
|
123
|
+
end.values
|
124
|
+
end
|
125
|
+
|
126
|
+
def heredoc_comment_blocks(heredoc_body)
|
127
|
+
# Collect comments inside the heredoc
|
128
|
+
line_range = (heredoc_body.begin - 1)..(heredoc_body.end - 1)
|
129
|
+
lines = processed_source.lines[line_range]
|
130
|
+
|
131
|
+
lines.each_with_object({}).with_index(line_range.begin) do |(line, hash), index|
|
132
|
+
merge_adjacent_comments(line, index, hash)
|
133
|
+
end.values
|
134
|
+
end
|
135
|
+
|
136
|
+
def merge_adjacent_comments(line, index, hash)
|
137
|
+
# Combine adjacent comment lines into a single string
|
138
|
+
return unless (line = line.dup.gsub!(BLOCK_COMMENT_REGEXP, ''))
|
139
|
+
|
140
|
+
hash[index] = if hash.keys.last == index - 1
|
141
|
+
[hash.delete(index - 1), line].join("\n")
|
142
|
+
else
|
143
|
+
line
|
144
|
+
end
|
145
|
+
end
|
146
|
+
|
147
|
+
def comment_regexp(arg_node)
|
148
|
+
# Replace the interpolations with wildcards
|
149
|
+
regexp_parts = arg_node.child_nodes.map do |n|
|
150
|
+
n.begin_type? ? /.+/ : source_to_regexp(n.source)
|
151
|
+
end
|
152
|
+
|
153
|
+
Regexp.new(regexp_parts.join)
|
154
|
+
end
|
155
|
+
|
156
|
+
def source_to_regexp(source)
|
157
|
+
# Get the source in the heredoc being `eval`ed, without any comments
|
158
|
+
# and turn it into a regexp
|
159
|
+
return /\s+/ if source.blank?
|
160
|
+
|
161
|
+
source = source.gsub(COMMENT_REGEXP, '')
|
162
|
+
return if source.blank?
|
163
|
+
|
164
|
+
/\s*#{Regexp.escape(source.strip)}/
|
165
|
+
end
|
166
|
+
end
|
167
|
+
end
|
168
|
+
end
|
169
|
+
end
|