rubocop-rails 2.15.2 → 2.17.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (88) hide show
  1. checksums.yaml +4 -4
  2. data/config/default.yml +122 -2
  3. data/config/obsoletion.yml +10 -0
  4. data/lib/rubocop/cop/mixin/active_record_helper.rb +3 -6
  5. data/lib/rubocop/cop/mixin/active_record_migrations_helper.rb +1 -3
  6. data/lib/rubocop/cop/mixin/index_method.rb +6 -16
  7. data/lib/rubocop/cop/mixin/migrations_helper.rb +1 -1
  8. data/lib/rubocop/cop/rails/action_controller_flash_before_render.rb +104 -0
  9. data/lib/rubocop/cop/rails/action_controller_test_case.rb +2 -2
  10. data/lib/rubocop/cop/rails/action_filter.rb +1 -1
  11. data/lib/rubocop/cop/rails/action_order.rb +117 -0
  12. data/lib/rubocop/cop/rails/active_record_aliases.rb +1 -4
  13. data/lib/rubocop/cop/rails/active_record_override.rb +2 -5
  14. data/lib/rubocop/cop/rails/active_support_on_load.rb +70 -0
  15. data/lib/rubocop/cop/rails/add_column_index.rb +1 -4
  16. data/lib/rubocop/cop/rails/application_controller.rb +1 -1
  17. data/lib/rubocop/cop/rails/application_job.rb +1 -1
  18. data/lib/rubocop/cop/rails/application_mailer.rb +1 -1
  19. data/lib/rubocop/cop/rails/application_record.rb +1 -1
  20. data/lib/rubocop/cop/rails/blank.rb +1 -2
  21. data/lib/rubocop/cop/rails/bulk_change_table.rb +6 -20
  22. data/lib/rubocop/cop/rails/compact_blank.rb +5 -1
  23. data/lib/rubocop/cop/rails/content_tag.rb +4 -5
  24. data/lib/rubocop/cop/rails/date.rb +4 -9
  25. data/lib/rubocop/cop/rails/delegate.rb +2 -5
  26. data/lib/rubocop/cop/rails/deprecated_active_model_errors_methods.rb +17 -13
  27. data/lib/rubocop/cop/rails/dot_separated_keys.rb +2 -2
  28. data/lib/rubocop/cop/rails/duration_arithmetic.rb +2 -2
  29. data/lib/rubocop/cop/rails/dynamic_find_by.rb +24 -12
  30. data/lib/rubocop/cop/rails/eager_evaluation_log_message.rb +4 -0
  31. data/lib/rubocop/cop/rails/enum_uniqueness.rb +2 -5
  32. data/lib/rubocop/cop/rails/environment_comparison.rb +1 -2
  33. data/lib/rubocop/cop/rails/file_path.rb +5 -7
  34. data/lib/rubocop/cop/rails/find_each.rb +8 -2
  35. data/lib/rubocop/cop/rails/freeze_time.rb +76 -0
  36. data/lib/rubocop/cop/rails/has_many_or_has_one_dependent.rb +2 -4
  37. data/lib/rubocop/cop/rails/helper_instance_variable.rb +1 -1
  38. data/lib/rubocop/cop/rails/http_positional_arguments.rb +4 -9
  39. data/lib/rubocop/cop/rails/http_status.rb +5 -10
  40. data/lib/rubocop/cop/rails/i18n_lazy_lookup.rb +2 -0
  41. data/lib/rubocop/cop/rails/ignored_columns_assignment.rb +50 -0
  42. data/lib/rubocop/cop/rails/ignored_skip_action_filter_option.rb +3 -10
  43. data/lib/rubocop/cop/rails/index_by.rb +1 -1
  44. data/lib/rubocop/cop/rails/index_with.rb +1 -1
  45. data/lib/rubocop/cop/rails/inverse_of.rb +3 -6
  46. data/lib/rubocop/cop/rails/lexically_scoped_action_filter.rb +2 -6
  47. data/lib/rubocop/cop/rails/link_to_blank.rb +1 -4
  48. data/lib/rubocop/cop/rails/mailer_name.rb +3 -3
  49. data/lib/rubocop/cop/rails/migration_class_name.rb +1 -1
  50. data/lib/rubocop/cop/rails/output.rb +3 -6
  51. data/lib/rubocop/cop/rails/pluck.rb +32 -12
  52. data/lib/rubocop/cop/rails/pluralization_grammar.rb +1 -2
  53. data/lib/rubocop/cop/rails/presence.rb +21 -12
  54. data/lib/rubocop/cop/rails/present.rb +3 -6
  55. data/lib/rubocop/cop/rails/rake_environment.rb +1 -1
  56. data/lib/rubocop/cop/rails/redundant_allow_nil.rb +2 -4
  57. data/lib/rubocop/cop/rails/redundant_foreign_key.rb +1 -1
  58. data/lib/rubocop/cop/rails/redundant_presence_validation_on_belongs_to.rb +3 -3
  59. data/lib/rubocop/cop/rails/redundant_receiver_in_with_options.rb +30 -26
  60. data/lib/rubocop/cop/rails/reflection_class_name.rb +17 -0
  61. data/lib/rubocop/cop/rails/refute_methods.rb +1 -5
  62. data/lib/rubocop/cop/rails/relative_date_constant.rb +2 -5
  63. data/lib/rubocop/cop/rails/request_referer.rb +1 -2
  64. data/lib/rubocop/cop/rails/require_dependency.rb +1 -1
  65. data/lib/rubocop/cop/rails/reversible_migration.rb +10 -33
  66. data/lib/rubocop/cop/rails/reversible_migration_method_definition.rb +1 -2
  67. data/lib/rubocop/cop/rails/root_pathname_methods.rb +225 -0
  68. data/lib/rubocop/cop/rails/safe_navigation_with_blank.rb +1 -3
  69. data/lib/rubocop/cop/rails/save_bang.rb +10 -22
  70. data/lib/rubocop/cop/rails/short_i18n.rb +2 -5
  71. data/lib/rubocop/cop/rails/skips_model_validations.rb +2 -3
  72. data/lib/rubocop/cop/rails/squished_sql_heredocs.rb +1 -5
  73. data/lib/rubocop/cop/rails/time_zone.rb +10 -21
  74. data/lib/rubocop/cop/rails/time_zone_assignment.rb +1 -1
  75. data/lib/rubocop/cop/rails/to_s_with_argument.rb +78 -0
  76. data/lib/rubocop/cop/rails/top_level_hash_with_indifferent_access.rb +49 -0
  77. data/lib/rubocop/cop/rails/uniq_before_pluck.rb +3 -6
  78. data/lib/rubocop/cop/rails/unique_validation_without_index.rb +1 -3
  79. data/lib/rubocop/cop/rails/unknown_env.rb +2 -4
  80. data/lib/rubocop/cop/rails/validation.rb +4 -12
  81. data/lib/rubocop/cop/rails/where_missing.rb +111 -0
  82. data/lib/rubocop/cop/rails/where_not_with_multiple_conditions.rb +55 -0
  83. data/lib/rubocop/cop/rails_cops.rb +10 -0
  84. data/lib/rubocop/rails/version.rb +1 -1
  85. data/lib/rubocop-rails.rb +10 -0
  86. metadata +16 -8
  87. data/bin/console +0 -11
  88. data/bin/setup +0 -7
