rubocop 0.70.0 → 0.75.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +6 -10
- data/bin/console +1 -0
- data/config/default.yml +91 -494
- data/lib/rubocop.rb +16 -54
- data/lib/rubocop/ast/builder.rb +2 -0
- data/lib/rubocop/ast/node.rb +9 -15
- data/lib/rubocop/ast/node/float_node.rb +12 -0
- data/lib/rubocop/ast/node/int_node.rb +12 -0
- data/lib/rubocop/ast/node/mixin/method_dispatch_node.rb +4 -4
- data/lib/rubocop/ast/node/mixin/numeric_node.rb +21 -0
- data/lib/rubocop/ast/node/resbody_node.rb +1 -6
- data/lib/rubocop/ast/traversal.rb +3 -3
- data/lib/rubocop/cached_data.rb +1 -1
- data/lib/rubocop/comment_config.rb +3 -2
- data/lib/rubocop/config.rb +21 -508
- data/lib/rubocop/config_loader.rb +22 -4
- data/lib/rubocop/config_loader_resolver.rb +2 -8
- data/lib/rubocop/config_obsoletion.rb +213 -0
- data/lib/rubocop/config_validator.rb +239 -0
- data/lib/rubocop/cop/autocorrect_logic.rb +71 -1
- data/lib/rubocop/cop/bundler/insecure_protocol_source.rb +1 -1
- data/lib/rubocop/cop/bundler/ordered_gems.rb +1 -1
- data/lib/rubocop/cop/commissioner.rb +3 -9
- data/lib/rubocop/cop/cop.rb +39 -12
- data/lib/rubocop/cop/corrector.rb +2 -3
- data/lib/rubocop/cop/correctors/alignment_corrector.rb +43 -17
- data/lib/rubocop/cop/correctors/empty_line_corrector.rb +2 -2
- data/lib/rubocop/cop/correctors/multiline_literal_brace_corrector.rb +2 -2
- data/lib/rubocop/cop/gemspec/duplicated_assignment.rb +2 -2
- data/lib/rubocop/cop/gemspec/ordered_dependencies.rb +1 -1
- data/lib/rubocop/cop/gemspec/required_ruby_version.rb +1 -1
- data/lib/rubocop/cop/gemspec/ruby_version_globals_usage.rb +55 -0
- data/lib/rubocop/cop/generator.rb +4 -4
- data/lib/rubocop/cop/generator/configuration_injector.rb +9 -4
- data/lib/rubocop/cop/generator/require_file_injector.rb +1 -1
- data/lib/rubocop/cop/internal_affairs/node_destructuring.rb +2 -2
- data/lib/rubocop/cop/internal_affairs/node_type_predicate.rb +1 -1
- data/lib/rubocop/cop/internal_affairs/offense_location_keyword.rb +2 -2
- data/lib/rubocop/cop/internal_affairs/redundant_location_argument.rb +1 -1
- data/lib/rubocop/cop/internal_affairs/redundant_message_argument.rb +2 -2
- data/lib/rubocop/cop/internal_affairs/useless_message_assertion.rb +2 -2
- data/lib/rubocop/cop/layout/block_alignment.rb +3 -3
- data/lib/rubocop/cop/layout/class_structure.rb +2 -2
- data/lib/rubocop/cop/layout/closing_parenthesis_indentation.rb +1 -1
- data/lib/rubocop/cop/layout/empty_lines_around_block_body.rb +3 -1
- data/lib/rubocop/cop/layout/extra_spacing.rb +14 -59
- data/lib/rubocop/cop/layout/heredoc_argument_closing_parenthesis.rb +4 -0
- data/lib/rubocop/cop/layout/indent_assignment.rb +9 -1
- data/lib/rubocop/cop/layout/indent_first_argument.rb +7 -3
- data/lib/rubocop/cop/layout/indent_first_parameter.rb +7 -3
- data/lib/rubocop/cop/layout/indent_heredoc.rb +4 -4
- data/lib/rubocop/cop/layout/indentation_consistency.rb +13 -12
- data/lib/rubocop/cop/layout/indentation_width.rb +28 -10
- data/lib/rubocop/cop/layout/leading_comment_space.rb +28 -0
- data/lib/rubocop/cop/layout/multiline_block_layout.rb +24 -2
- data/lib/rubocop/cop/layout/multiline_method_argument_line_breaks.rb +2 -0
- data/lib/rubocop/cop/layout/rescue_ensure_alignment.rb +18 -4
- data/lib/rubocop/cop/layout/space_around_block_parameters.rb +5 -1
- data/lib/rubocop/cop/layout/space_around_operators.rb +42 -23
- data/lib/rubocop/cop/layout/space_inside_array_literal_brackets.rb +1 -1
- data/lib/rubocop/cop/layout/space_inside_block_braces.rb +21 -2
- data/lib/rubocop/cop/layout/space_inside_string_interpolation.rb +24 -40
- data/lib/rubocop/cop/layout/tab.rb +10 -22
- data/lib/rubocop/cop/lint/assignment_in_condition.rb +17 -4
- data/lib/rubocop/cop/lint/big_decimal_new.rb +1 -1
- data/lib/rubocop/cop/lint/debugger.rb +4 -6
- data/lib/rubocop/cop/lint/duplicate_methods.rb +3 -3
- data/lib/rubocop/cop/lint/each_with_object_argument.rb +1 -1
- data/lib/rubocop/cop/lint/empty_interpolation.rb +4 -4
- data/lib/rubocop/cop/lint/erb_new_arguments.rb +57 -1
- data/lib/rubocop/cop/lint/format_parameter_mismatch.rb +11 -37
- data/lib/rubocop/cop/lint/ineffective_access_modifier.rb +1 -1
- data/lib/rubocop/cop/lint/inherit_exception.rb +1 -1
- data/lib/rubocop/cop/lint/literal_in_interpolation.rb +7 -8
- data/lib/rubocop/cop/lint/multiple_compare.rb +1 -1
- data/lib/rubocop/cop/lint/nested_method_definition.rb +3 -3
- data/lib/rubocop/cop/lint/next_without_accumulator.rb +1 -1
- data/lib/rubocop/cop/lint/non_local_exit_from_iterator.rb +1 -1
- data/lib/rubocop/cop/lint/number_conversion.rb +4 -4
- data/lib/rubocop/cop/lint/rand_one.rb +1 -1
- data/lib/rubocop/cop/lint/redundant_with_index.rb +1 -1
- data/lib/rubocop/cop/lint/redundant_with_object.rb +1 -1
- data/lib/rubocop/cop/lint/safe_navigation_chain.rb +5 -5
- data/lib/rubocop/cop/lint/safe_navigation_with_empty.rb +1 -1
- data/lib/rubocop/cop/lint/send_with_mixin_argument.rb +91 -0
- data/lib/rubocop/cop/lint/string_conversion_in_interpolation.rb +6 -6
- data/lib/rubocop/cop/lint/unified_integer.rb +1 -1
- data/lib/rubocop/cop/lint/unneeded_cop_disable_directive.rb +1 -1
- data/lib/rubocop/cop/lint/unneeded_require_statement.rb +1 -1
- data/lib/rubocop/cop/lint/unneeded_splat_expansion.rb +7 -2
- data/lib/rubocop/cop/lint/unreachable_code.rb +1 -1
- data/lib/rubocop/cop/lint/uri_escape_unescape.rb +1 -1
- data/lib/rubocop/cop/lint/uri_regexp.rb +2 -2
- data/lib/rubocop/cop/lint/useless_access_modifier.rb +6 -6
- data/lib/rubocop/cop/lint/useless_setter_call.rb +1 -1
- data/lib/rubocop/cop/message_annotator.rb +16 -7
- data/lib/rubocop/cop/metrics/class_length.rb +1 -1
- data/lib/rubocop/cop/metrics/line_length.rb +6 -0
- data/lib/rubocop/cop/metrics/module_length.rb +1 -1
- data/lib/rubocop/cop/metrics/parameter_lists.rb +1 -1
- data/lib/rubocop/cop/migration/department_name.rb +44 -0
- data/lib/rubocop/cop/mixin/alignment.rb +1 -1
- data/lib/rubocop/cop/mixin/def_node.rb +1 -1
- data/lib/rubocop/cop/mixin/documentation_comment.rb +0 -2
- data/lib/rubocop/cop/mixin/empty_parameter.rb +1 -1
- data/lib/rubocop/cop/mixin/enforce_superclass.rb +4 -4
- data/lib/rubocop/cop/mixin/frozen_string_literal.rb +1 -1
- data/lib/rubocop/cop/mixin/hash_alignment.rb +4 -0
- data/lib/rubocop/cop/mixin/interpolation.rb +27 -0
- data/lib/rubocop/cop/mixin/method_complexity.rb +1 -1
- data/lib/rubocop/cop/mixin/multiline_expression_indentation.rb +3 -3
- data/lib/rubocop/cop/mixin/preceding_following_alignment.rb +87 -0
- data/lib/rubocop/cop/mixin/safe_mode.rb +2 -0
- data/lib/rubocop/cop/mixin/surrounding_space.rb +7 -5
- data/lib/rubocop/cop/naming/binary_operator_parameter_name.rb +1 -1
- data/lib/rubocop/cop/naming/constant_name.rb +2 -2
- data/lib/rubocop/cop/naming/method_name.rb +12 -1
- data/lib/rubocop/cop/naming/predicate_name.rb +1 -1
- data/lib/rubocop/cop/naming/rescued_exceptions_variable_name.rb +20 -22
- data/lib/rubocop/cop/naming/variable_name.rb +1 -0
- data/lib/rubocop/cop/offense.rb +18 -7
- data/lib/rubocop/cop/registry.rb +22 -1
- data/lib/rubocop/cop/security/eval.rb +1 -1
- data/lib/rubocop/cop/security/json_load.rb +1 -1
- data/lib/rubocop/cop/security/marshal_load.rb +1 -1
- data/lib/rubocop/cop/security/open.rb +1 -1
- data/lib/rubocop/cop/security/yaml_load.rb +1 -1
- data/lib/rubocop/cop/style/access_modifier_declarations.rb +1 -0
- data/lib/rubocop/cop/style/alias.rb +1 -1
- data/lib/rubocop/cop/style/block_delimiters.rb +2 -1
- data/lib/rubocop/cop/style/braces_around_hash_parameters.rb +29 -10
- data/lib/rubocop/cop/style/class_and_module_children.rb +1 -1
- data/lib/rubocop/cop/style/colon_method_call.rb +1 -1
- data/lib/rubocop/cop/style/commented_keyword.rb +16 -30
- data/lib/rubocop/cop/style/conditional_assignment.rb +8 -9
- data/lib/rubocop/cop/style/constant_visibility.rb +14 -3
- data/lib/rubocop/cop/style/date_time.rb +3 -3
- data/lib/rubocop/cop/style/dir.rb +1 -1
- data/lib/rubocop/cop/style/documentation_method.rb +1 -1
- data/lib/rubocop/cop/style/double_cop_disable_directive.rb +55 -0
- data/lib/rubocop/cop/style/each_for_simple_loop.rb +1 -1
- data/lib/rubocop/cop/style/each_with_object.rb +1 -1
- data/lib/rubocop/cop/style/eval_with_location.rb +2 -2
- data/lib/rubocop/cop/style/even_odd.rb +1 -1
- data/lib/rubocop/cop/style/expand_path_arguments.rb +3 -3
- data/lib/rubocop/cop/style/float_division.rb +94 -0
- data/lib/rubocop/cop/style/format_string.rb +13 -9
- data/lib/rubocop/cop/style/format_string_token.rb +10 -40
- data/lib/rubocop/cop/style/frozen_string_literal_comment.rb +18 -33
- data/lib/rubocop/cop/style/guard_clause.rb +39 -10
- data/lib/rubocop/cop/style/hash_syntax.rb +2 -2
- data/lib/rubocop/cop/style/if_inside_else.rb +42 -0
- data/lib/rubocop/cop/style/if_unless_modifier.rb +51 -15
- data/lib/rubocop/cop/style/infinite_loop.rb +1 -1
- data/lib/rubocop/cop/style/inverse_methods.rb +2 -2
- data/lib/rubocop/cop/style/lambda.rb +0 -2
- data/lib/rubocop/cop/style/method_call_with_args_parentheses.rb +12 -6
- data/lib/rubocop/cop/style/min_max.rb +1 -1
- data/lib/rubocop/cop/style/mixin_usage.rb +12 -2
- data/lib/rubocop/cop/style/multiline_memoization.rb +1 -1
- data/lib/rubocop/cop/style/multiline_when_then.rb +55 -0
- data/lib/rubocop/cop/style/multiple_comparison.rb +1 -1
- data/lib/rubocop/cop/style/mutable_constant.rb +3 -3
- data/lib/rubocop/cop/style/nested_modifier.rb +18 -2
- data/lib/rubocop/cop/style/numeric_predicate.rb +3 -3
- data/lib/rubocop/cop/style/option_hash.rb +1 -1
- data/lib/rubocop/cop/style/or_assignment.rb +8 -3
- data/lib/rubocop/cop/style/parentheses_around_condition.rb +15 -1
- data/lib/rubocop/cop/style/random_with_offset.rb +6 -6
- data/lib/rubocop/cop/style/redundant_conditional.rb +2 -2
- data/lib/rubocop/cop/style/redundant_exception.rb +2 -2
- data/lib/rubocop/cop/style/redundant_freeze.rb +1 -1
- data/lib/rubocop/cop/style/redundant_parentheses.rb +15 -6
- data/lib/rubocop/cop/style/redundant_self.rb +18 -1
- data/lib/rubocop/cop/style/redundant_sort_by.rb +1 -1
- data/lib/rubocop/cop/style/rescue_modifier.rb +24 -0
- data/lib/rubocop/cop/style/rescue_standard_error.rb +2 -2
- data/lib/rubocop/cop/style/return_nil.rb +1 -1
- data/lib/rubocop/cop/style/safe_navigation.rb +11 -2
- data/lib/rubocop/cop/style/sample.rb +1 -1
- data/lib/rubocop/cop/style/single_line_methods.rb +8 -1
- data/lib/rubocop/cop/style/stderr_puts.rb +1 -1
- data/lib/rubocop/cop/style/string_hash_keys.rb +2 -2
- data/lib/rubocop/cop/style/strip.rb +1 -1
- data/lib/rubocop/cop/style/struct_inheritance.rb +3 -3
- data/lib/rubocop/cop/style/symbol_proc.rb +1 -1
- data/lib/rubocop/cop/style/ternary_parentheses.rb +32 -3
- data/lib/rubocop/cop/style/trailing_comma_in_arguments.rb +4 -0
- data/lib/rubocop/cop/style/trailing_method_end_statement.rb +4 -6
- data/lib/rubocop/cop/style/trivial_accessors.rb +1 -1
- data/lib/rubocop/cop/style/unneeded_sort.rb +1 -1
- data/lib/rubocop/cop/style/unpack_first.rb +1 -1
- data/lib/rubocop/cop/style/variable_interpolation.rb +6 -16
- data/lib/rubocop/cop/style/word_array.rb +2 -2
- data/lib/rubocop/cop/style/zero_length_predicate.rb +6 -6
- data/lib/rubocop/cop/team.rb +15 -14
- data/lib/rubocop/cop/utils/format_string.rb +128 -0
- data/lib/rubocop/cop/variable_force/variable.rb +15 -2
- data/lib/rubocop/core_ext/string.rb +0 -24
- data/lib/rubocop/error.rb +23 -0
- data/lib/rubocop/formatter/emacs_style_formatter.rb +8 -5
- data/lib/rubocop/formatter/formatter_set.rb +2 -1
- data/lib/rubocop/formatter/pacman_formatter.rb +80 -0
- data/lib/rubocop/formatter/simple_text_formatter.rb +9 -1
- data/lib/rubocop/formatter/tap_formatter.rb +9 -1
- data/lib/rubocop/magic_comment.rb +4 -0
- data/lib/rubocop/node_pattern.rb +86 -7
- data/lib/rubocop/options.rb +18 -2
- data/lib/rubocop/path_util.rb +1 -1
- data/lib/rubocop/processed_source.rb +9 -1
- data/lib/rubocop/rspec/cop_helper.rb +0 -1
- data/lib/rubocop/rspec/expect_offense.rb +4 -1
- data/lib/rubocop/rspec/shared_contexts.rb +12 -17
- data/lib/rubocop/rspec/support.rb +0 -1
- data/lib/rubocop/runner.rb +20 -15
- data/lib/rubocop/target_finder.rb +6 -4
- data/lib/rubocop/version.rb +1 -1
- data/lib/rubocop/yaml_duplication_checker.rb +8 -2
- metadata +16 -70
- data/lib/rubocop/cop/mixin/ignored_method_patterns.rb +0 -19
- data/lib/rubocop/cop/mixin/target_rails_version.rb +0 -16
- data/lib/rubocop/cop/rails/action_filter.rb +0 -117
- data/lib/rubocop/cop/rails/active_record_aliases.rb +0 -48
- data/lib/rubocop/cop/rails/active_record_override.rb +0 -82
- data/lib/rubocop/cop/rails/active_support_aliases.rb +0 -69
- data/lib/rubocop/cop/rails/application_job.rb +0 -40
- data/lib/rubocop/cop/rails/application_record.rb +0 -40
- data/lib/rubocop/cop/rails/assert_not.rb +0 -44
- data/lib/rubocop/cop/rails/belongs_to.rb +0 -102
- data/lib/rubocop/cop/rails/blank.rb +0 -164
- data/lib/rubocop/cop/rails/bulk_change_table.rb +0 -289
- data/lib/rubocop/cop/rails/create_table_with_timestamps.rb +0 -91
- data/lib/rubocop/cop/rails/date.rb +0 -161
- data/lib/rubocop/cop/rails/delegate.rb +0 -132
- data/lib/rubocop/cop/rails/delegate_allow_blank.rb +0 -37
- data/lib/rubocop/cop/rails/dynamic_find_by.rb +0 -91
- data/lib/rubocop/cop/rails/enum_uniqueness.rb +0 -45
- data/lib/rubocop/cop/rails/environment_comparison.rb +0 -68
- data/lib/rubocop/cop/rails/exit.rb +0 -67
- data/lib/rubocop/cop/rails/file_path.rb +0 -108
- data/lib/rubocop/cop/rails/find_by.rb +0 -55
- data/lib/rubocop/cop/rails/find_each.rb +0 -51
- data/lib/rubocop/cop/rails/has_and_belongs_to_many.rb +0 -25
- data/lib/rubocop/cop/rails/has_many_or_has_one_dependent.rb +0 -106
- data/lib/rubocop/cop/rails/http_positional_arguments.rb +0 -117
- data/lib/rubocop/cop/rails/http_status.rb +0 -179
- data/lib/rubocop/cop/rails/ignored_skip_action_filter_option.rb +0 -94
- data/lib/rubocop/cop/rails/inverse_of.rb +0 -246
- data/lib/rubocop/cop/rails/lexically_scoped_action_filter.rb +0 -175
- data/lib/rubocop/cop/rails/link_to_blank.rb +0 -98
- data/lib/rubocop/cop/rails/not_null_column.rb +0 -67
- data/lib/rubocop/cop/rails/output.rb +0 -49
- data/lib/rubocop/cop/rails/output_safety.rb +0 -99
- data/lib/rubocop/cop/rails/pluralization_grammar.rb +0 -107
- data/lib/rubocop/cop/rails/presence.rb +0 -124
- data/lib/rubocop/cop/rails/present.rb +0 -153
- data/lib/rubocop/cop/rails/read_write_attribute.rb +0 -74
- data/lib/rubocop/cop/rails/redundant_allow_nil.rb +0 -111
- data/lib/rubocop/cop/rails/redundant_receiver_in_with_options.rb +0 -136
- data/lib/rubocop/cop/rails/reflection_class_name.rb +0 -37
- data/lib/rubocop/cop/rails/refute_methods.rb +0 -76
- data/lib/rubocop/cop/rails/relative_date_constant.rb +0 -93
- data/lib/rubocop/cop/rails/request_referer.rb +0 -56
- data/lib/rubocop/cop/rails/reversible_migration.rb +0 -286
- data/lib/rubocop/cop/rails/safe_navigation.rb +0 -87
- data/lib/rubocop/cop/rails/save_bang.rb +0 -316
- data/lib/rubocop/cop/rails/scope_args.rb +0 -29
- data/lib/rubocop/cop/rails/skips_model_validations.rb +0 -87
- data/lib/rubocop/cop/rails/time_zone.rb +0 -238
- data/lib/rubocop/cop/rails/uniq_before_pluck.rb +0 -105
- data/lib/rubocop/cop/rails/unknown_env.rb +0 -63
- data/lib/rubocop/cop/rails/validation.rb +0 -109
- data/lib/rubocop/rspec/shared_examples.rb +0 -59
@@ -1,102 +0,0 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
module RuboCop
|
4
|
-
module Cop
|
5
|
-
module Rails
|
6
|
-
# This cop looks for belongs_to associations where we control whether the
|
7
|
-
# association is required via the deprecated `required` option instead.
|
8
|
-
#
|
9
|
-
# Since Rails 5, belongs_to associations are required by default and this
|
10
|
-
# can be controlled through the use of `optional: true`.
|
11
|
-
#
|
12
|
-
# From the release notes:
|
13
|
-
#
|
14
|
-
# belongs_to will now trigger a validation error by default if the
|
15
|
-
# association is not present. You can turn this off on a
|
16
|
-
# per-association basis with optional: true. Also deprecate required
|
17
|
-
# option in favor of optional for belongs_to. (Pull Request)
|
18
|
-
#
|
19
|
-
# In the case that the developer is doing `required: false`, we
|
20
|
-
# definitely want to autocorrect to `optional: true`.
|
21
|
-
#
|
22
|
-
# However, without knowing whether they've set overridden the default
|
23
|
-
# value of `config.active_record.belongs_to_required_by_default`, we
|
24
|
-
# can't say whether it's safe to remove `required: true` or whether we
|
25
|
-
# should replace it with `optional: false` (or, similarly, remove a
|
26
|
-
# superfluous `optional: false`). Therefore, in the cases we're using
|
27
|
-
# `required: true`, we'll simply invert it to `optional: false` and the
|
28
|
-
# user can remove depending on their defaults.
|
29
|
-
#
|
30
|
-
# @example
|
31
|
-
# # bad
|
32
|
-
# class Post < ApplicationRecord
|
33
|
-
# belongs_to :blog, required: false
|
34
|
-
# end
|
35
|
-
#
|
36
|
-
# # good
|
37
|
-
# class Post < ApplicationRecord
|
38
|
-
# belongs_to :blog, optional: true
|
39
|
-
# end
|
40
|
-
#
|
41
|
-
# # bad
|
42
|
-
# class Post < ApplicationRecord
|
43
|
-
# belongs_to :blog, required: true
|
44
|
-
# end
|
45
|
-
#
|
46
|
-
# # good
|
47
|
-
# class Post < ApplicationRecord
|
48
|
-
# belongs_to :blog, optional: false
|
49
|
-
# end
|
50
|
-
#
|
51
|
-
# @see https://guides.rubyonrails.org/5_0_release_notes.html
|
52
|
-
# @see https://github.com/rails/rails/pull/18937
|
53
|
-
class BelongsTo < Cop
|
54
|
-
extend TargetRailsVersion
|
55
|
-
|
56
|
-
minimum_target_rails_version 5.0
|
57
|
-
|
58
|
-
SUPERFLOUS_REQUIRE_FALSE_MSG =
|
59
|
-
'You specified `required: false`, in Rails > 5.0 the required ' \
|
60
|
-
'option is deprecated and you want to use `optional: true`.'
|
61
|
-
|
62
|
-
SUPERFLOUS_REQUIRE_TRUE_MSG =
|
63
|
-
'You specified `required: true`, in Rails > 5.0 the required ' \
|
64
|
-
'option is deprecated and you want to use `optional: false`. ' \
|
65
|
-
'In most configurations, this is the default and you can omit ' \
|
66
|
-
'this option altogether'
|
67
|
-
|
68
|
-
def_node_matcher :match_belongs_to_with_options, <<-PATTERN
|
69
|
-
(send _ :belongs_to _
|
70
|
-
(hash <$(pair (sym :required) ${true false}) ...>)
|
71
|
-
)
|
72
|
-
PATTERN
|
73
|
-
|
74
|
-
def on_send(node)
|
75
|
-
match_belongs_to_with_options(node) do |_option_node, option_value|
|
76
|
-
message =
|
77
|
-
if option_value.true_type?
|
78
|
-
SUPERFLOUS_REQUIRE_TRUE_MSG
|
79
|
-
elsif option_value.false_type?
|
80
|
-
SUPERFLOUS_REQUIRE_FALSE_MSG
|
81
|
-
end
|
82
|
-
|
83
|
-
add_offense(node, message: message, location: :selector)
|
84
|
-
end
|
85
|
-
end
|
86
|
-
|
87
|
-
def autocorrect(node)
|
88
|
-
option_node, option_value = match_belongs_to_with_options(node)
|
89
|
-
return unless option_node
|
90
|
-
|
91
|
-
lambda do |corrector|
|
92
|
-
if option_value.true_type?
|
93
|
-
corrector.replace(option_node.loc.expression, 'optional: false')
|
94
|
-
elsif option_value.false_type?
|
95
|
-
corrector.replace(option_node.loc.expression, 'optional: true')
|
96
|
-
end
|
97
|
-
end
|
98
|
-
end
|
99
|
-
end
|
100
|
-
end
|
101
|
-
end
|
102
|
-
end
|
@@ -1,164 +0,0 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
module RuboCop
|
4
|
-
module Cop
|
5
|
-
module Rails
|
6
|
-
# This cop checks for code that can be written with simpler conditionals
|
7
|
-
# using `Object#blank?` defined by Active Support.
|
8
|
-
#
|
9
|
-
# Interaction with `Style/UnlessElse`:
|
10
|
-
# The configuration of `NotPresent` will not produce an offense in the
|
11
|
-
# context of `unless else` if `Style/UnlessElse` is inabled. This is
|
12
|
-
# to prevent interference between the auto-correction of the two cops.
|
13
|
-
#
|
14
|
-
# @example NilOrEmpty: true (default)
|
15
|
-
# # Converts usages of `nil? || empty?` to `blank?`
|
16
|
-
#
|
17
|
-
# # bad
|
18
|
-
# foo.nil? || foo.empty?
|
19
|
-
# foo == nil || foo.empty?
|
20
|
-
#
|
21
|
-
# # good
|
22
|
-
# foo.blank?
|
23
|
-
#
|
24
|
-
# @example NotPresent: true (default)
|
25
|
-
# # Converts usages of `!present?` to `blank?`
|
26
|
-
#
|
27
|
-
# # bad
|
28
|
-
# !foo.present?
|
29
|
-
#
|
30
|
-
# # good
|
31
|
-
# foo.blank?
|
32
|
-
#
|
33
|
-
# @example UnlessPresent: true (default)
|
34
|
-
# # Converts usages of `unless present?` to `if blank?`
|
35
|
-
#
|
36
|
-
# # bad
|
37
|
-
# something unless foo.present?
|
38
|
-
#
|
39
|
-
# # good
|
40
|
-
# something if foo.blank?
|
41
|
-
#
|
42
|
-
# # bad
|
43
|
-
# unless foo.present?
|
44
|
-
# something
|
45
|
-
# end
|
46
|
-
#
|
47
|
-
# # good
|
48
|
-
# if foo.blank?
|
49
|
-
# something
|
50
|
-
# end
|
51
|
-
#
|
52
|
-
# # good
|
53
|
-
# def blank?
|
54
|
-
# !present?
|
55
|
-
# end
|
56
|
-
class Blank < Cop
|
57
|
-
MSG_NIL_OR_EMPTY = 'Use `%<prefer>s` instead of `%<current>s`.'
|
58
|
-
MSG_NOT_PRESENT = 'Use `%<prefer>s` instead of `%<current>s`.'
|
59
|
-
MSG_UNLESS_PRESENT = 'Use `if %<prefer>s` instead of ' \
|
60
|
-
'`%<current>s`.'
|
61
|
-
|
62
|
-
# `(send nil $_)` is not actually a valid match for an offense. Nodes
|
63
|
-
# that have a single method call on the left hand side
|
64
|
-
# (`bar || foo.empty?`) will blow up when checking
|
65
|
-
# `(send (:nil) :== $_)`.
|
66
|
-
def_node_matcher :nil_or_empty?, <<-PATTERN
|
67
|
-
(or
|
68
|
-
{
|
69
|
-
(send $_ :!)
|
70
|
-
(send $_ :nil?)
|
71
|
-
(send $_ :== nil)
|
72
|
-
(send nil :== $_)
|
73
|
-
}
|
74
|
-
{
|
75
|
-
(send $_ :empty?)
|
76
|
-
(send (send (send $_ :empty?) :!) :!)
|
77
|
-
}
|
78
|
-
)
|
79
|
-
PATTERN
|
80
|
-
|
81
|
-
def_node_matcher :not_present?, '(send (send $_ :present?) :!)'
|
82
|
-
|
83
|
-
def_node_matcher :defining_blank?, '(def :blank? (args) ...)'
|
84
|
-
|
85
|
-
def_node_matcher :unless_present?, <<-PATTERN
|
86
|
-
(:if $(send $_ :present?) {nil? (...)} ...)
|
87
|
-
PATTERN
|
88
|
-
|
89
|
-
def on_send(node)
|
90
|
-
return unless cop_config['NotPresent']
|
91
|
-
|
92
|
-
not_present?(node) do |receiver|
|
93
|
-
# accepts !present? if its in the body of a `blank?` method
|
94
|
-
next if defining_blank?(node.parent)
|
95
|
-
|
96
|
-
add_offense(node,
|
97
|
-
message: format(MSG_NOT_PRESENT,
|
98
|
-
prefer: replacement(receiver),
|
99
|
-
current: node.source))
|
100
|
-
end
|
101
|
-
end
|
102
|
-
|
103
|
-
def on_or(node)
|
104
|
-
return unless cop_config['NilOrEmpty']
|
105
|
-
|
106
|
-
nil_or_empty?(node) do |var1, var2|
|
107
|
-
return unless var1 == var2
|
108
|
-
|
109
|
-
add_offense(node,
|
110
|
-
message: format(MSG_NIL_OR_EMPTY,
|
111
|
-
prefer: replacement(var1),
|
112
|
-
current: node.source))
|
113
|
-
end
|
114
|
-
end
|
115
|
-
|
116
|
-
def on_if(node)
|
117
|
-
return unless cop_config['UnlessPresent']
|
118
|
-
return unless node.unless?
|
119
|
-
return if node.else? && config.for_cop('Style/UnlessElse')['Enabled']
|
120
|
-
|
121
|
-
unless_present?(node) do |method_call, receiver|
|
122
|
-
range = unless_condition(node, method_call)
|
123
|
-
|
124
|
-
add_offense(node,
|
125
|
-
location: range,
|
126
|
-
message: format(MSG_UNLESS_PRESENT,
|
127
|
-
prefer: replacement(receiver),
|
128
|
-
current: range.source))
|
129
|
-
end
|
130
|
-
end
|
131
|
-
|
132
|
-
def autocorrect(node)
|
133
|
-
lambda do |corrector|
|
134
|
-
method_call, variable1 = unless_present?(node)
|
135
|
-
|
136
|
-
if method_call
|
137
|
-
corrector.replace(node.loc.keyword, 'if')
|
138
|
-
range = method_call.loc.expression
|
139
|
-
else
|
140
|
-
variable1, _variable2 = nil_or_empty?(node) || not_present?(node)
|
141
|
-
range = node.loc.expression
|
142
|
-
end
|
143
|
-
|
144
|
-
corrector.replace(range, replacement(variable1))
|
145
|
-
end
|
146
|
-
end
|
147
|
-
|
148
|
-
private
|
149
|
-
|
150
|
-
def unless_condition(node, method_call)
|
151
|
-
if node.modifier_form?
|
152
|
-
node.loc.keyword.join(node.loc.expression.end)
|
153
|
-
else
|
154
|
-
node.loc.expression.begin.join(method_call.loc.expression)
|
155
|
-
end
|
156
|
-
end
|
157
|
-
|
158
|
-
def replacement(node)
|
159
|
-
node.respond_to?(:source) ? "#{node.source}.blank?" : 'blank?'
|
160
|
-
end
|
161
|
-
end
|
162
|
-
end
|
163
|
-
end
|
164
|
-
end
|
@@ -1,289 +0,0 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
module RuboCop
|
4
|
-
module Cop
|
5
|
-
module Rails
|
6
|
-
# This Cop checks whether alter queries are combinable.
|
7
|
-
# If combinable queries are detected, it suggests to you
|
8
|
-
# to use `change_table` with `bulk: true` instead.
|
9
|
-
# This option causes the migration to generate a single
|
10
|
-
# ALTER TABLE statement combining multiple column alterations.
|
11
|
-
#
|
12
|
-
# The `bulk` option is only supported on the MySQL and
|
13
|
-
# the PostgreSQL (5.2 later) adapter; thus it will
|
14
|
-
# automatically detect an adapter from `development` environment
|
15
|
-
# in `config/database.yml` when the `Database` option is not set.
|
16
|
-
# If the adapter is not `mysql2` or `postgresql`,
|
17
|
-
# this Cop ignores offenses.
|
18
|
-
#
|
19
|
-
# @example
|
20
|
-
# # bad
|
21
|
-
# def change
|
22
|
-
# add_column :users, :name, :string, null: false
|
23
|
-
# add_column :users, :nickname, :string
|
24
|
-
#
|
25
|
-
# # ALTER TABLE `users` ADD `name` varchar(255) NOT NULL
|
26
|
-
# # ALTER TABLE `users` ADD `nickname` varchar(255)
|
27
|
-
# end
|
28
|
-
#
|
29
|
-
# # good
|
30
|
-
# def change
|
31
|
-
# change_table :users, bulk: true do |t|
|
32
|
-
# t.string :name, null: false
|
33
|
-
# t.string :nickname
|
34
|
-
# end
|
35
|
-
#
|
36
|
-
# # ALTER TABLE `users` ADD `name` varchar(255) NOT NULL,
|
37
|
-
# # ADD `nickname` varchar(255)
|
38
|
-
# end
|
39
|
-
#
|
40
|
-
# @example
|
41
|
-
# # bad
|
42
|
-
# def change
|
43
|
-
# change_table :users do |t|
|
44
|
-
# t.string :name, null: false
|
45
|
-
# t.string :nickname
|
46
|
-
# end
|
47
|
-
# end
|
48
|
-
#
|
49
|
-
# # good
|
50
|
-
# def change
|
51
|
-
# change_table :users, bulk: true do |t|
|
52
|
-
# t.string :name, null: false
|
53
|
-
# t.string :nickname
|
54
|
-
# end
|
55
|
-
# end
|
56
|
-
#
|
57
|
-
# # good
|
58
|
-
# # When you don't want to combine alter queries.
|
59
|
-
# def change
|
60
|
-
# change_table :users, bulk: false do |t|
|
61
|
-
# t.string :name, null: false
|
62
|
-
# t.string :nickname
|
63
|
-
# end
|
64
|
-
# end
|
65
|
-
#
|
66
|
-
# @see https://api.rubyonrails.org/classes/ActiveRecord/ConnectionAdapters/SchemaStatements.html#method-i-change_table
|
67
|
-
# @see https://api.rubyonrails.org/classes/ActiveRecord/ConnectionAdapters/Table.html
|
68
|
-
class BulkChangeTable < Cop
|
69
|
-
MSG_FOR_CHANGE_TABLE = <<~MSG.chomp
|
70
|
-
You can combine alter queries using `bulk: true` options.
|
71
|
-
MSG
|
72
|
-
MSG_FOR_ALTER_METHODS = <<~MSG.chomp
|
73
|
-
You can use `change_table :%<table>s, bulk: true` to combine alter queries.
|
74
|
-
MSG
|
75
|
-
|
76
|
-
MYSQL = 'mysql'
|
77
|
-
POSTGRESQL = 'postgresql'
|
78
|
-
|
79
|
-
MIGRATION_METHODS = %i[change up down].freeze
|
80
|
-
|
81
|
-
COMBINABLE_TRANSFORMATIONS = %i[
|
82
|
-
primary_key
|
83
|
-
column
|
84
|
-
string
|
85
|
-
text
|
86
|
-
integer
|
87
|
-
bigint
|
88
|
-
float
|
89
|
-
decimal
|
90
|
-
numeric
|
91
|
-
datetime
|
92
|
-
timestamp
|
93
|
-
time
|
94
|
-
date
|
95
|
-
binary
|
96
|
-
boolean
|
97
|
-
json
|
98
|
-
virtual
|
99
|
-
remove
|
100
|
-
change
|
101
|
-
timestamps
|
102
|
-
remove_timestamps
|
103
|
-
].freeze
|
104
|
-
|
105
|
-
COMBINABLE_ALTER_METHODS = %i[
|
106
|
-
add_column
|
107
|
-
remove_column
|
108
|
-
remove_columns
|
109
|
-
change_column
|
110
|
-
add_timestamps
|
111
|
-
remove_timestamps
|
112
|
-
].freeze
|
113
|
-
|
114
|
-
MYSQL_COMBINABLE_TRANSFORMATIONS = %i[
|
115
|
-
rename
|
116
|
-
index
|
117
|
-
remove_index
|
118
|
-
].freeze
|
119
|
-
|
120
|
-
MYSQL_COMBINABLE_ALTER_METHODS = %i[
|
121
|
-
rename_column
|
122
|
-
add_index
|
123
|
-
remove_index
|
124
|
-
].freeze
|
125
|
-
|
126
|
-
POSTGRESQL_COMBINABLE_TRANSFORMATIONS = %i[
|
127
|
-
change_default
|
128
|
-
].freeze
|
129
|
-
|
130
|
-
POSTGRESQL_COMBINABLE_ALTER_METHODS = %i[
|
131
|
-
change_column_default
|
132
|
-
change_column_null
|
133
|
-
].freeze
|
134
|
-
|
135
|
-
def on_def(node)
|
136
|
-
return unless support_bulk_alter?
|
137
|
-
return unless MIGRATION_METHODS.include?(node.method_name)
|
138
|
-
return unless node.body
|
139
|
-
|
140
|
-
recorder = AlterMethodsRecorder.new
|
141
|
-
|
142
|
-
node.body.each_child_node(:send) do |send_node|
|
143
|
-
if combinable_alter_methods.include?(send_node.method_name)
|
144
|
-
recorder.process(send_node)
|
145
|
-
else
|
146
|
-
recorder.flush
|
147
|
-
end
|
148
|
-
end
|
149
|
-
|
150
|
-
recorder.offensive_nodes.each { |n| add_offense_for_alter_methods(n) }
|
151
|
-
end
|
152
|
-
|
153
|
-
def on_send(node)
|
154
|
-
return unless support_bulk_alter?
|
155
|
-
return unless node.command?(:change_table)
|
156
|
-
return if include_bulk_options?(node)
|
157
|
-
return unless node.block_node
|
158
|
-
|
159
|
-
send_nodes = node.block_node.body.each_child_node(:send).to_a
|
160
|
-
|
161
|
-
transformations = send_nodes.select do |send_node|
|
162
|
-
combinable_transformations.include?(send_node.method_name)
|
163
|
-
end
|
164
|
-
|
165
|
-
add_offense_for_change_table(node) if transformations.size > 1
|
166
|
-
end
|
167
|
-
|
168
|
-
private
|
169
|
-
|
170
|
-
# @param node [RuboCop::AST::SendNode] (send nil? :change_table ...)
|
171
|
-
def include_bulk_options?(node)
|
172
|
-
# arguments: [{(sym :table)(str "table")} (hash (pair (sym :bulk) _))]
|
173
|
-
options = node.arguments[1]
|
174
|
-
return false unless options
|
175
|
-
|
176
|
-
options.hash_type? &&
|
177
|
-
options.keys.any? { |key| key.sym_type? && key.value == :bulk }
|
178
|
-
end
|
179
|
-
|
180
|
-
def database
|
181
|
-
cop_config['Database'] || database_from_yaml
|
182
|
-
end
|
183
|
-
|
184
|
-
def database_from_yaml
|
185
|
-
return nil unless database_yaml
|
186
|
-
|
187
|
-
case database_yaml['adapter']
|
188
|
-
when 'mysql2'
|
189
|
-
MYSQL
|
190
|
-
when 'postgresql'
|
191
|
-
POSTGRESQL
|
192
|
-
end
|
193
|
-
end
|
194
|
-
|
195
|
-
def database_yaml
|
196
|
-
return nil unless File.exist?('config/database.yml')
|
197
|
-
|
198
|
-
yaml = YAML.load_file('config/database.yml')
|
199
|
-
return nil unless yaml.is_a? Hash
|
200
|
-
|
201
|
-
config = yaml['development']
|
202
|
-
return nil unless config.is_a?(Hash)
|
203
|
-
|
204
|
-
config
|
205
|
-
rescue Psych::SyntaxError
|
206
|
-
nil
|
207
|
-
end
|
208
|
-
|
209
|
-
def support_bulk_alter?
|
210
|
-
case database
|
211
|
-
when MYSQL
|
212
|
-
true
|
213
|
-
when POSTGRESQL
|
214
|
-
# Add bulk alter support for PostgreSQL in 5.2.0
|
215
|
-
# @see https://github.com/rails/rails/pull/31331
|
216
|
-
target_rails_version >= 5.2
|
217
|
-
else
|
218
|
-
false
|
219
|
-
end
|
220
|
-
end
|
221
|
-
|
222
|
-
def combinable_alter_methods
|
223
|
-
case database
|
224
|
-
when MYSQL
|
225
|
-
COMBINABLE_ALTER_METHODS + MYSQL_COMBINABLE_ALTER_METHODS
|
226
|
-
when POSTGRESQL
|
227
|
-
COMBINABLE_ALTER_METHODS + POSTGRESQL_COMBINABLE_ALTER_METHODS
|
228
|
-
end
|
229
|
-
end
|
230
|
-
|
231
|
-
def combinable_transformations
|
232
|
-
case database
|
233
|
-
when MYSQL
|
234
|
-
COMBINABLE_TRANSFORMATIONS + MYSQL_COMBINABLE_TRANSFORMATIONS
|
235
|
-
when POSTGRESQL
|
236
|
-
COMBINABLE_TRANSFORMATIONS + POSTGRESQL_COMBINABLE_TRANSFORMATIONS
|
237
|
-
end
|
238
|
-
end
|
239
|
-
|
240
|
-
# @param node [RuboCop::AST::SendNode]
|
241
|
-
def add_offense_for_alter_methods(node)
|
242
|
-
# arguments: [{(sym :table)(str "table")} ...]
|
243
|
-
table_node = node.arguments[0]
|
244
|
-
return unless table_node.is_a? RuboCop::AST::BasicLiteralNode
|
245
|
-
|
246
|
-
message = format(MSG_FOR_ALTER_METHODS, table: table_node.value)
|
247
|
-
add_offense(node, message: message)
|
248
|
-
end
|
249
|
-
|
250
|
-
# @param node [RuboCop::AST::SendNode]
|
251
|
-
def add_offense_for_change_table(node)
|
252
|
-
add_offense(node, message: MSG_FOR_CHANGE_TABLE)
|
253
|
-
end
|
254
|
-
|
255
|
-
# Record combinable alter methods and register offensive nodes.
|
256
|
-
class AlterMethodsRecorder
|
257
|
-
def initialize
|
258
|
-
@nodes = []
|
259
|
-
@offensive_nodes = []
|
260
|
-
end
|
261
|
-
|
262
|
-
# @param new_node [RuboCop::AST::SendNode]
|
263
|
-
def process(new_node)
|
264
|
-
# arguments: [{(sym :table)(str "table")} ...]
|
265
|
-
table_node = new_node.arguments[0]
|
266
|
-
if table_node.is_a? RuboCop::AST::BasicLiteralNode
|
267
|
-
flush unless @nodes.all? do |node|
|
268
|
-
node.arguments[0].value.to_s == table_node.value.to_s
|
269
|
-
end
|
270
|
-
@nodes << new_node
|
271
|
-
else
|
272
|
-
flush
|
273
|
-
end
|
274
|
-
end
|
275
|
-
|
276
|
-
def flush
|
277
|
-
@offensive_nodes << @nodes.first if @nodes.size > 1
|
278
|
-
@nodes = []
|
279
|
-
end
|
280
|
-
|
281
|
-
def offensive_nodes
|
282
|
-
flush
|
283
|
-
@offensive_nodes
|
284
|
-
end
|
285
|
-
end
|
286
|
-
end
|
287
|
-
end
|
288
|
-
end
|
289
|
-
end
|