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:


# bad

if 20
  do_something
end

# bad

if some_var && true
  do_something
end

# good

if some_var && some_condition
  do_something
end

Constant Summary collapse

MSG = 
'Literal `%s` appeared in a condition.'.freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, 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, 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_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?, block_length, comment_line?, compatible_external_encoding_for?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, hard_to_type?, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path

Constructor Details

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

Instance Method Details

#message(node) ⇒ Object 



68
69
70
 
# File 'lib/rubocop/cop/lint/literal_in_condition.rb', line 68

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

#on_case(case_node) ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/rubocop/cop/lint/literal_in_condition.rb', line 56

def on_case(case_node)
  if case_node.condition
    check_case(case_node)
  else
    case_node.each_when do |when_node|
      next unless when_node.conditions.all?(&:literal?)

      add_offense(when_node, :expression)
    end
  end
end

#on_if(node) ⇒ Object 



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

def on_if(node)
  check_for_literal(node)
end

#on_until(node) ⇒ Object 



48
49
50
 
# File 'lib/rubocop/cop/lint/literal_in_condition.rb', line 48

def on_until(node)
  check_for_literal(node)
end

#on_until_post(node) ⇒ Object 



52
53
54
 
# File 'lib/rubocop/cop/lint/literal_in_condition.rb', line 52

def on_until_post(node)
  check_for_literal(node)
end

#on_while(node) ⇒ Object 



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

def on_while(node)
  check_for_literal(node)
end

#on_while_post(node) ⇒ Object 



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

def on_while_post(node)
  check_for_literal(node)
end