@@ -0,0 +1,70 @@
1
+ # frozen_string_literal: true
2
+
3
+ module RuboCop
4
+ module Cop
5
+ module Rails
6
+ # Checks for Rails framework classes that are patched directly instead of using Active Support load hooks. Direct
7
+ # patching forcibly loads the framework referenced, using hooks defers loading until it's actually needed.
8
+ #
9
+ # @safety
10
+ # While using lazy load hooks is recommended, it changes the order in which is code is loaded and may reveal
11
+ # load order dependency bugs.
12
+ #
13
+ # @example
14
+ #
15
+ # # bad
16
+ # ActiveRecord::Base.include(MyClass)
17
+ #
18
+ # # good
19
+ # ActiveSupport.on_load(:active_record) { include MyClass }
20
+ class ActiveSupportOnLoad < Base
21
+ extend AutoCorrector
22
+
23
+ MSG = 'Use `%<prefer>s` instead of `%<current>s`.'
24
+ RESTRICT_ON_SEND = %i[prepend include extend].freeze
25
+ LOAD_HOOKS = {
26
+ 'ActionCable' => 'action_cable',
27
+ 'ActionCable::Channel::Base' => 'action_cable_channel',
28
+ 'ActionCable::Connection::Base' => 'action_cable_connection',
29
+ 'ActionCable::Connection::TestCase' => 'action_cable_connection_test_case',
30
+ 'ActionController::API' => 'action_controller',
31
+ 'ActionController::Base' => 'action_controller',
32
+ 'ActionController::TestCase' => 'action_controller_test_case',
33
+ 'ActionDispatch::IntegrationTest' => 'action_dispatch_integration_test',
34
+ 'ActionDispatch::Request' => 'action_dispatch_request',
35
+ 'ActionDispatch::Response' => 'action_dispatch_response',
36
+ 'ActionDispatch::SystemTestCase' => 'action_dispatch_system_test_case',
37
+ 'ActionMailbox::Base' => 'action_mailbox',
38
+ 'ActionMailbox::InboundEmail' => 'action_mailbox_inbound_email',
39
+ 'ActionMailbox::Record' => 'action_mailbox_record',
40
+ 'ActionMailbox::TestCase' => 'action_mailbox_test_case',
41
+ 'ActionMailer::Base' => 'action_mailer',
42
+ 'ActionMailer::TestCase' => 'action_mailer_test_case',
43
+ 'ActionText::Content' => 'action_text_content',
44
+ 'ActionText::Record' => 'action_text_record',
45
+ 'ActionText::RichText' => 'action_text_rich_text',
46
+ 'ActionView::Base' => 'action_view',
47
+ 'ActionView::TestCase' => 'action_view_test_case',
48
+ 'ActiveJob::Base' => 'active_job',
49
+ 'ActiveJob::TestCase' => 'active_job_test_case',
50
+ 'ActiveRecord::Base' => 'active_record',
51
+ 'ActiveStorage::Attachment' => 'active_storage_attachment',
52
+ 'ActiveStorage::Blob' => 'active_storage_blob',
53
+ 'ActiveStorage::Record' => 'active_storage_record',
54
+ 'ActiveStorage::VariantRecord' => 'active_storage_variant_record',
55
+ 'ActiveSupport::TestCase' => 'active_support_test_case'
56
+ }.freeze
57
+
58
+ def on_send(node)
59
+ receiver, method, arguments = *node # rubocop:disable InternalAffairs/NodeDestructuring
60
+ return unless receiver && (hook = LOAD_HOOKS[receiver.const_name])
61
+
62
+ preferred = "ActiveSupport.on_load(:#{hook}) { #{method} #{arguments.source} }"
63
+ add_offense(node, message: format(MSG, prefer: preferred, current: node.source)) do |corrector|
64
+ corrector.replace(node, preferred)
65
+ end
66
+ end
67
+ end
68
+ end
69
+ end
70
+ end
@@ -53,10 +53,7 @@ module RuboCop
53
53
  private
