Class: RuboCop::Cop::Rails::Present

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/rails/present.rb

Overview

This cops checks for code that can be changed to ‘blank?`. Settings:

NotNilAndNotEmpty: Convert checks for not `nil` and `not empty?`
                   to `present?`
NotBlank: Convert usages of not `blank?` to `present?`
UnlessBlank: Convert usages of `unless` `blank?` to `if` `present?`

Examples:

# NotNilAndNotEmpty: true
  # bad
  !foo.nil? && !foo.empty?
  foo != nil && !foo.empty?
  !foo.blank?

  # good
  foo.present?

# NotBlank: true
  # bad
  !foo.blank?
  not foo.blank?

  # good
  foo.present?

# UnlessBlank: true
  # bad
  something unless foo.blank?

  # good
  something if  foo.present?

Constant Summary collapse

MSG_NOT_BLANK = 
'Use `%s` instead of `%s`.'.freeze
MSG_EXISTS_AND_NOT_EMPTY = 
'Use `%s.present?` instead of `%s`.'.freeze
MSG_UNLESS_BLANK = 
'Use `if %s.present?` instead of `%s`.'.freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, comment_line?, compatible_external_encoding_for?, directions, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_by_whole_lines, range_with_surrounding_comma, range_with_surrounding_space, same_line?, scrub_string, source_range, strip_quotes, stripped_source_upto, symbol_without_quote?, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path, smart_path

Constructor Details

This class inherits a constructor from RuboCop::Cop::Cop

Instance Method Details

#autocorrect(node) ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/rubocop/cop/rails/present.rb', line 110

def autocorrect(node)
  lambda do |corrector|
    method_call, variable1 = unless_blank?(node)

    if method_call && variable1
      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
end

#on_and(node) ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/rubocop/cop/rails/present.rb', line 74

def on_and(node)
  return unless cop_config['NotNilAndNotEmpty']

  exists_and_not_empty?(node) do |variable1, variable2|
    return unless variable1 == variable2

    add_offense(node,
                :expression,
                format(MSG_EXISTS_AND_NOT_EMPTY,
                       variable1.source,
                       node.source))
  end
end

#on_if(node) ⇒ Object 



98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/rubocop/cop/rails/present.rb', line 98

def on_if(node)
  return unless cop_config['UnlessBlank']
  return unless node.unless?

  unless_blank?(node) do |method_call, receiver|
    range = unless_condition(node, method_call)
    add_offense(node,
                range,
                format(MSG_UNLESS_BLANK, receiver.source, range.source))
  end
end

#on_or(node) ⇒ Object 



88
89
90
91
92
93
94
95
96
 
# File 'lib/rubocop/cop/rails/present.rb', line 88

def on_or(node)
  return unless cop_config['NilOrEmpty']

  exists_and_not_empty?(node) do |variable1, variable2|
    return unless variable1 == variable2

    add_offense(node, :expression, MSG_EXISTS_AND_NOT_EMPTY)
  end
end

#on_send(node) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/rubocop/cop/rails/present.rb', line 62

def on_send(node)
  return unless cop_config['NotBlank']

  not_blank?(node) do |receiver|
    add_offense(node,
                :expression,
                format(MSG_NOT_BLANK,
                       replacement(receiver),
                       node.source))
  end
end