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

Inherits:

Base

• Object
• Base
• RuboCop::Cop::Style::MultilineTernaryOperator

Extended by:

AutoCorrector

Includes:

CommentsHelp

Defined in:

lib/rubocop/cop/style/multiline_ternary_operator.rb

Overview

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 will be autocorrected to single-line ternary operator. The same is true for `break`, `next`, and method call.

Examples:

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

return cond ?
       b :
       c

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

return cond ? b : c

Constant Summary

MSG_IF =

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

MSG_SINGLE_LINE =

'Avoid multi-line ternary operators, use single-line instead.'

SINGLE_LINE_TYPES =

%i[return break next send csend].freeze

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary

• #on_if(node) ⇒ Object

Methods included from AutoCorrector

support_autocorrect?

Methods included from CommentsHelp

#comments_contain_disables?, #comments_in_range, #contains_comments?, #source_range_with_comment

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

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

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#on_if(node) ⇒ Object

# File 'lib/rubocop/cop/style/multiline_ternary_operator.rb', line 44

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

  message = enforce_single_line_ternary_operator?(node) ? MSG_SINGLE_LINE : MSG_IF

  add_offense(node, message: message) do |corrector|
    next if part_of_ignored_node?(node)

    autocorrect(corrector, node)

    ignore_node(node)
  end
end