54
54
 
55
55
  def index_range(pair_node)
56
- range_with_surrounding_comma(
57
- range_with_surrounding_space(range: pair_node.loc.expression, side: :left),
58
- :left
59
- )
56
+ range_with_surrounding_comma(range_with_surrounding_space(pair_node.loc.expression, side: :left), :left)
60
57
  end
61
58
  end
62
59
  end
@@ -25,7 +25,7 @@ module RuboCop
25
25
 
26
26
  MSG = 'Controllers should subclass `ApplicationController`.'
27
27
  SUPERCLASS = 'ApplicationController'
28
- BASE_PATTERN = '(const (const nil? :ActionController) :Base)'
28
+ BASE_PATTERN = '(const (const {nil? cbase} :ActionController) :Base)'
29
29
 
30
30
  # rubocop:disable Layout/ClassStructure
31
31
  include RuboCop::Cop::EnforceSuperclass
@@ -28,7 +28,7 @@ module RuboCop
28
28
 
29
29
  MSG = 'Jobs should subclass `ApplicationJob`.'
30
30
  SUPERCLASS = 'ApplicationJob'
31
- BASE_PATTERN = '(const (const nil? :ActiveJob) :Base)'
31
+ BASE_PATTERN = '(const (const {nil? cbase} :ActiveJob) :Base)'
32
32
 
33
33
  # rubocop:disable Layout/ClassStructure
34
34
  include RuboCop::Cop::EnforceSuperclass
@@ -28,7 +28,7 @@ module RuboCop
28
28
 
29
29
  MSG = 'Mailers should subclass `ApplicationMailer`.'
30
30
  SUPERCLASS = 'ApplicationMailer'
31
- BASE_PATTERN = '(const (const nil? :ActionMailer) :Base)'
31
+ BASE_PATTERN = '(const (const {nil? cbase} :ActionMailer) :Base)'
32
32
 
33
33
  # rubocop:disable Layout/ClassStructure
34
34
  include RuboCop::Cop::EnforceSuperclass
@@ -29,7 +29,7 @@ module RuboCop
29
29
 
30
30
  MSG = 'Models should subclass `ApplicationRecord`.'
31
31
  SUPERCLASS = 'ApplicationRecord'
32
- BASE_PATTERN = '(const (const nil? :ActiveRecord) :Base)'
32
+ BASE_PATTERN = '(const (const {nil? cbase} :ActiveRecord) :Base)'
33
33
 
34
34
  # rubocop:disable Layout/ClassStructure
35
35
  include RuboCop::Cop::EnforceSuperclass
@@ -63,8 +63,7 @@ module RuboCop
63
63
 
64
64
  MSG_NIL_OR_EMPTY = 'Use `%<prefer>s` instead of `%<current>s`.'
