123456789_123456789_123456789_123456789_123456789_

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

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::AutoCorrector, ::RuboCop::Cop::Base, ::RuboCop::ExcludeLimit, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain:
Inherits: RuboCop::Cop::Base
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

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

::RuboCop::Cop::Base - Inherited

.gem_requirements, .lint?,
.support_autocorrect?

Returns if class supports autocorrect.

.support_multiple_source?

Override if your cop should be called repeatedly for multiple investigations Between calls to on_new_investigation and on_investigation_end, the result of processed_source will remain constant.

Class Method Summary

::RuboCop::Cop::Base - Inherited

.autocorrect_incompatible_with

List of cops that should not try to autocorrect at the same time as this cop.

.badge

Naming.

.callbacks_needed, .cop_name, .department,
.documentation_url

Returns an url to view this cops documentation online.

.exclude_from_registry

Call for abstract Cop classes.

.inherited,
.joining_forces

Override and return the Force class(es) you need to join.

.match?

Returns true if the cop name or the cop namespace matches any of the given names.

.new,
.requires_gem

Register a version requirement for the given gem name.

.restrict_on_send

::RuboCop::ExcludeLimit - Extended

exclude_limit

Sets up a configuration option to have an exclude limit tracked.

transform

Instance Attribute Summary

Instance Method Summary

::RuboCop::Cop::CommentsHelp - Included

#comments_contain_disables?, #comments_in_range, #contains_comments?, #source_range_with_comment, #begin_pos_with_comment, #buffer, #end_position_for,
#find_end_line

Returns the end line of a node, which might be a comment and not part of the AST End line is considered either the line at which another node starts, or the line at which the parent node ends.

#start_line_position

::RuboCop::Cop::Base - Inherited

#add_global_offense

Adds an offense that has no particular location.

#add_offense

Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense.

#begin_investigation

Called before any investigation.

#callbacks_needed,
#cop_config

Configuration Helpers.

#cop_name, #excluded_file?,
#external_dependency_checksum

This method should be overridden when a cop’s behavior depends on state that lives outside of these locations:

#inspect
#message

Gets called if no message is specified when calling add_offense or add_global_offense Cops are discouraged to override this; instead pass your message directly.

#name

Alias for Base#cop_name.

#offenses,
#on_investigation_end

Called after all on_…​

#on_new_investigation

Called before all on_…​

#on_other_file

Called instead of all on_…​

#parse

There should be very limited reasons for a Cop to do it’s own parsing.

#parser_engine,
#ready

Called between investigations.

#relevant_file?, #target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction,
#callback_argument

Reserved for Cop::Cop.

#complete_investigation

Called to complete an investigation.

#correct, #current_corrector,
#current_offense_locations

Reserved for Commissioner:

#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range,
#reset_investigation

Actually private methods.

#use_corrector

::RuboCop::Cop::AutocorrectLogic - Included

::RuboCop::Cop::IgnoredNode - Included

Constructor Details

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

Instance Method Details

#autocorrect(corrector, node) (private)

[ GitHub ]

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

def autocorrect(corrector, node)
  corrector.replace(node, replacement(node))
  return unless (parent = node.parent)
  return unless (comments_in_condition = comments_in_condition(node))

  corrector.insert_before(parent, comments_in_condition)
end

#comments_in_condition(node) (private)

[ GitHub ]

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

def comments_in_condition(node)
  comments_in_range(node).map do |comment|
    "#{comment.source}\n"
  end.join
end

#enforce_single_line_ternary_operator?(node) ⇒ Boolean (private)

[ GitHub ]

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

def enforce_single_line_ternary_operator?(node)
  SINGLE_LINE_TYPES.include?(node.parent&.type) && !use_assignment_method?(node.parent)
end

#offense?(node) ⇒ Boolean (private)

[ GitHub ]

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

def offense?(node)
  node.ternary? && node.multiline? && node.source != replacement(node)
end

#on_if(node)

[ GitHub ]

  
# 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

#replacement(node) (private)

[ GitHub ]

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

def replacement(node)
  if enforce_single_line_ternary_operator?(node)
    "#{node.condition.source} ? #{node.if_branch.source} : #{node.else_branch.source}"
  else
    <<~RUBY.chop
      if #{node.condition.source}
        #{node.if_branch.source}
      else
        #{node.else_branch.source}
      end
    RUBY
  end
end

#use_assignment_method?(node) ⇒ Boolean (private)

[ GitHub ]

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

def use_assignment_method?(node)
  node.send_type? && node.assignment_method?
end