Class: RuboCop::Cop::Style::MultilineTernaryOperator

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Defined in:
lib/rubocop/cop/style/multiline_ternary_operator.rb

Overview

This cop checks for multi-line ternary op expressions.

NOTE: ‘return if … else … end` is syntax error. If `return` is used before multiline ternary operator expression, it cannot be auto-corrected.

Examples:

# bad
a = cond ?
  b : c
a = cond ? b :
    c
a = cond ?
    b :
    c

# good
a = cond ? b : c
a = if cond
  b
else
  c
end

Constant Summary collapse

MSG = 
'Avoid multi-line ternary operators, ' \
'use `if` or `unless` instead.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

add_parentheses, args_begin, args_end, begins_its_line?, comment_line?, comment_lines?, double_quotes_required?, escape_string, first_part_of_call_chain, indent, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, hidden_dir?, hidden_file?, hidden_file_in_not_hidden_dir?, match_path?, maybe_hidden_file?, relative_path, smart_path

Constructor Details

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

Instance Method Details

#on_if(node) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/rubocop/cop/style/multiline_ternary_operator.rb', line 34

def on_if(node)
  return unless offense?(node)

  add_offense(node) do |corrector|
    # `return if ... else ... end` is syntax error. If `return` is used before
    # multiline ternary operator expression, it cannot be auto-corrected.
    next unless offense?(node) && !node.parent.return_type?

    corrector.replace(node, <<~RUBY.chop)
      if #{node.condition.source}
        #{node.if_branch.source}
      else
        #{node.else_branch.source}
      end
    RUBY
  end
end