65
65
  MSG_NOT_PRESENT = 'Use `%<prefer>s` instead of `%<current>s`.'
66
- MSG_UNLESS_PRESENT = 'Use `if %<prefer>s` instead of ' \
67
- '`%<current>s`.'
66
+ MSG_UNLESS_PRESENT = 'Use `if %<prefer>s` instead of `%<current>s`.'
68
67
  RESTRICT_ON_SEND = %i[!].freeze
69
68
 
70
69
  # `(send nil $_)` is not actually a valid match for an offense. Nodes
@@ -111,25 +111,13 @@ module RuboCop
111
111
  remove_timestamps
112
112
  ].freeze
113
113
 
114
- MYSQL_COMBINABLE_TRANSFORMATIONS = %i[
115
- rename
116
- index
117
- remove_index
118
- ].freeze
114
+ MYSQL_COMBINABLE_TRANSFORMATIONS = %i[rename index remove_index].freeze
119
115
 
120
- MYSQL_COMBINABLE_ALTER_METHODS = %i[
121
- rename_column
122
- add_index
123
- remove_index
124
- ].freeze
116
+ MYSQL_COMBINABLE_ALTER_METHODS = %i[rename_column add_index remove_index].freeze
125
117
 
126
- POSTGRESQL_COMBINABLE_TRANSFORMATIONS = %i[
127
- change_default
128
- ].freeze
118
+ POSTGRESQL_COMBINABLE_TRANSFORMATIONS = %i[change_default].freeze
129
119
 
130
- POSTGRESQL_COMBINABLE_ALTER_METHODS = %i[
131
- change_column_default
132
- ].freeze
120
+ POSTGRESQL_COMBINABLE_ALTER_METHODS = %i[change_column_default].freeze
133
121
 
134
122
  def on_def(node)
135
123
  return unless support_bulk_alter?
@@ -186,8 +174,7 @@ module RuboCop
186
174
  options = node.arguments[1]
187
175
  return false unless options
188
176
 
189
- options.hash_type? &&
190
- options.keys.any? { |key| key.sym_type? && key.value == :bulk }
177
+ options.hash_type? && options.keys.any? { |key| key.sym_type? && key.value == :bulk }
191
178
  end
192
179
 
193
180
  def database
@@ -237,8 +224,7 @@ module RuboCop
237
224
  end
238
225
 
239
226
  def call_to_combinable_alter_method?(child_node)
240
- child_node.send_type? &&
241
- combinable_alter_methods.include?(child_node.method_name)
227
+ child_node.send_type? && combinable_alter_methods.include?(child_node.method_name)
242
228
  end
243
229
 
244
230
  def combinable_alter_methods
@@ -93,7 +93,11 @@ module RuboCop
93
93
  end
94
94
 
95
95
  def offense_range(node)
96
- end_pos = node.parent&.block_type? ? node.parent.loc.expression.end_pos : node.loc.expression.end_pos
96
+ end_pos = if node.parent&.block_type? && node.parent&.send_node == node
97
+ node.parent.loc.expression.end_pos
98
+ else
99
+ node.loc.expression.end_pos
100
+ end
97
101
 
98
102
  range_between(node.loc.selector.begin_pos, end_pos)
99
103
  end
@@ -37,9 +37,7 @@ module RuboCop
37
37
  return if node.arguments.count >= 3
38
38
 
39
39
  first_argument = node.first_argument
40
- return if !first_argument ||
41
- allowed_argument?(first_argument) ||
42
- corrected_ancestor?(node)
40
+ return if !first_argument || allowed_argument?(first_argument) || corrected_ancestor?(node)
43
41
 
44
42
  preferred_method = node.first_argument.value.to_s.underscore
45
43
  message = format(MSG, preferred_method: preferred_method, current_argument: first_argument.source)
@@ -58,7 +56,8 @@ module RuboCop
58
56
  argument.send_type? ||
59
57
  argument.const_type? ||
60
58
  argument.splat_type? ||
61
- allowed_name?(argument)
59
+ allowed_name?(argument) ||
60
+ !argument.respond_to?(:value)
62
61
  end
63
62
 
64
63
  def register_offense(node, message, preferred_method)
@@ -82,7 +81,7 @@ module RuboCop
82
81
  def allowed_name?(argument)
83
82
  return false unless argument.str_type? || argument.sym_type?
84
83
 
85
- !/^[a-zA-Z\-][a-zA-Z\-0-9]*$/.match?(argument.value)
84
+ !/^[a-zA-Z-][a-zA-Z\-0-9]*$/.match?(argument.value)
86
85
  end
87
86
 
88
87
  def correction_range(node)
@@ -53,22 +53,17 @@ module RuboCop
53
53
  class Date < Base
