class RuboCop::Cop::Rails::Validation
This cop checks for the use of old-style attribute validation macros.
@example
# bad validates_acceptance_of :foo validates_confirmation_of :foo validates_exclusion_of :foo validates_format_of :foo validates_inclusion_of :foo validates_length_of :foo validates_numericality_of :foo validates_presence_of :foo validates_absence_of :foo validates_size_of :foo validates_uniqueness_of :foo # good validates :foo, acceptance: true validates :foo, confirmation: true validates :foo, exclusion: true validates :foo, format: true validates :foo, inclusion: true validates :foo, length: true validates :foo, numericality: true validates :foo, presence: true validates :foo, absence: true validates :foo, size: true validates :foo, uniqueness: true
Constants
- ALLOWLIST
- MSG
- RESTRICT_ON_SEND
- TYPES
Public Instance Methods
on_send(node)
click to toggle source
# File lib/rubocop/cop/rails/validation.rb, line 58 def on_send(node) return if node.receiver range = node.loc.selector add_offense(range, message: message(node)) do |corrector| last_argument = node.arguments.last return if !last_argument.literal? && !last_argument.splat_type? && !frozen_array_argument?(last_argument) corrector.replace(range, 'validates') correct_validate_type(corrector, node) end end
Private Instance Methods
braced_options(options)
click to toggle source
# File lib/rubocop/cop/rails/validation.rb, line 138 def braced_options(options) if options.braces? options.source else "{ #{options.source} }" end end
correct_validate_type(corrector, node)
click to toggle source
# File lib/rubocop/cop/rails/validation.rb, line 85 def correct_validate_type(corrector, node) last_argument = node.last_argument if last_argument.hash_type? correct_validate_type_for_hash(corrector, node, last_argument) elsif last_argument.array_type? loc = last_argument.loc correct_validate_type_for_array(corrector, node, last_argument, loc) elsif frozen_array_argument?(last_argument) arguments = node.last_argument.receiver loc = arguments.parent.loc correct_validate_type_for_array(corrector, node, arguments, loc) else range = last_argument.source_range corrector.insert_after(range, ", #{validate_type(node)}: true") end end
correct_validate_type_for_array(corrector, node, arguments, loc)
click to toggle source
# File lib/rubocop/cop/rails/validation.rb, line 113 def correct_validate_type_for_array(corrector, node, arguments, loc) attributes = [] arguments.each_child_node do |child_node| attributes << if arguments.percent_literal? ":#{child_node.source}" else child_node.source end end corrector.replace( loc.expression, "#{attributes.join(', ')}, #{validate_type(node)}: true" ) end
correct_validate_type_for_hash(corrector, node, arguments)
click to toggle source
# File lib/rubocop/cop/rails/validation.rb, line 106 def correct_validate_type_for_hash(corrector, node, arguments) corrector.replace( arguments.loc.expression, "#{validate_type(node)}: #{braced_options(arguments)}" ) end
frozen_array_argument?(argument)
click to toggle source
# File lib/rubocop/cop/rails/validation.rb, line 134 def frozen_array_argument?(argument) argument.send_type? && argument.method?(:freeze) end
message(node)
click to toggle source
# File lib/rubocop/cop/rails/validation.rb, line 75 def message(node) method_name = node.method_name format(MSG, prefer: preferred_method(method_name), current: method_name) end
preferred_method(method)
click to toggle source
# File lib/rubocop/cop/rails/validation.rb, line 81 def preferred_method(method) ALLOWLIST[RESTRICT_ON_SEND.index(method.to_sym)] end
validate_type(node)
click to toggle source
# File lib/rubocop/cop/rails/validation.rb, line 130 def validate_type(node) node.method_name.to_s.split('_')[1] end