Class: RuboCop::Cop::Rails::Validation

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/rails/validation.rb

Overview

This cop checks for the use of old-style attribute validation macros.

Examples:

# 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_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, size: true
validates :foo, uniqueness: true

Constant Summary collapse

MSG = 
'Prefer the new style validations `%<prefer>s` over ' \
'`%<current>s`.'.freeze
TYPES = 
%w[
  acceptance
  confirmation
  exclusion
  format
  inclusion
  length
  numericality
  presence
  size
  uniqueness
].freeze
DENYLIST = 
TYPES.map { |p| "validates_#{p}_of".to_sym }.freeze
ALLOWLIST = 
TYPES.map { |p| "validates :column, #{p}: value" }.freeze

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?, #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 



59
60
61
62
63
64
65
66
67
 
# File 'lib/rubocop/cop/rails/validation.rb', line 59

def autocorrect(node)
  last_argument = node.arguments.last
  return if !last_argument.literal? && !last_argument.splat_type?

  lambda do |corrector|
    corrector.replace(node.loc.selector, 'validates')
    correct_validate_type(corrector, node)
  end
end

#on_send(node) ⇒ Object 



53
54
55
56
57
 
# File 'lib/rubocop/cop/rails/validation.rb', line 53

def on_send(node)
  return unless !node.receiver && DENYLIST.include?(node.method_name)

  add_offense(node, location: :selector)
end