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
Public Instance Methods
autocorrect(node)
click to toggle source
# 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)
click to toggle source
# 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
Private Instance Methods
find_allow_nil_and_allow_blank(node)
click to toggle source
# File lib/rubocop/cop/rails/redundant_allow_nil.rb, line 75 def find_allow_nil_and_allow_blank(node) allow_nil = nil allow_blank = nil node.each_descendant do |descendant| next unless descendant.pair_type? key = descendant.children.first.source allow_nil = descendant if key == 'allow_nil' allow_blank = descendant if key == 'allow_blank' break if allow_nil && allow_blank end [allow_nil, allow_blank] end
next_sibling(node)
click to toggle source
# File lib/rubocop/cop/rails/redundant_allow_nil.rb, line 97 def next_sibling(node) node.parent.children[node.sibling_index + 1] end
node_beg(node)
click to toggle source
# File lib/rubocop/cop/rails/redundant_allow_nil.rb, line 101 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 105 def node_end(node) node.loc.expression.end_pos end
offense(allow_nil_val, allow_blank_val, allow_nil)
click to toggle source
# File lib/rubocop/cop/rails/redundant_allow_nil.rb, line 67 def offense(allow_nil_val, allow_blank_val, allow_nil) if allow_nil_val.type == allow_blank_val.type add_offense(allow_nil, message: MSG_SAME) elsif allow_nil_val.false_type? && allow_blank_val.true_type? add_offense(allow_nil, message: MSG_ALLOW_NIL_FALSE) end end
previous_sibling(node)
click to toggle source
# File lib/rubocop/cop/rails/redundant_allow_nil.rb, line 93 def previous_sibling(node) node.parent.children[node.sibling_index - 1] end