54
54
  include ConfigurableEnforcedStyle
55
55
 
56
- MSG = 'Do not use `Date.%<method_called>s` without zone. Use ' \
57
- '`Time.zone.%<day>s` instead.'
56
+ MSG = 'Do not use `Date.%<method_called>s` without zone. Use `Time.zone.%<day>s` instead.'
58
57
 
59
- MSG_SEND = 'Do not use `%<method>s` on Date objects, because they ' \
60
- 'know nothing about the time zone in use.'
58
+ MSG_SEND = 'Do not use `%<method>s` on Date objects, because they know nothing about the time zone in use.'
61
59
 
62
60
  RESTRICT_ON_SEND = %i[to_time to_time_in_current_zone].freeze
63
61
 
64
62
  BAD_DAYS = %i[today current yesterday tomorrow].freeze
65
63
 
66
- DEPRECATED_METHODS = [
67
- { deprecated: 'to_time_in_current_zone', relevant: 'in_time_zone' }
68
- ].freeze
64
+ DEPRECATED_METHODS = [{ deprecated: 'to_time_in_current_zone', relevant: 'in_time_zone' }].freeze
69
65
 
70
- DEPRECATED_MSG = '`%<deprecated>s` is deprecated. ' \
71
- 'Use `%<relevant>s` instead.'
66
+ DEPRECATED_MSG = '`%<deprecated>s` is deprecated. Use `%<relevant>s` instead.'
72
67
 
73
68
  def on_const(node)
74
69
  mod, klass = *node.children
@@ -93,15 +93,12 @@ module RuboCop
93
93
  return false if arg_array.size != argument_array.size
94
94
 
95
95
  arg_array.zip(argument_array).all? do |arg, argument|
96
- arg.arg_type? &&
97
- argument.lvar_type? &&
98
- arg.children == argument.children
96
+ arg.arg_type? && argument.lvar_type? && arg.children == argument.children
99
97
  end
100
98
  end
101
99
 
102
100
  def method_name_matches?(method_name, body)
103
- method_name == body.method_name ||
104
- (include_prefix_case? && method_name == prefixed_method_name(body))
101
+ method_name == body.method_name || (include_prefix_case? && method_name == prefixed_method_name(body))
105
102
  end
106
103
 
107
104
  def include_prefix_case?
@@ -37,7 +37,8 @@ module RuboCop
37
37
  extend AutoCorrector
38
38
 
39
39
  MSG = 'Avoid manipulating ActiveModel errors as hash directly.'
40
- AUTOCORECTABLE_METHODS = %i[<< clear keys].freeze
40
+ AUTOCORRECTABLE_METHODS = %i[<< clear keys].freeze
41
+ INCOMPATIBLE_METHODS = %i[keys values to_h to_xml].freeze
41
42
 
