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.

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::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES, Util::STRING_ESCAPES, Util::STRING_ESCAPE_REGEX

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?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, #message, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search_body

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?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, ternary_op?, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/rubocop/cop/style/unless_else.rb', line 22

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 



12
13
14
15
16
17
18
19
20
 
# File 'lib/rubocop/cop/style/unless_else.rb', line 12

def on_if(node)
  loc = node.loc

  # discard ternary ops and modifier if/unless nodes
  return unless loc.respond_to?(:keyword) && loc.respond_to?(:else)
  return unless loc.keyword.is?('unless') && loc.else

  add_offense(node, :expression)
end

#range_between_condition_and_else(node, condition) ⇒ Object 



34
35
36
37
38
 
# File 'lib/rubocop/cop/style/unless_else.rb', line 34

def range_between_condition_and_else(node, condition)
  Parser::Source::Range.new(node.source_range.source_buffer,
                            condition.source_range.end_pos,
                            node.loc.else.begin_pos)
end

#range_between_else_and_end(node) ⇒ Object 



40
41
42
43
44
 
# File 'lib/rubocop/cop/style/unless_else.rb', line 40

def range_between_else_and_end(node)
  Parser::Source::Range.new(node.source_range.source_buffer,
                            node.loc.else.end_pos,
                            node.loc.end.begin_pos)
end