Sha256: 18a2424c08e36e3ab0431b7d512c0168624bf4a427e9875bd5a79a0bfa6a6f9e
Contents?: true
Size: 1.81 KB
Versions: 6836
Compression:
Stored size: 1.81 KB
Contents
# frozen_string_literal: true
module RuboCop
module Cop
module Rails
# This cop checks for add_column call with NOT NULL constraint
# in migration file.
#
# @example
# # bad
# add_column :users, :name, :string, null: false
# add_reference :products, :category, null: false
#
# # good
# add_column :users, :name, :string, null: true
# add_column :users, :name, :string, null: false, default: ''
# add_reference :products, :category
# add_reference :products, :category, null: false, default: 1
class NotNullColumn < Cop
MSG = 'Do not add a NOT NULL column without a default value.'.freeze
def_node_matcher :add_not_null_column?, <<-PATTERN
(send nil? :add_column _ _ _ (hash $...))
PATTERN
def_node_matcher :add_not_null_reference?, <<-PATTERN
(send nil? :add_reference _ _ (hash $...))
PATTERN
def_node_matcher :null_false?, <<-PATTERN
(pair (sym :null) (false))
PATTERN
def_node_matcher :default_option?, <<-PATTERN
(pair (sym :default) !nil)
PATTERN
def on_send(node)
check_add_column(node)
check_add_reference(node)
end
private
def check_add_column(node)
pairs = add_not_null_column?(node)
check_pairs(pairs)
end
def check_add_reference(node)
pairs = add_not_null_reference?(node)
check_pairs(pairs)
end
def check_pairs(pairs)
return unless pairs
return if pairs.any? { |pair| default_option?(pair) }
null_false = pairs.find { |pair| null_false?(pair) }
return unless null_false
add_offense(null_false)
end
end
end
end
end
Version data entries
6,836 entries across 6,830 versions & 26 rubygems