class RuboCop::Cop::Rails::Present

This cop checks for code that can be written with simpler conditionals using `Object#present?` defined by Active Support.

Interaction with `Style/UnlessElse`: The configuration of `NotBlank` will not produce an offense in the context of `unless else` if `Style/UnlessElse` is inabled. This is to prevent interference between the auto-correction of the two cops.

@example NotNilAndNotEmpty: true (default)

# Converts usages of `!nil? && !empty?` to `present?`

# bad
!foo.nil? && !foo.empty?

# bad
foo != nil && !foo.empty?

# good
foo.present?

@example NotBlank: true (default)

# Converts usages of `!blank?` to `present?`

# bad
!foo.blank?

# bad
not foo.blank?

# good
foo.present?

@example UnlessBlank: true (default)

# Converts usages of `unless blank?` to `if present?`

# bad
something unless foo.blank?

# good
something if foo.present?

Constants

MSG_EXISTS_AND_NOT_EMPTY
MSG_NOT_BLANK
MSG_UNLESS_BLANK
RESTRICT_ON_SEND

Public Instance Methods

autocorrect(corrector, node) click to toggle source
# File lib/rubocop/cop/rails/present.rb, line 129
def autocorrect(corrector, node)
  method_call, variable1 = unless_blank?(node)

  if method_call
    corrector.replace(node.loc.keyword, 'if')
    range = method_call.loc.expression
  else
    variable1, _variable2 = exists_and_not_empty?(node) || not_blank?(node)
    range = node.loc.expression
  end

  corrector.replace(range, replacement(variable1))
end
on_and(node) click to toggle source
# File lib/rubocop/cop/rails/present.rb, line 88
def on_and(node)
  return unless cop_config['NotNilAndNotEmpty']

  exists_and_not_empty?(node) do |var1, var2|
    return unless var1 == var2

    message = format(MSG_EXISTS_AND_NOT_EMPTY, prefer: replacement(var1), current: node.source)

    add_offense(node, message: message) do |corrector|
      autocorrect(corrector, node)
    end
  end
end
on_if(node) click to toggle source
# File lib/rubocop/cop/rails/present.rb, line 114
def on_if(node)
  return unless cop_config['UnlessBlank']
  return unless node.unless?
  return if node.else? && config.for_cop('Style/UnlessElse')['Enabled']

  unless_blank?(node) do |method_call, receiver|
    range = unless_condition(node, method_call)
    msg = format(MSG_UNLESS_BLANK, prefer: replacement(receiver),
                                   current: range.source)
    add_offense(range, message: msg) do |corrector|
      autocorrect(corrector, node)
    end
  end
end
on_or(node) click to toggle source
# File lib/rubocop/cop/rails/present.rb, line 102
def on_or(node)
  return unless cop_config['NilOrEmpty']

  exists_and_not_empty?(node) do |var1, var2|
    return unless var1 == var2

    add_offense(node, message: MSG_EXISTS_AND_NOT_EMPTY) do |corrector|
      autocorrect(corrector, node)
    end
  end
end
on_send(node) click to toggle source
# File lib/rubocop/cop/rails/present.rb, line 76
def on_send(node)
  return unless cop_config['NotBlank']

  not_blank?(node) do |receiver|
    message = format(MSG_NOT_BLANK, prefer: replacement(receiver), current: node.source)

    add_offense(node, message: message) do |corrector|
      autocorrect(corrector, node)
    end
  end
end

Private Instance Methods

replacement(node) click to toggle source
# File lib/rubocop/cop/rails/present.rb, line 153
def replacement(node)
  node.respond_to?(:source) ? "#{node.source}.present?" : 'present?'
end
unless_condition(node, method_call) click to toggle source
# File lib/rubocop/cop/rails/present.rb, line 145
def unless_condition(node, method_call)
  if node.modifier_form?
    node.loc.keyword.join(node.loc.expression.end)
  else
    node.loc.expression.begin.join(method_call.loc.expression)
  end
end