Class: RuboCop::Cop::Lint::LiteralInCondition

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/lint/literal_in_condition.rb

Overview

This cop checks for literals used as the conditions or as operands in and/or expressions serving as the conditions of if/while/until.

Examples:


if 20
  do_something
end

if some_var && true
  do_something
end

Constant Summary collapse

MSG = 
'Literal `%s` appeared in a condition.'
LITERALS = 
[:str, :dstr, :int, :float, :array,
:hash, :regexp, :nil, :true, :false]
BASIC_LITERALS = 
LITERALS - [:dstr, :array, :hash]

Constants included from Util

Util::ASGN_NODES, Util::EQUALS_ASGN_NODES, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #display_cop_names?, #display_style_guide?, #excluded_file?, inherited, #initialize, #join_force?, lint?, match?, non_rails, qualified_cop_name, rails?, #reference_url, #relevant_file?, #style_guide_url

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?, block_length, command?, comment_line?, const_name, directions, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

This class inherits a constructor from RuboCop::Cop::Cop

Instance Method Details

#message(node) ⇒ Object 



60
61
62
 
# File 'lib/rubocop/cop/lint/literal_in_condition.rb', line 60

def message(node)
  format(MSG, node.loc.expression.source)
end

#on_case(node) ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/rubocop/cop/lint/literal_in_condition.rb', line 48

def on_case(node)
  cond, *whens, _else = *node

  if cond
    check_case_cond(cond)
  else
    whens.each do |when_node|
      check_for_literal(when_node)
    end
  end
end

#on_if(node) ⇒ Object 



28
29
30
 
# File 'lib/rubocop/cop/lint/literal_in_condition.rb', line 28

def on_if(node)
  check_for_literal(node)
end

#on_until(node) ⇒ Object 



40
41
42
 
# File 'lib/rubocop/cop/lint/literal_in_condition.rb', line 40

def on_until(node)
  check_for_literal(node)
end

#on_until_post(node) ⇒ Object 



44
45
46
 
# File 'lib/rubocop/cop/lint/literal_in_condition.rb', line 44

def on_until_post(node)
  check_for_literal(node)
end

#on_while(node) ⇒ Object 



32
33
34
 
# File 'lib/rubocop/cop/lint/literal_in_condition.rb', line 32

def on_while(node)
  check_for_literal(node)
end

#on_while_post(node) ⇒ Object 



36
37
38
 
# File 'lib/rubocop/cop/lint/literal_in_condition.rb', line 36

def on_while_post(node)
  check_for_literal(node)
end