Class: RuboCop::Cop::Rails::RedundantAllowNil

Inherits:
Cop
  • Object
show all
Includes:
RuboCop::Cop::RangeHelp
Defined in:
lib/rubocop/cop/rails/redundant_allow_nil.rb

Overview

Checks Rails model validations for a redundant ‘allow_nil` when `allow_blank` is present.

Examples:

# bad
validates :x, length: { is: 5 }, allow_nil: true, allow_blank: true

# bad
validates :x, length: { is: 5 }, allow_nil: false, allow_blank: true

# bad
validates :x, length: { is: 5 }, allow_nil: false, allow_blank: false

# good
validates :x, length: { is: 5 }, allow_blank: true

# good
validates :x, length: { is: 5 }, allow_blank: false

# good
# Here, `nil` is valid but `''` is not
validates :x, length: { is: 5 }, allow_nil: true, allow_blank: false

Constant Summary collapse

MSG_SAME = 
'`allow_nil` is redundant when `allow_blank` has the same value.'
MSG_ALLOW_NIL_FALSE = 
'`allow_nil: false` is redundant when `allow_blank` is true.'

Constants included from Util

Util::LITERAL_REGEX

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?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/rubocop/cop/rails/redundant_allow_nil.rb', line 50

def autocorrect(node)
  prv_sib = previous_sibling(node)
  nxt_sib = next_sibling(node)

  lambda do |corrector|
    if nxt_sib
      corrector.remove(range_between(node_beg(node), node_beg(nxt_sib)))
    elsif prv_sib
      corrector.remove(range_between(node_end(prv_sib), node_end(node)))
    else
      corrector.remove(node.loc.expression)
    end
  end
end

#on_send(node) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/rubocop/cop/rails/redundant_allow_nil.rb', line 38

def on_send(node)
  return unless node.method_name == :validates

  allow_nil, allow_blank = find_allow_nil_and_allow_blank(node)
  return unless allow_nil && allow_blank

  allow_nil_val = allow_nil.children.last
  allow_blank_val = allow_blank.children.last

  offense(allow_nil_val, allow_blank_val, allow_nil)
end