Class: RuboCop::Cop::Lint::Void

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

Overview

This cop checks for operators, variables and literals used in void context.

Examples:


# bad

def some_method
  some_num * 10
  do_something
end

# bad

def some_method(some_var)
  some_var
  do_something
end

# good

def some_method
  do_something
  some_num * 10
end

# good

def some_method(some_var)
  do_something
  some_var
end

Constant Summary collapse

OP_MSG = 
'Operator `%s` used in void context.'.freeze
VAR_MSG = 
'Variable `%s` used in void context.'.freeze
LIT_MSG = 
'Literal `%s` used in void context.'.freeze
SELF_MSG = 
'`self` used in void context.'.freeze
DEFINED_MSG = 
'`%s` used in void context.'.freeze
BINARY_OPERATORS = 
%i[* / % + - == === != < > <= >= <=>].freeze
UNARY_OPERATORS = 
%i[+@ -@ ~ !].freeze
OPERATORS = 
(BINARY_OPERATORS + UNARY_OPERATORS).freeze
VOID_CONTEXT_TYPES = 
%i[def for block].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, 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?, #message, #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?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, operator?, parentheses?, parenthesized_call?, precede?, range_between, range_by_whole_lines, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, symbol_without_quote?, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, find_file_upwards, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#on_begin(node) ⇒ Object Also known as: on_kwbegin 



56
57
58
 
# File 'lib/rubocop/cop/lint/void.rb', line 56

def on_begin(node)
  check_begin(node)
end