Class: RuboCop::Cop::Style::OneLineConditional

Inherits:

Base

• Object
• Base
• RuboCop::Cop::Style::OneLineConditional

Extended by:

AutoCorrector

Includes:

Alignment, ConfigurableEnforcedStyle, OnNormalIfUnless

Defined in:

lib/rubocop/cop/style/one_line_conditional.rb

Overview

Checks for uses of ‘if/then/else/end` constructs on a single line. A ternary operator (`?:`) or multi-line `if` is more readable. `AlwaysCorrectToMultiline` config option can be set to `true` to autocorrect all offenses to multi-line constructs. When `AlwaysCorrectToMultiline` is `false` (default case) the autocorrect will first try converting them to ternary operators.

Examples:

# bad
if foo then bar else baz end

# bad
unless foo then baz else bar end

# good
foo ? bar : baz

# good
bar if foo

# good
if foo then bar end

# good
if foo
  bar
else
  baz
end

AlwaysCorrectToMultiline: false (default)

# bad
if cond then run else dont end

# good
cond ? run : dont

AlwaysCorrectToMultiline: true

# bad
if cond then run else dont end

# good
if cond
  run
else
  dont
end

Constant Summary

MSG_SUFFIX =

'over single-line `%<keyword>s/then/else/end` constructs.'

MSG_TERNARY =

"Favor the ternary operator (`?:`) #{MSG_SUFFIX}"

MSG_MULTILINE =

"Favor multi-line `%<keyword>s` #{MSG_SUFFIX}"

Constants included from Alignment

Alignment::SPACE

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source, #project_index

Instance Method Summary

• #on_normal_if_unless(node) ⇒ Object

Methods included from AutoCorrector

support_autocorrect?

Methods included from OnNormalIfUnless

#on_if

Methods included from ConfigurableEnforcedStyle

#alternative_style, #alternative_styles, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #style, #style_configured?, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

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?, #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_gem_version, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

cop_dir_for, #exclude_limit, read_limits

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_normal_if_unless(node) ⇒ Object

# File 'lib/rubocop/cop/style/one_line_conditional.rb', line 63

def on_normal_if_unless(node)
  return unless node.single_line?
  return unless node.else_branch
  return if node.elsif? || node.if_branch&.begin_type?

  multiline = multiline?(node)

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

    autocorrect(corrector, node, multiline)

    ignore_node(node)
  end
end