class RuboCop::Cop::Rails::RedundantAllowNil
Checks Rails
model validations for a redundant `allow_nil` when `allow_blank` is present.
@example
# 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
Constants
- MSG_ALLOW_NIL_FALSE
- MSG_SAME
- RESTRICT_ON_SEND
Public Instance Methods
on_send(node)
click to toggle source
# File lib/rubocop/cop/rails/redundant_allow_nil.rb, line 41 def on_send(node) 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 if allow_nil_val.type == allow_blank_val.type register_offense(allow_nil, MSG_SAME) elsif allow_nil_val.false_type? && allow_blank_val.true_type? register_offense(allow_nil, MSG_ALLOW_NIL_FALSE) end end
Private Instance Methods
find_allow_nil_and_allow_blank(node)
click to toggle source
# File lib/rubocop/cop/rails/redundant_allow_nil.rb, line 72 def find_allow_nil_and_allow_blank(node) allow_nil, allow_blank = nil node.each_child_node do |child_node| if child_node.pair_type? key = child_node.children.first.source allow_nil = child_node if key == 'allow_nil' allow_blank = child_node if key == 'allow_blank' end return [allow_nil, allow_blank] if allow_nil && allow_blank found_in_children_nodes = find_allow_nil_and_allow_blank(child_node) return found_in_children_nodes if found_in_children_nodes end nil end
node_beg(node)
click to toggle source
# File lib/rubocop/cop/rails/redundant_allow_nil.rb, line 91 def node_beg(node) node.loc.expression.begin_pos end
node_end(node)
click to toggle source
# File lib/rubocop/cop/rails/redundant_allow_nil.rb, line 95 def node_end(node) node.loc.expression.end_pos end
register_offense(allow_nil, message)
click to toggle source
# File lib/rubocop/cop/rails/redundant_allow_nil.rb, line 57 def register_offense(allow_nil, message) add_offense(allow_nil, message: message) do |corrector| prv_sib = allow_nil.left_sibling nxt_sib = allow_nil.right_sibling if nxt_sib corrector.remove(range_between(node_beg(allow_nil), node_beg(nxt_sib))) elsif prv_sib corrector.remove(range_between(node_end(prv_sib), node_end(allow_nil))) else corrector.remove(allow_nil.loc.expression) end end end