Class: RuboCop::Cop::Rails::InverseOf

Inherits:
Base
  • Object
show all
Extended by:
TargetRailsVersion
Defined in:
lib/rubocop/cop/rails/inverse_of.rb

Overview

Looks for has_(one|many) and belongs_to associations where Active Record can't automatically determine the inverse association because of a scope or the options used. Using the blog with order scope example below, traversing the a Blog's association in both directions with blog.posts.first.blog would cause the blog to be loaded from the database twice.

:inverse_of must be manually specified for Active Record to use the associated object in memory, or set to false to opt-out. Note that setting nil does not stop Active Record from trying to determine the inverse automatically, and is not considered a valid value for this.

Examples:

# good
class Blog < ApplicationRecord
  has_many :posts
end

class Post < ApplicationRecord
  belongs_to :blog
end
# bad
class Blog < ApplicationRecord
  has_many :posts, -> { order(published_at: :desc) }
end

class Post < ApplicationRecord
  belongs_to :blog
end

# good
class Blog < ApplicationRecord
  has_many(:posts,
           -> { order(published_at: :desc) },
           inverse_of: :blog)
end

class Post < ApplicationRecord
  belongs_to :blog
end

# good
class Blog < ApplicationRecord
  with_options inverse_of: :blog do
    has_many :posts, -> { order(published_at: :desc) }
  end
end

class Post < ApplicationRecord
  belongs_to :blog
end

# good
# When you don't want to use the inverse association.
class Blog < ApplicationRecord
  has_many(:posts,
           -> { order(published_at: :desc) },
           inverse_of: false)
end
# bad
class Picture < ApplicationRecord
  belongs_to :imageable, polymorphic: true
end

class Employee < ApplicationRecord
  has_many :pictures, as: :imageable
end

class Product < ApplicationRecord
  has_many :pictures, as: :imageable
end

# good
class Picture < ApplicationRecord
  belongs_to :imageable, polymorphic: true
end

class Employee < ApplicationRecord
  has_many :pictures, as: :imageable, inverse_of: :imageable
end

class Product < ApplicationRecord
  has_many :pictures, as: :imageable, inverse_of: :imageable
end
# bad
# However, RuboCop can not detect this pattern...
class Physician < ApplicationRecord
  has_many :appointments
  has_many :patients, through: :appointments
end

class Appointment < ApplicationRecord
  belongs_to :physician
  belongs_to :patient
end

class Patient < ApplicationRecord
  has_many :appointments
  has_many :physicians, through: :appointments
end

# good
class Physician < ApplicationRecord
  has_many :appointments
  has_many :patients, through: :appointments
end

class Appointment < ApplicationRecord
  belongs_to :physician, inverse_of: :appointments
  belongs_to :patient, inverse_of: :appointments
end

class Patient < ApplicationRecord
  has_many :appointments
  has_many :physicians, through: :appointments
end

IgnoreScopes: false (default)

# bad
class Blog < ApplicationRecord
  has_many :posts, -> { order(published_at: :desc) }
end

IgnoreScopes: true

# good
class Blog < ApplicationRecord
  has_many :posts, -> { order(published_at: :desc) }
end

Constant Summary collapse

SPECIFY_MSG = 
'Specify an `:inverse_of` option.'
NIL_MSG = 
'You specified `inverse_of: nil`, you probably meant to use `inverse_of: false`.'
RESTRICT_ON_SEND = 
%i[has_many has_one belongs_to].freeze

Constants included from TargetRailsVersion

TargetRailsVersion::DEFAULT_RAILS_VERSION, TargetRailsVersion::TARGET_GEM_NAME, TargetRailsVersion::USES_REQUIRES_GEM_API

Instance Method Summary collapse

Methods included from TargetRailsVersion

extended, minimum_target_rails_version, resolve, support_target_rails_version?

Instance Method Details

#dynamic_options?(options) ⇒ Boolean 



223
224
225
 
# File 'lib/rubocop/cop/rails/inverse_of.rb', line 223

def dynamic_options?(options)
  options.any? { |option| option&.kwsplat_type? }
end

#on_send(node) ⇒ Object

rubocop:disable-next Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/rubocop/cop/rails/inverse_of.rb', line 184

def on_send(node)
  recv, arguments = association_recv_arguments(node)
  return unless arguments

  with_options = with_options_arguments(recv, node)

  options = arguments.concat(with_options).flat_map do |arg|
    options_from_argument(arg)
  end
  return if options_ignoring_inverse_of?(options)

  return unless scope?(arguments) || options_requiring_inverse_of?(options)

  return if options_contain_inverse_of?(options)
  return if dynamic_options?(options) && options.none? { |opt| inverse_of_nil_option?(opt) }

  add_offense(node.loc.selector, message: message(options))
end

#options_contain_inverse_of?(options) ⇒ Boolean 



227
228
229
 
# File 'lib/rubocop/cop/rails/inverse_of.rb', line 227

def options_contain_inverse_of?(options)
  options.any? { |opt| inverse_of_option?(opt) }
end

#options_ignoring_inverse_of?(options) ⇒ Boolean 



217
218
219
220
221
 
# File 'lib/rubocop/cop/rails/inverse_of.rb', line 217

def options_ignoring_inverse_of?(options)
  options.any? do |opt|
    through_option?(opt) || polymorphic_option?(opt)
  end
end

#options_requiring_inverse_of?(options) ⇒ Boolean 



207
208
209
210
211
212
213
214
215
 
# File 'lib/rubocop/cop/rails/inverse_of.rb', line 207

def options_requiring_inverse_of?(options)
  required = options.any? do |opt|
    conditions_option?(opt) || foreign_key_option?(opt)
  end

  return required if target_rails_version >= 5.2

  required || options.any? { |opt| as_option?(opt) }
end

#same_context_in_with_options?(arg, recv) ⇒ Boolean 



238
239
240
241
242
 
# File 'lib/rubocop/cop/rails/inverse_of.rb', line 238

def same_context_in_with_options?(arg, recv)
  return true if arg.nil? && recv.nil?

  arg && recv && arg.children[0] == recv.children[0]
end

#scope?(arguments) ⇒ Boolean 



203
204
205
 
# File 'lib/rubocop/cop/rails/inverse_of.rb', line 203

def scope?(arguments)
  !ignore_scopes? && arguments.any?(&:block_type?)
end

#with_options_arguments(recv, node) ⇒ Object 



231
232
233
234
235
236
 
# File 'lib/rubocop/cop/rails/inverse_of.rb', line 231

def with_options_arguments(recv, node)
  blocks = node.each_ancestor(:block).select do |block|
    block.send_node.command?(:with_options) && same_context_in_with_options?(block.first_argument, recv)
  end
  blocks.flat_map { |n| n.send_node.arguments }
end