Class: RuboCop::Cop::Style::UnlessElse

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/style/unless_else.rb

Overview

This cop looks for unless expressions with else clauses.

Examples:

# bad
unless foo_bar.nil?
  # do something...
else
  # do a different thing...
end

# good
if foo_bar.present?
  # do something...
else
  # do a different thing...
end

Constant Summary collapse

MSG = 
'Do not use `unless` with `else`. Rewrite these with the ' \
'positive case first.'.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

#autocorrect(node) ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/rubocop/cop/style/unless_else.rb', line 32

def autocorrect(node)
  condition, = *node
  body_range = range_between_condition_and_else(node, condition)
  else_range = range_between_else_and_end(node)

  lambda do |corrector|
    corrector.replace(node.loc.keyword, 'if'.freeze)
    corrector.replace(body_range, else_range.source)
    corrector.replace(else_range, body_range.source)
  end
end

#on_if(node) ⇒ Object 



26
27
28
29
30
 
# File 'lib/rubocop/cop/style/unless_else.rb', line 26

def on_if(node)
  return unless node.unless? && node.else?

  add_offense(node)
end

#range_between_condition_and_else(node, condition) ⇒ Object 



44
45
46
 
# File 'lib/rubocop/cop/style/unless_else.rb', line 44

def range_between_condition_and_else(node, condition)
  range_between(condition.source_range.end_pos, node.loc.else.begin_pos)
end

#range_between_else_and_end(node) ⇒ Object 



48
49
50
 
# File 'lib/rubocop/cop/style/unless_else.rb', line 48

def range_between_else_and_end(node)
  range_between(node.loc.else.end_pos, node.loc.end.begin_pos)
end