42
43
  MANIPULATIVE_METHODS = Set[
43
44
  *%i[
@@ -55,7 +56,7 @@ module RuboCop
55
56
  {
56
57
  #root_manipulation?
57
58
  #root_assignment?
58
- #errors_keys?
59
+ #errors_deprecated?
59
60
  #messages_details_manipulation?
60
61
  #messages_details_assignment?
61
62
  }
@@ -77,10 +78,10 @@ module RuboCop
77
78
  ...)
78
79
  PATTERN
79
80
 
80
- def_node_matcher :errors_keys?, <<~PATTERN
81
+ def_node_matcher :errors_deprecated?, <<~PATTERN
81
82
  (send
82
83
  (send #receiver_matcher :errors)
83
- :keys)
84
+ {:keys :values :to_h :to_xml})
84
85
  PATTERN
85
86
 
86
87
  def_node_matcher :messages_details_manipulation?, <<~PATTERN
@@ -106,10 +107,10 @@ module RuboCop
106
107
 
107
108
  def on_send(node)
108
109
  any_manipulation?(node) do
109
- next if node.method?(:keys) && target_rails_version <= 6.0
110
+ next if target_rails_version <= 6.0 && INCOMPATIBLE_METHODS.include?(node.method_name)
110
111
 
111
112
  add_offense(node) do |corrector|
112
- next unless AUTOCORECTABLE_METHODS.include?(node.method_name)
113
+ next if skip_autocorrect?(node)
113
114
 
114
115
  autocorrect(corrector, node)
115
116
  end
@@ -118,14 +119,16 @@ module RuboCop
118
119
 
119
120
  private
120
121
 
122
+ def skip_autocorrect?(node)
123
+ return true unless AUTOCORRECTABLE_METHODS.include?(node.method_name)
124
+ return false unless (receiver = node.receiver.receiver)
125
+
126
+ receiver.send_type? && receiver.method?(:details) && node.method?(:<<)
127
+ end
128
+
121
129
  def autocorrect(corrector, node)
122
130
  receiver = node.receiver
123
131
 
124
- if receiver.receiver.send_type? && receiver.receiver.method?(:messages)
125
- corrector.remove(receiver.receiver.loc.dot)
126
- corrector.remove(receiver.receiver.loc.selector)
127
- end
128
-
129
132
  range = offense_range(node, receiver)
130
133
  replacement = replacement(node, receiver)
131
134
 
@@ -133,11 +136,12 @@ module RuboCop
133
136
  end
134
137
 
135
138
  def offense_range(node, receiver)
136
- range_between(receiver.receiver.source_range.end_pos, node.source_range.end_pos)
139
+ receiver = receiver.receiver while receiver.send_type? && !receiver.method?(:errors) && receiver.receiver
140
+ range_between(receiver.source_range.end_pos, node.source_range.end_pos)
137
141
  end
138
142
 
139
143
  def replacement(node, receiver)
140
- return '.errors.attribute_names' if node.method?(:keys)
144
+ return '.attribute_names' if node.method?(:keys)
141
145
 
142
146
  key = receiver.first_argument.source
143
147
 
@@ -24,7 +24,7 @@ module RuboCop
24
24
  TRANSLATE_METHODS = %i[translate t].freeze
25
25
 
26
26
  def_node_matcher :translate_with_scope?, <<~PATTERN
27
- (send {nil? (const nil? :I18n)} {:translate :t} ${sym_type? str_type?}
27
+ (send {nil? (const {nil? cbase} :I18n)} {:translate :t} ${sym_type? str_type?}
28
28
  (hash <$(pair (sym :scope) ${array_type? sym_type?}) ...>)
29
29
  )
30
30
  PATTERN
@@ -37,7 +37,7 @@ module RuboCop
37
37
 
38
38
  add_offense(scope_node) do |corrector|
39
39
  # Eat the comma on the left.
40
- range = range_with_surrounding_space(range: scope_node.source_range, side: :left)
40
+ range = range_with_surrounding_space(scope_node.source_range, side: :left)
41
41
  range = range_with_surrounding_comma(range, :left)
42
42
  corrector.remove(range)
43
43
 
@@ -70,8 +70,8 @@ module RuboCop
70
70
  # @return [Boolean] true if matches
71
71
  def_node_matcher :time_current?, <<~PATTERN
72
72
  {
73
- (send (const _ :Time) :current)
74
- (send (send (const _ :Time) :zone) :now)
73
+ (send (const {nil? cbase} :Time) :current)
74
+ (send (send (const {nil? cbase} :Time) :zone) :now)
75
75
  }
76
76
  PATTERN
77
77
 
@@ -22,19 +22,23 @@ module RuboCop
22
22
  # User.find_by(name: name, email: email)
23
23
  # User.find_by!(email: email)
24
24
  #
25
- # @example AllowedMethods: find_by_sql
25
+ # @example AllowedMethods: ['find_by_sql', 'find_by_token_for'] (default)
26
26
  # # bad
27
27
  # User.find_by_query(users_query)
28
+ # User.find_by_token_for(:password_reset, token)
28
29
  #
29
30
  # # good
30
31
  # User.find_by_sql(users_sql)
32
+ # User.find_by_token_for(:password_reset, token)
31
33
  #
32
- # @example AllowedReceivers: Gem::Specification
34
+ # @example AllowedReceivers: ['Gem::Specification', 'page'] (default)
33
35
  # # bad
34
36
  # Specification.find_by_name('backend').gem_dir
37
+ # page.find_by_id('a_dom_id').click
35
38
  #
36
39
  # # good
37
40
  # Gem::Specification.find_by_name('backend').gem_dir
41
+ # page.find_by_id('a_dom_id').click
38
42
  class DynamicFindBy < Base
39
43
  include ActiveRecordHelper
40
44
  extend AutoCorrector
@@ -49,7 +53,7 @@ module RuboCop
49
53
  method_name = node.method_name
50
54
  static_name = static_method_name(method_name)
51
55
  return unless static_name
52
- return if node.arguments.any? { |argument| IGNORED_ARGUMENT_TYPES.include?(argument.type) }
56
+ return unless dynamic_find_by_arguments?(node)
53
57
 
54
58
  message = format(MSG, static_name: static_name, method: method_name)
55
59
  add_offense(node, message: message) do |corrector|
@@ -61,17 +65,12 @@ module RuboCop
61
65
  private
62
66
 
63
67
  def autocorrect(corrector, node)
64
- keywords = column_keywords(node.method_name)
65
-
66
- return if keywords.size != node.arguments.size
67
-
68
68
  autocorrect_method_name(corrector, node)
69
- autocorrect_argument_keywords(corrector, node, keywords)
69
+ autocorrect_argument_keywords(corrector, node, column_keywords(node.method_name))
70
70
  end
71
71
 
72
72
  def allowed_invocation?(node)
73
- allowed_method?(node) || allowed_receiver?(node) ||
74
- whitelisted?(node)
73
+ allowed_method?(node) || allowed_receiver?(node) || whitelisted?(node)
75
74
  end
76
75
 
77
76
  def allowed_method?(node)
@@ -95,8 +94,7 @@ module RuboCop
95
94
  end
96
95
 
97
96
  def autocorrect_method_name(corrector, node)
98
- corrector.replace(node.loc.selector,
99
- static_method_name(node.method_name.to_s))
97
+ corrector.replace(node.loc.selector, static_method_name(node.method_name.to_s))
100
98
  end
101
99
 
102
100
  def autocorrect_argument_keywords(corrector, node, keywords)
@@ -118,6 +116,20 @@ module RuboCop
118
116
 
119
117
  match[2] ? 'find_by!' : 'find_by'
120
118
  end
119
+
120
+ def dynamic_find_by_arguments?(node)
121
+ dynamic_find_by_arguments_count?(node) && dynamic_find_by_arguments_type?(node)
122
+ end
123
+
124
+ def dynamic_find_by_arguments_count?(node)
125
+ column_keywords(node.method_name).size == node.arguments.size
126
+ end
127
+
128
+ def dynamic_find_by_arguments_type?(node)
129
+ node.arguments.none? do |argument|
130
+ IGNORED_ARGUMENT_TYPES.include?(argument.type)
131
+ end
132
+ end
121
133
  end
122
134
  end
123
135
  end
@@ -37,6 +37,10 @@ module RuboCop
37
37
  )
38
38
  PATTERN
39
39
 
40
+ def self.autocorrect_incompatible_with
41
+ [Style::MethodCallWithArgsParentheses]
42
+ end
43
+
40
44
  def on_send(node)
41
45
  return if node.parent&.block_type?
42
46
 
@@ -20,8 +20,7 @@ module RuboCop
20
20
  class EnumUniqueness < Base
21
21
  include Duplication
22
22
 
23
- MSG = 'Duplicate value `%<value>s` found in `%<enum>s` ' \
24
- 'enum declaration.'
23
+ MSG = 'Duplicate value `%<value>s` found in `%<enum>s` enum declaration.'
25
24
  RESTRICT_ON_SEND = %i[enum].freeze
26
25
 
27
26
  def_node_matcher :enum?, <<~PATTERN
@@ -41,9 +40,7 @@ module RuboCop
41
40
  next unless duplicates?(items)
42
41
 
43
42
  consecutive_duplicates(items).each do |item|
44
- add_offense(item, message: format(
45
- MSG, value: item.source, enum: enum_name(key)
46
- ))
43
+ add_offense(item, message: format(MSG, value: item.source, enum: enum_name(key)))
47
44
  end
48
45
  end
49
46
  end
@@ -96,8 +96,7 @@ module RuboCop
96
96
  end
97
97
 
98
98
  def rails_env_on_lhs?(node)
99
- comparing_str_env_with_rails_env_on_lhs?(node) ||
100
- comparing_sym_env_with_rails_env_on_lhs?(node)
99
+ comparing_str_env_with_rails_env_on_lhs?(node) || comparing_sym_env_with_rails_env_on_lhs?(node)
101
100
  end
102
101
 
103
102
  def build_predicate_method_for_rails_env_on_lhs(node)
@@ -34,15 +34,15 @@ module RuboCop
34
34
  RESTRICT_ON_SEND = %i[join].freeze
35
35
 
36
36
  def_node_matcher :file_join_nodes?, <<~PATTERN
37
- (send (const nil? :File) :join ...)
37
+ (send (const {nil? cbase} :File) :join ...)
38
38
  PATTERN
39
39
 
40
40
  def_node_search :rails_root_nodes?, <<~PATTERN
41
- (send (const nil? :Rails) :root)
41
+ (send (const {nil? cbase} :Rails) :root)
42
42
  PATTERN
43
43
 
44
44
  def_node_matcher :rails_root_join_nodes?, <<~PATTERN
45
- (send (send (const nil? :Rails) :root) :join ...)
45
+ (send #rails_root_nodes? :join ...)
46
46
  PATTERN
47
47
 
48
48
  def on_dstr(node)
@@ -50,8 +50,7 @@ module RuboCop
50
50
  return unless node.children.last.str_type?
51
51
 
52
52
  last_child_source = node.children.last.source
53
- return unless last_child_source.start_with?('.') ||
54
- last_child_source.include?(File::SEPARATOR)
53
+ return unless last_child_source.start_with?('.') || last_child_source.include?(File::SEPARATOR)
55
54
  return if last_child_source.start_with?(':')
56
55
 
57
56
  register_offense(node)
@@ -97,8 +96,7 @@ module RuboCop
97
96
 
98
97
  def register_offense(node)
99
98
  line_range = node.loc.column...node.loc.last_column
100
- source_range = source_range(processed_source.buffer, node.first_line,
101
- line_range)
99
+ source_range = source_range(processed_source.buffer, node.first_line, line_range)
102
100
  add_offense(source_range)
103
101
  end
104
102
 
@@ -13,11 +13,17 @@ module RuboCop
13
13
  # # good
14
14
  # User.all.find_each
15
15
  #
16
- # @example IgnoredMethods: ['order']
16
+ # @example AllowedMethods: ['order']
17
+ # # good
18
+ # User.order(:foo).each
19
+ #
20
+ # @example AllowedPattern: ['order']
17
21
  # # good
18
22
  # User.order(:foo).each
19
23
  class FindEach < Base
20
24
  include ActiveRecordHelper
25
+ include AllowedMethods
26
+ include AllowedPattern
21
27
  extend AutoCorrector
22
28
 
23
29
  MSG = 'Use `find_each` instead of `each`.'
@@ -47,7 +53,7 @@ module RuboCop
47
53
 
48
54
  method_chain = node.each_node(:send).map(&:method_name)
49
55
 
50
- (cop_config['IgnoredMethods'].map(&:to_sym) & method_chain).any?
56
+ method_chain.any? { |method_name| allowed_method?(method_name) || matches_allowed_pattern?(method_name) }
51
57
  end
52
58
 
53
59
  def active_model_error_where?(node)
@@ -0,0 +1,76 @@
1
+ # frozen_string_literal: true
2
+
3
+ module RuboCop
4
+ module Cop
5
+ module Rails
6
+ # Identifies usages of `travel_to` with an argument of the current time and
7
+ # change them to use `freeze_time` instead.
8
+ #
9
+ # @safety
10
+ # This cop’s autocorrection is unsafe because `freeze_time` just delegates to
11
+ # `travel_to` with a default `Time.now`, it is not strictly equivalent to `Time.now`
12
+ # if the argument of `travel_to` is the current time considering time zone.
13
+ #
14
+ # @example
15
+ # # bad
16
+ # travel_to(Time.now)
17
+ # travel_to(Time.new)
18
+ # travel_to(DateTime.now)
19
+ # travel_to(Time.current)
20
+ # travel_to(Time.zone.now)
21
+ # travel_to(Time.now.in_time_zone)
22
+ # travel_to(Time.current.to_time)
23
+ #
24
+ # # good
25
+ # freeze_time
26
+ #
27
+ class FreezeTime < Base
28
+ extend AutoCorrector
29
+
30
+ MSG = 'Use `freeze_time` instead of `travel_to`.'
31
+ NOW_METHODS = %i[now new current].freeze
32
+ CONVERT_METHODS = %i[to_time in_time_zone].freeze
33
+ RESTRICT_ON_SEND = %i[travel_to].freeze
34
+
35
+ # @!method time_now?(node)
36
+ def_node_matcher :time_now?, <<~PATTERN
37
+ (const {nil? cbase} {:Time :DateTime})
38
+ PATTERN
39
+
40
+ # @!method zoned_time_now?(node)
41
+ def_node_matcher :zoned_time_now?, <<~PATTERN
42
+ (send (const {nil? cbase} :Time) :zone)
43
+ PATTERN
44
+
45
+ def on_send(node)
46
+ child_node, method_name, time_argument = *node.first_argument&.children
47
+ return if time_argument || !child_node
48
+ return unless current_time?(child_node, method_name) || current_time_with_convert?(child_node, method_name)
49
+
50
+ add_offense(node) do |corrector|
51
+ last_argument = node.last_argument
52
+ freeze_time_method = last_argument.block_pass_type? ? "freeze_time(#{last_argument.source})" : 'freeze_time'
53
+ corrector.replace(node, freeze_time_method)
54
+ end
55
+ end
56
+
57
+ private
58
+
59
+ def current_time?(node, method_name)
60
+ return false unless NOW_METHODS.include?(method_name)
61
+
62
+ node.send_type? ? zoned_time_now?(node) : time_now?(node)
63
+ end
64
+
65
+ def current_time_with_convert?(node, method_name)
66
+ return false unless CONVERT_METHODS.include?(method_name)
67
+
68
+ child_node, child_method_name, time_argument = *node.children
69
+ return if time_argument
70
+
71
+ current_time?(child_node, child_method_name)
72
+ end
73
+ end
74
+ end
75
+ end
76
+ end