Class: RuboCop::Cop::Style::IfUnlessModifier

Inherits:
Cop
  • Object
show all
Includes:
RuboCop::Cop::StatementModifier
Defined in:
lib/rubocop/cop/style/if_unless_modifier.rb

Overview

Checks for if and unless statements that would fit on one line if written as a modifier if/unless. The maximum line length is configurable.

Constant Summary

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 included from RuboCop::Cop::StatementModifier

#body_has_comment?, #body_length, #check, #length, #max_line_length

Methods included from IfNode

#elsif?, #if_else?, #modifier_if?, #ternary_op?

Methods inherited from Cop

#add_offense, all, #autocorrect?, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #debug?, #display_cop_names?, #exclude_file?, #include_file?, inherited, #initialize, #join_force?, lint?, #message, non_rails, qualified_cop_name, rails?, #relevant_file?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

block_length, command?, comment_line?, const_name, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_space, source_range, strip_quotes

Methods included from PathUtil

match_path?, relative_path

Constructor Details

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

Instance Method Details

#error_message(keyword) ⇒ Object 



12
13
14
15
 
# File 'lib/rubocop/cop/style/if_unless_modifier.rb', line 12

def error_message(keyword)
  "Favor modifier `#{keyword}` usage when having a single-line body." \
  ' Another good alternative is the usage of control flow `&&`/`||`.'
end

#investigate(processed_source) ⇒ Object 



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/rubocop/cop/style/if_unless_modifier.rb', line 17

def investigate(processed_source)
  return unless processed_source.ast
  on_node(:if, processed_source.ast) do |node|
    # discard ternary ops, if/else and modifier if/unless nodes
    next if ternary_op?(node)
    next if modifier_if?(node)
    next if elsif?(node)
    next if if_else?(node)

    if check(node, processed_source.comments)
      add_offense(node, :keyword,
                  error_message(node.loc.keyword.source))
    end
  end
end