rubocop 1.59.0 → 1.68.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE.txt +1 -1
- data/README.md +69 -70
- data/assets/output.css.erb +159 -0
- data/assets/output.html.erb +1 -160
- data/config/default.yml +165 -24
- data/config/internal_affairs.yml +11 -0
- data/exe/rubocop +4 -3
- data/lib/rubocop/cached_data.rb +21 -5
- data/lib/rubocop/cli/command/auto_generate_config.rb +18 -10
- data/lib/rubocop/cli/command/execute_runner.rb +1 -1
- data/lib/rubocop/cli/command/lsp.rb +4 -4
- data/lib/rubocop/cli/command/show_docs_url.rb +2 -2
- data/lib/rubocop/cli/command/version.rb +2 -2
- data/lib/rubocop/cli.rb +10 -1
- data/lib/rubocop/comment_config.rb +1 -1
- data/lib/rubocop/config.rb +41 -13
- data/lib/rubocop/config_finder.rb +12 -2
- data/lib/rubocop/config_loader.rb +15 -10
- data/lib/rubocop/config_loader_resolver.rb +13 -8
- data/lib/rubocop/config_obsoletion.rb +1 -1
- data/lib/rubocop/config_validator.rb +17 -9
- data/lib/rubocop/cop/autocorrect_logic.rb +28 -3
- data/lib/rubocop/cop/base.rb +73 -18
- data/lib/rubocop/cop/bundler/gem_version.rb +4 -5
- data/lib/rubocop/cop/cop.rb +30 -4
- data/lib/rubocop/cop/correctors/alignment_corrector.rb +1 -12
- data/lib/rubocop/cop/correctors/each_to_for_corrector.rb +4 -8
- data/lib/rubocop/cop/correctors/for_to_each_corrector.rb +5 -13
- data/lib/rubocop/cop/correctors/line_break_corrector.rb +2 -0
- data/lib/rubocop/cop/correctors/parentheses_corrector.rb +1 -1
- data/lib/rubocop/cop/correctors/percent_literal_corrector.rb +10 -0
- data/lib/rubocop/cop/documentation.rb +32 -5
- data/lib/rubocop/cop/exclude_limit.rb +1 -1
- data/lib/rubocop/cop/force.rb +12 -0
- data/lib/rubocop/cop/gemspec/add_runtime_dependency.rb +38 -0
- data/lib/rubocop/cop/gemspec/dependency_version.rb +3 -5
- data/lib/rubocop/cop/gemspec/duplicated_assignment.rb +2 -2
- data/lib/rubocop/cop/gemspec/required_ruby_version.rb +5 -1
- data/lib/rubocop/cop/gemspec/ruby_version_globals_usage.rb +3 -3
- data/lib/rubocop/cop/internal_affairs/cop_description.rb +0 -4
- data/lib/rubocop/cop/internal_affairs/empty_line_between_expect_offense_and_correction.rb +2 -1
- data/lib/rubocop/cop/internal_affairs/example_description.rb +6 -5
- data/lib/rubocop/cop/internal_affairs/method_name_end_with.rb +8 -6
- data/lib/rubocop/cop/internal_affairs/node_matcher_directive.rb +123 -29
- data/lib/rubocop/cop/internal_affairs/redundant_expect_offense_arguments.rb +34 -0
- data/lib/rubocop/cop/internal_affairs/redundant_message_argument.rb +6 -21
- data/lib/rubocop/cop/internal_affairs/redundant_source_range.rb +8 -1
- data/lib/rubocop/cop/internal_affairs/undefined_config.rb +11 -1
- data/lib/rubocop/cop/internal_affairs/useless_message_assertion.rb +0 -5
- data/lib/rubocop/cop/internal_affairs.rb +17 -0
- data/lib/rubocop/cop/layout/access_modifier_indentation.rb +5 -1
- data/lib/rubocop/cop/layout/assignment_indentation.rb +3 -2
- data/lib/rubocop/cop/layout/block_alignment.rb +30 -12
- data/lib/rubocop/cop/layout/case_indentation.rb +1 -1
- data/lib/rubocop/cop/layout/comment_indentation.rb +1 -1
- data/lib/rubocop/cop/layout/condition_position.rb +0 -4
- data/lib/rubocop/cop/layout/def_end_alignment.rb +1 -1
- data/lib/rubocop/cop/layout/empty_comment.rb +3 -1
- data/lib/rubocop/cop/layout/empty_line_after_guard_clause.rb +1 -1
- data/lib/rubocop/cop/layout/empty_line_after_magic_comment.rb +14 -7
- data/lib/rubocop/cop/layout/empty_line_after_multiline_condition.rb +1 -1
- data/lib/rubocop/cop/layout/empty_line_between_defs.rb +2 -1
- data/lib/rubocop/cop/layout/empty_lines_around_exception_handling_keywords.rb +8 -3
- data/lib/rubocop/cop/layout/end_alignment.rb +8 -2
- data/lib/rubocop/cop/layout/first_argument_indentation.rb +2 -2
- data/lib/rubocop/cop/layout/first_array_element_indentation.rb +18 -4
- data/lib/rubocop/cop/layout/first_method_argument_line_break.rb +8 -0
- data/lib/rubocop/cop/layout/heredoc_indentation.rb +1 -1
- data/lib/rubocop/cop/layout/indentation_width.rb +5 -6
- data/lib/rubocop/cop/layout/leading_comment_space.rb +56 -1
- data/lib/rubocop/cop/layout/line_continuation_leading_space.rb +1 -1
- data/lib/rubocop/cop/layout/line_length.rb +20 -20
- data/lib/rubocop/cop/layout/redundant_line_break.rb +14 -2
- data/lib/rubocop/cop/layout/space_around_operators.rb +3 -0
- data/lib/rubocop/cop/layout/space_before_block_braces.rb +19 -10
- data/lib/rubocop/cop/layout/space_before_brackets.rb +5 -5
- data/lib/rubocop/cop/layout/space_inside_block_braces.rb +4 -0
- data/lib/rubocop/cop/layout/space_inside_hash_literal_braces.rb +1 -1
- data/lib/rubocop/cop/layout/space_inside_string_interpolation.rb +3 -4
- data/lib/rubocop/cop/legacy/corrector.rb +12 -2
- data/lib/rubocop/cop/lint/ambiguous_block_association.rb +0 -2
- data/lib/rubocop/cop/lint/ambiguous_operator.rb +0 -2
- data/lib/rubocop/cop/lint/ambiguous_range.rb +4 -1
- data/lib/rubocop/cop/lint/ambiguous_regexp_literal.rb +0 -2
- data/lib/rubocop/cop/lint/assignment_in_condition.rb +2 -2
- data/lib/rubocop/cop/lint/big_decimal_new.rb +4 -7
- data/lib/rubocop/cop/lint/boolean_symbol.rb +1 -3
- data/lib/rubocop/cop/lint/circular_argument_reference.rb +0 -13
- data/lib/rubocop/cop/lint/debugger.rb +27 -6
- data/lib/rubocop/cop/lint/deprecated_class_methods.rb +1 -1
- data/lib/rubocop/cop/lint/deprecated_open_ssl_constant.rb +0 -10
- data/lib/rubocop/cop/lint/duplicate_branch.rb +39 -4
- data/lib/rubocop/cop/lint/duplicate_case_condition.rb +1 -5
- data/lib/rubocop/cop/lint/duplicate_hash_key.rb +0 -4
- data/lib/rubocop/cop/lint/duplicate_methods.rb +0 -10
- data/lib/rubocop/cop/lint/duplicate_set_element.rb +74 -0
- data/lib/rubocop/cop/lint/each_with_object_argument.rb +0 -4
- data/lib/rubocop/cop/lint/else_layout.rb +0 -2
- data/lib/rubocop/cop/lint/empty_conditional_body.rb +29 -8
- data/lib/rubocop/cop/lint/empty_ensure.rb +1 -11
- data/lib/rubocop/cop/lint/empty_interpolation.rb +0 -4
- data/lib/rubocop/cop/lint/empty_when.rb +1 -3
- data/lib/rubocop/cop/lint/ensure_return.rb +1 -9
- data/lib/rubocop/cop/lint/erb_new_arguments.rb +21 -14
- data/lib/rubocop/cop/lint/float_comparison.rb +1 -1
- data/lib/rubocop/cop/lint/float_out_of_range.rb +0 -4
- data/lib/rubocop/cop/lint/format_parameter_mismatch.rb +0 -10
- data/lib/rubocop/cop/lint/implicit_string_concatenation.rb +23 -12
- data/lib/rubocop/cop/lint/ineffective_access_modifier.rb +0 -7
- data/lib/rubocop/cop/lint/interpolation_check.rb +0 -4
- data/lib/rubocop/cop/lint/it_without_arguments_in_block.rb +5 -14
- data/lib/rubocop/cop/lint/literal_as_condition.rb +1 -1
- data/lib/rubocop/cop/lint/literal_assignment_in_condition.rb +13 -6
- data/lib/rubocop/cop/lint/literal_in_interpolation.rb +25 -6
- data/lib/rubocop/cop/lint/loop.rb +6 -12
- data/lib/rubocop/cop/lint/mixed_case_range.rb +9 -4
- data/lib/rubocop/cop/lint/nested_method_definition.rb +1 -7
- data/lib/rubocop/cop/lint/next_without_accumulator.rb +0 -4
- data/lib/rubocop/cop/lint/no_return_in_begin_end_blocks.rb +0 -5
- data/lib/rubocop/cop/lint/non_atomic_file_operation.rb +7 -0
- data/lib/rubocop/cop/lint/non_deterministic_require_order.rb +1 -1
- data/lib/rubocop/cop/lint/parentheses_as_grouped_expression.rb +5 -6
- data/lib/rubocop/cop/lint/percent_string_array.rb +0 -4
- data/lib/rubocop/cop/lint/percent_symbol_array.rb +0 -4
- data/lib/rubocop/cop/lint/rand_one.rb +0 -4
- data/lib/rubocop/cop/lint/redundant_cop_enable_directive.rb +3 -1
- data/lib/rubocop/cop/lint/redundant_safe_navigation.rb +14 -9
- data/lib/rubocop/cop/lint/redundant_splat_expansion.rb +1 -1
- data/lib/rubocop/cop/lint/redundant_string_coercion.rb +0 -4
- data/lib/rubocop/cop/lint/redundant_with_index.rb +4 -0
- data/lib/rubocop/cop/lint/require_parentheses.rb +0 -4
- data/lib/rubocop/cop/lint/rescue_exception.rb +0 -4
- data/lib/rubocop/cop/lint/rescue_type.rb +1 -3
- data/lib/rubocop/cop/lint/return_in_void_context.rb +0 -2
- data/lib/rubocop/cop/lint/safe_navigation_chain.rb +9 -4
- data/lib/rubocop/cop/lint/safe_navigation_consistency.rb +107 -41
- data/lib/rubocop/cop/lint/script_permission.rb +3 -3
- data/lib/rubocop/cop/lint/shadowed_argument.rb +1 -0
- data/lib/rubocop/cop/lint/shadowing_outer_local_variable.rb +6 -10
- data/lib/rubocop/cop/lint/symbol_conversion.rb +1 -1
- data/lib/rubocop/cop/lint/syntax.rb +6 -3
- data/lib/rubocop/cop/lint/to_enum_arguments.rb +1 -3
- data/lib/rubocop/cop/lint/unescaped_bracket_in_regexp.rb +88 -0
- data/lib/rubocop/cop/lint/unified_integer.rb +0 -4
- data/lib/rubocop/cop/lint/unmodified_reduce_accumulator.rb +1 -0
- data/lib/rubocop/cop/lint/unreachable_code.rb +4 -7
- data/lib/rubocop/cop/lint/unreachable_loop.rb +8 -2
- data/lib/rubocop/cop/lint/uri_regexp.rb +25 -7
- data/lib/rubocop/cop/lint/useless_assignment.rb +19 -16
- data/lib/rubocop/cop/lint/useless_else_without_rescue.rb +0 -4
- data/lib/rubocop/cop/lint/useless_numeric_operation.rb +77 -0
- data/lib/rubocop/cop/lint/useless_setter_call.rb +0 -4
- data/lib/rubocop/cop/lint/useless_times.rb +1 -1
- data/lib/rubocop/cop/lint/void.rb +41 -9
- data/lib/rubocop/cop/metrics/block_length.rb +6 -5
- data/lib/rubocop/cop/metrics/block_nesting.rb +19 -7
- data/lib/rubocop/cop/metrics/class_length.rb +6 -5
- data/lib/rubocop/cop/metrics/cyclomatic_complexity.rb +4 -1
- data/lib/rubocop/cop/metrics/method_length.rb +6 -5
- data/lib/rubocop/cop/metrics/module_length.rb +6 -5
- data/lib/rubocop/cop/metrics/utils/code_length_calculator.rb +5 -5
- data/lib/rubocop/cop/mixin/alignment.rb +5 -1
- data/lib/rubocop/cop/mixin/allowed_methods.rb +7 -1
- data/lib/rubocop/cop/mixin/allowed_pattern.rb +15 -3
- data/lib/rubocop/cop/mixin/annotation_comment.rb +0 -2
- data/lib/rubocop/cop/mixin/check_line_breakable.rb +10 -0
- data/lib/rubocop/cop/mixin/code_length.rb +12 -1
- data/lib/rubocop/cop/mixin/configurable_formatting.rb +1 -0
- data/lib/rubocop/cop/mixin/configurable_max.rb +5 -1
- data/lib/rubocop/cop/mixin/endless_method_rewriter.rb +24 -0
- data/lib/rubocop/cop/mixin/frozen_string_literal.rb +22 -10
- data/lib/rubocop/cop/mixin/hash_shorthand_syntax.rb +9 -2
- data/lib/rubocop/cop/mixin/line_length_help.rb +7 -2
- data/lib/rubocop/cop/mixin/method_complexity.rb +15 -6
- data/lib/rubocop/cop/mixin/multiline_expression_indentation.rb +1 -1
- data/lib/rubocop/cop/mixin/percent_array.rb +1 -1
- data/lib/rubocop/cop/mixin/rescue_node.rb +4 -0
- data/lib/rubocop/cop/mixin/safe_assignment.rb +1 -1
- data/lib/rubocop/cop/mixin/statement_modifier.rb +3 -2
- data/lib/rubocop/cop/mixin/string_literals_help.rb +12 -0
- data/lib/rubocop/cop/naming/accessor_method_name.rb +5 -0
- data/lib/rubocop/cop/naming/block_forwarding.rb +33 -6
- data/lib/rubocop/cop/naming/file_name.rb +2 -2
- data/lib/rubocop/cop/naming/inclusive_language.rb +13 -5
- data/lib/rubocop/cop/naming/predicate_name.rb +55 -29
- data/lib/rubocop/cop/naming/rescued_exceptions_variable_name.rb +10 -1
- data/lib/rubocop/cop/offense.rb +4 -5
- data/lib/rubocop/cop/registry.rb +1 -1
- data/lib/rubocop/cop/security/compound_hash.rb +2 -2
- data/lib/rubocop/cop/security/open.rb +2 -2
- data/lib/rubocop/cop/style/access_modifier_declarations.rb +62 -2
- data/lib/rubocop/cop/style/accessor_grouping.rb +10 -2
- data/lib/rubocop/cop/style/alias.rb +2 -1
- data/lib/rubocop/cop/style/ambiguous_endless_method_definition.rb +79 -0
- data/lib/rubocop/cop/style/arguments_forwarding.rb +141 -24
- data/lib/rubocop/cop/style/bitwise_predicate.rb +100 -0
- data/lib/rubocop/cop/style/block_delimiters.rb +31 -3
- data/lib/rubocop/cop/style/case_like_if.rb +1 -1
- data/lib/rubocop/cop/style/class_vars.rb +3 -3
- data/lib/rubocop/cop/style/collection_compact.rb +19 -10
- data/lib/rubocop/cop/style/combinable_defined.rb +115 -0
- data/lib/rubocop/cop/style/combinable_loops.rb +7 -0
- data/lib/rubocop/cop/style/commented_keyword.rb +12 -3
- data/lib/rubocop/cop/style/conditional_assignment.rb +7 -8
- data/lib/rubocop/cop/style/copyright.rb +31 -21
- data/lib/rubocop/cop/style/data_inheritance.rb +1 -1
- data/lib/rubocop/cop/style/def_with_parentheses.rb +0 -2
- data/lib/rubocop/cop/style/documentation.rb +24 -24
- data/lib/rubocop/cop/style/documentation_method.rb +20 -0
- data/lib/rubocop/cop/style/each_for_simple_loop.rb +7 -8
- data/lib/rubocop/cop/style/empty_else.rb +6 -5
- data/lib/rubocop/cop/style/empty_heredoc.rb +1 -14
- data/lib/rubocop/cop/style/empty_literal.rb +31 -22
- data/lib/rubocop/cop/style/endless_method.rb +1 -14
- data/lib/rubocop/cop/style/eval_with_location.rb +16 -24
- data/lib/rubocop/cop/style/exact_regexp_match.rb +2 -1
- data/lib/rubocop/cop/style/file_read.rb +2 -5
- data/lib/rubocop/cop/style/file_write.rb +2 -5
- data/lib/rubocop/cop/style/for.rb +2 -0
- data/lib/rubocop/cop/style/format_string.rb +9 -9
- data/lib/rubocop/cop/style/format_string_token.rb +2 -2
- data/lib/rubocop/cop/style/global_std_stream.rb +7 -1
- data/lib/rubocop/cop/style/guard_clause.rb +17 -2
- data/lib/rubocop/cop/style/hash_each_methods.rb +35 -8
- data/lib/rubocop/cop/style/hash_except.rb +8 -5
- data/lib/rubocop/cop/style/hash_syntax.rb +26 -4
- data/lib/rubocop/cop/style/identical_conditional_branches.rb +5 -2
- data/lib/rubocop/cop/style/if_inside_else.rb +1 -1
- data/lib/rubocop/cop/style/if_with_boolean_literal_branches.rb +5 -4
- data/lib/rubocop/cop/style/if_with_semicolon.rb +49 -6
- data/lib/rubocop/cop/style/in_pattern_then.rb +6 -2
- data/lib/rubocop/cop/style/inverse_methods.rb +8 -8
- data/lib/rubocop/cop/style/invertible_unless_condition.rb +46 -4
- data/lib/rubocop/cop/style/keyword_arguments_merging.rb +67 -0
- data/lib/rubocop/cop/style/lambda.rb +1 -1
- data/lib/rubocop/cop/style/magic_comment_format.rb +1 -1
- data/lib/rubocop/cop/style/map_compact_with_conditional_block.rb +81 -50
- data/lib/rubocop/cop/style/map_into_array.rb +233 -0
- data/lib/rubocop/cop/style/map_to_hash.rb +10 -6
- data/lib/rubocop/cop/style/map_to_set.rb +1 -1
- data/lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb +29 -11
- data/lib/rubocop/cop/style/method_call_with_args_parentheses.rb +2 -4
- data/lib/rubocop/cop/style/method_call_without_args_parentheses.rb +2 -2
- data/lib/rubocop/cop/style/missing_else.rb +0 -4
- data/lib/rubocop/cop/style/multiline_memoization.rb +1 -1
- data/lib/rubocop/cop/style/multiline_method_signature.rb +10 -1
- data/lib/rubocop/cop/style/multiline_ternary_operator.rb +5 -3
- data/lib/rubocop/cop/style/multiline_when_then.rb +0 -4
- data/lib/rubocop/cop/style/multiple_comparison.rb +28 -47
- data/lib/rubocop/cop/style/nested_modifier.rb +1 -1
- data/lib/rubocop/cop/style/nested_parenthesized_calls.rb +1 -1
- data/lib/rubocop/cop/style/nil_comparison.rb +2 -0
- data/lib/rubocop/cop/style/numeric_literal_prefix.rb +1 -1
- data/lib/rubocop/cop/style/numeric_predicate.rb +12 -4
- data/lib/rubocop/cop/style/object_then.rb +5 -3
- data/lib/rubocop/cop/style/one_line_conditional.rb +6 -2
- data/lib/rubocop/cop/style/operator_method_call.rb +25 -6
- data/lib/rubocop/cop/style/parallel_assignment.rb +8 -9
- data/lib/rubocop/cop/style/parentheses_around_condition.rb +8 -0
- data/lib/rubocop/cop/style/quoted_symbols.rb +1 -3
- data/lib/rubocop/cop/style/raise_args.rb +4 -1
- data/lib/rubocop/cop/style/redundant_argument.rb +25 -2
- data/lib/rubocop/cop/style/redundant_assignment.rb +10 -2
- data/lib/rubocop/cop/style/redundant_begin.rb +5 -1
- data/lib/rubocop/cop/style/redundant_condition.rb +4 -4
- data/lib/rubocop/cop/style/redundant_current_directory_in_path.rb +5 -4
- data/lib/rubocop/cop/style/redundant_each.rb +7 -4
- data/lib/rubocop/cop/style/redundant_file_extension_in_require.rb +1 -1
- data/lib/rubocop/cop/style/redundant_filter_chain.rb +1 -1
- data/lib/rubocop/cop/style/redundant_interpolation_unfreeze.rb +46 -0
- data/lib/rubocop/cop/style/redundant_line_continuation.rb +40 -7
- data/lib/rubocop/cop/style/redundant_parentheses.rb +27 -13
- data/lib/rubocop/cop/style/redundant_percent_q.rb +1 -1
- data/lib/rubocop/cop/style/redundant_regexp_argument.rb +4 -1
- data/lib/rubocop/cop/style/redundant_regexp_escape.rb +8 -24
- data/lib/rubocop/cop/style/redundant_return.rb +6 -0
- data/lib/rubocop/cop/style/require_order.rb +2 -2
- data/lib/rubocop/cop/style/rescue_modifier.rb +13 -1
- data/lib/rubocop/cop/style/return_nil_in_predicate_method_definition.rb +54 -12
- data/lib/rubocop/cop/style/safe_navigation.rb +106 -52
- data/lib/rubocop/cop/style/safe_navigation_chain_length.rb +52 -0
- data/lib/rubocop/cop/style/sample.rb +1 -3
- data/lib/rubocop/cop/style/select_by_regexp.rb +9 -6
- data/lib/rubocop/cop/style/semicolon.rb +1 -1
- data/lib/rubocop/cop/style/send.rb +4 -4
- data/lib/rubocop/cop/style/send_with_literal_method_name.rb +104 -0
- data/lib/rubocop/cop/style/slicing_with_range.rb +76 -10
- data/lib/rubocop/cop/style/sole_nested_conditional.rb +21 -2
- data/lib/rubocop/cop/style/special_global_vars.rb +1 -2
- data/lib/rubocop/cop/style/struct_inheritance.rb +1 -1
- data/lib/rubocop/cop/style/super_arguments.rb +174 -0
- data/lib/rubocop/cop/style/symbol_proc.rb +75 -5
- data/lib/rubocop/cop/style/ternary_parentheses.rb +26 -5
- data/lib/rubocop/cop/style/top_level_method_definition.rb +1 -1
- data/lib/rubocop/cop/style/trivial_accessors.rb +1 -1
- data/lib/rubocop/cop/style/while_until_do.rb +0 -2
- data/lib/rubocop/cop/style/while_until_modifier.rb +0 -1
- data/lib/rubocop/cop/style/zero_length_predicate.rb +32 -24
- data/lib/rubocop/cop/team.rb +27 -3
- data/lib/rubocop/cop/util.rb +8 -2
- data/lib/rubocop/cop/utils/regexp_ranges.rb +1 -1
- data/lib/rubocop/cop/variable_force/assignment.rb +18 -3
- data/lib/rubocop/cop/variable_force/branch.rb +1 -1
- data/lib/rubocop/cop/variable_force/variable.rb +5 -1
- data/lib/rubocop/cop/variable_force/variable_table.rb +2 -2
- data/lib/rubocop/cop/variable_force.rb +13 -1
- data/lib/rubocop/cops_documentation_generator.rb +96 -43
- data/lib/rubocop/core_ext/string.rb +2 -6
- data/lib/rubocop/directive_comment.rb +10 -8
- data/lib/rubocop/ext/regexp_node.rb +18 -35
- data/lib/rubocop/ext/regexp_parser.rb +4 -21
- data/lib/rubocop/file_finder.rb +9 -4
- data/lib/rubocop/formatter/clang_style_formatter.rb +3 -7
- data/lib/rubocop/formatter/disabled_config_formatter.rb +24 -9
- data/lib/rubocop/formatter/formatter_set.rb +7 -1
- data/lib/rubocop/formatter/html_formatter.rb +32 -10
- data/lib/rubocop/formatter/json_formatter.rb +0 -1
- data/lib/rubocop/formatter/junit_formatter.rb +70 -23
- data/lib/rubocop/formatter/offense_count_formatter.rb +12 -2
- data/lib/rubocop/formatter/tap_formatter.rb +3 -7
- data/lib/rubocop/formatter.rb +1 -1
- data/lib/rubocop/lockfile.rb +58 -7
- data/lib/rubocop/lsp/logger.rb +1 -1
- data/lib/rubocop/lsp/routes.rb +12 -15
- data/lib/rubocop/lsp/runtime.rb +3 -1
- data/lib/rubocop/lsp/server.rb +6 -2
- data/lib/rubocop/lsp/severity.rb +1 -1
- data/lib/rubocop/lsp.rb +36 -0
- data/lib/rubocop/magic_comment.rb +1 -1
- data/lib/rubocop/options.rb +17 -12
- data/lib/rubocop/path_util.rb +6 -2
- data/lib/rubocop/rake_task.rb +1 -1
- data/lib/rubocop/remote_config.rb +5 -1
- data/lib/rubocop/result_cache.rb +2 -8
- data/lib/rubocop/rspec/cop_helper.rb +8 -2
- data/lib/rubocop/rspec/expect_offense.rb +17 -8
- data/lib/rubocop/rspec/shared_contexts.rb +75 -18
- data/lib/rubocop/rspec/support.rb +3 -0
- data/lib/rubocop/runner.rb +31 -9
- data/lib/rubocop/server/cache.rb +16 -2
- data/lib/rubocop/server/client_command/exec.rb +2 -3
- data/lib/rubocop/server/client_command/start.rb +1 -1
- data/lib/rubocop/server/core.rb +5 -0
- data/lib/rubocop/server/server_command/exec.rb +0 -1
- data/lib/rubocop/target_finder.rb +84 -78
- data/lib/rubocop/target_ruby.rb +87 -81
- data/lib/rubocop/version.rb +45 -9
- data/lib/rubocop/yaml_duplication_checker.rb +20 -26
- data/lib/rubocop.rb +21 -1
- metadata +33 -35
- /data/lib/rubocop/formatter/{git_hub_actions_formatter.rb → github_actions_formatter.rb} +0 -0
@@ -1,17 +1,17 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
|
3
|
-
require_relative '../../lsp/server'
|
4
|
-
|
5
3
|
module RuboCop
|
6
4
|
class CLI
|
7
5
|
module Command
|
8
6
|
# Start Language Server Protocol of RuboCop.
|
9
7
|
# @api private
|
10
|
-
class
|
8
|
+
class LSP < Base
|
11
9
|
self.command_name = :lsp
|
12
10
|
|
13
11
|
def run
|
14
|
-
|
12
|
+
# Load on demand, `languge-server-protocol` is heavy to require.
|
13
|
+
require_relative '../../lsp/server'
|
14
|
+
RuboCop::LSP::Server.new(@config_store).start
|
15
15
|
end
|
16
16
|
end
|
17
17
|
end
|
@@ -26,10 +26,10 @@ module RuboCop
|
|
26
26
|
|
27
27
|
cops_array.each do |cop_name|
|
28
28
|
cop = registry_hash[cop_name]
|
29
|
-
|
30
29
|
next if cop.empty?
|
31
30
|
|
32
|
-
|
31
|
+
url = Cop::Documentation.url_for(cop.first, @config)
|
32
|
+
puts url if url
|
33
33
|
end
|
34
34
|
|
35
35
|
puts
|
@@ -9,8 +9,8 @@ module RuboCop
|
|
9
9
|
self.command_name = :version
|
10
10
|
|
11
11
|
def run
|
12
|
-
puts RuboCop::Version
|
13
|
-
puts RuboCop::Version.
|
12
|
+
puts RuboCop::Version::STRING if @options[:version]
|
13
|
+
puts RuboCop::Version.verbose(env: env) if @options[:verbose_version]
|
14
14
|
end
|
15
15
|
end
|
16
16
|
end
|
data/lib/rubocop/cli.rb
CHANGED
@@ -12,7 +12,7 @@ module RuboCop
|
|
12
12
|
STATUS_INTERRUPTED = Signal.list['INT'] + 128
|
13
13
|
DEFAULT_PARALLEL_OPTIONS = %i[
|
14
14
|
color config debug display_style_guide display_time display_only_fail_level_offenses
|
15
|
-
display_only_failed except extra_details fail_level fix_layout format
|
15
|
+
display_only_failed editor_mode except extra_details fail_level fix_layout format
|
16
16
|
ignore_disable_comments lint only only_guide_cops require safe
|
17
17
|
autocorrect safe_autocorrect autocorrect_all
|
18
18
|
].freeze
|
@@ -57,6 +57,10 @@ module RuboCop
|
|
57
57
|
rescue RuboCop::Error => e
|
58
58
|
warn Rainbow("Error: #{e.message}").red
|
59
59
|
STATUS_ERROR
|
60
|
+
rescue Interrupt
|
61
|
+
warn ''
|
62
|
+
warn 'Exiting...'
|
63
|
+
STATUS_INTERRUPTED
|
60
64
|
rescue Finished
|
61
65
|
STATUS_SUCCESS
|
62
66
|
rescue OptionParser::InvalidOption => e
|
@@ -151,6 +155,7 @@ module RuboCop
|
|
151
155
|
|
152
156
|
def act_on_options
|
153
157
|
set_options_to_config_loader
|
158
|
+
handle_editor_mode
|
154
159
|
|
155
160
|
@config_store.options_config = @options[:config] if @options[:config]
|
156
161
|
@config_store.force_default_config! if @options[:force_default_config]
|
@@ -174,6 +179,10 @@ module RuboCop
|
|
174
179
|
ConfigLoader.ignore_unrecognized_cops = @options[:ignore_unrecognized_cops]
|
175
180
|
end
|
176
181
|
|
182
|
+
def handle_editor_mode
|
183
|
+
RuboCop::LSP.enable if @options[:editor_mode]
|
184
|
+
end
|
185
|
+
|
177
186
|
# rubocop:disable Metrics/CyclomaticComplexity
|
178
187
|
def handle_exiting_options
|
179
188
|
return unless Options::EXITING_OPTIONS.any? { |o| @options.key? o }
|
@@ -4,7 +4,7 @@ module RuboCop
|
|
4
4
|
# This class parses the special `rubocop:disable` comments in a source
|
5
5
|
# and provides a way to check if each cop is enabled at arbitrary line.
|
6
6
|
class CommentConfig
|
7
|
-
extend
|
7
|
+
extend SimpleForwardable
|
8
8
|
|
9
9
|
CONFIG_DISABLED_LINE_RANGE_MIN = -Float::INFINITY
|
10
10
|
|
data/lib/rubocop/config.rb
CHANGED
@@ -1,7 +1,5 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
|
3
|
-
require 'pathname'
|
4
|
-
|
5
3
|
# FIXME: Moving Rails department code to RuboCop Rails will remove
|
6
4
|
# the following rubocop:disable comment.
|
7
5
|
# rubocop:disable Metrics/ClassLength
|
@@ -14,7 +12,7 @@ module RuboCop
|
|
14
12
|
class Config
|
15
13
|
include PathUtil
|
16
14
|
include FileFinder
|
17
|
-
extend
|
15
|
+
extend SimpleForwardable
|
18
16
|
|
19
17
|
CopConfig = Struct.new(:name, :metadata)
|
20
18
|
|
@@ -173,6 +171,10 @@ module RuboCop
|
|
173
171
|
for_all_cops['ActiveSupportExtensionsEnabled']
|
174
172
|
end
|
175
173
|
|
174
|
+
def string_literals_frozen_by_default?
|
175
|
+
for_all_cops['StringLiteralsFrozenByDefault']
|
176
|
+
end
|
177
|
+
|
176
178
|
def file_to_include?(file)
|
177
179
|
relative_file_path = path_relative_to_config(file)
|
178
180
|
|
@@ -246,6 +248,10 @@ module RuboCop
|
|
246
248
|
end
|
247
249
|
end
|
248
250
|
|
251
|
+
def parser_engine
|
252
|
+
@parser_engine ||= for_all_cops.fetch('ParserEngine', :parser_whitequark).to_sym
|
253
|
+
end
|
254
|
+
|
249
255
|
def target_rails_version
|
250
256
|
@target_rails_version ||=
|
251
257
|
if for_all_cops['TargetRailsVersion']
|
@@ -261,6 +267,7 @@ module RuboCop
|
|
261
267
|
PathUtil.smart_path(@loaded_path)
|
262
268
|
end
|
263
269
|
|
270
|
+
# @return [String, nil]
|
264
271
|
def bundler_lock_file_path
|
265
272
|
return nil unless loaded_path
|
266
273
|
|
@@ -284,27 +291,48 @@ module RuboCop
|
|
284
291
|
end
|
285
292
|
end
|
286
293
|
|
294
|
+
# Returns target's locked gem versions (i.e. from Gemfile.lock or gems.locked)
|
295
|
+
# @returns [Hash{String => Gem::Version}] The locked gem versions, keyed by the gems' names.
|
296
|
+
def gem_versions_in_target
|
297
|
+
@gem_versions_in_target ||= read_gem_versions_from_target_lockfile
|
298
|
+
end
|
299
|
+
|
287
300
|
def inspect # :nodoc:
|
288
301
|
"#<#{self.class.name}:#{object_id} @loaded_path=#{loaded_path}>"
|
289
302
|
end
|
290
303
|
|
291
304
|
private
|
292
305
|
|
306
|
+
# @return [Float, nil] The Rails version as a `major.minor` Float.
|
293
307
|
def target_rails_version_from_bundler_lock_file
|
294
308
|
@target_rails_version_from_bundler_lock_file ||= read_rails_version_from_bundler_lock_file
|
295
309
|
end
|
296
310
|
|
311
|
+
# @return [Float, nil] The Rails version as a `major.minor` Float.
|
297
312
|
def read_rails_version_from_bundler_lock_file
|
298
|
-
|
299
|
-
|
300
|
-
|
301
|
-
|
302
|
-
|
303
|
-
|
304
|
-
|
305
|
-
|
306
|
-
|
307
|
-
|
313
|
+
return nil unless gem_versions_in_target
|
314
|
+
|
315
|
+
# Look for `railties` instead of `rails`, to support apps that only use a subset of `rails`
|
316
|
+
# See https://github.com/rubocop/rubocop/pull/11289
|
317
|
+
rails_version_in_target = gem_versions_in_target['railties']
|
318
|
+
return nil unless rails_version_in_target
|
319
|
+
|
320
|
+
gem_version_to_major_minor_float(rails_version_in_target)
|
321
|
+
end
|
322
|
+
|
323
|
+
# @param [Gem::Version] gem_version an object like `Gem::Version.new("7.1.2.3")`
|
324
|
+
# @return [Float] The major and minor version, like `7.1`
|
325
|
+
def gem_version_to_major_minor_float(gem_version)
|
326
|
+
segments = gem_version.segments
|
327
|
+
Float("#{segments[0]}.#{segments[1]}")
|
328
|
+
end
|
329
|
+
|
330
|
+
# @returns [Hash{String => Gem::Version}] The locked gem versions, keyed by the gems' names.
|
331
|
+
def read_gem_versions_from_target_lockfile
|
332
|
+
lockfile_path = bundler_lock_file_path
|
333
|
+
return nil unless lockfile_path
|
334
|
+
|
335
|
+
Lockfile.new(lockfile_path).gem_versions
|
308
336
|
end
|
309
337
|
|
310
338
|
def enable_cop?(qualified_cop_name, cop_options)
|
@@ -17,8 +17,8 @@ module RuboCop
|
|
17
17
|
attr_writer :project_root
|
18
18
|
|
19
19
|
def find_config_path(target_dir)
|
20
|
-
find_project_dotfile(target_dir) ||
|
21
|
-
DEFAULT_FILE
|
20
|
+
find_project_dotfile(target_dir) || find_project_root_dot_config ||
|
21
|
+
find_user_dotfile || find_user_xdg_config || DEFAULT_FILE
|
22
22
|
end
|
23
23
|
|
24
24
|
# Returns the path RuboCop inferred as the root of the project. No file
|
@@ -41,6 +41,16 @@ module RuboCop
|
|
41
41
|
find_file_upwards(DOTFILE, target_dir, project_root)
|
42
42
|
end
|
43
43
|
|
44
|
+
def find_project_root_dot_config
|
45
|
+
return unless project_root
|
46
|
+
|
47
|
+
dotfile = File.join(project_root, '.config', DOTFILE)
|
48
|
+
return dotfile if File.exist?(dotfile)
|
49
|
+
|
50
|
+
xdg_config = File.join(project_root, '.config', 'rubocop', XDG_CONFIG)
|
51
|
+
xdg_config if File.exist?(xdg_config)
|
52
|
+
end
|
53
|
+
|
44
54
|
def find_user_dotfile
|
45
55
|
return unless ENV.key?('HOME')
|
46
56
|
|
@@ -1,7 +1,6 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
|
3
3
|
require 'erb'
|
4
|
-
require 'pathname'
|
5
4
|
require 'yaml'
|
6
5
|
require_relative 'config_finder'
|
7
6
|
|
@@ -68,8 +67,8 @@ module RuboCop
|
|
68
67
|
def load_yaml_configuration(absolute_path)
|
69
68
|
file_contents = read_file(absolute_path)
|
70
69
|
yaml_code = Dir.chdir(File.dirname(absolute_path)) { ERB.new(file_contents).result }
|
71
|
-
check_duplication(yaml_code, absolute_path)
|
72
|
-
hash =
|
70
|
+
yaml_tree = check_duplication(yaml_code, absolute_path)
|
71
|
+
hash = yaml_tree_to_hash(yaml_tree) || {}
|
73
72
|
|
74
73
|
puts "configuration from #{absolute_path}" if debug?
|
75
74
|
|
@@ -165,7 +164,7 @@ module RuboCop
|
|
165
164
|
# searches will go past this directory.
|
166
165
|
# @deprecated Use `RuboCop::ConfigFinder.project_root` instead.
|
167
166
|
def project_root
|
168
|
-
warn Rainbow(<<~WARNING).yellow
|
167
|
+
warn Rainbow(<<~WARNING).yellow, uplevel: 1
|
169
168
|
`RuboCop::ConfigLoader.project_root` is deprecated and will be removed in RuboCop 2.0. \
|
170
169
|
Use `RuboCop::ConfigFinder.project_root` instead.
|
171
170
|
WARNING
|
@@ -236,8 +235,8 @@ module RuboCop
|
|
236
235
|
raise ConfigNotFoundError, "Configuration file not found: #{absolute_path}"
|
237
236
|
end
|
238
237
|
|
239
|
-
def
|
240
|
-
|
238
|
+
def yaml_tree_to_hash(yaml_tree)
|
239
|
+
yaml_tree_to_hash!(yaml_tree)
|
241
240
|
rescue ::StandardError
|
242
241
|
if defined?(::SafeYAML)
|
243
242
|
raise 'SafeYAML is unmaintained, no longer needed and should be removed'
|
@@ -246,10 +245,16 @@ module RuboCop
|
|
246
245
|
raise
|
247
246
|
end
|
248
247
|
|
249
|
-
def
|
250
|
-
|
251
|
-
|
252
|
-
|
248
|
+
def yaml_tree_to_hash!(yaml_tree)
|
249
|
+
return nil unless yaml_tree
|
250
|
+
|
251
|
+
# Optimization: Because we checked for duplicate keys, we already have the
|
252
|
+
# yaml tree and don't need to parse it again.
|
253
|
+
# Also see https://github.com/ruby/psych/blob/v5.1.2/lib/psych.rb#L322-L336
|
254
|
+
class_loader = YAML::ClassLoader::Restricted.new(%w[Regexp Symbol], [])
|
255
|
+
scanner = YAML::ScalarScanner.new(class_loader)
|
256
|
+
visitor = YAML::Visitors::ToRuby.new(scanner, class_loader)
|
257
|
+
visitor.accept(yaml_tree)
|
253
258
|
end
|
254
259
|
end
|
255
260
|
|
@@ -6,7 +6,7 @@ require 'yaml'
|
|
6
6
|
module RuboCop
|
7
7
|
# A help class for ConfigLoader that handles configuration resolution.
|
8
8
|
# @api private
|
9
|
-
class ConfigLoaderResolver
|
9
|
+
class ConfigLoaderResolver # rubocop:disable Metrics/ClassLength
|
10
10
|
def resolve_requires(path, hash)
|
11
11
|
config_dir = File.dirname(path)
|
12
12
|
hash.delete('require').tap do |loaded_features|
|
@@ -166,7 +166,7 @@ module RuboCop
|
|
166
166
|
return unless duplicate_setting?(base_hash, derived_hash, key, opts[:inherited_file])
|
167
167
|
|
168
168
|
inherit_mode = opts[:inherit_mode]['merge'] || opts[:inherit_mode]['override']
|
169
|
-
return if base_hash[key].is_a?(Array) && inherit_mode
|
169
|
+
return if base_hash[key].is_a?(Array) && inherit_mode&.include?(key)
|
170
170
|
|
171
171
|
puts "#{PathUtil.smart_path(opts[:file])}: " \
|
172
172
|
"#{opts[:cop_name]}:#{key} overrides " \
|
@@ -194,11 +194,11 @@ module RuboCop
|
|
194
194
|
end
|
195
195
|
|
196
196
|
def should_merge?(mode, key)
|
197
|
-
mode && mode['merge']
|
197
|
+
mode && mode['merge']&.include?(key)
|
198
198
|
end
|
199
199
|
|
200
200
|
def should_override?(mode, key)
|
201
|
-
mode && mode['override']
|
201
|
+
mode && mode['override']&.include?(key)
|
202
202
|
end
|
203
203
|
|
204
204
|
def merge_hashes?(base_hash, derived_hash, key)
|
@@ -239,8 +239,7 @@ module RuboCop
|
|
239
239
|
end
|
240
240
|
|
241
241
|
def remote_file?(uri)
|
242
|
-
|
243
|
-
/\A#{regex}\z/.match?(uri)
|
242
|
+
uri.start_with?('http://', 'https://')
|
244
243
|
end
|
245
244
|
|
246
245
|
def handle_disabled_by_default(config, new_default_configuration)
|
@@ -267,8 +266,14 @@ module RuboCop
|
|
267
266
|
|
268
267
|
def gem_config_path(gem_name, relative_config_path)
|
269
268
|
if defined?(Bundler)
|
270
|
-
|
271
|
-
|
269
|
+
begin
|
270
|
+
gem = Bundler.load.specs[gem_name].first
|
271
|
+
gem_path = gem.full_gem_path if gem
|
272
|
+
rescue Bundler::GemfileNotFound
|
273
|
+
# No Gemfile found. Bundler may be loaded manually
|
274
|
+
rescue Bundler::GitError
|
275
|
+
# The Gemfile exists but contains an uninstalled git source
|
276
|
+
end
|
272
277
|
end
|
273
278
|
|
274
279
|
gem_path ||= Gem::Specification.find_by_name(gem_name).gem_dir
|
@@ -52,7 +52,7 @@ module RuboCop
|
|
52
52
|
def load_rules # rubocop:disable Metrics/AbcSize
|
53
53
|
rules = LOAD_RULES_CACHE[self.class.files] ||=
|
54
54
|
self.class.files.each_with_object({}) do |filename, hash|
|
55
|
-
hash.merge!(YAML.safe_load(File.read(filename))) do |_key, first, second|
|
55
|
+
hash.merge!(YAML.safe_load(File.read(filename)) || {}) do |_key, first, second|
|
56
56
|
case first
|
57
57
|
when Hash
|
58
58
|
first.merge(second)
|
@@ -1,15 +1,14 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
|
3
|
-
require 'pathname'
|
4
|
-
|
5
3
|
module RuboCop
|
6
4
|
# Handles validation of configuration, for example cop names, parameter
|
7
5
|
# names, and Ruby versions.
|
8
6
|
class ConfigValidator
|
9
|
-
extend
|
7
|
+
extend SimpleForwardable
|
10
8
|
|
11
9
|
# @api private
|
12
|
-
COMMON_PARAMS = %w[Exclude Include Severity inherit_mode AutoCorrect StyleGuide Details
|
10
|
+
COMMON_PARAMS = %w[Exclude Include Severity inherit_mode AutoCorrect StyleGuide Details
|
11
|
+
Enabled].freeze
|
13
12
|
# @api private
|
14
13
|
INTERNAL_PARAMS = %w[Description StyleGuide
|
15
14
|
VersionAdded VersionChanged VersionRemoved
|
@@ -20,6 +19,7 @@ module RuboCop
|
|
20
19
|
# @api private
|
21
20
|
CONFIG_CHECK_KEYS = %w[Enabled Safe SafeAutoCorrect AutoCorrect].to_set.freeze
|
22
21
|
CONFIG_CHECK_DEPARTMENTS = %w[pending override_department].freeze
|
22
|
+
CONFIG_CHECK_AUTOCORRECTS = %w[always contextual disabled].freeze
|
23
23
|
private_constant :CONFIG_CHECK_KEYS, :CONFIG_CHECK_DEPARTMENTS
|
24
24
|
|
25
25
|
def_delegators :@config, :smart_loaded_path, :for_all_cops
|
@@ -250,23 +250,31 @@ module RuboCop
|
|
250
250
|
end
|
251
251
|
end
|
252
252
|
|
253
|
+
# rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
|
253
254
|
def check_cop_config_value(hash, parent = nil)
|
254
255
|
hash.each do |key, value|
|
255
256
|
check_cop_config_value(value, key) if value.is_a?(Hash)
|
256
257
|
|
257
258
|
next unless CONFIG_CHECK_KEYS.include?(key) && value.is_a?(String)
|
258
259
|
|
259
|
-
|
260
|
+
if key == 'Enabled' && !CONFIG_CHECK_DEPARTMENTS.include?(value)
|
261
|
+
supposed_values = 'a boolean'
|
262
|
+
elsif key == 'AutoCorrect' && !CONFIG_CHECK_AUTOCORRECTS.include?(value)
|
263
|
+
supposed_values = '`always`, `contextual`, `disabled`, or a boolean'
|
264
|
+
else
|
265
|
+
next
|
266
|
+
end
|
260
267
|
|
261
|
-
raise ValidationError,
|
268
|
+
raise ValidationError, param_error_message(parent, key, value, supposed_values)
|
262
269
|
end
|
263
270
|
end
|
271
|
+
# rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
|
264
272
|
|
265
273
|
# FIXME: Handling colors in exception messages like this is ugly.
|
266
|
-
def
|
274
|
+
def param_error_message(parent, key, value, supposed_values)
|
267
275
|
"#{Rainbow('').reset}" \
|
268
|
-
"Property #{Rainbow(key).yellow} of
|
269
|
-
"is supposed to be
|
276
|
+
"Property #{Rainbow(key).yellow} of #{Rainbow(parent).yellow} cop " \
|
277
|
+
"is supposed to be #{supposed_values} and #{Rainbow(value).yellow} is not."
|
270
278
|
end
|
271
279
|
end
|
272
280
|
end
|
@@ -32,7 +32,12 @@ module RuboCop
|
|
32
32
|
# allow turning off autocorrect on a cop by cop basis
|
33
33
|
return true unless cop_config
|
34
34
|
|
35
|
-
|
35
|
+
# `false` is the same as `disabled` for backward compatibility.
|
36
|
+
return false if ['disabled', false].include?(cop_config['AutoCorrect'])
|
37
|
+
|
38
|
+
# When LSP is enabled, it is considered as editing source code,
|
39
|
+
# and autocorrection with `AutoCorrect: contextual` will not be performed.
|
40
|
+
return false if contextual_autocorrect? && LSP.enabled?
|
36
41
|
|
37
42
|
# :safe_autocorrect is a derived option based on several command-line
|
38
43
|
# arguments - see RuboCop::Options#add_autocorrection_options
|
@@ -44,7 +49,9 @@ module RuboCop
|
|
44
49
|
private
|
45
50
|
|
46
51
|
def disable_offense(offense_range)
|
47
|
-
range = surrounding_heredoc(offense_range) ||
|
52
|
+
range = surrounding_heredoc(offense_range) ||
|
53
|
+
surrounding_percent_array(offense_range) ||
|
54
|
+
string_continuation(offense_range)
|
48
55
|
|
49
56
|
if range
|
50
57
|
disable_offense_before_and_after(range_by_lines(range))
|
@@ -83,8 +90,26 @@ module RuboCop
|
|
83
90
|
end
|
84
91
|
|
85
92
|
percent_array.map(&:source_range).find do |range|
|
86
|
-
offense_range
|
93
|
+
range_overlaps_offense?(offense_range, range)
|
94
|
+
end
|
95
|
+
end
|
96
|
+
|
97
|
+
def string_continuation(offense_range)
|
98
|
+
return nil if offense_range.empty?
|
99
|
+
|
100
|
+
string_continuation_nodes = processed_source.ast.each_descendant.filter_map do |node|
|
101
|
+
range_by_lines(node.source_range) if string_continuation?(node)
|
87
102
|
end
|
103
|
+
|
104
|
+
string_continuation_nodes.find { |range| range_overlaps_offense?(offense_range, range) }
|
105
|
+
end
|
106
|
+
|
107
|
+
def range_overlaps_offense?(offense_range, range)
|
108
|
+
offense_range.begin_pos > range.begin_pos && range.overlaps?(offense_range)
|
109
|
+
end
|
110
|
+
|
111
|
+
def string_continuation?(node)
|
112
|
+
(node.str_type? || node.dstr_type? || node.xstr_type?) && node.source.match?(/\\\s*$/)
|
88
113
|
end
|
89
114
|
|
90
115
|
def range_of_first_line(range)
|
data/lib/rubocop/cop/base.rb
CHANGED
@@ -60,16 +60,20 @@ module RuboCop
|
|
60
60
|
[]
|
61
61
|
end
|
62
62
|
|
63
|
-
#
|
63
|
+
# Returns an url to view this cops documentation online.
|
64
|
+
# Requires 'DocumentationBaseURL' to be set for your department.
|
65
|
+
# Will follow the convention of RuboCops own documentation structure,
|
66
|
+
# overwrite this method to accommodate your custom layout.
|
64
67
|
# @return [String, nil]
|
65
68
|
#
|
66
69
|
# @api public
|
67
|
-
def self.documentation_url
|
68
|
-
Documentation.url_for(self)
|
70
|
+
def self.documentation_url(config = nil)
|
71
|
+
Documentation.url_for(self, config)
|
69
72
|
end
|
70
73
|
|
71
74
|
def self.inherited(subclass)
|
72
75
|
super
|
76
|
+
subclass.instance_variable_set(:@gem_requirements, gem_requirements.dup)
|
73
77
|
Registry.global.enlist(subclass)
|
74
78
|
end
|
75
79
|
|
@@ -126,6 +130,29 @@ module RuboCop
|
|
126
130
|
false
|
127
131
|
end
|
128
132
|
|
133
|
+
## Gem requirements
|
134
|
+
|
135
|
+
@gem_requirements = {}
|
136
|
+
|
137
|
+
class << self
|
138
|
+
attr_reader :gem_requirements
|
139
|
+
|
140
|
+
# Register a version requirement for the given gem name.
|
141
|
+
# This cop will be skipped unless the target satisfies *all* requirements.
|
142
|
+
# @param [String] gem_name
|
143
|
+
# @param [Array<String>] version_requirements The version requirements,
|
144
|
+
# using the same syntax as a Gemfile, e.g. ">= 1.2.3"
|
145
|
+
#
|
146
|
+
# If omitted, any version of the gem will be accepted.
|
147
|
+
#
|
148
|
+
# https://guides.rubygems.org/patterns/#declaring-dependencies
|
149
|
+
#
|
150
|
+
# @api public
|
151
|
+
def requires_gem(gem_name, *version_requirements)
|
152
|
+
@gem_requirements[gem_name] = Gem::Requirement.new(version_requirements)
|
153
|
+
end
|
154
|
+
end
|
155
|
+
|
129
156
|
def initialize(config = nil, options = nil)
|
130
157
|
@config = config || Config.new
|
131
158
|
@options = options || { debug: false }
|
@@ -162,7 +189,9 @@ module RuboCop
|
|
162
189
|
def add_global_offense(message = nil, severity: nil)
|
163
190
|
severity = find_severity(nil, severity)
|
164
191
|
message = find_message(nil, message)
|
165
|
-
|
192
|
+
range = Offense::NO_LOCATION
|
193
|
+
status = enabled_line?(range.line) ? :unsupported : :disabled
|
194
|
+
current_offenses << Offense.new(severity, range, message, name, status)
|
166
195
|
end
|
167
196
|
|
168
197
|
# Adds an offense on the specified range (or node with an expression)
|
@@ -232,6 +261,10 @@ module RuboCop
|
|
232
261
|
@config.target_ruby_version
|
233
262
|
end
|
234
263
|
|
264
|
+
def parser_engine
|
265
|
+
@config.parser_engine
|
266
|
+
end
|
267
|
+
|
235
268
|
def target_rails_version
|
236
269
|
@config.target_rails_version
|
237
270
|
end
|
@@ -240,7 +273,12 @@ module RuboCop
|
|
240
273
|
@config.active_support_extensions_enabled?
|
241
274
|
end
|
242
275
|
|
276
|
+
def string_literals_frozen_by_default?
|
277
|
+
@config.string_literals_frozen_by_default?
|
278
|
+
end
|
279
|
+
|
243
280
|
def relevant_file?(file)
|
281
|
+
return false unless target_satisfies_all_gem_version_requirements?
|
244
282
|
return true unless @config.clusivity_config_for_badge?(self.class.badge)
|
245
283
|
|
246
284
|
file == RuboCop::AST::ProcessedSource::STRING_SOURCE_NAME ||
|
@@ -254,7 +292,7 @@ module RuboCop
|
|
254
292
|
|
255
293
|
# There should be very limited reasons for a Cop to do it's own parsing
|
256
294
|
def parse(source, path = nil)
|
257
|
-
ProcessedSource.new(source, target_ruby_version, path)
|
295
|
+
ProcessedSource.new(source, target_ruby_version, path, parser_engine: parser_engine)
|
258
296
|
end
|
259
297
|
|
260
298
|
# @api private
|
@@ -284,8 +322,12 @@ module RuboCop
|
|
284
322
|
# @api private
|
285
323
|
def self.callbacks_needed
|
286
324
|
@callbacks_needed ||= public_instance_methods.select do |m|
|
287
|
-
|
288
|
-
|
325
|
+
# OPTIMIZE: Check method existence first to make fewer `start_with?` calls.
|
326
|
+
# At the time of writing this comment, this excludes 98 of ~104 methods.
|
327
|
+
# `start_with?` with two string arguments instead of a regex is faster
|
328
|
+
# in this specific case as well.
|
329
|
+
!Base.method_defined?(m) && # exclude standard "callbacks" like 'on_begin_investigation'
|
330
|
+
m.start_with?('on_', 'after_')
|
289
331
|
end
|
290
332
|
end
|
291
333
|
# rubocop:enable Layout/ClassStructure
|
@@ -305,6 +347,17 @@ module RuboCop
|
|
305
347
|
@current_original = original
|
306
348
|
end
|
307
349
|
|
350
|
+
# @api private
|
351
|
+
def always_autocorrect?
|
352
|
+
# `true` is the same as `'always'` for backward compatibility.
|
353
|
+
['always', true].include?(cop_config.fetch('AutoCorrect', 'always'))
|
354
|
+
end
|
355
|
+
|
356
|
+
# @api private
|
357
|
+
def contextual_autocorrect?
|
358
|
+
cop_config.fetch('AutoCorrect', 'always') == 'contextual'
|
359
|
+
end
|
360
|
+
|
308
361
|
def inspect # :nodoc:
|
309
362
|
"#<#{self.class.name}:#{object_id} @config=#{@config} @options=#{@options}>"
|
310
363
|
end
|
@@ -356,16 +409,6 @@ module RuboCop
|
|
356
409
|
|
357
410
|
### Actually private methods
|
358
411
|
|
359
|
-
# rubocop:disable Layout/ClassStructure
|
360
|
-
def self.builtin?
|
361
|
-
return false unless (m = instance_methods(false).first) # any custom method will do
|
362
|
-
|
363
|
-
path, _line = instance_method(m).source_location
|
364
|
-
path.start_with?(__dir__)
|
365
|
-
end
|
366
|
-
private_class_method :builtin?
|
367
|
-
# rubocop:enable Layout/ClassStructure
|
368
|
-
|
369
412
|
def reset_investigation
|
370
413
|
@currently_disabled_lines = @current_offenses = @processed_source = @current_corrector = nil
|
371
414
|
end
|
@@ -389,7 +432,7 @@ module RuboCop
|
|
389
432
|
def use_corrector(range, corrector)
|
390
433
|
if autocorrect?
|
391
434
|
attempt_correction(range, corrector)
|
392
|
-
elsif corrector &&
|
435
|
+
elsif corrector && (always_autocorrect? || (contextual_autocorrect? && !LSP.enabled?))
|
393
436
|
:uncorrected
|
394
437
|
else
|
395
438
|
:unsupported
|
@@ -481,6 +524,18 @@ module RuboCop
|
|
481
524
|
range.end_pos + @current_offset
|
482
525
|
)
|
483
526
|
end
|
527
|
+
|
528
|
+
def target_satisfies_all_gem_version_requirements?
|
529
|
+
self.class.gem_requirements.all? do |gem_name, version_req|
|
530
|
+
all_gem_versions_in_target = @config.gem_versions_in_target
|
531
|
+
next false unless all_gem_versions_in_target
|
532
|
+
|
533
|
+
gem_version_in_target = all_gem_versions_in_target[gem_name]
|
534
|
+
next false unless gem_version_in_target
|
535
|
+
|
536
|
+
version_req.satisfied_by?(gem_version_in_target)
|
537
|
+
end
|
538
|
+
end
|
484
539
|
end
|
485
540
|
end
|
486
541
|
end
|
@@ -56,6 +56,7 @@ module RuboCop
|
|
56
56
|
|
57
57
|
REQUIRED_MSG = 'Gem version specification is required.'
|
58
58
|
FORBIDDEN_MSG = 'Gem version specification is forbidden.'
|
59
|
+
RESTRICT_ON_SEND = %i[gem].freeze
|
59
60
|
VERSION_SPECIFICATION_REGEX = /^\s*[~<>=]*\s*[0-9.]+/.freeze
|
60
61
|
|
61
62
|
# @!method includes_version_specification?(node)
|
@@ -90,13 +91,11 @@ module RuboCop
|
|
90
91
|
Array(cop_config['AllowedGems'])
|
91
92
|
end
|
92
93
|
|
93
|
-
def message(
|
94
|
-
gem_specification = range.source
|
95
|
-
|
94
|
+
def message(_range)
|
96
95
|
if required_style?
|
97
|
-
|
96
|
+
REQUIRED_MSG
|
98
97
|
elsif forbidden_style?
|
99
|
-
|
98
|
+
FORBIDDEN_MSG
|
100
99
|
end
|
101
100
|
end
|
102
101
|
|